Instruction function

Utilisation 1 : (Déclare une fonction nommée.)function functionname([parameter0, parameter1,...parameterN]){statement(s)}Utilisation 2 : (Déclare une fonction anonyme et renvoie une référence à cette dernière.)function ([parameter0, parameter1,...parameterN]){ statement(s) }

Comprend un ensemble d'instructions que vous définissez pour effectuer une certaine tâche. Vous pouvez définir une fonction à un emplacement et l'appeler à partir de différents scripts dans un fichier SWF. Lorsque vous définissez une fonction, vous pouvez également spécifier des paramètres pour la fonction. Les paramètres sont des espaces réservés pour les valeurs sur lesquelles la fonction opère. Vous pouvez passer différents paramètres à une fonction lors de chaque appel, de façon à pouvoir utiliser une fonction dans différentes situations.

Utilisez l'instruction return dans le paramètre statement(s) d'une fonction pour que cette dernière génère ou renvoie une valeur.

Vous pouvez utiliser cette instruction pour définir une function ayant les paramètres spécifiés functionname, parameters, et statement(s). Lorsqu'un script appelle une fonction, les instructions figurant dans la définition de la fonction s'exécute. Les références anticipées sont autorisées. Dans un script, une fonction peut être déclarée après son appel. Une définition de fonction remplace toute définition précédente de la même fonction. Vous pouvez utiliser cette syntaxe dans toutes les circonstances où une instruction est autorisée.

Vous pouvez également utiliser cette instruction pour créer une fonction anonyme et lui renvoyer une référence. Cette syntaxe est utilisée dans des expressions et est particulièrement utile pour l'installation des méthodes dans les objets.

Pour bénéficier de fonctionnalités supplémentaires, vous pouvez utiliser l'objet arguments dans votre définition de fonction. Certaines utilisations communes de l'objet arguments créent une fonction qui accepte un nombre variable de paramètres et créent une fonction anonyme récursive.

Disponibilité : ActionScript 1.0 ; Flash Lite 2.0

Valeur renvoyée

String : Usage 1 : Le formulaire de déclaration ne doit rien renvoyer. Utilisation 2 : référence à la fonction anonyme.

Paramètres

functionname:String - Nom de la fonction déclarée.

Exemple

L'exemple suivant définit la fonction sqr qui accepte un paramètre et renvoie la valeur Math.pow(x, 2) du paramètre :

function sqr(x:Number) { 
 return Math.pow(x, 2); 
} 
var y:Number = sqr(3); 
trace (y); // Renvoie : 9

Si la fonction est définie et utilisée dans le même script, la définition de fonction peut apparaître lorsque vous l'avez utilisée :

var y:Number = sqr(3); 
trace (y); // Renvoie : 9 
function sqr(x:Number) { 
 return Math.pow(x, 2); 
}

La fonction suivante crée un objet LoadVars et charge params.txt dans le fichier SWF. Si le chargement du fichier réussit, variables loaded est renvoyé :

var myLV:LoadVars = new LoadVars(); 
myLV.load("params.txt"); 
myLV.onLoad = function(success:Boolean) { 
 trace("variables loaded"); 
}