NWScript - Fonctions G (... et fin)

GetMaster(...)

object GetMaster
(
    object oAssociate = OBJECT_SELF
)

Paramètres :
- oAssociate : L'objet concerné (défaut : OBJECT_SELF).

Description :
Renvoie la valeur "object" de la créature à laquelle appartient la créature désignée par oAssociate.

Fonction(s) connexe(s) :
GetAssociate

GetMatchedSubstring(...)

string GetMatchedSubstring
(
    int nString
)

Paramètres :
- nString : La chaîne de caractères concernée.

Description :
Renvoie la partie d'une chaîne de caractères, dont l'index est défini par nString. Cette fonction s'utilise lorsque l'événement "OnConversation" d'une créature, d'un plaçable, ou d'une porte a été déclenché. La description de Bioware/Obsidian se résumant à ces deux phrases, voici quelques détails supplémentaires :

Pour que cette fonction soit effective, il faut que des valeurs de type "string" soient indexées sur l'objet grâce à la fonction "SetListenPattern(...)". Ces valeurs indexées auront un identifiant grâce auquel une comparaison sera possible lorsque l'événement "OnConversation" sera déclenché.

En outre, il est possible d'indexer le terme "**", celui-ci analysant toute chaîne de caractères, quelque soit sa valeur (correspond au terme "*" utilisé lors d'une recherche de fichier). Il est également possible de combiner ce terme à une autre chaîne de caractères (ex. "Bon**"), permettant l'analyse de toute chaîne de caractères commençant par "Bon". De la même manière, il est possible d'inverser la combinaison (ex. "**jour"), permettant donc l'analyse de toute chaîne de caractères se terminant par "jour". Enfin, une combinaison complexe est possible, en assemblant plusieurs valeurs séparée par ce même terme (ex. "jour**main"). Notez que la fonction "GetMatchedSubStringCount()" permet de déterminer combien de parties de texte on été indexées. Notez également que les majuscules et minuscules ne sont pas prises en compte. Il est possible d'indexer "ABC", et de retrouver "abc", "AbC" ou encore "aBc".

En pratique, voici comment "GetMatchedSubstring(...)" se présente :

Admettons que nous avons indexé la chaîne de caractères "bon**". Cette méthode d'analyse comprendra deux parties : Le premier "bon" trouvé, et ce qui se trouve après. Le PNJ reconnaîtra donc toute phrase comprenant "bon". la fonction "GetMatchedSubstring(...)" nous permet ensuite de séparer les parties et renvoyer ce qui nous intéresse. C'est flou mais c'est ça qui est bon.

Si la phrase "Je vous souhaite le bonjour, messire." est prononcée :
- "GetMatchedSubstring( 0 )" renverra la valeur "bon".
- "GetMatchedSubstring( 1 )" renverra la valeur "jour, messire.".
L'indexation de la phrase estdonc : "[bon][jour, messire.]".

Si la même phrase est prononcée, mais que "**bon" a été indexé :
- "GetMatchedSubstring( 0 )" renverra la valeur "Je vous souhaite le ".
- "GetMatchedSubstring( 1 )" renverra la valeur "bon".
L'indexation de la phrase est donc : "[Je vous souhaite le ][bon]".

Admettons maintenant que nous avons indexé la chaîne de caractères "**pa**bon**". Cette méthode d'analyse comprendra cinq parties : "**", le premier "pa" trouvé, "**", le premier "bon" trouvé, et encore "**". C'est encore plus flou, je sais.

Si la phrase "Mon papa me donne un bonbon au piment." est prononcée :
- "GetMatchedSubstring( 0 )" renverra la valeur "Mon " (ce qui se trouve avant le premier "pa").
- "GetMatchedSubstring( 1 )" renverra la valeur "pa" (le premier "pa" trouvé : "mon papa...").
- "GetMatchedSubstring( 2 )" renverra la valeur "pa me donne un " (ce qui se trouve après le premier "pa" et avant le premier "bon").
- "GetMatchedSubstring( 3 )" renverra la valeur "bon" (le pemier "bon" trouvé : "un bonbon...").
- "GetMatchedSubstring( 4 )" renverra la valeur "bon au piment." (ce qui se trouve après le premier "bon").
L'indexation de la phrase est donc : "[Mon ][pa][pa me donne un ][bon][bon au piment.]".

Notez bien que le compte part de 0, qui correspondra à la première partie indexée ayant été trouvée.

Je sais, moi aussi j'ai du mal. Dites-vous bien que c'est l'une des pires fonctions que la terre ait jamais porté.

Fonction(s) connexe(s) :
GetMatchedSubstringsCount, SetListenPattern

GetMatchedSubstringsCount()

int GetMatchedSubstringsCount()

Description :
Renvoie le nombre de parties de texte indexées dans une chaîne de caractères. Comme la fonction précédente, nous voila bien avancés avec cette simple description made in Bioware/Obsidian. Voici donc un petit exemple pour la route, en admettant que nous nous trouvons dans les deux mêmes cas précédents :

"bon**" est indexé, et la phrase "Je vous souhaite le bonjour, messire." est prononcée : "GetMatchedSubstringsCount()" renverra la valeur 2 car deux valeurs indexées ont été trouvées ("bon", et "jour, messire.")

"**pa**bon**" est indexé, et la phrase "Mon papa me donne un bonbon au piment." est prononcée : "GetMatchedSubstringsCount()" renverra la valeur 5 car cinq valeurs indexées ont été trouvées ("Mon ", "pa", "pa me donne un ", "bon" et "bon au piment.")

Fonction(s) connexe(s) :
GetMatchedSubstring

GetMaxHenchmen()

int GetMaxHenchmen()

Description :
Renvoie le nombre de compagnons d'arme pouvant être attribués à une créature.

Fonction(s) connexe(s) :
SetMaxHenchmen

GetMaxHitPoints(...)

int GetMaxHitPoints
(
    object oObject = OBJECT_SELF
)

Paramètres :
- oObject : L'objet concerné (défaut : OBJECT_SELF).

Description :
Renvoie le nombre de points de vie maximum de l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetCurrentHitPoints

GetMetaMagicFeat()

int GetMetaMagicFeat()

Description :
Renvoie le type de métamagie utilisée lors du dernier sort lancé par l'objet source. La valeur renvoyée peut être comparée aux constantes METAMAGIC_*. Cette fonction s'utilise dans le script d'un sort, ou lors d'un événement "OnSpellCastAt".

Fonction(s) connexe(s) :
GetLastSpell

GetModule()

object GetModule()

Description :
Renvoie la valeur "object" du module.

Fonction(s) connexe(s) :
GetModuleName

GetModuleItemAcquired()

object GetModuleItemAcquired()

Description :
Renvoie la valeur "object" du dernier item ayant été acquis par un joueur. Cette fonction s'utilise lors de l'événement "OnItemAcquired" du module.

Fonction(s) connexe(s) :
GetModuleItemAcquiredBy, GetModuleItemAcquiredFrom, GetModuleItemAcquiredStackSize, GetModuleItemLost

GetModuleItemAcquiredBy()

object GetModuleItemAcquiredBy()

Description :
Renvoie la valeur "object" du dernier joueur ayant acquis un item. Cette fonction s'utilise lors de l'événement "OnItemAcquired" du module.

Fonction(s) connexe(s) :
GetModuleItemAcquired, GetModuleItemAcquiredFrom, GetModuleItemAcquiredStackSize, GetModuleItemLostBy

GetModuleItemAcquiredFrom()

object GetModuleItemAcquiredFrom()

Description :
Renvoie la valeur "object" du précédent possesseur du dernier item ayant été acquis par un joueur. La valeur OBJECT_INVALID sera renvoyée si l'item a été récupéré directement du sol.

Fonction(s) connexe(s) :
GetModuleItemAcquired, GetModuleItemAcquiredBy, GetModuleItemAcquiredStackSize

GetModuleItemAcquiredStackSize()

int GetModuleItemAcquiredStackSize()

Description :
Renvoie la taille de la pile du dernier item ayant été acquis par un joueur. Si l'item n'est pas empilable, la valeur 1 sera renvoyée.

Fonction(s) connexe(s) :
GetModuleItemAcquired, GetModuleItemAcquiredBy, GetModuleItemAcquiredFrom

GetModuleItemLost()

object GetModuleItemLost()

Description :
Renvoie la valeur "object" du dernier item ayant été abandonné par un joueur (ou retiré).

Fonction(s) connexe(s) :
GetModuleItemAcquired, GetModuleItemLostBy

GetModuleItemLostBy()

object GetModuleItemLostBy()

Description :
Renvoie la valeur "object" du dernier joueur ayant abandonné un item (ou perdu).

Fonction(s) connexe(s) :
GetModuleItemAcquiredBy, GetModuleItemLost

GetModuleName()

string GetModuleName()

Description :
Renvoie le nom du module, utilisant le langage défini dans les options du serveur NWN2.

Fonction(s) connexe(s) :
GetModule

GetModuleXPScale()

int GetModuleXPScale()

Description :
Renvoie l'echelle d'expérience définie dans les propriétés du module (Cf. paramètre "Echelle PX" dans l'éditeur).

Fonction(s) connexe(s) :
SetModuleXPScale

GetMovementRate(...)

int GetMovementRate
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie le facteur de vitesse de la créature désignée par oCreature (Cf. paramètre "Rythme de marche" dans l'éditeur).

GetMovementRateFactor(...)

float GetMovementRateFactor
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie le de vitesse de la créature désignée par oCreature. Cette valeur prend en compte les modifications dues à un effet, à l'encombrement, etc. (Cf. paramètre "Rythme de marche" dans l'éditeur).

Fonction(s) connexe(s) :
SetMovementRateFactor

GetName(...)

string GetName
(
    object oObject
)

Paramètres :
- oObject : L'objet concerné.

Description :
Renvoie le nom de l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetFirstName, GetLastName

GetNearestCreature(...)

object GetNearestCreature
(
    int nFirstCriteriaType,
    int nFirstCriteriaValue,
    object oTarget = OBJECT_SELF,
    int nNth = 1,
    int nSecondCriteriaType = -1,
    int nSecondCriteriaValue = -1,
    int nThirdCriteriaType = -1,
    int nThirdCriteriaValue = -1
)

Paramètres :
- nFirstCriteriaType : Constante CREATURE_TYPE_* définissant le type du premier critère de recherche.
- nFirstCriteriaValue : La valeur du premier critère de recherche.
- oTarget : L'objet concerné (défaut : OBJECT_SELF).
- nNth : La position de la créature recherchée (défaut : 1).
- nSecondCriteriaType : Constante CREATURE_TYPE_* définissant le type du second critère de recherche (défaut : -1).
- nSecondCriteriaValue : La valeur du second critère de recherche (défaut : -1).
- nThirdCriteriaType : Constante CREATURE_TYPE_* définissant le type du troisième critère de recherche (défaut : -1).
- nThirdCriteriaValue : La valeur du troisième critère de recherche (défaut : -1).

Description :
Renvoie la valeur "object" de la créature la plus proche de l'objet désigné par oObject, et selon les critères de recherche définis. La valeur définie par nNth correspond à la position de la créature que l'on souhaite trouver; la valeur 3 signifierait que l'on cherche la troisième créature correspondant aux critères définis. Selon la constante spécifiée par nProperty, nSpecial utilisera un groupe de constantes différent et aura une signification différente :

CREATURE_TYPE_CLASS : CLASS_TYPE_* (classe de personnage).
CREATURE_TYPE_DOES_NOT_HAVE_SPELL_EFFECT : SPELL_* (sort).
CREATURE_TYPE_HAS_SPELL_EFFECT : SPELL_* (sort).
CREATURE_TYPE_IS_ALIVE : CREATURE_ALIVE_* (vivante).
CREATURE_TYPE_PERCEPTION : PERCEPTION_* (perception).
CREATURE_TYPE_PLAYER_CHAR : PLAYER_CHAR_* (contrôlée par un joueur).
CREATURE_TYPE_RACIAL_TYPE : RACIAL_TYPE_* (groupe racial).
CREATURE_TYPE_REPUTATION : REPUTATION_TYPE_* (réputation).
CREATURE_TYPE_SCRIPTHIDDEN : CREATURE_SCRIPTHIDDEN_* (scripts dissimulés).

Les seconds et troisièmes critères fonctionnent de la même manière que les premiers.

Fonction(s) connexe(s) :
GetNearestCreatureToLocation, GetNearestObject, GetNearestObjectByTag, GetNearestObjectToLocation, GetNearestTrapToObject

GetNearestCreatureToLocation(...)

object GetNearestCreatureToLocation
(
    int nFirstCriteriaType,
    int nFirstCriteriaValue,
    location lLocation,
    int nNth = 1,
    int nSecondCriteriaType = -1,
    int nSecondCriteriaValue = -1,
    int nThirdCriteriaType = -1,
    int nThirdCriteriaValue = -1
)

Paramètres :
- nFirstCriteriaType : Constante CREATURE_TYPE_* définissant le type du premier critère de recherche.
- nFirstCriteriaValue : La valeur du premier critère de recherche.
- lLocation : La localisation concernée.
- nNth : La position de la créature recherchée (défaut : 1).
- nSecondCriteriaType : Constante CREATURE_TYPE_* définissant le type du second critère de recherche (défaut : -1).
- nSecondCriteriaValue : La valeur du second critère de recherche (défaut : -1).
- nThirdCriteriaType : Constante CREATURE_TYPE_* définissant le type du troisième critère de recherche (défaut : -1).
- nThirdCriteriaValue : La valeur du troisième critère de recherche (défaut : -1).

Description :
Renvoie la valeur "object" de la créature la plus proche de la localisation désignée par lLocation, et selon les critères de recherche définis. Fonctionne de la même manière que la fonction "GetNearestCreature(...)".

Fonction(s) connexe(s) :
GetNearestCreature, GetNearestObject, GetNearestObjectByTag, GetNearestObjectToLocation, GetNearestTrapToObject

GetNearestObject(...)

object GetNearestObject
(
    int nObjectType = OBJECT_TYPE_ALL,
    object oTarget = OBJECT_SELF,
    int nNth = 1
)

Paramètres :
- nObjectType : Constante OBJECT_TYPE_* définissant le type d'objet à rechercher (défaut : OBJECT_TYPE_ALL).
- oTarget : L'objet concerné (défaut : OBJECT_SELF).
- nNth : La position de l'objet recherché (défaut : 1).

Description :
Renvoie la valeur "object" de l'objet le plus proche de oObject, et dont le type est défini par nObjectType. La valeur définie par nNth correspond à la position de l'objet que l'on souhaite trouver; la valeur 3 signifierait que l'on cherche le troisième objet correspondant au type souhaité.

Fonction(s) connexe(s) :
GetNearestCreature, GetNearestCreatureToLocation, GetNearestObjectByTag, GetNearestObjectToLocation, GetNearestTrapToObject

GetNearestObjectByTag(...)

object GetNearestObjectByTag
(
    string sTag,
    object oTarget = OBJECT_SELF,
    int nNth = 1
)

Paramètres :
- sTag : Le Tag de l'objet à rechercher.
- oTarget : L'objet concerné (défaut : OBJECT_SELF).
- nNth : La position de l'objet recherché (défaut : 1).

Description :
Renvoie la valeur "object" de l'objet le plus proche de oObject, et dont le Tag est défini par sTag. La valeur définie par nNth correspond à la position de l'objet que l'on souhaite trouver; la valeur 3 signifierait que l'on cherche le troisième objet correspondant au type souhaité.

Fonction(s) connexe(s) :
GetNearestCreature, GetNearestCreatureToLocation, GetNearestObject, GetNearestObjectToLocation, GetNearestTrapToObject

GetNearestObjectToLocation(...)

object GetNearestObjectToLocation
(
    int nObjectType,
    location lLocation,
    int nNth = 1
)

Paramètres :
- nObjectType : Constante OBJECT_TYPE_*OBJECT_TYPE_* définissant le type d'objet à rechercher.
- lLocation : La localisation concernée.
- nNth : La position de l'objet recherché (défaut : 1).

Description :
Renvoie la valeur "object" de l'objet le plus proche de la localisation désignée par lLocation, et dont le type est défini par nObjectType. La valeur définie par nNth correspond à la position de l'objet que l'on souhaite trouver; la valeur 3 signifierait que l'on cherche le troisième objet correspondant au type souhaité.

Fonction(s) connexe(s) :
GetNearestCreature, GetNearestCreatureToLocation, GetNearestObject, GetNearestObjectByTag, GetNearestTrapToObject

GetNearestTrapToObject(...)

object GetNearestTrapToObject
(
    object oTarget = OBJECT_SELF,
    int nTrapDetected = TRUE
)

Paramètres :
- oTarget : L'objet concerné (défaut : OBJECT_SELF).
- nTrapDetected : Détermine si le piège doit avoir été détecté (défaut : TRUE).

Description :
Renvoie la valeur "object" du piège le plus proche de l'objet désigné par oObject. Un "piège" peut correspondre à un déclencheur de type piège, un plaçable piégé, ou une porte piégée.

Fonction(s) connexe(s) :
GetNearestCreature, GetNearestCreatureToLocation, GetNearestObject, GetNearestObjectByTag, GetNearestObjectToLocation

GetNextArea()

object GetNextArea()

Description :
Renvoie la valeur "object" de la "zone suivante" de la liste des zone du module. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstArea()".

Fonction(s) connexe(s) :
GetFirstArea

GetNextEffect(...)

effect GetNextEffect
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie la valeur "effect" de "l'effet actif suivant" appliqué sur un joueur. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstEffect(...)".

Fonction(s) connexe(s) :
GetFirstEffect

GetNextEnteringPC()

object GetNextEnteringPC()

Description :
Renvoie la valeur "object" du "joueur suivant" se connectant au module. Cette fonction s'utilise lors de l'événement "OnClientEnter" dans une boucle ayant été engagée par "GetFirstEnteringPC()".

Fonction(s) connexe(s) :
GetFirstEnteringPC

GetNextFactionMember(...)

object GetNextFactionMember
(
    object oMemberOfFaction,
    int bPCOnly = TRUE
)

Paramètres :
- oMemberOfFaction : Le membre de la faction concernée.
- bPCOnly : Détermine si seuls les joueurs doivent être considérés (défaut : TRUE).

Description :
Renvoie la valeur "object" du "membre suivant" de la faction à laquelle appartient l'objet désigné par oMemberOfFaction. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstFactionMember(...)".

Fonction(s) connexe(s) :
GetFirstFactionMember

GetNextInPersistentObject(...)

object GetNextInPersistentObject
(
    object oPersistentObject = OBJECT_SELF,
    int nResidentObjectType = OBJECT_TYPE_CREATURE,
    int nPersistentZone = PERSISTENT_ZONE_ACTIVE
)

Paramètres :
- oPersistentObject : Le déclencheur, la rencontre, ou la zone d'effet concernée (défaut : OBJECT_SELF).
- nResidentObjectType : Constante OBJECT_TYPE_* définissant le type d'objet à rechercher (défaut : OBJECT_TYPE_CREATURE).
- nPersistentZone : Constante PERSISTENT_ZONE_*. Seule la valeur par défaut est utilisée (défaut : PERSISTENT_ZONE_ACTIVE).

Description :
Renvoie la valeur "object" de "l'objet suivant" présent dans le déclencheur, la rencontre, ou la zone d'effet désigné(e) par oPersistentObject. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstInPersistentObject(...)".

Fonction(s) connexe(s) :
GetFirstInPersistentObject

GetNextItemInInventory(...)

object GetNextItemInInventory
(
    object oTarget = OBJECT_SELF
)

Paramètres :
- oTarget : L'objet concerné (défaut : OBJECT_SELF).

Description :
Renvoie la valeur "object" de "l'item suivant" présent dans l'inventaire de l'objet désigné par oTarget. Ne prend pas en compte les objets équipés. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstItemInInventory(...)".

Fonction(s) connexe(s) :
GetFirstItemInInventory

GetNextItemProperty(...)

itemproperty GetNextItemProperty
(
    object oItem
)

Paramètres :
- oTarget : L'item concerné.

Description :
Renvoie la "propriété d'item suivante" de l'item désigné par oItem. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstItemProperty(...)".

Fonction(s) connexe(s) :
GetFirstItemProperty

GetNextObjectInArea(...)

object GetNextObjectInArea
(
    object oArea = OBJECT_INVALID
)

Paramètres :
- oArea : La zone concernée (défaut : OBJECT_INVALID).

Description :
Renvoie la valeur "object" de "l'objet suivant" présent dans la zone désignée par oArea. Si oArea est égal à OBJECT_INVALID, la zone dans laquelle se trouve l'objet source sera utilisée. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstObjectInArea(...)".

Fonction(s) connexe(s) :
GetFirstObjectInArea

GetNextObjectInShape(...)

object GetNextObjectInShape
(
    int nShape,
    float fSize,
    location lTarget,
    int bLineOfSight = FALSE,
    int nObjectFilter = OBJECT_TYPE_CREATURE,
    vector vOrigin = [0.0,0.0,0.0]
)

Paramètres :
- nShape : Constante SHAPE_* définissant le type de surface à couvrir.
- fSize : Taille de référence selon le type de surface à couvrir.
- lTarget : En cas de sphère ou de cube, la localisation d'origine. En cas de cône ou de cylindre, la localisation de fin.
- bLineOfSight : Détermine si les objets recherchés doivent être visibles à partir du point d'origine (défaut : FALSE).
- nObjectFilter : Constante OBJECT_TYPE_* définissant le type d'objet à rechercher (défaut : OBJECT_TYPE_CREATURE).
- vector : Utilisé en cas de cône ou de cylindre; le point d'origine (défaut : [0.0,0.0,0.0]).

Description :
Renvoie la valeur "object" de "l'objet suivant" présent sur la surface définie par les paramètres de la fonction. Le paramètre nShape peut définir différentes formes : une phère, un cylindre, un cône, ou un cube. Le paramètre fSize est considéré différemment selon la forme définie; respectivement : le rayon de la sphère, la longueur du cylindre, le rayon le plus large du cône, ou la moitié de la largeur du cube. Le paramètre nObjectFilter supporte l'association de deux valeurs, grâce à l'opérateur "ou" (OBJECT_TYPE_CREATURE | OBJECT_TYPE_DOOR). Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstObjectInShape(...)".

Fonction(s) connexe(s) :
GetFirstObjectInShape

GetNextPC(...)

object GetNextPC
(
    int bOwnedCharacter = TRUE
)

Paramètres :
- bOwnedCharacter : Détermine si le personnage principal d'un joueur doit être recherché (défaut : TRUE).

Description :
Renvoie la valeur "object" du "personnage principal" suivant, dans la liste des joueurs connectés au module. Si bOwnedCharacter est égal à FALSE, le "personnage suivant, contrôlé par un joueur" sera recherché. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstPC(...)".

Fonction(s) connexe(s) :
GetFirstPC

GetNextRosterMember()

object GetNextRosterMember()

Description :
Renvoie le nom du "compagnon suivant" inscrit dans la "liste des compagnons". L'ordre des compagnons est toujours le même, et est organisé par ordre chronologique (premier inscrit, second inscrit, etc.). Si la liste est vide, la valeur renvoyée sera une chaîne de caractères vide. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstRosterMember()".

Fonction(s) connexe(s) :
GetFirstRosterMember

GetNextSubArea(...)

object GetNextSubArea
(
    object oArea
)

Paramètres :
- oArea : La zone concernée.

Description :
Renvoie la valeur "object" du déclencheur suivant. Sont pris en compte : les déclencheurs, les zones d'effets, et les rencontres. Cette fonction s'utilise dans une boucle ayant été engagée par "GetFirstSubArea(...)".

Fonction(s) connexe(s) :
GetFirstSubArea

GetNodeSpeaker()

string GetNodeSpeaker()

Description :
Renvoie le Tag d'un personnage devant participer à une conversation. Cette fonction n'est effective QUE dans un script de "condition", où la valeur renvoyée sera le Tag de l'objet rattaché à l'entrée de la discussion.

Fonction(s) connexe(s) :
GetPCSpeaker

GetNum2DAColumns(...)

int GetNum2DAColumns
(
    string s2DAName
)

Paramètres :
- s2DAName : Le nom du fichier 2DA concerné (sans l'extension).

Description :
Renvoie le nombre de colonnes que comporte le fichier 2DA désigné par s2DAName. Cette fonction a pour effet de mettre le fichier 2DA concerné dans la mémoire cache, à moins qu'il ne fut déjà rajouté. Si le fichier 2DA est introuvable, la fonction renverra la valeur -1.

Fonction(s) connexe(s) :
Clear2DACache, Get2DAString, GetNum2DARows

GetNum2DARows(...)

int GetNum2DARows
(
    string s2DAName
)

Paramètres :
- s2DAName : Le nom du fichier 2DA concerné (sans l'extension).

Description :
Renvoie le nombre de lignes que comporte le fichier 2DA désigné par s2DAName. Cette fonction a pour effet de mettre le fichier 2DA concerné dans la mémoire cache, à moins qu'il ne fut déjà rajouté. Si le fichier 2DA est introuvable, la fonction renverra la valeur -1.

Fonction(s) connexe(s) :
Clear2DACache, Get2DAString, GetNum2DAColumns

GetNumActions(...)

int GetNumActions
(
    object oObject
)

Paramètres :
- oObject : L'objet concerné.

Description :
Renvoie le nombre d'actions que l'objet désigné par oObject doit encore accomplir.

Fonction(s) connexe(s) :
GetNumCutsceneActionsPending

GetNumCutsceneActionsPending()

int GetNumCutsceneActionsPending()

Description :
Renvoie le nombre d'actions restantes de type "cinématique" devant être accomplies. Cette fonction peut notamment aider à déterminer où se trouve une erreur, lorsqu'une cinématique ne peut être mise en pause (ou reprise).

Fonction(s) connexe(s) :
GetNumActions

GetNumStackedItems(...)

int GetNumStackedItems
(
    object oItem
)

Paramètres :
- oItem : L'item concerné.

Description :
Renvoie la valeur de la pile que contient l'item désigné par oItem. Si oItem n'est pas un item empilable, la valeur 1 sera renvoyée.

Fonction(s) connexe(s) :
SetItemStackSize

GetObjectByTag(...)

object GetObjectByTag
(
    string sTag,
    int nNth = 0
)

Paramètres :
- sTag : Le Tag de l'objet recherché.
- nNth : La position de l'objet recherché (défaut : 0).

Description :
Renvoie la valeur "object" de l'objet dont le Tag est défini par sTag. La valeur définie par nNth correspond à la position de l'objet que l'on souhaite retrouver, moins 1; la valeur 2 signifierait donc que l'on cherche le troisième objet portant le Tag défini (logique, quoi).

Fonction(s) connexe(s) :
GetWaypointByTag, GetObjectByTagAndType

GetObjectByTagAndType(...)

object GetObjectByTagAndType
(
    string sTag,
    int nObjectType,
    int nTh
)

Paramètres :
- sTag : Le Tag de l'objet recherché.
- nObjectType : Le type de l'objet recherché, défini par la constante OBJECT_TYPE_*.
- nNth : La position de l'objet recherché.

Description :
Renvoie la valeur "object" de l'objet dont le Tag est défini par sTag, ET dont le type correspond à nObjectType. Si le type d'objet ne correspond pas, bien que le tag puisse exister, la fonction renverra la valeur OBJECT_INVALID. De la même manière que la fonction GetObjectByTag, La valeur définie par nTh correspond à la position de l'objet que l'on souhaite retrouver.

Fonction(s) connexe(s) :
GetObjectByTag

GetObjectFromRosterName(...)

object GetObjectFromRosterName
(
    string sRosterName
)

Paramètres :
- sRosterName : Le nom de compagnon de la créature recherchée.

Description :
Renvoie la valeur "object" de la créature répondant au nom de compagnon défini par sRosterName. Si sRosterName n'est pas un nom de compagnon valide, ou si la créature correspondant au nom n'est pas en jeu, la valeur OBJECT_INVALID sera renvoyée.

Fonction(s) connexe(s) :
GetRosterNameFromObject

GetObjectHeard(...)

int GetObjectHeard
(
    object oTarget,
    object oSource = OBJECT_SELF
)

Paramètres :
- oTarget : La créature ciblée.
- oSource : La créature concernée (défaut : OBJECT_SELF).

Description :
Détermine si la créature désignée par oSource "entend" l'objet désigné par oTarget. oSource doit être une créature pour que la fonction soit effective.

Fonction(s) connexe(s) :
GetObjectSeen

GetObjectSeen(...)

int GetObjectSeen
(
    object oTarget,
    object oSource = OBJECT_SELF
)

Paramètres :
- oTarget : La créature ciblée.
- oSource : La créature concernée (défaut : OBJECT_SELF).

Description :
Détermine si la créature désignée par oSource "voit" l'objet désigné par oTarget. oSource doit être une créature pour que la fonction soit effective.

Fonction(s) connexe(s) :
GetObjectHeard

GetObjectType(...)

int GetObjectType
(
    object oTarget
)

Paramètres :
- oTarget : L'objet concerné.

Description :
Renvoie le type d'objet qu'est oTarget. La valeur renvoyée peut être comparée aux constantes OBJECT_TYPE_*.

GetOnePartyMode()

int GetOnePartyMode()

Description :
Détermine si la partie en cours est en mode "Un seul groupe".

GetOwnedCharacter(...)

object GetOwnedCharacter
(
    object oControlled
)

Paramètres :
- oControlled : Le joueur concerné.

Description :
Renvoie la valeur "object" du "personnage principal" du joueur désigné par oControlled.

Fonction(s) connexe(s) :
SetOwnersControlledCompanion

GetPartyMembersDyingFlag()

int GetPartyMembersDyingFlag()

Description :
Détermine si le paramètre de campagne "PartyMembersDying" est actif ou inactif.

GetPartyMotto()

string GetPartyMotto()

Description :
Renvoie la devise d'un groupe sous la forme d'une chaîne de caractères.

Fonction(s) connexe(s) :
GetPartyName

GetPartyName()

string GetPartyName()

Description :
Renvoie le nom d'un groupe sous la forme d'une chaîne de caractères.

Fonction(s) connexe(s) :
GetPartyMotto

GetPause()

int GetPause()

Description :
Détermine si le jeu est (ou n'est pas) en pause.

Fonction(s) connexe(s) :
SetPause

GetPCIPAddress(...)

string GetPCIPAddress
(
    object oPlayer
)

Paramètres :
- oPlayer : Le joueur concerné.

Description :
Renvoie l'adresse IP du joueur désigné par oPlayer, sous la forme d'une chaîne de caractères. Une adresse IP correspond à une valeur du type "123.123.123.123".

Fonction(s) connexe(s) :
GetPCPlayerName, GetPCPublicCDKey

GetPCItemLastEquipped()

object GetPCItemLastEquipped()

Description :
Renvoie la valeur "object" du dernier item ayant été équipé par un joueur. Cette fonction s'utilise lors de l'événement "OnPlayerEquipItem" du module.

Fonction(s) connexe(s) :
GetPCItemLastEquippedBy, GetPCItemLastUnequipped

GetPCItemLastEquippedBy()

object GetPCItemLastEquipped()

Description :
Renvoie la valeur "object" du dernier joueur ayant équipé un item. Cette fonction s'utilise lors de l'événement "OnPlayerEquipItem" du module.

Fonction(s) connexe(s) :
GetPCItemLastEquipped, GetPCItemLastUnequippedBy

GetPCItemLastUnequipped()

object GetPCItemLastUnequipped()

Description :
Renvoie la valeur "object" du dernier item équipé ayant été retiré par joueur. Cette fonction s'utilise lors de l'événement "OnPlayerEquipItem" du module.

Fonction(s) connexe(s) :
GetPCItemLastEquipped, GetPCItemLastUnequippedBy

GetPCItemLastUnequippedBy()

object GetPCItemLastUnequippedBy()

Description :
Renvoie la valeur "object" du dernier joueur ayant retiré un item équipé. Cette fonction s'utilise lors de l'événement "OnPlayerEquipItem" du module.

Fonction(s) connexe(s) :
GetPCItemLastEquippedBy, GetPCItemLastUnequipped

GetPCLevellingUp()

object GetPCLevellingUp()

Description :
Renvoie la valeur "object" du dernier joueur ayant accompli la montée d'un niveau (avec les points de compétence, toussa quoi).

GetPCPlayerName(...)

string GetPCPlayerName
(
    object oPlayer
)

Paramètres :
- oPlayer : Le joueur concerné.

Description :
Renvoie le nom de connexion du joueur désigné par oPlayer.

Fonction(s) connexe(s) :
GetPCIPAddress, GetPCPublicCDKey

GetPCPublicCDKey(...)

string GetPCPublicCDKey
(
    object oPlayer
)

Paramètres :
- oPlayer : Le joueur concerné.

Description :
Renvoie la "partie publique" de la clé CD du joueur désigné par oPlayer.

Fonction(s) connexe(s) :
GetPCIPAddress, GetPCPlayerName

GetPCSecretNumber()

string GetPCSecretNumber()

Description :
Renvoie le numéro de téléphone de mon chien (oui oui, à appeler en cas d'urgence).

GetPCSpeaker()

object GetPCSpeaker()

Description :
Renvoie la valeur "object" du joueur impliqué dans la conversation en cours. Cette fonction s'utilise dans les scripts "condition" et "action" liés à une conversation.

Fonction(s) connexe(s) :
GetNodeSpeaker

GetPickpocketableFlag(...)

int GetPickpocketableFlag
(
    object oPlayer
)

Paramètres :
- oItem : L'item concerné.

Description :
Détermine si l'item désigné par oItem peut être acquis par un escamotage (Cf. paramètre "Vol possible ?" dans l'éditeur).

Fonction(s) connexe(s) :
SetPickpocketableFlag

GetPlaceableIllumination(...)

int GetPlaceableIllumination
(
    object oPlaceable = OBJECT_SELF
)

Paramètres :
- oPlaceable : Le plaçable concerné (défaut : OBJECT_SELF).

Description :
Détermine si le plaçable désigné par oPlaçable emet une lumière.

Fonction(s) connexe(s) :
SetPlaceableIllumination

GetPlaceableLastClickedBy()

object GetPlaceableLastClickedBy()

Description :
Renvoie la valeur "object" du dernier joueur ayant cliqué sur l'objet source. Cette fonction s'utilise lors de l'événement "OnClick" d'un plaçable.

Fonction(s) connexe(s) :
GetClickingObject

GetPlayerCreatureExamineTarget(...)

object GetPlayerCreatureExamineTarget
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie la valeur "object" de l'objet que le joueur désigné par oCreature est en train d'examiner.

Fonction(s) connexe(s) :
ActionExamine, GetPlayerCurrentTarget

GetPlayerCurrentTarget(...)

object GetPlayerCurrentTarget
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie la valeur "object" de l'objet que le joueur désigné par oCreature est en train de cibler.

Fonction(s) connexe(s) :
GetPlayerCreatureExamineTarget

GetPlotFlag(...)

int GetPlotFlag
(
    object oTarget = OBJECT_SELF
)

Paramètres :
- oTarget : L'objet concerné (défaut : OBJECT_SELF).

Description :
Détermine si l'objet désigné par oTarget fait partie de l'intrigue (Cf. paramètre "Intrigue" dans l'éditeur).

Fonction(s) connexe(s) :
SetPlotFlag

GetPolymorphLocked(...)

int GetPolymorphLocked
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Détermine si la créature désignée par oCreature peut annuler manuellement une métamorphose. Renvoie la valeur 0 si c'est le cas, ou si oCreature n'est pas une créature.

GetPosition(...)

vector GetPosition
(
    object oTarget
)

Paramètres :
- oTarget : L'objet concerné.

Description :
Renvoie la position de l'objet désigné par oTarget.

Fonction(s) connexe(s) :
GetPositionFromLocation

GetPositionFromLocation(...)

vector GetPositionFromLocation
(
    location lLocation
)

Paramètres :
- lLocation : La localisation dont on souhaite extraire la zone.

Description :
Renvoie la valeur "vector" de la position incluse dans la localisation définie par lLocation.

Fonction(s) connexe(s) :
GetAreaFromLocation, GetFacingFromLocation, GetPosition

GetPrimaryPlayer()

object GetPrimaryPlayer()

Description :
Renvoie la valeur "object" du joueur principal du module. Le joueur principal peut être celui qui héberge la partie en cours, ou qui héberge le serveur NWN2 tout en s'y connectant. Un joueur principal sera introuvable si l'hébergeur est connecté via le client MD, si le serveur NWN2 est sur un serveur dédié, ou si l'hébergeur est en cours de création de personnage.

GetProjectileTravelTime(...)

vector GetProjectileTravelTime
(
    location lSource,
    location lTarget,
    int nProjectilePathType,
    int nSpellID = -1
)

Paramètres :
- lSource : La localisation d'origine.
- lTarget : La localisation d'arrivée.
- nProjectilePathType : Constante PROJECTILE_PATH_TYPE_* définissant le type de trajectoire concerné.
- nSpellID : Constante SPELL_* définissant le sort à prendre en référence (défaut : -1).

Description :
Renvoie le temps que mettra un projectile pour aller de lSource à lTarget, dans la trajectoire désignée. Si nSpellID fait référence à un sort, et que nProjectilePathType est égal à PROJECTILE_PATH_TYPE_SPELL, la trajectoire correspondra à celle définie dans le fichier spells.2da.

GetRacialType(...)

int GetRacialType
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie la race de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes RACIAL_TYPE_*.

Fonction(s) connexe(s) :
GetIsPlayableRacialType, GetSubRace

GetReflexAdjustedDamage(...)

int GetReflexAdjustedDamage
(
    int nDamage,
    object oTarget,
    int nDC,
    int nSaveType = SAVING_THROW_TYPE_NONE,
    object oSaveVersus = OBJECT_SELF
)

Paramètres :
- nDamage : Les dégâts initiaux.
- oTarget : L'objet concerné.
- nDC : Le seuil de difficulté du jet de sauvegarde.
- nSaveType : Constante SAVING_THROW_TYPE_* définissant le type de sauvegarde concernée (défaut : SAVING_THROW_TYPE_NONE).
- oSaveVersus : Le lanceur de sorts opposé (défaut : OBJECT_SELF).

Description :
Renvoie le total ajusté des dégâts d'un sort nécessitant le test de réflexes de l'objet désigné par oTarget. Cette fonction prend en compte les dons "Esquive totale" et "Esquive extraordinaire".

Fonction(s) connexe(s) :
GetReflexSavingThrow

GetReflexSavingThrow(...)

int GetReflexSavingThrow
(
    object oTarget
)

Paramètres :
- oTarget : L'objet concerné.

Description :
Renvoie le résultat du jet de réflexes de l'objet désigné par oTarget. Ne s'applique qu'aux créatures, aux plaçables (?), et aux portes (?!).

Fonction(s) connexe(s) :
GetFortitudeSavingThrow, GetReflexAdjustedDamage, GetWillSavingThrow

GetReputation(...)

int GetReputation
(
    object oSource,
    object oTarget
)

Paramètres :
- oSource : L'objet concerné.
- oTarget : L'objet à analyser.

Description :
Renvoie la réputation personnelle qu'entretient l'objet désigné par oTarget vis-à-vis de l'objet désigné par oSource. La réputation est une valeur comprise entre 0 et 100, et comprend trois seuils : 0-10 pour hostile; 11-89 pour neutre, 90-100 pour amical.

Fonction(s) connexe(s) :
AdjustReputation

GetResRef(...)

string GetResRef
(
    object oObject
)

Paramètres :
- oObject : L'objet concerné.

Description :
Renvoie le ResRef (Blueprint) de l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetTag

GetRosterNameFromObject(...)

string GetRosterNameFromObject
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie le nom de compagnon que porte la créature désignée par oCreature dans la "liste des compagnons".

Fonction(s) connexe(s) :
GetObjectFromRosterName

GetRosterNPCPartyLimit()

int GetRosterNPCPartyLimit()

Description :
Renvoie le nombre maximum de compagnons que peut contenir un groupe. La limite est effective lors de la sélection des membres du groupe via la fenêtre de sélection. Notez que la fonction "AddRosterMemberToParty(...)" n'est pas sujette à cette limitation.

Fonction(s) connexe(s) :
SetRosterNPCPartyLimit

GetScale(...)

float GetScale
(
    object oObject,
    int nAxis
)

Paramètres :
- oObject : L'objet concerné.
- nAxis : Constante SCALE_* définissant l'axe concerné.

Description :
Renvoie la valeur de l'échelle de l'objet désigné par oObject, basée sur l'axe défini par nAxis. Cette fonction ne prendra en compte aucun effet appliqué par la fonction "EffectSetScale(...)", et ne renverra que la valeur de base de l'échelle de l'objet (Cf. paramètre "Echelle" dans l'éditeur). oObject doit être une créature ou un plaçable, autrement la fonction sera sans effet.

Fonction(s) connexe(s) :
SetScale

GetScriptHidden(...)

int GetScriptHidden
(
    object oObject
)

Paramètres :
- oObject : L'objet concerné.

Description :
Détermine si les scripts de l'objet désigné par oObject sont masqués (Cf. paramètre "Script dissimulé" dans l'éditeur).

Fonction(s) connexe(s) :
SetScriptHidden

GetSelectedMapPointTag()

string GetSelectedMapPointTag()

Description :
Renvoie le Tag du lieu sélectionné sur la carte du monde. Cette fonction ne fonctionne qu'au sein de la carte du monde, dans les scripts de condition, de sélection et d'action.

GetSittingCreature(...)

object GetSittingCreature
(
    object oChair
)

Paramètres :
- oChair : Le plaçable concerné.

Description :
Renvoie la valeur "object" de la créature assise sur le plaçable désigné par oChair.

Fonction(s) connexe(s) :
ActionSit

GetSkillPointsRemaining(...)

int GetSkillPointsRemaining
(
    object oPC
)

Paramètres :
- oPC : Le joueur concerné.

Description :
Renvoie le nombre de points de compétence restants dont disposera le joueur désigné par oPC à son prochain passage de niveau.

Fonction(s) connexe(s) :
SetSkillPointsRemaining

GetSkillRank(...)

int GetSkillRank
(
    int nSkill,
    object oTarget = OBJECT_SELF,
    int bBaseOnly = FALSE
)

Paramètres :
- nSkill : Constante SKILL_* définissant la compétence concernée.
- oTarget : La créature concernée (défaut : OBJECT_SELF).
- bBaseOnly : Détermine si le seul le rang doit être renvoyé, sans aucun modificiateur (défaut : FALSE).

Description :
Renvoie le nombre de points que la créature désignée par oTarget a dans la compétence définie par nSkill. La valeur -1 est renvoyée si la créature n'a pas cette compétence. Si la créature a la compétence, mais qu'aucun point n'a été attribué, la valeur 0 sera renvoyée.

GetSpellCastItem()

object GetSpellCastItem()

Description :
Renvoie la valeur "object" de l'item ayant servi à lancer le dernier sort. Cette fonction s'utilise dans un script de sort.

Fonction(s) connexe(s) :
GetSpellFeatId, GetSpellId, GetSpellLevel, GetSpellSaveDC, GetSpellTargetLocation, GetSpellTargetObject

GetSpellFeatId()

int GetSpellFeatId()

Description :
Renvoie la référence du don associé au dernier sort lancé. La valeur renvoyée peut être comparée aux constantes FEAT_*. Cette fonction s'utilise dans un script de sort.

Fonction(s) connexe(s) :
GetSpellCastItem, GetSpellId, GetSpellLevel, GetSpellSaveDC, GetSpellTargetLocation, GetSpellTargetObject

GetSpellId()

int GetSpellId()

Description :
Renvoie la référence du dernier sort lancé. La valeur renvoyée peut être comparée aux constantes SPELL_*. Cette fonction s'utilise dans un script de sort.

Fonction(s) connexe(s) :
GetSpellCastItem, GetSpellFeatId, GetSpellLevel, GetSpellSaveDC, GetSpellTargetLocation, GetSpellTargetObject

GetSpellKnown(...)

int GetSpellKnown
(
    object oCreature,
    int nSpell
)

Paramètres :
- oCreature: La créature concernée.
- nSpell : Constante SPELL_* définissant le sort concerné.

Description :
Détermine si la créature désignée par oCreature connaît le sort désigné par nSpell, grâce à l'une de ses classes ou de son niveau.

Fonction(s) connexe(s) :
GetHasSpell, SetSpellKnown

GetSpellLevel(...)

int GetSpellLevel
(
    int nSpellID
)

Paramètres :
- nSpellID : Constante SPELL_* définissant le sort concerné.

Description :
Renvoie le niveau du sort désigné par nSpellID. Cette fonction s'utilise dans un script de sort.

Fonction(s) connexe(s) :
GetSpellCastItem, GetSpellFeatId, GetSpellId, GetSpellSaveDC, GetSpellTargetLocation, GetSpellTargetObject

GetSpellResistance(...)

int GetSpellResistance
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie la valeur de la résistance aux sorts de la créature désignée par oCreature. La valeur 0 est renvoyée en cas d'erreur, ou si la créature n'a pas de résistance aux sorts.

Fonction(s) connexe(s) :
ResistSpell

GetSpellSaveDC()

int GetSpellSaveDC()

Description :
Renvoie le seuil de difficulté du jet de sauvegarde à effectuer. La valeur d'un tel seuil est égal à 10, auquel sont rajoutés le niveau du sort, ainsi que la caractéristique principale du lanceur de sort (ex. intelligence pour un magicien). Cette fonction s'utilise dans un script de sort, ou lorsque les événements associés à une zone d'effet sont déclenchés.

Fonction(s) connexe(s) :
GetSpellCastItem, GetSpellFeatId, GetSpellId, GetSpellLevel, GetSpellTargetLocation, GetSpellTargetObject

GetSpellTargetLocation()

location GetSpellTargetLocation()

Description :
Renvoie la localisation ciblée par le dernier sort lancé. Cette fonction s'utilise dans un script de sort.

Fonction(s) connexe(s) :
GetSpellCastItem, GetSpellFeatId, GetSpellId, GetSpellLevel, GetSpellSaveDC, GetSpellTargetObject

GetSpellTargetObject()

object GetSpellTargetObject()

Description :
Renvoie la valeur "object" de l'objet ciblé par le dernier sort lancé. Cette fonction s'utilise dans un script de sort.

Fonction(s) connexe(s) :
GetSpellCastItem, GetSpellFeatId, GetSpellId, GetSpellLevel, GetSpellSaveDC, GetSpellTargetLocation

GetSoundFileDuration(...)

int GetSpellTargetObject
(
    string sSoundFile
)

Paramètre(s) :
sSoundFile : le nom du fichier son concerné (sans l'extension).

Description :
Renvoie la durée en millisecondes du fichier son désigné par sSoundFile. Si le fichier est introuvable, la valeur 0 sera renvoyée.

GetStandardFactionReputation(...)

int GetStandardFactionReputation
(
    int nStandardFaction,
    object oCreature = OBJECT_SELF
)

Paramètres :
- nStandardFaction : Constante STANDARD_FACTION_* définissant la faction de base concernée.
- oCreature : La créature concernée (défaut : OBJECT_SELF).

Description :
Renvoie la réputation qu'entretient la créature désignée par oCreature vis-à-vis de la faction de base définie par nStandardFaction. La valeur renvoyée est comprise entre 0 (hostile) et 100 (amical).

Fonction(s) connexe(s) :
GetFactionAverageReputation, GetReputation, SetStandardFactionReputation

GetStartingLocation()

location GetStartingLocation()

Description :
Renvoie la localisation du point de départ du module.

GetStealthMode(...)

int GetStealthMode
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Détermine si la créature désignée par oCreature est en mode "furtivité". La valeur renvoyée peut être comparée aux constantes STEALTH_MODE_*.

Fonction(s) connexe(s) :
GetActionMode, GetDetectMode, SetActionMode

GetStolenFlag(...)

int GetStolenFlag
(
    object oStolen
)

Paramètres :
- oStolen : L'item concerné.

Description :
Détermine si l'item désigné par oStolen est déclaré comme ayant été volé (Cf. paramètre "Volé ?" dans l'éditeur).

Fonction(s) connexe(s) :
SetStolenFlag

GetStoreGold(...)

int GetStoreGold
(
    object oidStore
)

Paramètres :
- oidStore : L'échoppe concernée.

Description :
Renvoie le montant de pièces d'or dont l'échoppe désignée par oidStore dispose. La valeur renvoyée sera égale à -1 si l'échoppe n'utilise pas de pièces d'or, ou sera égale à -2 si l'échoppe ne peut pas être localisée.

Fonction(s) connexe(s) :
SetStoreGold

GetStoreIdentifyCost(...)

int GetStoreIdentifyCost
(
    object oidStore
)

Paramètres :
- oidStore : L'échoppe concernée.

Description :
Renvoie le coût d'identification que l'échoppe désignée par oidStore pratique. La valeur renvoyée sera égale à -1 si l'échoppe ne permet pas d'identification, ou sera égale à -2 si l'échoppe ne peut pas être localisée.

Fonction(s) connexe(s) :
SetStoreIdentifyCost

GetStoreMaxBuyPrice(...)

int GetStoreMaxBuyPrice
(
    object oidStore
)

Paramètres :
- oidStore : L'échoppe concernée.

Description :
Renvoie le prix maximum que l'échoppe désignée par oidStore paiera lors du rachat d'un item. La valeur renvoyée sera égale à -1 si l'échoppe rachète les item quelque soit le prix, ou sera égale à -2 si l'échoppe ne peut pas être localisée.

Fonction(s) connexe(s) :
SetStoreMaxBuyPrice

GetStringByStrRef(...)

int GetStringByStrRef
(
    int nStrRef,
    int nGender = GENDER_MALE
)

Paramètres :
- nStrRef : La référence TLK du texte concerné.
- nGender : Constante GENDER_* définissant le genre à utiliser (défaut : GENDER_MALE).

Description :
Renvoie la chaîne de caractère correspondant à la référence définie par nStrRef, dans le genre spécifié (masculin ou féminin).

GetStringLeft(...)

string GetStringLeft
(
    string sString,
    int nCount
)

Paramètres :
- sString : La chaîne de caractères concernée.
- nCount : Le nombre de caractères à sélectionner.

Description :
Renvoie le nombre de caractères défini par nCount en partant de la gauche de la chaîne de caractères désignée par sString. nCount doit être une valeur supérieure à 0 afin de sélectionner au moins un caractère. Si nCount est égal à 4, et que la chaîne de caractères "ABCDEFGH" est soumise à la fonction, la valeur renvoyée sera "ABCD".

Fonction(s) connexe(s) :
GetStringLength, GetStringRight, GetSubString

GetStringLength(...)

int GetStringLength
(
    string sString
)

Paramètres :
- sString : La chaîne de caractères concernée.

Description :
Renvoie le nombre de caractères que comprend la chaîne de caractères désignée par sString.

Fonction(s) connexe(s) :
GetStringLeft, GetStringRight, GetSubString

GetStringLowerCase(...)

string GetStringLength
(
    string sString
)

Paramètres :
- sString : La chaîne de caractères concernée.

Description :
Convertit la chaîne de caractères désignée par sString en minuscules.

Fonction(s) connexe(s) :
GetStringUpperCase

GetStringRight(...)

string GetStringRight
(
    string sString,
    int nCount
)

Paramètres :
- sString : La chaîne de caractères concernée.
- nCount : Le nombre de caractères à sélectionner.

Description :
Renvoie le nombre de caractères défini par nCount en partant de la droite de la chaîne de caractères désignée par sString. nCount doit être une valeur supérieure à 0 afin de sélectionner au moins un caractère. Si nCount est égal à 4, et que la chaîne de caractères "ABCDEFGH" est soumise à la fonction, la valeur renvoyée sera "EFGH".

Fonction(s) connexe(s) :
GetStringLeft, GetStringLength, GetSubString

GetStringUpperCase(...)

string GetStringUpperCase
(
    string sString
)

Paramètres :
- sString : La chaîne de caractères concernée.

Description :
Convertit la chaîne de caractères désignée par sString en majuscules.

Fonction(s) connexe(s) :
GetStringLowerCase

GetStrRefSoundDuration(...)

float GetStrRefSoundDuration
(
    int nStrRef
)

Paramètres :
- nStrRef : La référence du son concerné.

Description :
Renvoie la longueur en seconde du son dont la référence est désignée par nStrRef. La valeur 0.0f est renvoyée si aucune durée n'est répertoriée, ou si le son n'est pas référencé.

GetSubRace(...)

int GetSubRace
(
    object oTarget
)

Paramètres :
- oTarget : La créature concernée.

Description :
Renvoie la sous-race de la créature désignée par oTarget. La valeur renvoyée peut être comparée aux constantes RACIAL_SUBTYPE_*.

Fonction(s) connexe(s) :
GetRacialType

GetSubString(...)

string GetSubString
(
    string sString,
    int nStart,
    int nCount
)

Paramètres :
- sString : La chaîne de caractères concernée.
- nStart : La position de départ dans la chaîne.
- nCount : Le nombre de caractères à sélectionner.

Description :
Renvoie la suite de caractères incluse dans la chaîne de caractères désignée par sString. La valeur commencera à la position définie par nStart (0 inclus) et comprendra un nombre de caractères défini par nCount. Si nStart est égal à 2, que nCount est égal à 4, et que la chaîne de caractères "ABCDEFGH" est soumise à la fonction, la valeur renvoyée sera "CDEF".

Fonction(s) connexe(s) :
GetStringLeft, GetStringLength, GetStringRight

GetSurfaceMaterialsAtLocation(...)

int GetSurfaceMaterialsAtLocation
(
    location lLocation
)

Paramètres :
- lLocation : La localisation concernée.

Description :
Renvoie le type de surface le sol représente, à la localisation désignée par lLocation. La valeur renvoyée peut être comparée aux constantes SM_*. En tant que valeur binaire, et peut être composée de plusieurs de ces constantes.

Fonction(s) connexe(s) :
GetIsLocationValid

GetTag(...)

int GetTag
(
    object oObject
)

Paramètres :
- oObject : L'objet concerné.

Description :
Renvoie le Tag de l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetResRef

GetTalkTableLanguage()

int GetTalkTableLanguage()

Description :
Renvoie le langage du fichier TLK utilisé par le jeu. La valeur renvoyée peut être comparée aux constantes LANGUAGE_*

GetTileMainLight1Color(...)

int GetTileMainLight1Color
(
    location lTile
)

Paramètres :
- lTile : La localisation incluse dans la parcelle de terrain (tile, tuile, gros carré, au choix).

Description :
Renvoie la couleur de la première "lumière principale" de la parcelle de terrain où est incluse la localisation désignée par lTile. La valeur renvoyée peut être comparée aux constantes TILE_MAIN_LIGHT_COLOR_*.

Fonction(s) connexe(s) :
GetTileMainLight2Color, GetTileSourceLight1Color, SetTileMainLightColor

GetTileMainLight2Color(...)

int GetTileMainLight2Color
(
    location lTile
)

Paramètres :
- lTile : La localisation incluse dans la parcelle de terrain (tile, tuile, gros carré, au choix).

Description :
Renvoie la couleur de la seconde "lumière principale" de la parcelle de terrain où est incluse la localisation désignée par lTile. La valeur renvoyée peut être comparée aux constantes TILE_MAIN_LIGHT_COLOR_*.

Fonction(s) connexe(s) :
GetTileMainLight1Color, GetTileSourceLight2Color, SetTileMainLightColor

GetTileSourceLight1Color(...)

int GetTileSourceLight1Color
(
    location lTile
)

Paramètres :
- lTile : La localisation incluse dans la parcelle de terrain (tile, tuile, gros carré, au choix).

Description :
Renvoie la couleur de la première "lumière source" de la parcelle de terrain où est incluse la localisation désignée par lTile. La valeur renvoyée peut être comparée aux constantes TILE_SOURCE_LIGHT_COLOR_*.

Fonction(s) connexe(s) :
GetTileMainLight1Color, GetTileSourceLight2Color, SetTileSourceLightColor

GetTileSourceLight2Color(...)

int GetTileSourceLight2Color
(
    location lTile
)

Paramètres :
- lTile : La localisation incluse dans la parcelle de terrain (tile, tuile, gros carré, au choix).

Description :
Renvoie la couleur de la seconde "lumière source" de la parcelle de terrain où est incluse la localisation désignée par lTile. La valeur renvoyée peut être comparée aux constantes TILE_SOURCE_LIGHT_COLOR_*.

Fonction(s) connexe(s) :
GetTileMainLight2Color, GetTileSourceLight1Color, SetTileSourceLightColor

GetTimeHour()

int GetTimeHour()

Description :
Renvoie la valeur de l'heure du module. L'écoulement des heures dépend du nombre de minutes allouées dans les propriétés du module.

Fonction(s) connexe(s) :
GetTimeMillisecond, GetTimeMinute, GetTimeSecond, SetTime

GetTimeMillisecond()

int GetTimeHour()

Description :
Renvoie la valeur des millisecondes du module (il faut avoir envie).

Fonction(s) connexe(s) :
GetTimeHour, GetTimeMinute, GetTimeSecond, SetTime

GetTimeMinute()

int GetTimeHour()

Description :
Renvoie la valeur des minutes du module. Une minute est toujours égale à 60 secondes, mais le nombre de minutes comprise dans une heure est celui défini dans les propriétés du module. Une heure peut comprendre seulement deux minutes.

Fonction(s) connexe(s) :
GetTimeHour, GetTimeMillisecond, GetTimeSecond, SetTime

GetTimeSecond()

int GetTimeHour()

Description :
Renvoie la valeur des secondes du module.

Fonction(s) connexe(s) :
GetTimeHour, GetTimeMillisecond, GetTimeMinute, SetTime

GetTotalDamageDealt()

int GetTotalDamageDealt()

Description :
Renvoie la quantité de dégâts qu'a subit l'objet source. Cette fonction s'utilise dans l'événement "OnDamaged" d'une créature, d'un plaçable ou d'une porte.

Fonction(s) connexe(s) :
GetDamageDealtByType

GetTotalLevels(...)

int GetTotalLevels
(
    object oCreature,
    int bIncludeNegativeLevels
)

Paramètres :
- oCreature : La créature concernée.
- bIncludeNegativeLevels : Détermine si des "niveaux négatifs" doivent être comptabilisés.

Description :
Renvoie la somme des niveaux que la créature désignée par oCreature possède dans toutes les classes. Le paramètre bIncludeNegativeLevels est utilisé dans le cas où une créature subit un effet de "niveaux négatifs".

Fonction(s) connexe(s) :
GetHitDice, GetLevelByClass, GetLevelByPosition

GetTransitionTarget(...)

object GetTransitionTarget
(
    object oTransition
)

Paramètres :
- oTransition : Le plaçable ou la porte concernée.

Description :
Renvoie la valeur "object" de la destination dont le tag est défini dans les propriétés du plaçable ou de la porte désignée par oTransition. La fonction peut ainsi pointer sur un point de passage ou une autre porte.

Fonction(s) connexe(s) :
UnlinkDoor

GetTrapActive(...)

int GetTrapActive
(
    object oObject
)

Paramètres :
- oObject : L'objet concerné.

Description :
Détermine si le déclencheur, le plaçable ou la porte désignée par oObject est piégé, et si ce piège est actif. La valeur FALSE sera renvoyée si un piège est présent mais inactif (Cf. paramètre "TrapActive" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapActive

GetTrapBaseType(...)

int GetTrapBaseType
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Renvoie le type de piège de base que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject. La valeur renvoyée peut être comparée aux constantes TRAP_BASE_TYPE_*.

Fonction(s) connexe(s) :
GetTrap*, SetTrapBaseType

GetTrapCreator(...)

object GetTrapCreator
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Renvoie la valeur "object" de la créature ayant piégé le déclencheur, le plaçable ou la porte désignée par oTrapObject. La valeur OBJECT_INVALID sera renvoyée si le piège a été créé à partir de l'éditeur.

Fonction(s) connexe(s) :
GetTrap*, SetTrapCreator

GetTrapDetectable(...)

int GetTrapDetectable
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Détermine si le piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject est détectable (Cf. paramètre "Piège détectable ?" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapDetectable

GetTrapDetectDC(...)

int GetTrapDetectDC
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Renvoie le seuil de difficulté de détection du piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject (Cf. paramètre "DD Détection des pièges" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapDetectDC

GetTrapDetectedBy(...)

int GetTrapDetectedBy
(
    object oTrapObject,
    object oCreature
)

Paramètres :
- oTrapObject : L'objet concerné.
- oCreature : La créature concerné.

Description :
Détermine si la créature désignée par oCreature a détecté le piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject.

Fonction(s) connexe(s) :
GetTrap*, SetTrapDetectedBy

GetTrapDisarmable(...)

int GetTrapDisarmable
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Détermine si le piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject peut être désarmé (Cf. paramètre "Piège désamorçable ?" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapDisarmable

GetTrapDisarmDC(...)

int GetTrapDisarmDC
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Renvoie le seuil de difficulté de désamorçage du piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject (Cf. paramètre "DD Désarmement ?" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapDisarmDC

GetTrapFlagged(...)

int GetTrapFlagged
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Détermine si le piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject a été signalé par un joueur (et donc à la vue de tous).

Fonction(s) connexe(s) :
GetTrap*, SetTrapFlagged

GetTrapKeyTag(...)

string GetTrapKeyTag
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Renvoie le Tag de la clé permettant de désamorcer le piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject (Cf. paramètre "Nom de la clé" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapKeyTag

GetTrapOneShot(...)

int GetTrapOneShot
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Détermine si le piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject ne se déclenche qu'une seule fois (Cf. paramètre "Piège à déclenchement unique ?" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapOneShot

GetTrapRecoverable(...)

int GetTrapRecoverable
(
    object oTrapObject
)

Paramètres :
- oTrapObject : L'objet concerné.

Description :
Détermine si le piège que contient le déclencheur, le plaçable ou la porte désignée par oTrapObject est récupérable (Cf. paramètre "TrapRecoverable" dans l'éditeur).

Fonction(s) connexe(s) :
GetTrap*, SetTrapRecoverable

GetTRUEBaseAttackBonus(...)

int GetTRUEBaseAttackBonus
(
    object oTarget
)

Paramètres :
- oTarget : La créature concernée.

Description :
Renvoie le bonus à l'attaque de base de la créature désignée par oTarget.

Fonction(s) connexe(s) :
GetBaseAttackBonus

GetTurnResistanceHD(...)

int GetTurnResistanceHD
(
    object oUndead = OBJECT_SELF
)

Paramètres :
- oUndead : La créature concernée (défaut : OBJECT_SELF).

Description :
Renvoie le nombre de dés de vie maximum auxquels la créature désignée par oUndead peut résister. Ne fonctionne que sur les créatures de type "mort-vivant".

GetTypeFromTalent(...)

int GetTypeFromTalent
(
    talent tTalent
)

Paramètres :
- tTalent : Le talent concerné.

Description :
Renvoie le type du talent désigné par tTalent. La valeur renvoyée peut être comparée aux constantes TALENT_TYPE_*.

Fonction(s) connexe(s) :
GetCreatureHasTalent

GetUseableFlag(...)

int GetUseableFlag
(
    object oObject = OBJECT_SELF
)

Paramètres :
- oObject : Le plaçable concerné (défaut : OBJECT_SELF).

Description :
Détermine si le plaçable désigné par oObject est utilisable (Cf. paramètre "Utilisable ?" dans l'éditeur).

Fonction(s) connexe(s) :
SetUseableFlag

GetUserDefinedEventNumber()

int GetUserDefinedEventNumber()

Description :
Renvoie l'identifiant d'un événement personnalisé. Cette fonction s'utilise lors de l'événement "OnUserDefined". Elle peut être utilisée avec les constantes EVENT_*.

Fonction(s) connexe(s) :
EventUserDefined

GetVariableCount(...)

int GetVariableCount
(
    object oObject
)

Paramètres :
- oObject : L'objet concerné.

Description :
Renvoie le nombre de variables locales inscrites sur l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetVariableName, GetVariableType, GetVariableValue*

GetVariableName(...)

string GetVariableName
(
    object oTarget,
    int nPosition
)

Paramètres :
- oTarget : L'objet concerné.
- nPosition : La position de la variable dont on souhaite retrouver le nom.

Description :
Renvoie le nom de la variable locale inscrite sur l'objet désigné par oTarget, et située à la position nPosition. Renverra une chaîne de caractères vide si aucune variable locale n'existe à cette position, ou si oTarget désigne un objet non valide.

Fonction(s) connexe(s) :
GetVariableCount, GetVariableType, GetVariableValue*

GetVariableType(...)

int GetVariableType
(
    object oTarget,
    int nPosition
)

Paramètres :
- oTarget : L'objet concerné.
- nPosition : La position de la variable dont on souhaite retrouver le type.

Description :
Renvoie le type de la variable locale inscrite sur l'objet désigné par oTarget, et située à la position nPosition. La valeur renvoyée peut être comparée aux constantes VARIABLE_TYPE_*. Renverra la valeur -1 si la variable n'existe pas.

Fonction(s) connexe(s) :
GetVariableCount, GetVariableName, GetVariableValue*

GetVariableValueFloat(...)

float GetVariableValueFloat
(
    object oObject,
    int nIndex
)

Paramètres :
- oObject : L'objet concerné.
- nIndex : La position de la variable dont on souhaite récupérer la valeur.

Description :
Renvoie la valeur float de la variable locale inscrite sur l'objet désigné par oObject, et située à la position nIndex. Renverra la valeur 0.0 si la variable n'existe pas, ou si la valeur inscrite n'est pas du type float.

Fonction(s) connexe(s) :
GetVariableCount, GetVariableName, GetVariableValueInt, GetVariableValueLocation, GetVariableValueObject, GetVariableValueString

GetVariableValueInt(...)

int GetVariableValueInt
(
    object oObject,
    int nIndex
)

Paramètres :
- oObject : L'objet concerné.
- nIndex : La position de la variable dont on souhaite récupérer la valeur.

Description :
Renvoie la valeur int de la variable locale inscrite sur l'objet désigné par oObject, et située à la position nIndex. Renverra la valeur 0 si la variable n'existe pas, ou si la valeur inscrite n'est pas du type int.

Fonction(s) connexe(s) :
GetVariableCount, GetVariableName, GetVariableValueFloat, GetVariableValueLocation, GetVariableValueObject, GetVariableValueString

GetVariableValueLocation(...)

location GetVariableValueLocation
(
    object oObject,
    int nIndex
)

Paramètres :
- oObject : L'objet concerné.
- nIndex : La position de la variable dont on souhaite récupérer la valeur.

Description :
Renvoie la valeur location de la variable locale inscrite sur l'objet désigné par oObject, et située à la position nIndex. Renverra une localisation non valide si la variable n'existe pas, ou si la valeur inscrite n'est pas du type location.

Fonction(s) connexe(s) :
GetVariableCount, GetVariableName, GetVariableValueFloat, GetVariableValueInt, GetVariableValueObject, GetVariableValueString

GetVariableValueObject(...)

object GetVariableValueObject
(
    object oObject,
    int nIndex
)

Paramètres :
- oObject : L'objet concerné.
- nIndex : La position de la variable dont on souhaite récupérer la valeur.

Description :
Renvoie la valeur object de la variable locale inscrite sur l'objet désigné par oObject, et située à la position nIndex. Renverra la valeur OBJECT_INVALID si la variable n'existe pas, ou si la valeur inscrite n'est pas du type object.

Fonction(s) connexe(s) :
GetVariableCount, GetVariableName, GetVariableValueFloat, GetVariableValueInt, GetVariableValueLocation, GetVariableValueString

GetVariableValueString(...)

string GetVariableValueString
(
    object oObject,
    int nIndex
)

Paramètres :
- oObject : L'objet concerné.
- nIndex : La position de la variable dont on souhaite récupérer la valeur.

Description :
Renvoie la valeur string de la variable locale inscrite sur l'objet désigné par oObject, et située à la position nIndex. Renverra une chaîne de caractères vide si la variable n'existe pas, ou si la valeur inscrite n'est pas du type string.

Fonction(s) connexe(s) :
GetVariableCount, GetVariableName, GetVariableValueFloat, GetVariableValueInt, GetVariableValueLocation, GetVariableValueObject

GetWaypointByTag(...)

object GetWaypointByTag
(
    string sTag
)

Paramètres :
- sTag : Le Tag du point de passage recherché.

Description :
Renvoie la valeur "object" du point de passage dont le Tag est défini par sTag.

Fonction(s) connexe(s) :
GetObjectByTag

GetWeaponRanged(...)

int GetWeaponRanged
(
    object oItem
)

Paramètres :
- oItem : L'item concerné.

Description :
Détermine si l'item désigné par oItem est une arme à distance.

Fonction(s) connexe(s) :
GetWeaponType

GetWeaponType(...)

int GetWeaponType
(
    object oItem
)

Paramètres :
- oItem : L'item concerné.

Description :
Renvoie le type de dégâts de base qu'inflige l'arme désignée par oItem. La valeur renvoyée peut être comparée aux constantes WEAPON_TYPE_*.

Fonction(s) connexe(s) :
GetWeaponRanged

GetWeather(...)

int GetWeather
(
    object oArea,
    int nWeatherType
)

Paramètres :
- oArea : La zone concernée.
- nWeatherType : Constante WEATHER_TYPE_* définissant la condition météo à consulter.

Description :
Renvoie la puissance du type d'intempérie défini pour la zone désignée par oArea. La valeur renvoyée peut être comparée aux constantes WEATHER_POWER_*.

Fonction(s) connexe(s) :
SetWeather

GetWeight(...)

int GetWeight
(
    object oTarget = OBJECT_SELF
)

Paramètres :
- oTarget : L'objet concerné (défaut : OBJECT_SELF).

Description :
Si oTarget désigne un item, la valeur renvoyée sera le poids de cet item (consultable dans le fichier baseitems.2da). Si oTarget désigne une créature, la valeur renvoyée sera le poids total de l'équipement que cette créature transporte.

GetWillSavingThrow(...)

int GetWillSavingThrow
(
    object oTarget
)

Paramètres :
- oTarget : L'objet concerné.

Description :
Renvoie le résultat du jet de volonté de l'objet désigné par oTarget. Ne s'applique qu'aux créatures, aux plaçables (?), et aux portes (?!).

Fonction(s) connexe(s) :
GetFortitudeSavingThrow, GetReflexSavingThrow, WillSave

GetXP(...)

int GetXP
(
    object oCreature
)

Paramètres :
- oCreature : La créature concernée.

Description :
Renvoie le montant d'expérience qu'a accumulé la créature désignée par oCreature.

Fonction(s) connexe(s) :
GiveXPToCreature, SetXP

GiveGoldToCreature(...)

void GiveGoldToCreature
(
    object oCreature,
    int nGP,
    int bDisplayFeedback = TRUE
)

Paramètres :
- oCreature : La créature concernée.
- nGP : Le montant d'or à attribuer.
- bDisplayFeedback : Détermine si un message doit s'afficher dans la fenêtre de discussion/combat (défaut : TRUE).

Description :
Attribue une somme d'or à la créature désignée par oCreature. Cette somme s'ajoute à l'or que possède déjà oCreature.

Fonction(s) connexe(s) :
GetGold, GiveXPToCreature

GiveXPToCreature(...)

void GiveXPToCreature
(
    object oCreature,
    int nXpAmount
)

Paramètres :
- oCreature : La créature concernée.
- nXpAmount : Le montant d'expérience à attribuer.

Description :
Attribue une somme d'expérience à la créature désignée par oCreature. Cette somme s'ajoute au total d'expérience déjà accumulé par oCreature.

Fonction(s) connexe(s) :
GiveGoldToCreature, SetXP

LISTE DES FONCTIONS

Fonctions par page :
A - BCD - EF - G - HI - JLMNOPR - S - TUVWY

de "Get2DAString(...)" à "GetGoodEvilValue(...)"
de "GetHardness(...)" à "GetLootable(...)"
de "GetMaster(...)" à "GiveXPToCreature(...)"