NWScript - Fonctions G (... suite...)

GetHardness(...)

int GetHardness
(
    object oObject
)

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

Description :
Renvoie la valeur de le la solidité de l'objet désigné par oObject (Cf. paramètre "Solidité" dans l'éditeur). Renvoie la valeur 0 si oObjet n'a pas de valeur de solidité, ou si ce n'est ni un plaçable, ni une porte.

Fonction(s) connexe(s) :
SetHardness

GetHasAnySpellEffect(...)

int GetHasAnySpellEffect
(
    object oObject
)

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

Description :
Détermine si au moins un effet actif, sur l'objet désigné par oObject, a été appliqué par le biais d'un sort.

Fonction(s) connexe(s) :
GetHasFeatEffect, GetHasSpellEffect

GetHasFeat(...)

int GetHasFeat
(
    int nFeat,
    object oCreature = OBJECT_SELF,
    int nIgnoreUses = FALSE
)

Paramètres :
- nFeat : Constante FEAT_* définissant le don concerné.
- oCreature: La créature concernée (défaut : OBJECT_SELF).
- nIgnoreUses : Détermine si tous les dons de oCreature sont considérés comme utilisables, même si le nombre d'utilisations par jour a été atteint (défaut : FALSE).

Description :
Détermine si la créature désignée par oCreature possède le don défini par nFeat, et s'il est utilisable.

Fonction(s) connexe(s) :
FeatAdd, FeatRemove, GetHasSkill, GetHasSpell

GetHasFeatEffect(...)

int GetHasFeatEffect
(
    int nFeat,
    object oObject = OBJECT_SELF
)

Paramètres :
- nFeat : Constante FEAT_* définissant le don concerné.
- oObject : L'objet concerné (défaut : OBJECT_SELF).

Description :
Détermine si un effet actif, sur l'objet désigné par oObject, a été appliqué par le biais du don défini par nFeat.

Fonction(s) connexe(s) :
GetHasAnySpellEffect, GetHasSpellEffect

GetHasInventory(...)

int GetHasInventory
(
    object oObject
)

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

Description :
Détermine si l'objet désigné par oObject a un inventaire. La valeur renvoyée sera automatiquement TRUE pour les créatures et les magasins, mais effectuera une vérification pour les items et les plaçables (Cf. paramètre "Dispose d'un inventaire" dans l'éditeur).

Fonction(s) connexe(s) :
OpenInventory

GetHasSkill(...)

int GetHasSkill
(
    int nSkill,
    object oCreature = OBJECT_SELF
)

Paramètres :
- nSkill : Constante SKILL_* définissant la compétence à vérifier.
- oCreature: La créature concernée (défaut : OBJECT_SELF).

Description :
Détermine si la créature désignée par oCreature possède la compétence définie par nSkill, et si elle est utilisable.

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

GetHasSpell(...)

int GetHasSpell
(
    int nSpell,
    object oCreature = OBJECT_SELF
)

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

Description :
Renvoie le nombre d'incantations possibles du sort défini par nSpell, auxquelles la créature désignée peut procéder.

Fonction(s) connexe(s) :
GetHasFeat, GetHasSkill, GetSpellKnown

GetHasSpellEffect(...)

int GetHasSpellEffect
(
    int nSpell,
    object oObject = OBJECT_SELF
)

Paramètres :
- nSpell : Constante SPELL_* définissant le sort concerné.
- oObject : L'objet concerné (défaut : OBJECT_SELF).

Description :
Détermine si un effet actif, sur l'objet désigné par oObject, a été appliqué par le biais du sort défini par nSpell.

Fonction(s) connexe(s) :
GetHasAnySpellEffect, GetHasFeatEffect

GetHenchman(...)

object GetHenchman
(
    object oMaster = OBJECT_SELF,
    int nNth = 1
)

Paramètres :
- oMaster : La créature concernée (défaut : OBJECT_SELF).
- nNth : Dans le cas de plusieurs compagnons d'armes, sa position dans la liste (défaut : 1).

Description :
Renvoie la valeur "object" du compagnon d'armes appartenant à la créature désignée par oMaster.

Fonction(s) connexe(s) :
GetAssociate

GetHitDice(...)

int GetHitDice
(
    object oCreature
)

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

Description :
Renvoie le nombre de dés de vie de la créature désignée par oCreature. Peut aussi servir à déterminer le niveau actuel d'un personnage joueur.

Fonction(s) connexe(s) :
GetChallengeRating, GetTotalLevels

GetIdentified(...)

int GetIdentified
(
    object oItem
)

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

Description :
Détermine si l'item désigné par oItem a été identifié (Cf. paramètre "Identifié" dans l'éditeur).

Fonction(s) connexe(s) :
SetIdentified

GetIdFromTalent(...)

int GetIdFromTalent
(
    talent tTalent
)

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

Description :
Détermine l'identité exacte du talent désigné par tTalent, pouvant être comparé aux constantes FEAT_*, SKILL_*, ou SPELL_*.

Fonction(s) connexe(s) :
TalentFeat, TalentSkill, TalentSpell

GetImmortal(...)

int GetIdentified
(
    object oTarget = OBJECT_SELF
)

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

Description :
Détermine si la créature désignée par oCreature est immortelle (Cf. paramètre "Immortel" dans l'éditeur).

Fonction(s) connexe(s) :
SetImmortal

GetInfiniteFlag(...)

int GetInfiniteFlag
(
    object oItem
)

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

Description :
Détermine si l'item désigné par oItem est en quantité illimitée dans une échoppe (Cf. paramètre "Illimité" dans l'éditeur).

Fonction(s) connexe(s) :
SetInfiniteFlag

GetInventoryDisturbItem()

object GetInventoryDisturbItem()

Description :
Renvoie la valeur "object" de l'item ayant déclenché l'événement "OnDisturb" de l'objet source.

Fonction(s) connexe(s) :
GetInventoryDisturbType

GetInventoryDisturbType()

int GetInventoryDisturbType()

Description :
Détermine la manière dont l'inventaire de l'objet source a été modifié lors de l'événement "OnDisturb". La valeur renvoyée peut être comparée aux constantes INVENTORY_DISTURB_TYPE_*. Ne fonctionne que sur les créatures et les plaçables.

Fonction(s) connexe(s) :
GetInventoryDisturbItem

GetIsAreaAboveGround(...)

int GetIsAreaAboveGround
(
    object oArea
)

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

Description :
Détermine si la zone désignée par oArea est en surface ou souterraine (Cf. paramètre "Souterrain" dans l'éditeur). La valeur renvoyée peut être comparée aux constantes AREA_ABOVEGROUND (surface) et AREA_UNDERGROUND (souterrain).

Fonction(s) connexe(s) :
GetIsAreaInterior, GetIsAreaNatural

GetIsAreaInterior(...)

int GetIsAreaInterior
(
    object oArea = OBJECT_INVALID
)

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

Description :
Détermine si la zone désignée par oArea est en intérieur ou en extérieur (Cf. paramètre "Intérieur" dans l'éditeur). Une zone souterraine est considérée comme une zone intérieure.

Fonction(s) connexe(s) :
GetIsAreaAboveGround, GetIsAreaNatural

GetIsAreaNatural(...)

int GetIsAreaNatural
(
    object oArea
)

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

Description :
Détermine si la zone désignée par oArea est naturelle ou artificielle (Cf. paramètre "Naturel" dans l'éditeur).La valeur renvoyée peut être comparée aux constantes AREA_NATURAL (naturel) et AREA_ARTIFICIAL (artificiel).

Fonction(s) connexe(s) :
GetIsAreaAboveGround, GetIsAreaInterior

GetIsCompanionPossessionBlocked(...)

int GetIsCompanionPossessionBlocked
(
    object oCreature
)

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

Description :
Détermine si la possession de la créature désignée par oCreature est bloquée. Une créature dont la possession est bloquée ne peut être possédée, excepté par un MD. Un personnage joueur ne peut pas être "dépossédé".

Fonction(s) connexe(s) :
SetIsCompanionPossessionBlocked

GetIsCreatureDisarmable(...)

int GetIsCreatureDisarmable
(
    object oCreature
)

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

Description :
Détermine s'il est possible de désarmer la créature désignée par oCreature. Vérifie si le paramètre "Désarmable" est actif, et si oCreature a une arme équipée dans l'emplacement "main droite" et/ou "main gauche" (Cf. paramètre "Désarmement possible" dans l'éditeur).

Fonction(s) connexe(s) :
SetIsCreatureDisarmable

GetIsDawn()

int GetIsDawn()

Description :
Détermine si l'heure actuelle du module correspond à l'aube.

Fonction(s) connexe(s) :
GetIsDay, GetIsDusk, GetIsNight

GetIsDay()

int GetIsDay()

Description :
Détermine si l'heure actuelle du module correspond à la journée.

Fonction(s) connexe(s) :
DayToNight, GetIsDawn, GetIsDusk, GetIsNight

GetIsDead(...)

int GetIsDead
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature est morte. Cette fonction considèrera qu'un joueur agonisant est mort.

Fonction(s) connexe(s) :
GetCurrentHitPoints

GetIsDM(...)

int GetIsDM
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature est un MD. Cette fonction ne pourra pas considérer les créatures possédées par un MD, pour lesquelles il faudra utiliser la fonction "GetIsDMPossessed(...)".

Fonction(s) connexe(s) :
GetIsDMPossessed, GetIsPC

GetIsDMPossessed(...)

int GetIsDMPossessed
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature est possédée par un MD. Cette fonction ne pourra pas considérer les MD ne possédant pas de créature, pour lesquels il faudra utiliser la fonction "GetIsDM(...)".

Fonction(s) connexe(s) :
GetIsDM, GetIsOwnedByPlayer, GetIsPossessedFamiliar

GetIsDoorActionPossible(...)

int GetIsDoorActionPossible
(
    object oTargetDoor,
    int nDoorAction
)

Paramètres :
- oTargetDoor : La porte concernée.
- nDoorAction : Constante DOOR_ACTION_* définissant le type d'action concerné.

Description :
Détermine si l'action définie par nDoorAction est réalisable sur la porte désignée par oTargetDoor.

Fonction(s) connexe(s) :
DoDoorAction, GetIsPlaceableObjectActionPossible

GetIsDusk()

int GetIsDusk()

Description :
Détermine si l'heure actuelle du module correspond au crépuscule.

Fonction(s) connexe(s) :
GetIsDawn, GetIsDay, GetIsNight

GetIsEffectValid(...)

int GetIsEffectValid
(
    effect eEffect
)

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

Description :
Détermine si l'effet désigné par eEffect est valide. Ne s'applique qu'aux effets appliqués sur des objets.

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

GetIsEncounterCreature(...)

int GetIsEncounterCreature
(
    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 a été mise en jeu par le biais d'une rencontre.

GetIsEnemy(...)

int GetIsEnemy
(
    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 considére la créature désignée par oTarget comme un ennemi.

Fonction(s) connexe(s) :
GetIsFriend, GetIsNeutral, GetIsReactionTypeHostile, GetReputation, SetIsTemporaryEnemy

GetIsFriend(...)

int GetIsFriend
(
    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 considére la créature désignée par oTarget comme un allié.

Fonction(s) connexe(s) :
GetIsEnemy, GetIsNeutral, GetIsReactionTypeFriendly, GetReputation, SetIsTemporaryFriend

GetIsImmune(...)

int GetIsImmune
(
    object oCreature,
    int nImmunityType,
    object oVersus = OBJECT_INVALID
)

Paramètres :
- oCreature : La créature concernée.
- nImmunityType : Constante IMMUNITY_TYPE_* définissant le type d'immunité concerné.
- oVersus : Créature adverse consultée dans le cas d'une immunité face à une race ou un alignement (défaut : OBJECT_INVALID).

Description :
Détermine si la créature désignée par oCreature bénéficie de l'immunité définie par nImmunityType.

GetIsInCombat(...)

int GetIsInCombat
(
    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 est en train de combattre.

GetIsInSubArea(...)

int GetIsInSubArea
(
    object oCreature,
    object oSubArea = OBJECT_SELF
)

Paramètres :
- oCreature : La créature concernée.
- oSubArea : Le déclencheur, la rencontre ou la zone d'effet concernée (défaut : OBJECT_SELF).

Description :
Détermine si la créature désignée par oCreature est dans la surface couverte par le déclencheur, la rencontre, ou la zone d'effet que désigne oSubArea. Plus précisément, si oCréature a déclenché l'événement "OnEnter" et que l'événement "OnExit" n'a pas encore été déclenché.

GetIsItemPropertyValid(...)

int GetIsItemPropertyValid
(
    itemproperty ipProperty
)

Paramètres :
- ipProperty : La propriété d'item concernée.

Description :
Détermine si la propriété d'item désignée par ipProperty est valide.

Fonction(s) connexe(s) :
GetFirstItemProperty, GetNextItemProperty, GetIsEffectValid

GetIsListening(...)

int GetIsListening
(
    object oObject
)

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

Description :
Détermine si l'objet désigné par oObject est en mode "écoute".

Fonction(s) connexe(s) :
GetListenPatternNumber, SetListening

GetIsLocationValid(...)

int GetIsLocationValid
(
    location lLocation
)

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

Description :
Détermine si la localisation désignée par lLocation est valide, et qu'une créature peut s'y déplacer.

Fonction(s) connexe(s) :
GetIsObjectValid

GetIsNeutral(...)

int GetIsNeutral
(
    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 considére la créature désignée par oTarget comme neutre.

Fonction(s) connexe(s) :
GetIsEnemy, GetIsFriend, GetIsReactionTypeNeutral, GetReputation, SetIsTemporaryNeutral

GetIsNight()

int GetIsNight()

Description :
Détermine si l'heure actuelle du module correspond à la nuit.

Fonction(s) connexe(s) :
GetIsDawn, GetIsDay, GetIsDusk, NightToDay

GetIsObjectValid(...)

int GetIsObjectValid
(
    object oObject
)

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

Description :
Détermine si l'objet désigné par oObject est valide.

Fonction(s) connexe(s) :
GetIsLocationValid

GetIsOpen(...)

int GetIsOpen
(
    object oObject
)

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

Description :
Détermine si l'objet désigné par oObject est ouvert. Ne fonctionne qu'avec les plaçables et les portes.

GetIsOverlandMap(...)

int GetIsOverlandMap
(
    object oArea
)

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

Description :
Détermine si la zone désignée par oArea est une carte du monde interactive. Renvoie la valeur 0 si ce n'est pas le cas.

GetIsOwnedByPlayer(...)

int GetIsOwnedByPlayer
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature est le personnage principal d'un joueur. Si la créature est possédée par un joueur, mais qu'il ne s'agit pas de son personnage principal, la valeur FALSE sera renvoyée. Pour déterminer si une créature est possédée par un joueur, il faudra utiliser la fonction "GetIsPC(...)".

Fonction(s) connexe(s) :
GetIsDMPossessed, GetIsPossessedFamiliar

GetIsPartyTransition(...)

int GetIsPartyTransition
(
    object oObject
)

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

Description :
Détermine si l'objet désigné par oObject autorise une transition de groupe (Cf. paramètre "Transition du groupe ?" dans l'éditeur).

Fonction(s) connexe(s) :
GetTransitionTarget, JumpPartyToArea

GetIsPC(...)

int GetIsPC
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature est un joueur. S'il s'agit du personnage principal, mais que le joueur possède une autre créature, la valeur FALSE sera renvoyée. Pour déterminer si une créature est le personnage principal d'un joueur, il faudra utiliser la fonction "GetIsOwnedByPlayer(...)".

Fonction(s) connexe(s) :
GetIsDM, GetIsOwnedByPlayer, GetIsPlayerCreated, GetIsPossessedFamiliar

GetIsPlaceableObjectActionPossible(...)

int GetIsPlaceableObjectActionPossible
(
    object oPlaceable,
    int nPlaceableAction
)

Paramètres :
- oTargetDoor : Le plaçable concerné.
- nPlaceableAction : Constante PLACEABLE_ACTION_* définissant le type d'action concerné.

Description :
Détermine si l'action définie par nPlaceableAction est réalisable sur le plaçable désigné par oPlaceable.

Fonction(s) connexe(s) :
DoPlaceableObjectAction, GetIsDoorActionPossible

GetIsPlayableRacialType(...)

int GetIsPlayableRacialType
(
    object oCreature
)

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

Description :
Détermine si la race de la créature désignée par oCreature est disponible aux joueurs.

Fonction(s) connexe(s) :
GetRacialType

GetIsPlayerCreated(...)

int GetIsPlayerCreated
(
    object oCreature
)

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

Description :
Détermine si le personnage joueur désigné par oCreature a été créé à partir de l'interface de création de personnage. Cette fonction permet principalement de faire la différence entre les compagnons d'armes créés par un joueur et les PNJs ayant été recrutés. Si oCreature ne fait pas (ou plus) partie de la liste des compagnons d'armes, la fonction renverra la valeur FALSE.

Fonction(s) connexe(s) :
GetIsPC, GetIsRosterMember

GetIsPossessedFamiliar(...)

int GetIsPossessedFamiliar
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature est un familier possédé par son maître.

Fonction(s) connexe(s) :
GetIsDMPossessed, GetIsOwnedByPlayer, GetIsPC, GetIsPlayerCreated, GetIsPossessedFamiliar

GetIsReactionTypeFriendly(...)

int GetIsReactionTypeFriendly
(
    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 a un comportement amical par rapport à la créature désignée par oTarget. Le résultat dépend de la réputation, des paramètres JcJ, et (dans le cas où deux joueurs sont consultés) du paramètre hostile/amical de oSource vis-à-vis de oTarget. Pour définir uniquement la réaction de oSource par rapport à oTarget en considérant la faction et la réputation personnelle, il sera préférable d'utilser la fonction "GetIsFriend(...)".

Fonction(s) connexe(s) :
GetIsFriend, GetIsReactionTypeHostile, GetIsReactionTypeNeutral, GetReputation, SetIsTemporaryFriend

GetIsReactionTypeHostile(...)

int GetIsReactionTypeHostile
(
    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 a un comportement hostile par rapport à la créature désignée par oTarget. Le résultat dépend de la réputation, des paramètres JcJ, et (dans le cas où deux joueurs sont consultés) du paramètre hostile/amical de oSource vis-à-vis de oTarget. Pour définir uniquement la réaction de oSource par rapport à oTarget en considérant la faction et la réputation personnelle, il sera préférable d'utilser la fonction "GetIsEnemy(...)".

Fonction(s) connexe(s) :
GetIsEnemy, GetIsReactionTypeFriendly, GetIsReactionTypeNeutral, GetReputation, SetIsTemporaryEnemy

GetIsReactionTypeNeutral(...)

int GetIsReactionTypeNeutral
(
    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 a un comportement neutre par rapport à la créature désignée par oTarget. Le résultat dépend de la réputation, des paramètres JcJ, et (dans le cas où deux joueurs sont consultés) du paramètre hostile/amical de oSource vis-à-vis de oTarget. Pour définir uniquement la réaction de oSource par rapport à oTarget en considérant la faction et la réputation personnelle, il sera préférable d'utilser la fonction "GetIsNeutral(...)".

Fonction(s) connexe(s) :
GetIsNeutral, GetIsReactionTypeFriendly, GetIsReactionTypeHostile, GetReputation, SetIsTemporaryNeutral

GetIsResting(...)

int GetIsResting
(
    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 est en train de se reposer.

Fonction(s) connexe(s) :
ActionRest

GetIsRosterMember(...)

int GetIsRosterMember
(
    object oMember
)

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

Description :
Détermine si la créature désignée par oMember fait partie de la "liste des compagnons disponibles".

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

GetIsRosterMemberAvailable(...)

int GetIsRosterMemberAvailable
(
    string sRosterName
)

Paramètres :
- sRosterName : Le nom de compagnon concerné.

Description :
Détermine si le membre de la liste des compagnons, dont le nom de compagnon est défini par sRosterName, peut être inclus dans un groupe. Si ce membre fait déjà partie d'un autre groupe, ou s'il ne peut pas être sélectionné, la valeur FALSE sera renvoyée.

Fonction(s) connexe(s) :
AddRosterMemberToParty, GetIsRosterMember*

GetIsRosterMemberCampaignNPC(...)

int GetIsRosterMemberCampaignNPC
(
    string sRosterName
)

Paramètres :
- sRosterName : Le nom de compagnon concerné.

Description :
Détermine si le membre de la liste des compagnons, dont le nom de compagnon est défini par sRosterName, est considéré comme "compagnon de campagne". Un "compagnon de campagne" est stocké de manière persistante et peut être retrouvé d'un module à un autre. Cependant, il n'apparaît pas dans la "liste des compagnons disponibles" et ne peut pas être rajouté via la fenêtre de sélection des compagnons. Il est possible néanmoins de les rajouter dans un groupe par script.

Fonction(s) connexe(s) :
GetIsRosterMember*, SetIsRosterMemberCampaignNPC

GetIsRosterMemberSelectable(...)

int GetIsRosterMemberSelectable
(
    string sRosterName
)

Paramètres :
- sRosterName : Le nom de compagnon concerné.

Description :
Détermine si le membre de la liste des compagnons, dont le nom de compagnon est défini par sRosterName, peut être sélectionné. Un membre pouvant être "sélectionné" n'est pas forcément "disponible". Il est effectivement possible qu'un compagnon soit "disponible" mais "non-sélectionnable", pour des raisons liées à l'intrigue par exemple (je sais, c'est flou, mais ça devient évident quand on mange la description plusieurs fois).

Fonction(s) connexe(s) :
GetIsRosterMember*, SetIsRosterMemberSelectable

GetIsSinglePlayer()

int GetIsSinglePlayer()

Description :
Détermine si la partie en cours est mono-joueur.

GetIsSkillSuccessful(...)

int GetIsSkillSuccessful
(
    object oTarget,
    int nSkill,
    int nDifficulty
)

Paramètres :
- oTarget : La créature concernée.
- nSkill : Constante SKILL_* définissant la compétence concernée.
- nDifficulty : Le seuil de difficulté à franchir.

Description :
Détermine si la créature désignée par oTarget réussit le jet de compétence défini par les paramètres. Si la compétence nSkill additionnée à 1d20 dépasse le seuil de difficulté défini par nDifficulty, la valeur TRUE sera renvoyée.

Fonction(s) connexe(s) :
GetHasSkill

GetIsSpirit(...)

int GetIsSpirit
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature est un "esprit" (Cf. paramètre "SpiritOverride" dans l'éditeur). Si la créature est une fée ou un élémentaire, la valeur TRUE sera toujours renvoyée.

GetIsTalentValid(...)

int GetIsTalentValid
(
    talent tTalent
)

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

Description :
Détermine si le talent désigné par tTalent est valide.

Fonction(s) connexe(s) :
GetCreatureHasTalent

GetIsTrapped(...)

int GetIsTrapped
(
    object oObject
)

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

Description :
Détermine si l'objet désigné par oObject est piégé. Seuls les déclencheurs, les plaçables et les portes peuvent être piégés.

Fonction(s) connexe(s) :
CreateTrapOnObject

GetIsWeaponEffective(...)

int GetIsWeaponEffective
(
    object oVersus = OBJECT_INVALID,
    int bOffHand = FALSE
)

Paramètres :
- oVersus : Créature adverse concernée (défaut : OBJECT_INVALID).
- bOffHand : Détermine si l'arme en main secondaire doit être consultée (défaut : FALSE).

Description :
Détermine si l'arme qu'équipe l'objet source est capable d'infliger des dégâts à la créature désignée par oVersus.

GetItemActivated()

object GetItemActivated()

Description :
Renvoie la valeur "object" de l'item venant d'être activé. Cette fonction s'utilise en général dans le script exécuté par l'événement "OnItemActivated" du module.

Fonction(s) connexe(s) :
GetItemActivatedTarget, GetItemActivatedTargetLocation, GetItemActivator

GetItemActivatedTarget()

object GetItemActivatedTarget()

Description :
Renvoie la valeur "object" de l'objet sur lequel un item vient d'être activé. Cette fonction s'utilise en général dans le script exécuté par l'événement "OnItemActivated" du module.

Fonction(s) connexe(s) :
GetItemActivated, GetItemActivatedTargetLocation, GetItemActivator

GetItemActivatedTargetLocation()

location GetItemActivatedTargetLocation()

Description :
Renvoie la localisation sur laquelle un item vient d'être activé. Cette fonction s'utilise en général dans le script exécuté par l'événement "OnItemActivated" du module.

Fonction(s) connexe(s) :
GetItemActivated, GetItemActivatedTarget, GetItemActivator

GetItemActivator()

object GetItemActivator()

Description :
Renvoie la valeur "object" de la personne venant d'activer un item. Cette fonction s'utilise en général dans le script exécuté par l'événement "OnItemActivated" du module.

Fonction(s) connexe(s) :
GetItemActivated, GetItemActivatedTarget, GetItemActivatedTargetLocation

GetItemACValue(...)

int GetItemACValue
(
    object oItem
)

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

Description :
Renvoie la valeur de la classe d'armure de l'item désigné par oItem. Si l'item n'a aucune valeur d'armure, ou s'il ne s'agit pas d'un item, la valeur 0 sera renvoyée.

Fonction(s) connexe(s) :
GetAC

GetItemAppearance(...)

int GetItemAppearance
(
    object oItem,
    int nType,
    int nIndex
)

Paramètres :
- oItem : L'item concerné.
- nType : Constante ITEM_APPR_TYPE_* définissant le type d'apparence concernée.
- nIndex : Constante ITEM_APPR_* définissant la sous-catégorie de l'apparence concernée.

Description :
Renvoie la valeur de l'apparence de l'item désigné par oItem par rapport aux paramètres indiqués. Si oItem est un casque, le paramètre nIndex sera ignoré.

Fonction(s) connexe(s) :
CopyItemAndModify

GetItemBaseMaterialType(...)

int GetItemBaseMaterialType
(
    object oItem
)

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

Description :
Renvoie le type de matériau de base de l'item désigné par oItem. Cette valeur, correspondant au champ "Matériel" des propriétés d'un item, peut être comparée aux constantes GMATERIAL_*. Seuls les matériaux de base définis dans le fichier 2DA iprp_materials.2da sont actuellement pris en compte.

Fonction(s) connexe(s) :
SetItemBaseMaterialType

GetItemCharges(...)

int GetItemCharges
(
    object oItem
)

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

Description :
Renvoie le nombre de charges du sort dont l'item désigné par oItem dispose.

Fonction(s) connexe(s) :
SetItemCharges

GetItemCursedFlag(...)

int GetItemCursedFlag
(
    object oItem
)

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

Description :
Détermine si l'item désigné par oItem est maudit et ne peut pas être abandonné (Cf. paramètre "Maudit" dans l'éditeur).

Fonction(s) connexe(s) :
SetItemCursedFlag

GetItemHasItemProperty(...)

int GetItemHasItemProperty
(
    object oItem,
    int nProperty
)

Paramètres :
- oItem : L'item concerné.
- nProperty : Constante ITEM_PROPERTY_* définissant la propriété d'item concernée.

Description :
Détermine si l'item désigné par oItem contient la propriété d'item dont la référence est définie par nProperty.

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

GetItemIcon(...)

int GetItemIcon
(
    object oTarget
)

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

Description :
Renvoie l'index de la ligne du fichier 2DA auquel l'icône de l'item désigné par oTarget correspond.

Fonction(s) connexe(s) :
SetItemIcon

GetItemInSlot(...)

object GetItemInSlot
(
    int nInventorySlot,
    object oCreature = OBJECT_SELF
)

Paramètres :
- nInventorySlot : Constante INVENTORY_SLOT_* définissant l'emplacement d'équipement concerné.
- oCreature : La créature concernée (défaut : OBJECT_SELF).

Description :
Renvoie la valeur "object" de l'item qui devrait se trouver dans l'emplacement d'équipement de la créature désignée par oCreature.

Fonction(s) connexe(s) :
ActionEquipItem, ActionUnequipItem, GetItemPossessedBy

GetItemPossessedBy(...)

object GetItemPossessedBy
(
    object oCreature,
    string sItemTag
)

Paramètres :
- oCreature : La créature concernée.
- sItemTag : Le Tag de l'item recherché.

Description :
Renvoie la valeur "object" de l'item, dont le tag est défini par sItemTag, que posséde l'objet désigné par oCreature.

Fonction(s) connexe(s) :
GetItemInSlot, GetItemPossessor

GetItemPossessor(...)

object GetItemPossessor
(
    object oItem
)

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

Description :
Renvoie la valeur "object" du possesseur actuel de l'item désigné par oItem.

Fonction(s) connexe(s) :
GetItemPossessedBy

GetItemPropActivation(...)

int GetItemPropActivation
(
    object oItem
)

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

Description :
Renvoie le type de préférence d'activation des propriétés de l'item désigné par oItem. Si la valeur renvoyée est 0 si l'item doit seulement être équipé, 1 si l'item doit uniquement se trouver dans l'inventaire, 2 si les deux sont valables (cf. paramètre "Préférences pour l'activation des propriétés de l'objet" dans les propriétés d'un item).

Fonction(s) connexe(s) :
SetItemPropActivation

GetItemPropertyCostTable(...)

int GetItemPropertyCostTable
(
    itemproperty iProp
)

Paramètres :
- iProp : La propriété d'item concernée.

Description :
Renvoie la référence du coût correspondant à la propriété d'item désignée par iProp. Consulter le fichier iprp_costtable.2da pour les valeurs exactes.

Fonction(s) connexe(s) :
GetItemPropertyCostTableValue

GetItemPropertyCostTableValue(...)

int GetItemPropertyCostTableValue
(
    itemproperty iProp
)

Paramètres :
- iProp : La propriété d'item concernée.

Description :
Renvoie la valeur du coût correspondant à la propriété d'item désignée par iProp. Consulter le fichier iprp_costtable.2da pour les valeurs exactes.

Fonction(s) connexe(s) :
GetItemPropertyCostTable

GetItemPropertyDurationType(...)

int GetItemPropertyDurationType
(
    itemproperty ip
)

Paramètres :
- ip : La propriété d'item concernée.

Description :
Renvoie le type de durée de la propriété d'item désignée par ip. La valeur renvoyée peut être comparée aux constantes DURATION_TYPE_*.

Fonction(s) connexe(s) :
GetEffectDurationType, GetFirstItemProperty, GetNextItemProperty

GetItemPropertyParam1(...)

int GetItemPropertyParam1
(
    itemproperty iProp
)

Paramètres :
- iProp : La propriété d'item concernée.

Description :
Renvoie la référence du paramètre "Param1" correspondant à la propriété d'item désignée par iProp. Consulter le fichier iprp_paramtable.2da pour les valeurs exactes.

Fonction(s) connexe(s) :
GetItemPropertyParam1Value

GetItemPropertyParam1Value(...)

int GetItemPropertyParam1Value
(
    itemproperty iProp
)

Paramètres :
- iProp : La propriété d'item concernée.

Description :
Renvoie la valeur du paramètre "Param1" correspondant à la propriété d'item désignée par iProp. Consulter le fichier iprp_paramtable.2da pour les valeurs exactes.

Fonction(s) connexe(s) :
GetItemPropertyParam1

GetItemPropertySubType(...)

int GetItemPropertySubType
(
    itemproperty iProp
)

Paramètres :
- iProp : La propriété d'item concernée.

Description :
Renvoie la référence de la sous-catégorie à laquelle appartient la propriété d'item désignée par iProp. Consulter le fichier itempropdef.2da pour les valeurs exactes.

Fonction(s) connexe(s) :
GetEffectSubType, GetFirstItemProperty, GetItemPropertyType, GetNextItemProperty

GetItemPropertyType(...)

int GetItemPropertyType
(
    itemproperty ip
)

Paramètres :
- ip : La propriété d'item concernée.

Description :
Renvoie le type de la propriété d'item désignée par ip. La valeur renvoyée peut être comparée aux constantes ITEM_PROPERTY_*.

Fonction(s) connexe(s) :
GetEffectType, GetFirstItemProperty, GetItemPropertySubType, GetNextItemProperty

GetItemStackSize(...)

int GetItemStackSize
(
    object oItem
)

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

Description :
Renvoie la valeur de la pile de l'item empilable désigné par oItem.

Fonction(s) connexe(s) :
SetItemStackSize

GetJournalEntry(...)

int GetJournalEntry
(
    string szPlotID,
    object oObjectJournal
)

Paramètres :
- szPlotID : Le Tag de la quête concernée.
- oObjectJournal : Le joueur concerné.

Description :
Renvoie l'entrée active dans le journal du joueur désigné par oObjectJournal, concernant la quête dont le Tag est défini par szPlotID.

Fonction(s) connexe(s) :
AddJournalQuestEntry, GetJournalQuestExperience, RemoveJournalQuestEntry

GetJournalQuestExperience(...)

int GetJournalQuestExperience
(
    string szPlotID
)

Paramètres :
- szPlotID : Le Tag de la quête concernée.

Description :
Renvoie le montant d'expérience que doit rapporter la quête dont le Tag est défini par szPlotID.

Fonction(s) connexe(s) :
GetJournalEntry

GetKeyRequiredFeedbackMessage(...)

string GetKeyRequiredFeedbackMessage
(
    object oObject
)

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

Description :
Renvoie le message à afficher lorsqu'un joueur essayant d'ouvrir l'objet verrouillé désigné par oObject aboutit à un echec. Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
SetKeyRequiredFeedbackMessage

GetLastAssociateCommand(...)

int GetLastAssociateCommand
(
    object oAssociate = OBJECT_SELF
)

Paramètres :
- oAssociate : Le compagnon concerné (défaut : OBJECT_SELF).

Description :
Renvoie le dernier ordre ayant été envoyé au compagnon désigné par oAssociate. La valeur renvoyée peut être comparée aux constantes ASSOCIATE_COMMAND_*. Un compagnon peut être un "compagnon d'armes", un "familier", un "compagnon animal", une "invocation", ou une "créature dominée".

GetLastAttacker(...)

object GetLastAttacker
(
    object oAttackee = OBJECT_SELF
)

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

Description :
Renvoie la valeur "object" de la dernière créature ayant attaqué l'objet désigné par oAttackee. Cette fontion ne devrait être utilisée QUE lors de l'événement "OnPhysicalAttacked" d'une créature, d'un plaçable ou d'une porte.

Fonction(s) connexe(s) :
GetLastHostileActor

GetLastAttackMode(...)

int GetLastAttackMode
(
    object oCreature = OBJECT_SELF
)

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

Description :
Renvoie le mode d'attaque dans lequel la dernière attaque de la créature désignée par oCreature s'est effectuée. La valeur renvoyée peut être comparée aux constantes COMBAT_MODE_*.

GetLastAttackType(...)

int GetLastAttackType
(
    object oCreature = OBJECT_SELF
)

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

Description :
Renvoie le type de la dernière attaque que la créature désignée par oCreature a porté. La valeur renvoyée peut être comparée aux constantes SPECIAL_ATTACK_*.

GetLastClosedBy()

object GetLastClosedBy()

Description :
Renvoie la valeur "object" du dernier objet ayant fermé l'objet source. Cette fonction s'utilise lorsque l'événement "OnClose" d'un plaçable ou d'une porte a été déclenché.

Fonction(s) connexe(s) :
GetLastOpenedBy

GetLastDamager(...)

object GetLastDamager
(
    object oObject = OBJECT_SELF
)

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

Description :
Renvoie la valeur "object" de la dernière créature ayant infligé des dégâts à l'objet désigné par oObject. Cette fonction s'utilise généralement lorsque l'événement "OnDamaged" d'une créature, d'un plaçable ou d'une porte a été déclenché.

Fonction(s) connexe(s) :
GetLastHostileActor

GetLastDisarmed()

object GetLastDisarmed()

Description :
Renvoie la valeur "object" du dernier objet ayant désamorcé le piège de l'objet source. Cette fonction s'utilise lorsque l'événement "OnDisarm" d'un déclencheur, d'un plaçable ou d'une porte a été déclenché.

GetLastDisturbed()

object GetLastDisturbed()

Description :
Renvoie la valeur "object" du dernier objet ayant interféré avec l'inventaire de l'objet source. Cette fonction s'utilise lorsque l'événement "OnDisturb" d'une créature ou d'un plaçable a été déclenché.

Fonction(s) connexe(s) :
GetLastHostileActor

GetLastHostileActor(...)

object GetLastHostileActor
(
    object oVictim = OBJECT_SELF
)

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

Description :
Renvoie la valeur "object" de la dernière créature ayant effectué une action hostile à l'encontre de l'objet désigné par oVictim. Cette créature doit être la dernière à avoir déclenché l'événement "OnPhysicalAttacked", "OnDamaged", "OnSpellCastAt" (par un sort hostile) ou "OnDisturb" (par escamotage).
La valeur renvoyée correspondra toujours :
- à une créature
- à un personnage ne faisant pas partie de l'intrigue (Cf. paramètre "Intrigue" dans l'éditeur)
- au créateur d'une zone d'effet hostile
- à une créature vivante et en jeu.
Le créateur d'un piège hostile ne pourra pas être retrouvé à l'aide de cette fonction.

Fonction(s) connexe(s) :
GetLastAttacker, GetLastDamager, GetLastDisturbed, GetLastSpellCaster

GetLastKiller()

object GetLastKiller()

Description :
Renvoie la valeur "object" du dernier objet ayant tué/détruit l'objet source. Cette fonction s'utilise lorsque l'événement "OnDeath" d'une créature, d'un plaçable ou d'une porte a été déclenché.

GetLastLocked()

object GetLastKiller()

Description :
Renvoie la valeur "object" du dernier objet ayant verrouillé l'objet source. Cette fonction s'utilise lorsque l'événement "OnLocked" d'un plaçable ou d'une porte a été déclenché.

Fonction(s) connexe(s) :
GetLastUnlocked

GetLastName(...)

string GetLastName
(
    object oTarget
)

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

Description :
Renvoie le nom de famille de l'objet désigné par oTarget. Ne s'applique qu'aux créatures.

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

GetLastOpenedBy()

object GetLastOpenedBy()

Description :
Renvoie la valeur "object" du dernier objet ayant ouvert l'objet source. Cette fonction s'utilise lorsque l'événement "OnOpen" d'une échoppe, d'un plaçable ou d'une porte a été déclenché.

Fonction(s) connexe(s) :
GetLastClosedBy

GetLastPCRested()

object GetLastPCRested()

Description :
Renvoie la valeur "object" du dernier joueur ayant déclenché une phase de repos. Cette fonction s'utilise lorsque l'événement "OnPlayerRest" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastRestEventType

GetLastPCToCancelCutscene()

object GetLastPCToCancelCutscene()

Description :
Renvoie la valeur "object" du dernier joueur ayant annulé une cinématique. Cette fonction s'utilise lorsque l'événement "OnCutsceneAbort" du module a été déclenché.

GetLastPerceived()

object GetLastPerceived()

Description :
Renvoie la valeur "object" de la dernière créature ayant été remarquée par l'objet source. Cette fonction s'utilise lorsque l'événement "OnPerception" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastPerceptionHeard, GetLastPerceptionInaudible, GetLastPerceptionSeen, GetLastPerceptionVanished

GetLastPerceptionHeard()

int GetLastPerceptionHeard()

Description :
Détermine si la dernière créature ayant été remarqué par l'objet source a été entendue. Cette fonction s'utilise lorsque l'événement "OnPerception" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastPerceived, GetLastPerceptionInaudible, GetLastPerceptionSeen, GetLastPerceptionVanished

GetLastPerceptionInaudible()

int GetLastPerceptionInaudible()

Description :
Détermine si la dernière créature ayant été remarqué par l'objet source ne peut plus être entendue. Cette fonction s'utilise lorsque l'événement "OnPerception" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastPerceived, GetLastPerceptionHeard, GetLastPerceptionSeen, GetLastPerceptionVanished

GetLastPerceptionSeen()

int GetLastPerceptionSeen()

Description :
Détermine si la dernière créature ayant été remarqué par l'objet source a été vue. Cette fonction s'utilise lorsque l'événement "OnPerception" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastPerceived, GetLastPerceptionHeard, GetLastPerceptionInaudible, GetLastPerceptionVanished

GetLastPerceptionVanished()

int GetLastPerceptionVanished()

Description :
Détermine si la dernière créature ayant été remarqué par l'objet source vient de disparaître. Cette fonction s'utilise lorsque l'événement "OnPerception" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastPerceived, GetLastPerceptionHeard, GetLastPerceptionInaudible, GetLastPerceptionSeen

GetLastPlayerDied()

object GetLastPlayerDied()

Description :
Renvoie la valeur "object" du dernier joueur venant de mourir. Cette fonction s'utilise lorsque l'événement "OnPlayerDeath" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastKiller, GetLastPlayerDying

GetLastPlayerDying()

object GetLastPlayerDied()

Description :
Renvoie la valeur "object" du dernier joueur venant à "agoniser". Cette fonction s'utilise lorsque l'événement "OnPlayerDying" du module a été déclenché.

Fonction(s) connexe(s) :
GetLastKiller, GetLastPlayerDied

GetLastRespawnButtonPresser()

object GetLastRespawnButtonPresser()

Description :
Renvoie la valeur "object" du dernier joueur ayant cliqué sur le bouton "Respawn". Cette fonction s'utilise lorsque l'événement "OnPlayerRespawn" du module a été déclenché.

GetLastRestEventType()

int GetLastRestEventType()

Description :
Renvoie le type de phase qui a été déclenchée lors du dernier repos exécuté par un joueur. Cette fonction s'utilise lorsque l'événement "OnPlayerRest" du module a été déclenché. La valeur renvoyée peut être comparée aux constantes REST_EVENTTYPE_*.

Fonction(s) connexe(s) :
GetLastPCRested

GetLastSpeaker()

object GetLastSpeaker()

Description :
Renvoie la valeur "object" de la dernière créature ayant "parlé". 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é.

GetLastSpell()

int GetLastSpell()

Description :
Renvoie la référence du dernier sort ayant été lancé. Cette fonction s'utilise lorsque l'événement "OnSpellCastAt" d'une créature, d'un plaçable ou d'une porte a été déclenché.

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

GetLastSpellCastClass()

int GetLastSpellCastClass()

Description :
Renvoie la référence de la classe ayant servi à lancer le dernier sort. Cette fonction s'utilise lorsque l'événement "OnSpellCastAt" d'une créature, d'un plaçable ou d'une porte a été déclenché. La valeur 255 (CLASS_TYPE_INVALID) sera renvoyée si la classe du lanceur de sort ne peut pas être déterminée. La valeur renvoyée peut être comparée aux constantes CLASS_TYPE_*.

Fonction(s) connexe(s) :
GetLastSpell, GetLastSpellCaster, GetLastSpellHarmful

GetLastSpellCaster()

object GetLastSpellCaster()

Description :
Renvoie la valeur "object" du lanceur de sort ayant lancé le dernier sort. Cette fonction s'utilise lorsque l'événement "OnSpellCastAt" d'une créature, d'un plaçable ou d'une porte a été déclenché. La valeur OBJECT_INVALID sera renvoyée le lanceur de sort n'est ni une créature, ni un plaçable, ni une porte.

Fonction(s) connexe(s) :
GetLastSpell, GetLastSpellCastClass, GetLastSpellHarmful

GetLastSpellHarmful()

int GetLastSpellHarmful()

Description :
Détermine si le dernier sort lancé peut être considéré comme hostile. Cette fonction s'utilise lorsque l'événement "OnSpellCastAt" d'une créature, d'un plaçable ou d'une porte a été déclenché.

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

GetLastTrapDetected(...)

object GetLastTrapDetected
(
    object oTarget = OBJECT_SELF
)

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

Description :
Renvoie la valeur "object" du dernier piège que l'objet désigné par oTarget a détecté.

Fonction(s) connexe(s) :
GetTrapDetectedBy

GetLastUnlocked()

object GetLastUnlocked()

Description :
Renvoie la valeur "object" du dernier objet ayant déverrouillé l'objet source. La valeur OBJECT_INVALID sera renvoyée si l'objet source n'est ni un plaçable, ni une porte.

Fonction(s) connexe(s) :
GetLastLocked

GetLastUsedBy()

object GetLastUsedBy()

Description :
Renvoie la valeur "object" du dernier objet ayant utilisé l'objet source. La valeur OBJECT_INVALID sera renvoyée si l'objet source n'est ni un plaçable, ni une porte.

GetLastWeaponUsed(...)

object GetLastWeaponUsed
(
    object oCreature
)

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

Description :
Renvoie la valeur "object" de la dernière arme qu'a utilisé la créature désignée par oCreature. Cette fonction s'utilise lorsque l'événement "OnPhysicalAttacked" ou "OnDamaged" d'une créature, d'un plaçable ou d'une porte a été déclenché. La valeur OBJECT_INVALID sera renvoyée si oCreature n'a effectué aucune attaque, ou si aucune arme n'est équipée.

Fonction(s) connexe(s) :
GetLastAttacker

GetLawChaosValue(...)

int GetLawChaosValue
(
    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 (Chaotique) et 100 (Loyal).

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

GetLevelByClass(...)

int GetLevelByClass
(
    int nClassType,
    object oCreature = OBJECT_SELF
)

Paramètres :
- nClassType : Constante CLASS_TYPE_* définissant la classe concernée.
- oCreature : La créature concernée (défaut : OBJECT_SELF).

Description :
Renvoie le nombre de niveaux que la créature désignée par oCreature possède dans la classe définie par nClassType.

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

GetLevelByPosition(...)

int GetLevelByPosition
(
    int nClassPosition,
    object oCreature = OBJECT_SELF
)

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

Description :
Renvoie la classe que la créature désignée par oCréature suit à la position définie par nClassPosition. Une créature peut suivre 4 classes différentes. Si nClassPosition fait référence à une position non-utilisée, ou si oCreature n'est pas une créature valide, la valeur 0 sera renvoyée.

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

GetLevelUpPackage(...)

int GetLevelByPosition
(
    object oCreature
)

Paramètres :
- nClassPosition : La position de la classe concernée.
- oCreature : La créature concernée.

Description :
Renvoie l'archétype que la créature définie par oCreature suit lors d'une montée de niveau. La valeur renvoyée peut être comparé aux constantes PACKAGE_*, ou peut être consultée dans le fichier packages.2da.

Fonction(s) connexe(s) :
GetCreatureStartingPackage, SetLevelUpPackage

GetLimboCreatureCount()

int GetLimboCreatureCount()

Description :
Renvoie le nombre de créatures situées dans les limbes. Cette fonction ne garantit pas la validité de toutes ces créatures.

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

GetListenPatternNumber()

int GetListenPatternNumber()

Description :
Renvoie l'identifiant de la chaîne de caractères ayant été "entendue" par l'objet source. 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é.

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

GetLocalFloat(...)

float GetLocalFloat
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable concernée.

Description :
Renvoie la valeur "float" de la variable locale dont le nom est défini par sVarName, et rattachée à l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalInt, GetLocalLocation, GetLocalObject, GetLocalString, SetLocalFloat

GetLocalInt(...)

int GetLocalInt
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable concernée.

Description :
Renvoie la valeur "int" de la variable locale dont le nom est défini par sVarName, et rattachée à l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalFloat, GetLocalLocation, GetLocalObject, GetLocalString, SetLocalInt

GetLocalLocation(...)

location GetLocalLocation
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable concernée.

Description :
Renvoie la valeur "location" de la variable locale dont le nom est défini par sVarName, et rattachée à l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalFloat, GetLocalInt, GetLocalObject, GetLocalString, SetLocalLocation

GetLocalObject(...)

object GetLocalObject
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable concernée.

Description :
Renvoie la valeur "object" de la variable locale dont le nom est défini par sVarName, et rattachée à l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalFloat, GetLocalInt, GetLocalLocation, GetLocalString, SetLocalObject

GetLocalString(...)

string GetLocalString
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable concernée.

Description :
Renvoie la valeur "string" de la variable locale dont le nom est défini par sVarName, et rattachée à l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalFloat, GetLocalInt, GetLocalLocation, GetLocalObject, SetLocalString

GetLocation(...)

location GetLocation
(
    object oObject
)

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

Description :
Renvoie la localisation correspondant à l'objet désigné par oObject.

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

GetLocked(...)

int GetLocked
(
    object oObject
)

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

Description :
Détermine si l'objet désigné par oTarget est verrouillé. Cette fonction ne s'applique qu'aux déclencheurs, aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLock*, SetLocked

GetLockKeyRequired(...)

int GetLockKeyRequired
(
    object oObject
)

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

Description :
Détermine si une clé est requise pour déverrouiller l'objet désigné par oTarget. Cette fonction ne s'applique qu'aux déclencheurs, aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLock*, SetLockKeyRequired

GetLockKeyTag(...)

string GetLockKeyTag
(
    object oObject
)

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

Description :
Renvoie le Tag de la clé requise pour déverrouiller l'objet désigné par oTarget. Cette fonction ne s'applique qu'aux déclencheurs, aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLock*, SetLockKeyTag

GetLockLockable(...)

int GetLockLockable
(
    object oObject
)

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

Description :
Détermine s'il est possible de verrouiller l'objet désigné par oTarget. Cette fonction ne s'applique qu'aux déclencheurs, aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLock*, SetLockLockable

GetLockLockDC(...)

int GetLockLockDC
(
    object oObject
)

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

Description :
Renvoie le seuil de difficulté à franchir pour verrouiller l'objet désigné par oObject. Cette fonction ne s'applique qu'aux déclencheurs, aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLock*, SetLockLockDC

GetLockUnlockDC(...)

int GetLockUnlockDC
(
    object oObject
)

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

Description :
Renvoie le seuil de difficulté à franchir pour déverrouiller l'objet désigné par oObject. Cette fonction ne s'applique qu'aux déclencheurs, aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLock*, SetLockUnlockDC

GetLootable(...)

int GetLootable
(
    object oCreature
)

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

Description :
Détermine si la créature désignée par oCreature peut être fouillée à sa mort (Cf. paramètre "Corps détroussable" dans l'éditeur).

Fonction(s) connexe(s) :
SetLootable

LISTE DES FONCTIONS

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

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