NWScript - Fonctions G (début...)

Get2DAString(...)

string Get2DAString
(
    string s2DA,
    string sColumn,
    int nRow,
)

Paramètres :
- s2DA : Fichier 2DA à consulter.
- sColumn : Colonne à consulter.
- nRow : Ligne à consulter.

Description :
Renvoie l'entrée d'un fichier 2DA (nom du fichier sans l'extension, 16 caractères maximum), situé à la colonne sColumn et à la ligne nRow. Cette fonction consomme un peu plus de ressources que la normale, ce qui la rend délicate à utiliser dans une boucle. Renvoie une chaîne de caractères vide si la ligne, la colonne ou le fichier 2DA est introuvable.

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

GetAbilityModifier(...)

int GetAbilityModifier
(
    int nAbility,
    object oCreature = OBJECT_SELF
)

Paramètres :
- nAbility : Constante ABILITY_* définissant la caractéristique concernée.
- oCreature : La créature concernée (défaut : OBJECT_SELF).

Description :
Renvoie la valeur du bonus associé à la caractéristique définie par nAbility de la créature désignée par oCreature.

Fonction(s) connexe(s) :
GetAbilityScore

GetAbilityScore(...)

int GetAbilityScore
(
    object oCreature,
    int nAbilityType,
    int nBaseAttribute = FALSE
)

Paramètres :
- oCreature : La créature concernée.
- nAbility : Constante ABILITY_* définissant la caractéristique concernée.
- nBaseAttribute : Détermine si valeur de la caractéristique sans bonus (même racial) doit être renvoyée (défaut : FALSE).

Description :
Renvoie la valeur de la caractéristique définie par nAbility de la créature désignée par oCreature.

Fonction(s) connexe(s) :
GetAbilityModifier

GetAC(...)

int GetAC
(
    object oObject,
    int nForFutureUse = 0
)

Paramètres :
- oObject : La créature concernée.
- nForFutureUse : Comme son nom l'indique, pour un "usage futur" (défaut : 0).

Description :
Renvoie la valeur de la classe d'armure de la créature désignée par oObject. Si oObject est un item, un plaçable ou une porte, la valeur 0 est renvoyée. S'il s'agit d'un autre objet, la valeur -1 est renvoyée.

Fonction(s) connexe(s) :
GetArmorRank, GetArmorRulesType, GetFactionBestAC, GetFactionWorstAC

GetActionMode(...)

int GetActionMode
(
    object oCreature,
    int nMode
)

Paramètres :
- oCreature : La créature concernée.
- nMode : Constante ACTION_MODE_* définissant le mode d'action concerné.

Description :
Renvoie l'état de la créature désignée par oCreature vis-à-vis du mode d'action défini par nMode. La valeur TRUE est renvoyée si oCreature est effectivement dans ce mode d'action.

Fonction(s) connexe(s) :
ActionCounterSpell, GetCurrentAction, GetDefensiveCastingMode, GetDetectMode, SetActionMode

GetAge(...)

int GetAge
(
    object oCreature
)

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

Description :
Renvoie l'âge de la créature.

GetAILevel(...)

int GetAILevel
(
    object oTarget = OBJECT_SELF
)

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

Description :
Renvoie le niveau actuel de l'intelligence artificielle de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes AI_LEVEL_*.

Fonction(s) connexe(s) :
SetAILevel

GetAlignmentGoodEvil(...)

int GetAlignmentGoodEvil
(
    object oCreature
)

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

Description :
Renvoie la valeur de l'alignement Mauvais/Bon de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes ALIGNMENT_*.

Fonction(s) connexe(s) :
AdjustAlignment, GetAlignmentLawChaos, GetGoodEvilValue

GetAlignmentLawChaos(...)

int GetAlignmentLawChaos
(
    object oCreature
)

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

Description :
Renvoie la valeur de l'alignement Chaotique/Loyal de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes ALIGNMENT_*.

Fonction(s) connexe(s) :
AdjustAlignment, GetAlignmentGoodEvil, GetLawChaosValue

GetAnimalCompanionCreatureType(...)

int GetAnimalCompanionCreatureType
(
    object oCreature
)

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

Description :
Renvoie le type du compagnon animal appartenant à la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes ANIMAL_COMPANION_CREATURE_TYPE_*. Renvoie la valeur ANIMAL_COMPANION_CREATURE_TYPE_NONE si oCreature n'est pas valide, ou s'il n'a pas de compagnon animal.

Fonction(s) connexe(s) :
GetAnimalCompanionName, GetFamiliarCreatureType, SummonAnimalCompanion

GetAnimalCompanionName(...)

string GetAnimalCompanionName
(
    object oCreature
)

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

Description :
Renvoie le nom du compagnon animal appartenant à la créature désignée par oCreature. La fonction renverra une chaîne de caractères vide si oCreature n'est pas valide, s'il n'a pas de compagnon animal, ou si le nom du compagnon animal est une chaîne de caractères vide.

Fonction(s) connexe(s) :
GetAnimalCompanionCreatureType, GetFamiliarName, SummonAnimalCompanion

GetAppearanceType(...)

int GetAppearanceType
(
    object oCreature
)

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

Description :
Renvoie le type d'apparence de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes APPEARANCE_TYPE_*.

Fonction(s) connexe(s) :
GetCreatureSize, SetCreatureAppearanceType

GetArcaneSpellFailure(...)

int GetArcaneSpellFailure
(
    object oCreature
)

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

Description :
Renvoie le pourcentage de chances d'echec aux sorts de la créature désignée par oCreature.

GetArea(...)

object GetArea
(
    object oTarget
)

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

Description :
Renvoie la valeur "object" de la zone où se trouve l'objet désigné par oTarget.

Fonction(s) connexe(s) :
GetAreaFromLocation, GetAreaSize, GetFirstArea, GetNextArea

GetAreaFromLocation(...)

object GetAreaFromLocation
(
    location lLocation
)

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

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

Fonction(s) connexe(s) :
GetArea, GetFacingFromLocation, GetPositionFromLocation

GetAreaOfEffectCreator(...)

object GetAreaOfEffectCreator
(
    object oAreaOfEffectObject = OBJECT_SELF
)

Paramètres :
- oAreaOfEffectObject : La zone d'effet concernée (défaut : OBJECT_SELF).

Description :
Renvoie la valeur "object" de la créature ayant créé la zone d'effet désignée par oAreaOfEffectObject.

Fonction(s) connexe(s) :
EffectAreaOfEffect, GetAreaOfEffectDuration, GetAreaOfEffectSpellId, GetEffectCreator

GetAreaOfEffectDuration(...)

int GetAreaOfEffectDuration
(
    object oAreaOfEffectObject = OBJECT_SELF
)

Paramètres :
- oAreaOfEffectObject : La zone d'effet concernée (défaut : OBJECT_SELF).

Description :
Renvoie le type de durée appliqué à la zone d'effet désignée par oAreaOfEffectObject. La valeur renvoyée peut être comparée aux constantes DURATION_TYPE_*.

Fonction(s) connexe(s) :
EffectAreaOfEffect, GetAreaOfEffectCreator, GetAreaOfEffectSpellId, GetEffectDurationType

GetAreaOfEffectSpellId(...)

int GetAreaOfEffectSpellId
(
    object oAreaOfEffectObject = OBJECT_SELF
)

Paramètres :
- oAreaOfEffectObject : La zone d'effet concernée (défaut : OBJECT_SELF).

Description :
Renvoie le type de sort relatif à la zone d'effet désignée par oAreaOfEffectObject. La valeur renvoyée peut être comparée aux constantes SPELL_*.

Fonction(s) connexe(s) :
EffectAreaOfEffect, GetAreaOfEffectCreator, GetAreaOfEffectDuration, GetEffectSpellId

GetAreaSize(...)

int GetAreaSize
(
    int nAreaDimension,
    object oArea = OBJECT_INVALID
)

Paramètres :
- nAreaDimension : La dimension désirée AREA_HEIGHT (longeur) ou AREA_WIDTH (largeur).
- oArea : La zone concernée (défaut : OBJECT_INVALID).

Description :
Renvoie la longueur/largeur en nombre de tiles (tuiles/gros carrés/le-nom-que-vous-voulez) de la zone désignée par oArea.

Fonction(s) connexe(s) :
GetArea

GetArmorRank(...)

int GetArmorRank
(
    object oItem
)

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

Description :
Renvoie le type d'armure (vêtement/légère/intermédiaire/lourde) de l'item désigné par oItem. La valeur renvoyée peut être comparée aux constantes ARMOR_RANK_*.

Fonction(s) connexe(s) :
GetAC, GetArmorRulesType

GetArmorRulesType(...)

int GetArmorRulesType
(
    object oItem
)

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

Description :
Renvoie le numéro de la ligne du ficher 2DA armorrulesstats.2da, correspondant aux règles auxquelles l'armure désignée par oItem obéit. Ces règles peuvent être consultées dans le champ "ArmorRulesInfo", dans les propriétés de cette armure. Si l'item n'est pas du type "armure", la fonction renverra la valeur 0.

Fonction(s) connexe(s) :
GetAC, GetArmorRank

GetAssociate(...)

object GetAssociate
(
    int nAssociateType,
    object oMaster = OBJECT_SELF,
    int nTh=1
)

Paramètres :
- nAssociateType : Constante ASSOCIATE_TYPE_* définissant le type de compagnon que l'on souhaite rechercher.
- oMaster : La créature maître (défaut : OBJECT_SELF).
- nTh : Dans le cas de plusieurs compagnon du même type, sa position dans la liste (défaut : 1).

Description :
Renvoie la valeur "object" du compagnon sous les ordres de oMaster, dont le type est défini par nAssociateType. Un compagnon peut être un "compagnon d'armes", un "compagnon animal", un "familier", une "invocation", ou une "créature dominée".

Fonction(s) connexe(s) :
GetAssociateType, GetMaster

GetAssociateType(...)

int GetAssociateType
(
    object oAssociate
)

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

Description :
Renvoie le type de compagnon qu'est la créature désignée par oAssociate. La valeur renvoyée peut être comparée aux constantes ASSOCIATE_TYPE_*. Un compagnon peut être un "compagnon d'armes", un "compagnon animal", un "familier", une "invocation", ou une "créature dominée".

Fonction(s) connexe(s) :
GetAssociate

GetAttackTarget(...)

object GetAttackTarget
(
    object oCreature = OBJECT_SELF
)

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

Description :
Renvoie la valeur "object" de la cible des attaques de la créature désignée par oCreature. Ne s'applique qu'aux créatures en train de combattre.

Fonction(s) connexe(s) :
GetAttemptedAttackTarget, GetAttemptedSpellTarget

GetAttemptedAttackTarget()

object GetAttemptedAttackTarget()

Description :
Renvoie la valeur "object" de la cible que l'objet source est en train d'attaquer. Cette valeur est mise à jour à chaque attaque, et réinitialisée à la fin du combat.

Fonction(s) connexe(s) :
GetAttackTarget, GetAttemptedSpellTarget, GetGoingToBeAttackedBy

GetAttemptedSpellTarget()

object GetAttemptedSpellTarget()

Description :
Renvoie la valeur "object" de la cible sur laquelle l'objet source est en train de lancer un sort. Cette valeur est mise à jour à chaque sort lancé, et réinitialisée à la fin du combat.

Fonction(s) connexe(s) :
GetAttackTarget, GetAttemptedAttackTarget, GetGoingToBeAttackedBy

GetBaseAttackBonus(...)

int GetBaseAttackBonus
(
    object oCreature
)

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

Description :
Renvoie le nombre d'attaques de base que la créature désignée par oCreature peut effectuer.

Fonction(s) connexe(s) :
GetTRUEBaseAttackBonus, SetBaseAttackBonus

GetBaseItemType(...)

int GetBaseItemType
(
    object oItem
)

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

Description :
Renvoie le type d'item de base qu'est l'item désigné par oItem. La valeur renvoyée peut être comparée aux constantes BASE_ITEM_*.

GetBicFileName()

object GetBicFileName
(
    object oPC
)

Description :
Renvoie le nom du fichier dans lequel sont contenues les informations relatives au personnage joueur désigné par oPC. Ne fonctionne que pour les personnages stockés dans le répertoire "servervault".

GetBlockingDoor()

object GetBlockingDoor()

Description :
Renvoie la valeur "object" de la dernière porte ayant bloqué l'objet source. Cette fonction s'utilise lorsque l'événement "OnBlocked" d'une créature est déclenché.

Fonction(s) connexe(s) :
DoDoorAction

GetBumpState(...)

int GetBumpState
(
    object oCreature
)

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

Description :
Renvoie le type de collision appliqué à la créature désignée par oCreature (Cf. paramètre "Statut collision" dans l'éditeur). La valeur renvoyée peut être comparée aux constantes BUMPSTATE_*.

Fonction(s) connexe(s) :
SetBumpState

GetCalendarDay()

int GetCalendarDay()

Description :
Renvoie le jour du calendrier du module.

Fonction(s) connexe(s) :
GetCalendarMonth, GetCalendarYear, SetCalendar

GetCalendarMonth()

int GetCalendarMonth()

Description :
Renvoie le mois du calendrier du module.

Fonction(s) connexe(s) :
GetCalendarDay, GetCalendarYear, SetCalendar

GetCalendarYear()

int GetCalendarYear()

Description :
Renvoie l'année du calendrier du module.

Fonction(s) connexe(s) :
GetCalendarDay, GetCalendarMonth, SetCalendar

GetCampaignFloat(...)

float GetCampaignFloat
(
    string sCampaignName,
    string sVarName,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : La base de données à consulter.
- sVarName : Le nom de la variable à consulter.
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Renvoie la valeur "float" de la variable définie par sVarName, enregistrée dans le fichier BDD désigné par sCampaignName. Un joueur peut avoir été rattaché à la variable, auquel cas il faudra le désigner avec le paramètre oPlayer. Le nom d'une variable est unique quelque soit le type de valeur qu'elle contient, à moins d'avoir un joueur spécifique rattaché. Le nom d'une base de donnée reconnaît les majuscules et les minuscules.

Fonction(s) connexe(s) :
GetCampaignInt, GetCampaignLocation, GetCampaignString, GetCampaignVector, RetrieveCampaignObject, SetCampaignFloat

GetCampaignInt(...)

int GetCampaignInt
(
    string sCampaignName,
    string sVarName,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : La base de données à consulter.
- sVarName : Le nom de la variable à consulter.
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Renvoie la valeur "int" de la variable définie par sVarName, enregistrée dans le fichier BDD désigné par sCampaignName. Un joueur peut avoir été rattaché à la variable, auquel cas il faudra le désigner avec le paramètre oPlayer. Le nom d'une variable est unique quelque soit le type de valeur qu'elle contient, à moins d'avoir un joueur spécifique rattaché. Le nom d'une base de donnée reconnaît les majuscules et les minuscules.

Fonction(s) connexe(s) :
GetCampaignFloat, GetCampaignLocation, GetCampaignString, GetCampaignVector, RetrieveCampaignObject, SetCampaignInt

GetCampaignLocation(...)

location GetCampaignLocation
(
    string sCampaignName,
    string sVarName,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : La base de données à consulter.
- sVarName : Le nom de la variable à consulter.
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Renvoie la valeur "location" de la variable définie par sVarName, enregistrée dans le fichier BDD désigné par sCampaignName. Un joueur peut avoir été rattaché à la variable, auquel cas il faudra le désigner avec le paramètre oPlayer. Le nom d'une variable est unique quelque soit le type de valeur qu'elle contient, à moins d'avoir un joueur spécifique rattaché. Le nom d'une base de donnée reconnaît les majuscules et les minuscules.

Fonction(s) connexe(s) :
GetCampaignFloat, GetCampaignInt, GetCampaignString, GetCampaignVector, RetrieveCampaignObject, SetCampaignLocation

GetCampaignString(...)

string GetCampaignString
(
    string sCampaignName,
    string sVarName,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : La base de données à consulter.
- sVarName : Le nom de la variable à consulter.
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Renvoie la valeur "string" de la variable définie par sVarName, enregistrée dans le fichier BDD désigné par sCampaignName. Un joueur peut avoir été rattaché à la variable, auquel cas il faudra le désigner avec le paramètre oPlayer. Le nom d'une variable est unique quelque soit le type de valeur qu'elle contient, à moins d'avoir un joueur spécifique rattaché. Le nom d'une base de donnée reconnaît les majuscules et les minuscules.

Fonction(s) connexe(s) :
GetCampaignFloat, GetCampaignInt, GetCampaignLocation, GetCampaignVector, RetrieveCampaignObject, SetCampaignString

GetCampaignVector(...)

vector GetCampaignVector
(
    string sCampaignName,
    string sVarName,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : La base de données à consulter.
- sVarName : Le nom de la variable à consulter.
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Renvoie la valeur "vector" de la variable définie par sVarName, enregistrée dans le fichier BDD désigné par sCampaignName. Un joueur peut avoir été rattaché à la variable, auquel cas il faudra le désigner avec le paramètre oPlayer. Le nom d'une variable est unique quelque soit le type de valeur qu'elle contient, à moins d'avoir un joueur spécifique rattaché. Le nom d'une base de donnée reconnaît les majuscules et les minuscules.

Fonction(s) connexe(s) :
GetCampaignFloat, GetCampaignInt, GetCampaignLocation, GetCampaignString, RetrieveCampaignObject, SetCampaignVector

GetCanTalkToNonPlayerOwnedCreatures(...)

int GetCanTalkToNonPlayerOwnedCreatures
(
    object oObject
)

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

Description :
Cette fonction (au nom définitivement bien barbare) permet de contrôler si l'objet désigné par oObject peut converser avec un personnage non-joueur (Cf. paramètre "Possibilité de parler aux créatures non contrôlées par un joueur ?" dans l'éditeur).

Fonction(s) connexe(s) :
SetCanTalkToNonPlayerOwnedCreatures

GetCasterClassSpellSchool(...)

int GetCasterClassSpellSchool
(
    object oPC,
    int nClassPos
)

Paramètres :
- oPC : Le lanceur de sorts concerné.
- nClassPos : La position de la classe concernée.

Description :
Renvoie l'école de magie affiliée à la classe du lanceur de sorts désigné par oPC (pas plus de précisions pour l'instant).

GetCasterLevel(...)

int GetCasterLevel
(
    object oCreature
)

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

Description :
Renvoie le niveau de lanceur de sort de la créature désignée par oCreature. S'applique en cas de sort ou de capacité spéciale. La valeur 0 sera renvoyée si la créature n'a pas encore lancé de sort.

Fonction(s) connexe(s) :
GetLastSpellCastClass, GetLastSpellCaster

GetChallengeRating(...)

float GetChallengeRating
(
    object oCreature
)

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

Description :
Renvoie le facteur de puissance de la créature désignée par oCreature.

GetCharBackground(...)

int GetCharBackground
(
    object oCreature
)

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

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

GetClassByPosition(...)

int GetClassByPosition
(
    int nClassPosition,
    object oCreature = OBJECT_SELF
)

Paramètres :
- nClassPosition : La position de la classe.
- oCreature : La créature concernée (défaut : OBJECT_SELF).

Description :
Renvoie la classe située à la position définie par nClassPosition de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes CLASS_TYPE_*. nClassPosition est une valeur comprise entre 1 et 4. Par exemple, une créature n'ayant qu'une classe n'aura qu'une position disponible (nClassPosition = 1). La valeur 255 (CLASS_TYPE_INVALID) sera renvoyée si la créature n'a aucune classe dans la position que l'on souhaite consulter.

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

GetClickingObject()

object GetClickingObject()

Description :
Renvoie la valeur "object" du joueur ayant cliqué sur l'objet source. Ne s'applique qu'aux déclencheurs.

Fonction(s) connexe(s) :
GetPlaceableLastClickedBy

GetCollision(...)

int GetCollision
(
    object oTarget
)

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

Description :
Renvoie le statut de collision de l'objet désigné par oTarget (cf. paramètre "Statut collision" dans l'éditeur).

Fonction(s) connexe(s) :
SetCollision

GetCommandable(...)

int GetCommandable
(
    object oTarget = OBJECT_SELF
)

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

Description :
Permet de savoir si l'objet désigné par oTarget peut accomplir des actions, et si sa liste d'action peut être modifiée.

Fonction(s) connexe(s) :
SetCommandable

GetControlledCharacter(...)

object GetControlledCharacter
(
    object oCreature
)

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

Description :
Renvoie la valeur "object" du personnage joueur contrôlant la créature désignée par oCreature.

Fonction(s) connexe(s) :
GetOwnedCharacter, SetOwnersControlledCompanion

GetCreatureHasTalent(...)

int GetCreatureHasTalent
(
    talent tTalent,
    object oCreature = OBJECT_SELF
)

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

Description :
Détermine si la créature désignée par oCreature possède le talent défini par tTalent.

Fonction(s) connexe(s) :
GetCreatureTalentBest, GetCreatureTalentRandom, GetHasFeat, GetHasSkill, GetHasSpell

GetCreatureInLimbo(...)

object GetCreatureInLimbo
(
    int nTh = 0
)

Paramètres :
- nTh : Définit la position dans la liste des créatures situées dans les limbes.

Description :
Renvoie la valeur object d'une créature située dans les limbes, à la position définie par nTh. Afin de vérifier si la créature est valide, il ne faudra pas la comparer à OBJECT_INVALID, mais utiliser la fonction GetIsValidObject. De plus, si la fonction renvoie la valeur OBJECT_INVALID, cela ne signifie pas qu'il n'y a plus de créature dans les limbes, mais que la créature à la position nTh n'existe pas (plus).

Pour retirer une créature des limbes, il faudra utiliser la fonction ActionJumpToLocation. A partir de cet instant, il faudra prendre en compte que le nombre de créatures dans les limbes ne changera pas, et qu'il ne sera plus possible de récupérer la valeur object des créatures situées dans les limbes, tant que le script n'aura pas fini de s'exécuter.

Fonction(s) connexe(s) :
GetLimboCreatureCount, SendCreatureToLimbo

GetCreatureSize(...)

int GetCreatureSize
(
    object oCreature
)

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

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

Fonction(s) connexe(s) :
GetAppearanceType

GetCreatureStartingPackage(...)

int GetCreatureStartingPackage
(
    object oCreature
)

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

Description :
Renvoie le type d'archétype défini dans les propriétés de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes PACKAGE_*.

Fonction(s) connexe(s) :
GetLevelUpPackage

GetCreatureTalentBest(...)

talent GetCreatureTalentBest
(
    int nCategory,
    int nCRMax,
    object oCreature = OBJECT_SELF,
    int iExcludedTalentsFlag = 0
)

Paramètres :
- nCategory : Constante TALENT_CATEGORY_* définissant la catégorie de talent concernée.
- nCRMax : le facteur de puissance maximum autorisé pour le talent.
- oCreature : La créature concernée (défaut : OBJECT_SELF).
- iExcludedTalentsFlag : Constante TALENT_EXCLUDE_* définissant le type de talent à exclure (défaut : 0).

Description :
Renvoie le meilleur talent adapté aux paramètres choisis, dont le facteur de puissance se rapproche le plus de nCRMax sans le dépasser.

Fonction(s) connexe(s) :
GetCreatureHasTalent, GetCreatureTalentRandom

GetCreatureTalentRandom(...)

talent GetCreatureTalentRandom
(
    int nCategory,
    object oCreature = OBJECT_SELF,
    int iExcludedTalentsFlag = 0
)

Paramètres :
- nCategory : Constante TALENT_CATEGORY_* définissant la catégorie de talent concernée.
- oCreature : La créature concernée (défaut : OBJECT_SELF).
- iExcludedTalentsFlag : Constante TALENT_EXCLUDE_* définissant le type de talent à exclure (défaut : 0).

Description :
Renvoie un talent au hasard correspondant aux paramètres choisis.

Fonction(s) connexe(s) :
GetCreatureHasTalent, GetCreatureTalentBest

GetCurrentAction(...)

int GetCurrentAction
(
    object oObject = OBJECT_SELF
)

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

Description :
Renvoie le type d'action que l'objet désigné par oObject est en train d'accomplir. La valeur renvoyée peut être comparée aux constantes ACTION_*.

Fonction(s) connexe(s) :
GetActionMode

GetCurrentHitPoints(...)

int GetCurrentHitPoints
(
    object oObject = OBJECT_SELF
)

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

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

Fonction(s) connexe(s) :
GetIsDead, GetMaxHitPoints

GetCustomHeartbeat(...)

int GetCustomHeartbeat
(
    object oTarget
)

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

Description :
Renvoie le temps en millisecondes entre deux activations de l'événement "OnHeartBeat" de l'objet désigné par oTarget, tel qu'il a été défini par la fonction "SetCustomHeartbeat(...)" (1000 millisecondes = 1 seconde). Par défaut, ce temps est égal à 0.

Fonction(s) connexe(s) :
SetCustomHeartbeat

GetCutsceneCameraMoveRate(...)

float GetCutsceneCameraMoveRate
(
    object oCreature
)

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

Description :
Renvoie la vitesse de déplacement de la créature désignée par oCreature, utilisée comme caméra pour la cinématique en cours.

Fonction(s) connexe(s) :
SetCutsceneCameraMoveRate

GetDamageDealtByType(...)

int GetDamageDealtByType
(
    int nDamageType
)

Paramètres :
- nDamageType : Constante DAMAGE_TYPE_* définissant le type de dégâts concerné.

Description :
Renvoie le total des points de dégâts du type défini par nDamageType qu'a subi l'objet source. Cette fonction s'utilise en général lors d'un événement "OnDamaged".

Fonction(s) connexe(s) :
GetLastDamager, GetTotalDamageDealt

GetDefensiveCastingMode(...)

int GetDefensiveCastingMode
(
    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 "incantation défensive". La valeur renvoyée peut être comparée aux constantes DEFENSIVE_CASTING_MODE_*.

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

GetDeity(...)

string GetDeity
(
    object oCreature
)

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

Description :
Renvoie le nom de la divinité définie pour la créature désignée par oCreature. Renvoie une chaîne de caractères vide si oCreature n'a pas de divinité.

Fonction(s) connexe(s) :
SetDeity

GetDescription(...)

string GetDescription
(
    object oTarget
)

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

Description :
Renvoie la déscription de l'objet désigné par oTarget. S'applique aux créatures, items, et plaçables (et les portes, alors ?!).

Fonction(s) connexe(s) :
SetDescription

GetDetectMode(...)

int GetDetectMode
(
    object oCreature
)

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

Description :
Détermine si la créature concernée est en mode "fouille". Bizarrement, les créatures de type "elfe" renvoient toujours la valeur TRUE (elle est bien bonne, hein ?). La valeur renvoyée peut être comparée aux constantes DETECT_MODE_*.

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

GetDialogSoundLength(...)

float GetDialogSoundLength
(
    int nStrRef
)

Paramètres :
- nStrRef : La référence du son à "mesurer".

Description :
Renvoie le temps de lecture en secondes du son désigné par nStrRef.

GetDistanceBetween(...)

float GetDistanceBetween
(
    object oObjectA,
    object oObjectB
)

Paramètres :
- oObjectA : Le premier objet de repère.
- oObjectB : Le second objet de repère.

Description :
Renvoie la distance en mètres entre l'objet oObjectA et l'objet oObjectB. Ne fonctionne pas si les objets de repère sont chacun dans une zone différente.

Fonction(s) connexe(s) :
GetDistanceBetweenLocations, GetDistanceToObject

GetDistanceBetweenLocations(...)

float GetDistanceBetweenLocations
(
    location lLocationA,
    location lLocationB
)

Paramètres :
- lLocationA : La première localisation de repère.
- lLocationB : La seconde localisation de repère.

Description :
Renvoie la distance en mètres entre la localisation lLocationA et la localisation lLocationB. Ne fonctionne pas si les localisations de repère concernent chacune une zone différente.

Fonction(s) connexe(s) :
GetDistanceBetween, GetDistanceToObject

GetDistanceToObject(...)

float GetDistanceToObject
(
    object oObject
)

Paramètres :
- oObject : L'objet de repère.

Description :
Renvoie la distance en mètres entre l'objet source et l'objet de repère désigné par oObject. Ne fonctionne pas si l'objet de repère n'est pas dans la même zone que l'objet source.

Fonction(s) connexe(s) :
GetDistanceBetween, GetDistanceBetweenLocations

GetDroppableFlag(...)

int GetDroppableFlag
(
    object oItem
)

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

Description :
Détermine s'il est possible de se séparer de l'item désigné par oItem (Cf. paramètre "Abandon possible" dans l'éditeur).

Fonction(s) connexe(s) :
SetDroppableFlag

GetEffectCreator(...)

object GetEffectCreator
(
    effect eEffect
)

Paramètres :
- eEffect : L'effet concerné.

Description :
Renvoie la valeur "object" de l'objet ayant créé l'effet désigné par eEffect.

Fonction(s) connexe(s) :
GetAreaOfEffectCreator

GetEffectDurationType(...)

int GetEffectDurationType
(
    effect eEffect
)

Paramètres :
- eEffect : L'effet concerné.

Description :
Renvoie le type de durée de l'effet désigné par eEffect. La valeur renvoyée peut être comparée aux constantes DURATION_TYPE_*.

Fonction(s) connexe(s) :
GetAreaOfEffectDuration, GetFirstEffect, GetItemPropertyDurationType, GetNextEffect

GetEffectInteger(...)

int GetEffectInteger
(
    effect eEffect
)

Paramètres :
- eEffect : L'effet concerné.

Description :
Renvoie le nombre entier inclus dans l'effet désigné par eEffect.

Fonction(s) connexe(s) :
GetFirstEffect, GetNextEffect

GetEffectSpellId(...)

int GetEffectSpellId
(
    effect eSpellEffect
)

Paramètres :
- eSpellEffect : L'effet du sort concerné.

Description :
Renvoie la référence du sort à l'origine de l'effet désigné par eEffect. La valeur renvoyée peut être comparée aux constantes SPELL_*.

Fonction(s) connexe(s) :
GetAreaOfEffectSpellId, GetFirstEffect, GetHasSpellEffect, GetNextEffect

GetEffectSubType(...)

int GetEffectSubType
(
    effect eEffect
)

Paramètres :
- eEffect : L'effet concerné.

Description :
Renvoie la sous-catégorie de l'effet désigné par eEffect. La valeur renvoyée peut être comparée aux constantes SUBTYPE_*.

Fonction(s) connexe(s) :
GetEffectType, GetFirstEffect, GetItemPropertySubType, GetNextEffect

GetEffectType(...)

int GetEffectType
(
    effect eEffect
)

Paramètres :
- eEffect : L'effet concerné.

Description :
Renvoie le type de l'effet désigné par eEffect. La valeur renvoyée peut être comparée aux constantes EFFECT_TYPE_*.

Fonction(s) connexe(s) :
GetEffectSubType, GetFirstEffect, GetItemPropertyType, GetNextEffect

GetEncounterActive(...)

int GetEncounterActive
(
    object oEncounter = OBJECT_SELF
)

Paramètres :
- oEncounter : La rencontre concernée (défaut : OBJECT_SELF).

Description :
Détermine si la rencontre désignée par oEncounter est active.

Fonction(s) connexe(s) :
SetEncounterActive

GetEncounterDifficulty(...)

int GetEncounterDifficulty
(
    object oEncounter = OBJECT_SELF
)

Paramètres :
- oEncounter : La rencontre concernée (défaut : OBJECT_SELF).

Description :
Renvoie le niveau de difficulté de la rencontre désignée par oEncounter. La valeur renvoyée peut être comparée aux constantes ENCOUNTER_DIFFICULTY_*.

Fonction(s) connexe(s) :
SetEncounterDifficulty

GetEncounterSpawnsCurrent(...)

int GetEncounterSpawnsCurrent
(
    object oEncounter = OBJECT_SELF
)

Paramètres :
- oEncounter : La rencontre concernée (défaut : OBJECT_SELF).

Description :
Renvoie le nombre d'activations auxquelles la rencontre désignée par oEncounter a procédé jusqu'à lors.

Fonction(s) connexe(s) :
SetEncounterSpawnsCurrent

GetEncounterSpawnsMax(...)

int GetEncounterSpawnsMax
(
    object oEncounter = OBJECT_SELF
)

Paramètres :
- oEncounter : La rencontre concernée (défaut : OBJECT_SELF).

Description :
Renvoie le nombre d'activations maximum auxquelles la rencontre désignée par oEncounter procédera.

Fonction(s) connexe(s) :
SetEncounterSpawnsMax

GetEncumbranceState(...)

int GetEncumbranceState
(
    object oCreature
)

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

Description :
Renvoie l'état de surcharge de la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes ENCUMBRANCE_STATE_*.

Fonction(s) connexe(s) :
GetWeight

GetEnteringObject()

object GetEnteringObject()

Description :
Renvoie la valeur "object" de l'objet ayant déclenché l'événement "OnClientEnter", "OnClientLoaded" ou "OnEnter" du module, d'une zone, d'un déclencheur, d'une rencontre, ou d'une zone d'effet. Peut également s'utiliser dans l'événement "OnClick" d'une porte de transition.

Fonction(s) connexe(s) :
GetExitingObject, GetFirstEnteringPC

GetEventHandler(...)

string GetEventHandler
(
    object oObject,
    int iEventID
)

Paramètres :
- oObject : L'objet concernée.
- iEventID : Constante CREATURE_SCRIPT_* ou SCRIPT_* définissant le type d'événement concerné.

Description :
Renvoie le nom du script associé à l'événement défini par iEventID de l'objet désigné par oObject. Le groupe de constante est différent selon le type de l'objet concerné (ex. si l'objet est un plaçable, le groupe de constantes sera SCRIPT_PLACEABLE_*). Renvoie une chaîne de caractère vide si aucun script n'est trouvé.

Fonction(s) connexe(s) :
SetEventHandler

GetExitingObject()

object GetExitingObject()

Description :
Renvoie la valeur "object" de l'objet ayant déclenché l'événement "OnClientLeave" ou "OnExit" du module, d'une zone, d'un déclencheur, d'une rencontre, ou d'une zone d'effet.

Fonction(s) connexe(s) :
GetEnteringObject

GetFacing(...)

float GetFacing
(
    object oTarget
)

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

Description :
Renvoie la valeur de l'orientation de l'objet désigné par oTArget. L'orientation est une valeur comprise entre 0.0f et 360.0f.

Fonction(s) connexe(s) :
GetFacingFromLocation, SetFacing, SetFacingPoint

GetFacingFromLocation(...)

float GetFacingFromLocation
(
    location lLocation
)

Paramètres :
- lLocation : La localisation dont on souhaite extraire l'orientation.

Description :
Renvoie la valeur de l'orientation incluse dans la localisation définie par lLocation.

Fonction(s) connexe(s) :
GetAreaFromLocation, GetFacing, GetPositionFromLocation

GetFactionAverageGoodEvilAlignment(...)

int GetFactionAverageGoodEvilAlignment
(
    object oFactionMember
)

Paramètres :
- oFactionMember : Le membre de la faction concernée.

Description :
Renvoie la valeur de l'alignement moyen "Mauvais/Bon" de la faction à laquelle appartient l'objet désigné par oFactionMember. La valeur renvoyée est comprise entre 0 (Mauvais) et 100 (Bon).

Fonction(s) connexe(s) :
GetFaction*, GetFactionAverageLawChaosAlignment, GetGoodEvilValue

GetFactionAverageLawChaosAlignment(...)

int GetFactionAverageGoodEvilAlignment
(
    object oFactionMember
)

Paramètres :
- oFactionMember : Le membre de la faction concernée.

Description :
Renvoie la valeur de l'alignement moyen "Chaotique/Loyal" de la faction à laquelle appartient l'objet désigné par oFactionMember. La valeur renvoyée est comprise entre 0 (Chaotique) et 100 (Loyal).

Fonction(s) connexe(s) :
GetFaction*, GetFactionAverageGoodEvilAlignment, GetLawChaosValue

GetFactionAverageLevel(...)

int GetFactionAverageGoodEvilAlignment
(
    object oFactionMember
)

Paramètres :
- oFactionMember : Le membre de la faction concernée.

Description :
Renvoie le niveau moyen de la faction à laquelle appartient l'objet désigné par oFactionMember.

Fonction(s) connexe(s) :
GetFaction*, GetFactionAverageXP, GetTotalLevels

GetFactionAverageReputation(...)

int GetFactionAverageReputation
(
    object oSourceFactionMember,
    object oTarget
)

Paramètres :
- oSourceFactionMember : Le membre de la faction concernée.
- oTarget : L'objet concerné.

Description :
Renvoie la valeur de la réputation moyenne qu'entretient l'objet désigné par oTarget vis-à-vis de la faction à laquelle appartient l'objet désigné par oSourceFactionMember. La valeur renvoyée est comprise entre 0 (hostile) et 100 (amical).

Fonction(s) connexe(s) :
AdjustReputation, GetFaction*, GetStandardFactionReputation

GetFactionAverageXP(...)

int GetFactionAverageXP
(
    object oFactionMember
)

Paramètres :
- oFactionMember : Le membre de la faction concernée.
- oTarget : L'objet concerné.

Description :
Renvoie la valeur d'expérience moyenne de la faction à laquelle appartient l'objet désigné par oFactionMember.

Fonction(s) connexe(s) :
GetFaction*, GetFactionAverageLevel, GetXP

GetFactionBestAC(...)

object GetFactionBestAC
(
    object oFactionMember = OBJECT_SELF,
    int bMustBeVisible = TRUE
)

Paramètres :
- oFactionMember : Le membre de la faction concernée (défaut : OBJECT_SELF).
- bMustBeVisible : Détermine si le membre recherché doit être visible par oFactionMember (défaut : TRUE).

Description :
Renvoie la valeur "object" du membre de la faction à laquelle appartient l'objet désigné par oFactionMember, et ayant la classe d'armure la plus haute.

Fonction(s) connexe(s) :
GetAC, GetFaction*, GetFactionWorstAC

GetFactionEqual(...)

int GetFactionEqual
(
    object oFirstObject,
    object oSecondObject = OBJECT_SELF
)

Paramètres :
- oFirstObject : Le premier objet à comparer.
- oSecondObject : Le second objet à comparer (défaut : OBJECT_SELF).

Description :
Détermine si l'objet désigné par oFirstObject appartient à la même faction que l'objet désigné par oSecondObject.

Fonction(s) connexe(s) :
GetFaction*

GetFactionGold(...)

int GetFactionGold
(
    object oFactionMember
)

Paramètres :
- oFactionMember : Le membre de la faction concernée.

Description :
Renvoie la somme d'or que peut réunir la totalité des membres de la faction à laquelle appartient l'objet désigné par oFactionMember.

Fonction(s) connexe(s) :
GetFaction*, GetGold

GetFactionLeader(...)

object GetFactionLeader
(
    object oMemberOfFaction
)

Paramètres :
- oMemberOfFaction : Le membre de la faction concernée.

Description :
Renvoie la valeur "object" du chef de la faction à laquelle appartient l'objet désigné par oMemberOfFaction.

Fonction(s) connexe(s) :
GetFaction*, GetFirstFactionMember, GetNextFactionMember

GetFactionLeastDamagedMember(...)

object GetFactionLeastDamagedMember
(
    object oFactionMember = OBJECT_SELF,
    int bMustBeVisible = TRUE
)

Paramètres :
- oFactionMember : Le membre de la faction concernée (défaut : OBJECT_SELF).
- bMustBeVisible : Détermine si le membre recherché doit être visible par oFactionMember (défaut : TRUE).

Description :
Renvoie la valeur "object" du membre de la faction à laquelle appartient l'objet désigné par oFactionMember, et ayant subi le moins de dégâts.

Fonction(s) connexe(s) :
GetFaction*, GetFactionMostDamagedMember

GetFactionMostDamagedMember(...)

object GetFactionMostDamagedMember
(
    object oFactionMember = OBJECT_SELF,
    int bMustBeVisible = TRUE
)

Paramètres :
- oFactionMember : Le membre de la faction concernée (défaut : OBJECT_SELF).
- bMustBeVisible : Détermine si le membre recherché doit être visible par oFactionMember (défaut : TRUE).

Description :
Renvoie la valeur "object" du membre de la faction à laquelle appartient l'objet désigné par oFactionMember, et ayant subi le plus de dégâts.

Fonction(s) connexe(s) :
GetFaction*, GetFactionLeastDamagedMember

GetFactionMostFrequentClass(...)

int GetFactionMostFrequentClass
(
    object oFactionMember
)

Paramètres :
- oFactionMember : Le membre de la faction concernée.

Description :
Renvoie la référence de la classe la plus pratiquée dans la faction à laquelle appartient l'objet désigné par oFactionMember. La valeur renvoyée peut être comparée aux constantes CLASS_TYPE_*.

Fonction(s) connexe(s) :
GetClassByPosition, GetFaction*

GetFactionStrongestMember(...)

object GetFactionStrongestMember
(
    object oFactionMember = OBJECT_SELF,
    int bMustBeVisible = TRUE
)

Paramètres :
- oFactionMember : Le membre de la faction concernée (défaut : OBJECT_SELF).
- bMustBeVisible : Détermine si le membre recherché doit être visible par oFactionMember (défaut : TRUE).

Description :
Renvoie la valeur "object" du membre de la faction à laquelle appartient l'objet désigné par oFactionMember, et étant considéré comme le plus puissant.

Fonction(s) connexe(s) :
GetFaction*, GetFactionWeakestMember

GetFactionWeakestMember(...)

object GetFactionWeakestMember
(
    object oFactionMember = OBJECT_SELF,
    int bMustBeVisible = TRUE
)

Paramètres :
- oFactionMember : Le membre de la faction concernée (défaut : OBJECT_SELF).
- bMustBeVisible : Détermine si le membre recherché doit être visible par oFactionMember (défaut : TRUE).

Description :
Renvoie la valeur "object" du membre de la faction à laquelle appartient l'objet désigné par oFactionMember, et étant considéré comme le moins puissant.

Fonction(s) connexe(s) :
GetFaction*, GetFactionStrongestMember

GetFactionWorstAC(...)

object GetFactionWorstAC
(
    object oFactionMember = OBJECT_SELF,
    int bMustBeVisible = TRUE
)

Paramètres :
- oFactionMember : Le membre de la faction concernée (défaut : OBJECT_SELF).
- bMustBeVisible : Détermine si le membre recherché doit être visible par oFactionMember (défaut : TRUE).

Description :
Renvoie la valeur "object" du membre de la faction à laquelle appartient l'objet désigné par oFactionMember, et ayant la classe d'armure la plus basse.

Fonction(s) connexe(s) :
GetAC, GetFaction*, GetFactionBestAC

GetFamiliarCreatureType(...)

int GetFamiliarCreatureType
(
    object oCreature
)

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

Description :
Renvoie le type du familier appartenant à la créature désignée par oCreature. La valeur renvoyée peut être comparée aux constantes FAMILIAR_CREATURE_TYPE_*. Renvoie la valeur FAMILIAR_CREATURE_TYPE_NONE si oCreature n'est pas valide, ou s'il n'a pas de familier.

Fonction(s) connexe(s) :
GetAnimalCompanionCreatureType, GetFamiliarName, SummonFamiliar

GetFamiliarName(...)

string GetFamiliarName
(
    object oCreature
)

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

Description :
Renvoie le nom du familier appartenant à la créature désignée par oCreature. La fonction renverra une chaîne de caractères vide si oCreature n'est pas valide, s'il n'a pas de familier, ou si le nom du familier est une chaîne de caractères vide.

Fonction(s) connexe(s) :
GetAnimalCompanionName, GetFamiliarCreatureType, SummonFamiliar

GetFirstArea()

object GetFirstArea()

Description :
Renvoie la valeur "object" de la première zone dans la liste des zones du module. Cette fonction s'utilise en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetArea, GetNextArea

GetFirstEffect(...)

effect GetFirstEffect
(
    object oCreature
)

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

Description :
Renvoie le premier effet actif appliqué sur la créature désignée par oCreature. Cette fonction s'utilise en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetNextEffect, RemoveEffect

GetFirstEnteringPC()

object GetFirstEnteringPC()

Description :
Renvoie la valeur "object" du premier joueur en train de se connecter au module. Cette fonction n'est effective QUE lors de l'événement "OnClientEnter", et s'utilise en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetEnteringObject, GetFirstPC, GetNextEnteringPC

GetFirstFactionMember(...)

object GetFirstFactionMember
(
    object oMemberOfFaction,
    int bPCOnly = TRUE
)

Paramètres :
- oMemberOfFaction : Le membre de la faction concernée.
- bPCOnly : Détermine si le membre recherché doit être un personnage joueur (défaut : TRUE).

Description :
Renvoie la valeur "object" du premier membre de la faction à laquelle appartient l'objet désigné par oFactionMember. Cette fonction s'utilise en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetFactionLeader, GetNextFactionMember

GetFirstInPersistentObject(...)

object GetFirstInPersistentObject
(
    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" du premier objet présent dans le déclencheur, la rencontre, ou la zone d'effet désigné(e) par oPersistentObject. Cette fonction s'utilise en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetFirstObjectInArea, GetFirstObjectInShape, GetNextInPersistentObject

GetFirstItemInInventory(...)

object GetFirstItemInInventory
(
    object oTarget = OBJECT_SELF
)

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

Description :
Renvoie la valeur "object" du premier item 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 en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetHasInventory, GetNextItemInInventory

GetFirstItemProperty(...)

itemproperty GetFirstItemProperty
(
    object oItem
)

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

Description :
Renvoie la première propriété d'item de l'item désigné par oItem. Cette fonction s'utilise en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetNextItemProperty, RemoveItemProperty

GetFirstName(...)

string GetFirstName
(
    object oTarget
)

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

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

Fonction(s) connexe(s) :
GetLastName, GetName, SetFirstName

GetFirstObjectInArea(...)

object GetFirstObjectInArea
(
    object oArea = OBJECT_INVALID
)

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

Description :
Renvoie la valeur "object" du premier objet 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 en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetFirstInPersistentObject, GetFirstObjectInShape, GetNextObjectInArea

GetFirstObjectInShape(...)

object GetFirstObjectInShape
(
    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" du premier objet 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 en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetFirstInPersistentObject, GetFirstObjectInArea, GetNextObjectInShape

GetFirstPC(...)

object GetFirstObjectInArea
(
    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 premier "personnage principal d'un joueur" dans la liste des joueurs connectés au module. Si bOwnedCharacter est égal à FALSE, le premier "personnage contrôlé par un joueur" sera recherché. Cette fonction s'utilise en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetFirstEnteringPC, GetNextPC

GetFirstRosterMember()

string GetFirstRosterMember()

Description :
Renvoie la nom du premier compagnon 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 en général avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetIsRosterMember*, GetNextRosterMember, RemoveRosterMember

GetFirstSubArea(...)

object GetFirstSubArea
(
    object oArea,
    vector vPosition
)

Description :
Renvoie la valeur "object" du premier déclencheur contenu dans la zone désignée par oArea, et recouvrant un point défini par vPosition. Sont ainsi pris en compte : les déclencheurs, les zones d'effets, et les rencontres. Cette fonction s'utilise avant le départ d'une boucle.

Fonction(s) connexe(s) :
GetNextSubArea

GetFortitudeSavingThrow(...)

int GetFortitudeSavingThrow
(
    object oTarget
)

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

Description :
Renvoie la valeur du bonus de vigueur de l'objet désigné par oTarget. Ne fonctionne que sur les créatures, plaçables et portes.

Fonction(s) connexe(s) :
FortitudeSave, GetReflexSavingThrow, GetWillSavingThrow

GetGameDifficulty()

int GetGameDifficulty()

Description :
Détermine quelle est la difficulté du jeu en cours. La valeur retournée peut être comparée aux constantes GAME_DIFFICULTY_*.

GetGender(...)

int GetGender
(
    object oCreature
)

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

Description :
Détermine quel est le sexe de la créature. La valeur renvoyée peut être comparée aux constantes GENDER_*.

GetGlobalBool(...)

int GetGlobalBool
(
    string sName
)

Paramètres :
- sName : Le nom de la variable globale concernée.

Description :
Renvoie la valeur de la variable globale de type "bool" dont le nom est défini par sName. Cette valeur est en fait de type "int", mais définit un état "TRUE" (1) ou "FALSE" (0).

Fonction(s) connexe(s) :
GetGlobalFloat, GetGlobalInt, GetGlobalString, LoadGlobalVariables, SetGlobalBool

GetGlobalFloat(...)

float GetGlobalFloat
(
    string sName
)

Paramètres :
- sName : Le nom de la variable globale concernée.

Description :
Renvoie la valeur de la variable globale de type "float" dont le nom est défini par sName.

Fonction(s) connexe(s) :
GetGlobalBool, GetGlobalInt, GetGlobalString, LoadGlobalVariables, SetGlobalFloat

GetGlobalInt(...)

int GetGlobalInt
(
    string sName
)

Paramètres :
- sName : Le nom de la variable globale concernée.

Description :
Renvoie la valeur de la variable globale de type "int" dont le nom est défini par sName.

Fonction(s) connexe(s) :
GetGlobalBool, GetGlobalFloat, GetGlobalString, LoadGlobalVariables, SetGlobalInt

GetGlobalString(...)

string GetGlobalString
(
    string sName
)

Paramètres :
- sName : Le nom de la variable globale concernée.

Description :
Renvoie la valeur de la variable globale de type "string" dont le nom est défini par sName.

Fonction(s) connexe(s) :
GetGlobalBool, GetGlobalFloat, GetGlobalInt, LoadGlobalVariables, SetGlobalString

GetGoingToBeAttackedBy(...)

object GetGoingToBeAttackedBy
(
    object oTarget
)

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

Description :
Renvoie la valeur "object" de la créature en train d'attaquer l'objet désigné par oTarget. Cette valeur est remise à zéro à chaque fin de round et ne devrait être utilisée qu'à la suite d'un signal "Going to be attacked" émis par une créature voisine subissant une attaque.

Fonction(s) connexe(s) :
GetAttemptedAttackTarget, GetAttemptedSpellTarget

GetGold(...)

int GetGold
(
    object oTarget = OBJECT_SELF
)

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

Description :
Renvoie le total de pièces d'or que possède l'objet désigné par oTarget.

Fonction(s) connexe(s) :
GetFactionGold, GetGoldPieceValue, GetStoreGold, GiveGoldToCreature, TakeGoldFromCreature

GetGoldPieceValue(...)

int GetGoldPieceValue
(
    object oItem
)

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

Description :
Renvoie le prix en pièces d'or de l'item désigné par oItem.

Fonction(s) connexe(s) :
GetGold

GetGoodEvilValue(...)

int GetGoodEvilValue
(
    object oCreature
)

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

Description :
Renvoie la valeur de l'alignement de la créature désignée par oCreature. La valeur renvoyée est comprise entre 0 (Mauvais) et 100 (Bon).

Fonction(s) connexe(s) :
AdjustAlignment, GetFactionAverageGoodEvilAlignment

LISTE DES FONCTIONS

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

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