Fonctions de A à C

Fonctions de A à C.

Activate
AddFlames
AddItem
AddScriptPackage
AddSpell
AddTopic
AdvancePCLevel
AdvancePCSkill
Autosave
CanHaveFlames
CanPayCrimeGold
Cast
CloseCurrentOblivionGate
CloseOblivionGate
CompleteQuest
CreateFullActorCopy

¤ Activate
Fonction d’objet


Syntaxe :
Activate [''ActivatorID''],'' ["Flag"]

Exemple :
Activate player
MonCoffre.Activate
Activate player, 1

Cette fonction indique à l'objet d'exécuter son activation par défaut ou d'exécuter les instructions du bloc OnActivate lorsqu'il est présent.
Un bloc "OnActivate" dans un script d'objet s'exécute à la place de l'activation par défaut du jeu.

Si "ActivatorID" est omis, la fonction Activate utilise la référence de celui qui a réellement activé l'objet. C'est très utile à l'intérieur d'un bloc OnActivate où vous voulez que l'activation procède normalement excepté dans certaines circonstances. Voir exemples plus loin.


Que signifie ceci :

Code:

    Activate

Equivalent à ceci :

Code:

    ref monActeur                      ; déclaration d'une variable de type référence
    set monActeur to GetActionRef      ; la référence qui fait l'action est renseignée
    Activate monActeur                ; l'objet du script est activé par l'acteur

Dans un script, si ActivatorID est inclu, l'objet activé va exécuter son action par défaut comme s'il avait été activé par ActivatorID. C'est important lorsque le fait pour un acteur d'activer un objet à une conséquence sur cet acteur, par exemple une porte de téléportation vers une autre cellule… Voir l'exemple plus loin.

Code:

TYPE D'OBJET                ACTIVATION PAR DEFAUT 
  NPC                            Dialogue   
  Container                      Ouvrir 
  Porte                          Ouvrir   
  Arme                            Equiper 
  Armure                          Equiper
  Vêtement                        Equiper 
  Livre/Manuscrit                Lire 

Si l'option "Flag" est omise, l'objet activé exécute son activation par défaut. Le bloc de script "OnActivate", éventuellement présent dans le script lié à l'objet, n'est pas exécuté. C'est l'utilisation la plus courante de la fonction activate.

Si "Flag" est à 1, l'objet activé exécute son bloc de script "OnActivate", s'il existe. C'est donc un moyen de remplacer l'activation par défaut par le morceau de script contenu dans le bloc "OnActivate". Utiliser cette option avec précaution. La présence accidentelle de la fonction activate avec l'option à 1 dans le bloc "OnActivate" provoque une boucle à l'infini et un blocage du jeu.

Utilisée avec prudence, cette option est un outil puissant, car elle permet d'exécuter des appels (pseudo fonction call) entre des scripts d'objets et même des sorts. La référence "ActivatorId" sert alors d'argument lors de l'activation de l'objet qui rétroagira avec cette référence passée en argument. Cette utilisation de "Activate" est assez particulière et requiert une conception soignée des scripts concernés.

Exemple 1 :

Vous appliquez ce script à une porte , la porte fera comme si le PC l'a réellement activée (si c'est une porte de téléportation, le PC sera téléporté vers le lieu cible).

Code:

    Activate player

Exemple 2 :

Dans ce script, celui qui active l'objet obtient l'activation par défaut que si "MaCondition == 1" est vraie.

Code:

 begin OnActivate
 if MaCondition == 1
  Activate ; exécute l'activation par défaut
 else
  xxxxx    ; faire autre chose
 endif
 end

Exemple 3 :

Ce script boucle sur le message à l'infini – à ne pas faire, bien sûr…
Le bloc OnActivate est dans le script d'un objet qui se réactive lui-même à l'infini

Code:

 float infini
 begin OnActivate
  set infini to infini + .1
  message "Infinity = %.1f", infini 
  activate player, 1
 end

Exemple 4 :

Voici une application intéressante de l'option NormalActivationFlag : Quelque part, un objet comportant ce script est activé. Cela provoque l'activation par le joueur de la référence "MaPorte". Mais comme le flag est à 1, l'activation par défaut de MaPorte est remplacée par l'execution du bloc OnActivate du script associé à " MaPorte"… Si MaPorte est un objet fictif, non implanté dans Oblivion, le script associé se comporte comme un sous-programme, utilisable à chaque fois qu'on active quelque-chose.

Script appelant :

Code:

 begin OnActivate
  ; passe les paramètres Mygate et player à la fonction activate, lors de l'activation par le PC
  if IsActionRef player == 1
      Maporte.Activate player 1
  endif
 end

Script appelé, associé à MaPorte
 begin OnActivate
    … sous programme …
 end

¤ AddFlames
Fonction d’objet

[color:1ac0=orange:1ac0]Syntaxe :
AddFlames

Ajoute un objet [color:1ac0=cyan:1ac0]FlameNode à l'objet appelant.

Ceci est un exemple d'appel de AddFlames et RemoveFlames dans un script.
[[Image:TESCS2_FlameOff.jpg|Avant AddFlames[/b][/size]
[[Image: TESCS2_FlameOn.jpg|Après AddFlames[/b][/size]

[color:1ac0=orange:1ac0]Voir également :
[[Oblivion : FlameNode[/b][/size]
§ CanHaveFlames
§ HasFlames
§ RemoveFlames

¤ AddItem
Fonction d’objet

Syntaxe :
[''ActorID''|''ContainerID''.]AddItem ''ObjectID'', ''Nombre''

Ajoute le "Nombre" d'objets ''ObjectID'' à l'inventaire du container appelant.

Exemples :
AddItem MyObject, 1

Ref MyItem
Short count
set MyItem to ArenaAkaviriLongSword
set count to 1
player.additem MyItem Count

Notes :

* Vous pouvez utiliser
** une variable de type référence comme ''ObjectID''
** une variable de type short pour ''Nombre''.

* Cela ne marche pas dans un bloc OnAdd, car l'objet est directement créé dans l'inventaire plutôt que de lui être vraiment ajouté.
* En test, il est possible que vous ayez besoin d'ajouter des objets au PC à partir de la console pour tester leurs blocs OnAdd. On peut dans ce cas utiliser § PlaceAtMe et prendre directement l'objet placé sur le sol.

Console et identifiant de l'objet

Utilisation de la console : Pour utiliser AddItem (de même pour PlaceAtMe) avec la console, vous devez utiliser le FormID, pas le EditorID. Dans le TESCS2, FormID est dans la petite colonne de l'éditeur d'objets, juste à coté de EditorID. Elargissez cette colonne pour voir l'indentifiant qu'elle contient.

Ainsi, à la console :

player.additem LowerPants02, 1 ; donne une erreur à la console , mais correct dans un script
player.additem 000229AB, 1 ; correct à la console

''FormId est de la forme : yyxxxxxxx.''

Le préfixe "yy" est le n° d'ordre de chargement plugin, xxxxxx la référence de l'objet dans ce plugin (non modifiable). Le préfixe 00 désigne Oblivion.esm, 01 le premier plugin chargé, 02 le deuxième… Le préfixe yy dépend donc de l'ordre et du rang de chargement de votre plugin. Si vous modifiez la liste des plugins dans le jeu, la valeur yy peut donc changer, mais pas xxxxxx. Vérifiez le rang de votre plugin pour utiliser sans risque d'erreur les commandes console. Par ailleurs, un FormID commençant par FF est un objet créé dans la sauvegarde du jeu (références créées au cours du jeu par exemple par un script...)

Voir également :
§ RemoveItem
§ GetItemCount

¤ AddScriptPackage
Fonction d’acteur
Fonction AI (intelligence artificielle)

Description

Ajoute un script de package à l'acteur appelant cette fonction. Ce package a la priorité sur tout autre package, jusqu'à ce qu'il soit terminé. Pour la définition de ce qu'est un package, voir § Packages

Syntaxe

[''ActorID''.]AddScriptPackage ''PackageID''

Exemples

AddScriptPackage MQ07BeggarToTavern

Notes
* Un acteur ne peut exécuter qu'un seul script de package à la fois. Quand on appelle deux fois la fonction AddScriptPackage sur le même acteur, le second package remplace le premier.

* A moins que le script ajouté contienne certaines contraintes comme "must complete" et/ou "must reach location", il est remplacé par un package plus prioritaire que lui, s'il y en a un, dès que l'acteur réévalue ses packages. Par défaut, les packages sont réévalués par le moteur du jeu une fois à chaque heure.

Voir également :
§ RemoveScriptPackage

¤ AddSpell
Fonction d’acteur
Fonction de magie

Ajoute un article de type sort à l'inventaire de l'acteur appelant. Les sorts incluent les maladies, les aptitudes, les sorts et les pouvoirs. Lorsque une aptitude ou une maladie est ajouté, il apparaît parmi les sorts magiques actifs. Quant un sort ou pouvoir est ajouter, il apparaît comme prêt à lancer. Il y a d'autres différences importantes. Voir Sorts pour plus d'informations.

Syntax

[''ActorID''.]AddSpell ''SpellID''

Exemple

AddSpell AbWeaknessNormalWeapons

Notes
*Addspell fonctionne seulement avec les types de sorts listés dans la section "Spells" de la fenêtre "Object window"du TESCS.
*Addspell ne permet pas d'ajouter des "leveled spells" à un acteur par script. Pour ajouter dynamiquement un sort au PC sur la base de son niveau, utiser l'exemple de script suivant :

Code:

 if ( Player.GetLevel >= 25 )
   player.addspell InnerFire25
 elseif ( player.Getlevel >= 20 )
   player. InnerFire20
 elseif ( player.Getlevel >= 15 )
   player.addspell InnerFire15
 elseif ( player.Getlevel >= 10 )
   player.addspell InnerFire10
 elseif ( player.Getlevel >= 5 )
   player.addspell InnerFire05
 else
   player.addspell InnerFire01
 endif

*Soyez prudent lorsque vous utilisez cette fonction sur des acteurs non-uniques (des instances). L'ajout d'une aptitude ou d'un sort à un acteur ajoute également le sort à l'objet de base : si vous le faites, toutes les futures instances de cet objet auront également le sort ou la capacité. Les autres instances déjà créées, en revanche, resteront inchangées.
*Comme beaucoup de fonctions, celle-ci agit un peu différemment lorsqu'elle est utilisée à la console de commande : le sort doit être spécifié par son FormID.

Voir également :
§ RemoveSpell

¤ AddTopic
Fonction de dialogue

Description :

AddTopic ajoute un sujet de dialogue à la liste des sujets connus du PC.

:Seuls les sujets de cette liste peuvent apparaître dans la liste des sujets de dialogue d'un NPC. Des sujets peuvent également être ajoutés en utilisant la liste "AddTopic" de la fenêtre de l'éditeur de dialogue. Voir l'article § Edition d'un dialogue.

Syntaxe :
AddTopic TopicID

Exemple :
AddTopic HiddenCave

¤ AdvancePCLevel
Fonction du PJ

Syntaxe :

advLevel

----
Permet d'augmenter manuellement le niveau du PC par l'affichage du menu "level up".

¤ AdvancePCSkill
Fonction du PJ

Syntaxe :
AdvancePCSkill ''Skill'' ''Amount''
advSkill ''Skill'' ''Amount''

Exemple :
AdvancePCSkill Blade 2

Augmente un talent du PJ (PC) de la quantité ''Amount'', comme si le PJ avait augmenté son talent par l'utilisation ou l'entrainement.

Cette fonction est sujette aux mêmes problèmes que § ModPCSkill. Consultez, s'il vous plait, cette page avant d'utiliser cette fonction.

¤ Autosave
Fonction diverse

Syntaxe :
Autosave
----
Force une sauvegarde automatique dans l'emplacement habituel de sauvegarde automatique.

¤ CanHaveFlames
Fonction d’objet
Fonction condition

Syntaxe :
CanHaveFlames

Retourne la valeur 1 si l'objet appelant peut avoir des flames.

Voir également :
§ HasFlames
§ AddFlames
§ RemoveFlames

¤ CanPayCrimeGold
Fonction de crime
Fonction condition

Syntaxe :
CanPayCrimeGold

Retourne 1 si l'acteur appelant possède suffisamment d'or dans son inventaire pour payer sa pénalité , 0 sinon.

Voir également :
§ GetCrimeGold
§ ModCrimeGold
§ SetCrimeGold

¤ Cast
Fonction d’acteur
Fonction de magie


Syntaxe :
[''ActorID''|''ActivatorID''.]Cast ''SpellID'' [''TargetRefID'']
Exemple :
Cast ShrineAkatoshSpeedMagicka Player
Player.Cast ShrineAkatoshSpeedMagicka Aenvir

L'objet appelant (acteur ou activateur) lance un sort de magie sur la cible. Sorts proprement-dits seulement (impossible de faire lancer des maladies, des capacités ou des pouvoirs de cette manière).


Le sort sera lancé même si son lanceur n’a pas le sort dans sa liste de sorts connus, et aucun point de mana ne lui sera retiré.

¤ CloseCurrentOblivionGate
Fonction diverse

Syntaxe :
CloseCurrentOblivionGate iNoResetFlag (optional)


Lorsque CloseCurrentOblivionGate est appelée, le monde d'Oblivion dans lequel se trouve le joueur est fermé. Le joueur est renvoyé là où il est entré, face à la porte. Ensuite, la porte s'effondre et est marquée comme détruite (inutilisable). Les acteurs étrangers sortent par la porte et le monde relié réinitialisé (fermé ?).

Si l'option iNoResetFlag = 1, le monde d'Oblivion n'est pas réinitialisé (fermé, détruit ?) quand la porte est fermée.

Voir également :
§ CloseOblivionGate

¤ CloseOblivionGate
Fonction diverse

Syntaxe :
CloseOblivionGate iNoResetFlag (optional)


Fonction de Référence.

Si la référence appelante est une porte d'Oblivion, celle-ci se ferme.

Voir § CloseCurrentOblivionGate pour les effets.


Voir également :
§ CloseCurrentOblivionGate

¤ CompleteQuest
Fonction de quête

Syntaxe :
CompleteQuest ''QuestID''
Exemple :
CompleteQuest SQ09

Marque la quête comme terminée. Le seul effet visible est que la quête est celle-ci est maintenant affichée comme terminée dans la liste des quêtes.

Voir également :
§ StartQuest
§ StopQuest

¤ CreateFullActorCopy
Fonction d’acteur
Fonction de variable de référence

Syntaxe :
[''ActorID''.]CreateFullActorCopy

Exemple 1 :
player.CreateFullActorCopy

Crée une copie de l'acteur spécifié et de sa base.


Exemple 2 :
set newRef to player.CreateFullActorCopy

Crée une copie de l'acteur et retourne la référence de la nouvelle copie, utilisable pour renseigner une variable de référence.


Dans les deux cas, la copie est une duplication exacte de l'acteur d'origine, y compris l'inventaire, avec les exceptions suivantes :

* Les articles de l'inventaire sont dupliqués de la même manière que la fonction § DuplicateAllItems
* La copie n'a pas d' AI packages ni de factions.

Voir également :
* § DeleteFullActorCopy
* § DuplicateNPCStats
* § PlaceAtMe