Api ActiveX Flash

Méthodes de la classe MovieClip

Liste des méthodes de la classe MovieClip mises à disposition par le contrôle ActiveX Shockwave Flash.

• TGotoFrame
• TGotoLabel
• TCurrentFrame
• TCurrentLabel
• TPlay
• TStopPlay
• TSetProperty
• TSetPropertyNum
• TGetProperty
• TGetPropertyNum
• TGetPropertyAsNumber
• TCallFrame
• TCallLabel

Les méthodes suivantes utilisent des namespaces (path ou chemin) pour déclarer, évaluer une variable ou atteindre un MovieClip. Ces namespaces sont tous restés formaté comme ils l'étaient historiquement lors de leur création avec le langage Actionscript du player Flash4.
La syntaxe de ces arguments avec le langage de script Flash 5 et de version supérieure est : _root.myMovie.myVariable mais s'écrit ici /myMovie:MyVariable.

Important: Si la cible sur laquelle doit être appliquée une de ces méthodes ne peut-être trouvée, cela provoquera une erreur JScript.

TGotoFrame

• [in] BSTR Target
• [in] long FrameNum

Déplaces la tête de lecture de l'animation secondaire Target sur sa frame désignée par l'entier FrameNum , et arrêtes la lecture du MovieClip lorsque celle-ci est en cours. Si la frame en question n'existe pas ou qu'elle n'est pas encore chargée, la tête de lecture se déplace sur la dernière frame accessible de l'animation et s'y arrête.

Identique à la méthode GotoFrame à ceci prés que la cible de l'action de TGotoFrame n'est pas l'animation principale, mais le movieClip Target désigné par le premier argument de la fonction.Si la cible de la fonction est réduite à "/" , le résultat de l'appel à la méthode sera strictement identique à celui de la méthode GotoFrame. Si le nom de la cible de la méthode ne peut-être résolu lors de l'appel à la méthode, cet appel restera sans conséquences.

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    //AVEC UNE ANIMATION CONTENANT UN CLIP POSE DIRECTEMENT SUR LA SCENE ET NOMME myMovie:
    oAnimation.TGotoFrame('/myMovie',15);
}

Important: Les frames sont zéro indéxées contrairement à l'argument utilisé avec la méthode Actionscript MovieClip.gotoAndStop à laquelle elle est identique.

TGotoLabel

• [in] BSTR Target
• [in] BSTR Label

Identique à la méthode TGotoFrame mais avec la possibilité de passer le label d'une frame d'un MovieClip ou de l'animation principale en tant que deuxième argument de la méthode.

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    //AVEC UNE ANIMATION CONTENANT UN CLIP POSE DIRECTEMENT SUR LA SCENE ET NOMME myMovie:
    oAnimation.TGotoFrame('/myMovie','some_frame_label');
}

TCurrentFrame

• [in] BSTR target
• [out, retval] long* FrameNum

Retournes le numéro de la frame de l'animation secondaire target sur laquelle se situe actuellement la tête de lecture.
Si aucun MovieClip correspondant à l'argument target n'a pu être trouvé, l'appel à la méthode retournera -1.

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    var nCurrentFrame;

    nCurrentFrame = oAnimation.TCurrentFrame('/myMovie');

    if( nCurrentFrame == -1)
        alert("Le MovieClip '/myMovie' n'existe pas");
    else
        alert("Le MovieClip est sur sa frame n°" + nCurrentFrame + " .");
}

Important: Le numéro de la frame retourné est zéro indexé.

TCurrentLabel

• [in] BSTR target
• [out, retval] BSTR* pVal

Retournes le label porté par la frame de l'animation secondaire target sur laquelle se situe actuellement la tête de lecture.
Si aucun MovieClip correspondant à l'argument target n'a pu être trouvé, ou la tête de lecture ne se situe actuellement sur aucune frame portant un label, l'appel à la méthode retournera une chaîne vide.

Cette méthode ne trouve actuellement aucun équivalent en ActionScript et peut donc se révéler trés pratique pour résoudre le besoin d'y avoir recours.

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    var sCurrentFrameLabel;

    sCurrentFrameLabel = oAnimation.TCurrentLabel('/myMovie');

    if( sCurrentFrameLabel == "")
        alert("Le MovieClip n'existe pas ou sa frame courante ne porte aucun label");
    else
        alert("Le MovieClip est sur sa frame de label: " + sCurrentFrameLabel + " .");
}

TPlay

• [in] BSTR target

Lances la lecture de l'animation secondaire target lorsque celle-ci est arrêtée. Cette méthode est l'équivalent de la méthode ActionScript MovieClip.play.

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    oAnimation.TPlay('/myMovie');
}

TStopPlay

• [in] BSTR target

Arrêtes la lecture de l'animation secondaire target lorsque celle-ci est en cours de lecture. Cette méthode est l'équivalent de la méthode ActionScript MovieClip.stop().

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    oAnimation.TStopPlay();
}

TSetProperty

• [in] BSTR target
• [in] int property
• [in] BSTR value

Affectes une valeur à la propriété native property de l'animation secondaire target.

Chaque propriété est codée par un nombre trouvant sa correspondance une liste de 19 propriétés.Toutes ces propriétés ne peuvent se voir affecter une valeur.
La valeur d'affectation de chaque propriété doit être passée comme une chaîne.

Les valeurs JScript de type numérique peuvent être passées telles quelles puisqu'elles seront automatiquement converties en chaîne lors de l'appel à la méthode.

Liste des propriétés de l'occurence de la classe Actionscript MovieClip qui peuvent recevoir une affectation:

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    //LA TAILLE DU MOVIE CLIP *myMovie* EST FIXEE A 500 PIXELS EN LARGEUR
    oAnimation.TSetProperty('/myMovie',8,'500');
}

TSetPropertyNum

• [in] BSTR target
• [in] int property
• [in] double value

Affectes une valeur à la propriété native property de l'animation secondaire target.

Chaque propriété est codée par un nombre trouvant sa correspondance une liste de 19 propriétés. Toutes ces propriétés ne peuvent se voir affecter une valeur.
La valeur d'affectation de chaque propriété doit être passée comme un nombre.

Cette propriété a une action strictement identique à celle de la propriété TSetProperty à ceci prés que le format numérique de la valeur value exclue l'affectation de toutes les propriétés nécessitant le passage d'une valeur de type chaîne. Le passage d'une valeur de type chaîne provoquera une erreur Jscript.

Liste des propriétés de l'occurence de la classe Actionscript MovieClip qui peuvent recevoir une affectation par une valeur numérique:

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    //LA TAILLE DU MOVIE CLIP *myMovie* EST FIXEE A 500 PIXELS EN LARGEUR
    oAnimation.TSetPropertyNum('/myMovie',8,500);
}

TGetProperty

• [in] BSTR target
• [in] int property
• [out, retval] BSTR* pVal

Retournes la valeur de la propriété native property de l'animation secondaire target.

Chaque propriété est codée par un nombre trouvant sa correspondance une liste de 19 propriétés. Toutes ces propriétés peuvent être évaluées
La valeur de chaque propriété est retournée comme une chaîne.

Liste des propriétés de l'occurence de la classe Actionscript MovieClip qui peuvent recevoir une affectation par une valeur numérique:

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    var sValue,nValue;

    sValue = oAnimation.TGetProperty('/myMovie',8);

    //IL FAUT CONVERTIR LA VALEUR EN VARIABLE DE TYPE NOMBRE AU PREALABLE
    nValue = parseFloat(sValue);

    if( nValue >= 500)
        alert('La largeur du MovieClip *myMovie* est supérieure à 500 pixels');
    else
       alert('La largeur du MovieClip *myMovie* est inférieure à 500 pixels');    
}

TGetPropertyNum

• [in] BSTR target
• [in] int property
• [out, retval] double* pVal

Retournes la valeur de la propriété native property de l'animation secondaire target.

Chaque propriété est codée par un nombre trouvant sa correspondance une liste de 19 propriétés. Toutes ces propriétés peuvent être évaluées
La valeur de chaque propriété est retournée comme un nombre.

Cette propriété a une action strictement identique à celle de la propriété TGetProperty à ceci prés que le format numérique de la valeur value retournée exclue l'évaluation de toutes les propriétés nécessitant le passage d'une valeur de type chaîne. L'évaluation d'une valeur de propriété de type chaîne retournera une variable de type nombre de valeur NaN. Pour aller jusqu'au bout des choses, il faudrait préciser que toutes les valeurs de types chaînes sont reçues, mais sont en fait évaluées par la fonction parsefloat(value) avant d'être retournées. Un MovieClip nommé "1" retournerait la valeur numérique 1 ce qui est une aberration. Pour simplifier, donc, toutes les valeurs de propriété de type chaîne seront supprimées du tableau.

Liste des propriétés de l'occurence de la classe Actionscript MovieClip qui peuvent être évaluée par une pure valeur numérique:

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    var nValue;

    nValue = oAnimation.TGetProperty('/myMovie',8);

    if( nValue >= 500)
        alert('La largeur du MovieClip *myMovie* est supérieure à 500 pixels');
    else
       alert('La largeur du MovieClip *myMovie* est inférieure à 500 pixels');    
}

TGetPropertyAsNumber

Strictement identique à TGetPropertyNum.

TCallFrame

• [in] BSTR target
• [in] int FrameNum

Permet d'exécuter le code situé sur la frame de numéro frameNum de l'animation target sans modifier la position de la tête de lecture sur cette même animation. Avec le langage de script Flash4, il s'agit de la seule solution pour exécuter plusieurs fois le même code sur le temps d'exécution d'une même frame de l'animation.

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    oAnimation.TCallFrame('/myMovie',8);
}

Important: Les frames sont zéro indéxées contrairement à l'argument utilisé avec la méthode Actionscript MovieClip.call à laquelle elle est identique.

TCallLabel

• [in] BSTR target
• [in] BSTR label

Permet d'exécuter le code situé sur la frame portant le label label de l'animation target sans modifier la position de la tête de lecture sur cette même animation. Avec le langage de script Flash4, il s'agit de la seule solution pour exécuter plusieurs fois le même code sur le temps d'exécution d'une même frame de l'animation.

Exemple d'appel à la méthode depuis Jscript:

window.onTest = function(oAnimation)
{
    oAnimation.TCallLabel('/myMovie','some_frame_label');
}