NWScript - Fonctions de B à D

BeginConversation(...)

int BeginConversation
(
    string sResRef = "",
    object oObjectToDialog = OBJECT_INVALID,
    int bPreventHello = FALSE
)

Paramètres :
- sResRef : La conversation à engager (Défaut : "").
- oObjectToDialog : L'objet avec lequel la conversation sera engagée (Défaut : OBJECT_INVALID).
- bPreventHello : Empêche l'interlocuteur de prononcer la phrase de bienvenue (Défaut : FALSE).

Description :
L'objet source engagera une conversation avec l'objet désigné par oObjectTodialog. Utilisé dans l'événement "OnConversation", et si oObjectToDialog est égal à OBJECT_INVALID, la conversation sera engagée avec le joueur ayant déclenché cet événement. Si sResRef est une chaîne de caractères vide, la conversation définie dans les propriétés de l'objet source sera engagée.

Fonction(s) connexe(s) :
ActionStartConversation

BlackScreen(...)

void BlackScreen
(
    object oCreature,
    int nColor = 0
)

Paramètres :
- oCreature : Le joueur à affecter.
- nColor : Constante COLOR_* définissant la couleur à afficher (Défaut : 0).

Description :
L'écran du joueur désigné par oCreature affichera un "écran noir". Différentes couleurs peuvent être utilisées.
Le paramètre nColor est une valeur numérique comprise entre 0 et 16777215 (noir - blanc), définissant la couleur à utiliser. Pour calculer cette couleur, il faudra convertir la valeur hexadécimale de cette couleur en valeur décimale (par exemple : FF0000 désignant le rouge, devient 16711680). La calculatrice de Windows permet de convertir aisément les valeurs.

Fonction(s) connexe(s) :
FadeToBlack, StopFade

BootPC(...)

void BootPC
(
    object oPlayer
)

Paramètres :
- oPlayer : Le joueur à éjecter.

Description :
Le joueur désigné par oPlayer sera éjecté du serveur.

Fonction(s) connexe(s) :
ActivatePortal

CalcPointAwayFromPoint(...)

location CalcPointAwayFromPoint
(
    location lPoint,
    location lAwayFromPoint,
    float fDistance,
    float fAngularVariance,
    int bComputeDistFromStart
)

Paramètres :
- lPoint : La localisation de départ.
- lAwayFromPoint : La localisation de référence, à partir de laquelle une nouvelle localisation sera calculée.
- fDistance : La distance entre la localisation à calculer et la localisation de référence.
- fAngularVariance : Une variation aléatoire ajoutée à la localisation à calculer.
- bComputeDistFromStart : Détermine si la paramètre fDistance est utilisé par rapport à lPoint (TRUE), ou par rapport à lAwayFromPoint (FALSE).

Description :
Une localisation sera calculée à partir de lPoint, et à une certaine distance de lAwayFromPoint. Le paramètre fDistance peut avoir une valeur négative. Le paramètre fAngularVariance est une valeur comprise entre 0 et 180. Le paramètre bComputeDistFromStart doit avoir une valeur égale à 0 ou 1 (FALSE / TRUE). Si la nouvelle localisation ne peut pas être calculée avec succès, la valeur de lPoint sera renvoyée.

Fonction(s) connexe(s) :
CalcSafeLocation

CalcSafeLocation(...)

location CalcSafeLocation
(
    object oCreature,
    location lTestPosition,
    float fSearchRadius,
    int bWalkStraighLineRequired,
    int bIgnoreTestPosition
)

Paramètres :
- oCreature : La créature pour laquelle une localisation "sans danger" sera calculée.
- lTestPosition : La localisation près de laquelle la localisation "sans danger" sera calculée.
- fSearchRadius : La distance maximum de recherche, par rapport à lTestPosition.
- bWalkStraighLineRequired : Détermine si une localisation "sans danger" avec un chemin direct doit être calculée.
- bIgnoreTestPosition : Détermine si la localisation lTestPosition elle-même doit être ignorée.

Description :
Une localisation "sans danger" pour la créature désignée par oCreature sera calculée à partir de lTestPosition. Si une localisation "sans danger" ne peut être calculée, la localisation de oCreature sera renvoyée.

Fonction(s) connexe(s) :
CalcPointAwayFromPoint

ChangeFaction(...)

void ChangeFaction
(
    object oObjectToChangeFaction,
    object oMemberOfFactionToJoin
)

Paramètres :
- oObjectToChangeFaction : L'objet à affecter.
- oMemberOfFactionToJoin : L'objet appartenant à la faction à rejoindre.

Description :
L'objet désigné par oObjectToChangeFaction rejoindra la faction à laquelle appartient oMemberOfFactionToJoin. Si l'un ou l'autre est un personnage joueur, la fonction sera sans effet.

Fonction(s) connexe(s) :
ChangeToStandardFaction

ChangeToStandardFaction(...)

void ChangeToStandardFaction
(
    object oCreatureToChange,
    int nStandardFaction
)

Paramètres :
- oCreatureToChange : L'objet à affecter.
- nStandardFaction : Constante STANDARD_FACTION_* définissant la faction standard à rejoindre.

Description :
L'objet désigné par oCreatureToChange rejoindra la faction standard définie par nStandardFaction. Si oCreatureToChange est personnage joueur, la fonction sera sans effet.

Fonction(s) connexe(s) :
ChangeFaction

CharToASCII(...)

int CharToASCII
(
    string sString
)

Paramètres :
- sString : La chaîne de caractères dont le premier caractère sera converti.

Description :
Le premier caractère de la chaîne désignée par sString sera converti en valeur numérique ASCII.

Clear2DACache(...)

void Clear2DACache
(
    string s2DAName = ""
)

Paramètres :
- s2DAName : Le nom du fichier 2DA (défaut : "").

Description :
Le cache du 2DA désigné par s2DAName sera vidé, signifiant que son contenu sera directement recherché sur dans le fichier lors de la prochaine recherche. Si s2DAName ne désigne aucun fichier 2DA, le cache entier sera vidé. Seuls les fichiers 2DA ayant déjà été consultés via un script sont rajoutés en mémoire cache.

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

ClearAllActions(...)

void ClearAllActions
(
    int nClearCombatState = FALSE
)

Paramètres :
- nClearCombatState : Détermine si le mode combat doit être annulé (défaut : FALSE).

Description :
L'objet source stoppera toute action en cours, et sa file d'actions en attente sera vidée. Si un combat était engagé et que nClearCombatState est égal à TRUE, le combat sera stoppé.

ClearCombatOverrides(...)

void ClearCombatOverrides
(
    object oCreature
)

Paramètres :
- oCreature : La créature à affecter.

Description :
Cette fonction annule le mode de combat forcé par la fonction "SetCombatOverrides(...)", pour la créature désignée par oCreatre.

Fonction(s) connexe(s) :
SetCombatOverrides

ClearListBox(...)

void ClearListBox
(
    object oPlayer,
    string sScreenName,
    string sListBox
)

Paramètres :
- oPlayer : Le joueur dont l'interface sera affectée.
- sScreenName : Le nom de l'élément d'interface contenant la liste.
- sListBox : Le nom de la liste à affecter.

Description :
Remet à zéro une liste d'un élément de l'interface du joueur désigné par oPlayer.

Fonction(s) connexe(s) :
AddListBoxRow, ModifyListBoxRow, RemoveListBoxRow

ClearPersonalReputation(...)

void ClearPersonalReputation
(
    object oTarget,
    object oSource = OBJECT_SELF
)

Paramètres :
- oTarget : L'objet à affecter.
- oSource : L'objet par rapport auquel la réputation sera ajustée (défaut : OBJECT_SELF).

Description :
La réputation de l'objet désigné par oTarget vis-à-vis de oSource sera remise à zéro. N'agit pas sur la faction entière, mais uniquement sur oTarget.

Fonction(s) connexe(s) :
AdjustReputation, GetReputation

ClearScriptParams()

void ClearScriptParams()

Description :
Supprime les paramètres utilisés pour les scripts exécutés via la fonction ExecuteScriptEnhanced.

Fonction(s) connexe(s) :
AddScriptParameter*, ExecuteScriptEnhanced

CloseGUIScreen(...)

void CloseGUIScreen
(
    object oPlayer,
    string sScreenName
)

Paramètres :
- oPlayer : Le joueur à affecter.
- sScreenName : Le nom de la fenêtre concernée.

Description :
La fenêtre du joueur oPlayer, et désignée par sScreenName, sera fermée.

Fonction(s) connexe(s) :
DisplayGuiScreen, PopUpDeathGUIPanel, PopUpGUIPanel

CopyItem(...)

object CopyItem
(
    object oItem,
    object oTargetInventory = OBJECT_INVALID,
    int bCopyVars = FALSE
)

Paramètres :
- oItem : L'item à dupliquer.
- oTargetInventory : La cible dans l'inventaire duquel l'item dupliqué sera placé (défaut : OBJECT_INVALID).
- bCopyVars : Détermine si les variables locales de l'item source doivent être copiées (défaut : FALSE).

Description :
L'item désigné par oItem sera dupliqué. Si oTargetInventory est égal à OBJECT_INVALID, l'item sera créé au même endroit que l'item source. Si l'item source est un contenant (sac sans fond ou autre) et qu'il contient des items, la fonction sera sans effet. Si l'item source est empilable et qu'il est dupliqué au même endroit, l'item créé sera directement empilé. Si la fonction s'est s'exécutée avec succès, la valeur de l'item créé sera renvoyée. Sinon, la valeur OBJECT_INVALID sera renvoyée.

Fonction(s) connexe(s) :
CopyItemAndModify, CopyObject, CreateInstancedAreaFromSource, CreateItemOnObject

CopyItemAndModify(...)

object CopyItemAndModify
(
    object oItem,
    int nType,
    int nIndex,
    int nNewValue,
    int bCopyVars = FALSE
)

Paramètres :
- oItem : L'item à dupliquer.
- nType : Constante ITEM_APPR_TYPE_* définissant le type de modification à effectuer.
- nIndex : Constante ITEM_APPR_* définissant la sous-catégorie de la modification.
- nNewValue : La nouvelle valeur à attribuer.
- bCopyVars : Détermine si les variables locales de l'item source doivent être copiées (défaut : FALSE).

Description :
L'item désigné par oItem est dupliqué, en faisant une modification mineure sur son apparence. Si oItem est un casque, le paramètre nIndex sera ignoré. Si la fonction s'est s'exécutée avec succès, la valeur de l'item créé sera renvoyée. Sinon, la valeur OBJECT_INVALID sera renvoyée.

Fonction(s) connexe(s) :
CopyItem, CopyObject, CreateInstancedAreaFromSource, CreateItemOnObject

CopyObject(...)

object CopyObject
(
    object oSource,
    location locLocation,
    object oOwner = OBJECT_INVALID,
    string sNewTag = ""
)

Paramètres :
- oSource : L'objet à dupliquer.
- locLocation : La localisation sur laquelle l'objet dupliqué apparaîtra.
- oOwner : Le nouveau possesseur, si un item est dupliqué (défaut : OBJECT_INVALID).
- sNewTag : Le nouveau Tag à attribuer (défaut : "").

Description :
L'objet désigné par oSource sera dupliqué. S'il s'agit d'un item, et que oOwner est un contenant, l'item dupliqué sera placé dans l'inventaire de ce dernier. Si la valeur sNewTag est une chaîne de caractère vide, le Tag de l'objet source sera attribué à l'objet créé. Si oSource n'est ni une créature, ni un item, la fonction sera sans effet. Si la fonction s'est s'exécutée avec succès, la valeur de l'item créé sera renvoyée. Sinon, la valeur OBJECT_INVALID sera renvoyée.

Fonction(s) connexe(s) :
CopyItem, CopyItemAndModify, CreateInstancedAreaFromSource, CreateObject

cos(...)

float cos
(
    float fValue
)

Paramètres :
- fValue : La valeur de l'angle (en degrés).

Description :
La valeur de l'angle désigné par fValue sera convertie en valeur Cosinus (côté adjacent/hypoténuse).

Fonction(s) connexe(s) :
acos, sin, tan

CreateInstancedAreaFromSource(...)

object CreateInstancedAreaFromSource
(
    object oArea
)

Paramètres :
- oArea : La zone de référence.

Description :
Crée une nouvelle instance de la zone désignée par oArea. La zone d'origine étant copiée à partir de son emplacement de sauvegarde, aucune modification apportée pendant le jeu ne sera prise en compte. Les objets créés ou détruits en jeu en sont un exemple.

Fonction(s) connexe(s) :
CopyItem, CopyItemAndModify, CopyObject

CreateItemOnObject(...)

object CreateItemOnObject
(
    string sItemTemplate,
    object oTarget = OBJECT_SELF,
    int nStackSize = 1,
    string sNewTag = ""
)

Paramètres :
- sItemTemplate : Le ResRef de l'item.
- oTarget : L'objet dans l'inventaire duquel l'item sera créé (défaut : OBJECT_SELF).
- nStackSize : Le nombre d'item empilés (défaut : 1).
- sNewTag : Le nouveau Tag à attribuer (défaut : "").

Description :
L'item dont le ResRef est désigné par sItemTemplate sera créé dans l'inventaire de oTarget. Si sItemTemplate fait fait référence à un item non-empilable, le paramètre nStackSize sera ignoré. Dans le cas inverse, une pile d'item sera créée et rajoutée à une pile déjà existante s'il y a lieu. Si la valeur sNewTag est une chaîne de caractère vide, le Tag de l'objet source sera attribué à l'objet créé. Si la fonction s'est s'exécutée avec succès, la valeur de l'item créé sera renvoyée. Sinon, la valeur OBJECT_INVALID sera renvoyée.

Objets empilables : La valeur de nStackSize ne peut pas dépasser la valeur maximum initiale de l'item empilable (ex. 153 flèches donneront 99 flèches). S'il existe déjà une pile dans l'inventaire de oTarget, et que le nombre d'objet dépasse le maximum empilable, une nouvelle pile sera créée en tenant compte de la valeur maximale initiale. Par ex. s'il y a déjà 50 flèches, et que 80 sont créées, la pile de 50 sera complétée jusqu'à 99 et une nouvelle pile de 31 flèches sera créée. Par contre si nStackSize est égal à 153, seules 99 flèches seront créées, puis complèteront les 50 avant de créer une nouvelle pile de 50.

Fonction(s) connexe(s) :
CopyItem, CopyItemAndModify, CreateObject, DestroyObject

CreateObject(...)

object CreateObject
(
    int nObjectType,
    string sTemplate,
    location lLocation,
    int bUseAppearAnimation = FALSE,
    string sNewTag = ""
)

Paramètres :
- nObjectType : Constante OBJECT_TYPE_* définissant le type d'objet à créer.
- sTemplate : Le ResRef de l'objet.
- lLocation : La localisation sur laquelle l'objet créé apparaîtra.
- bUseAppearAnimation : Définit si l'objet créé doit apparaître en utilisant une animation (défaut : FALSE).
- sNewTag : Le nouveau Tag à attribuer (défaut : "").

Description :
L'objet dont le ResRef est désigné par sTemplate sera créé sur la localisation lLocation. Si la valeur sNewTag est une chaîne de caractère vide, le Tag initial de l'objet sera utilisé. Si la fonction s'est s'exécutée avec succès, la valeur de l'objet créé sera renvoyée. Sinon, la valeur OBJECT_INVALID sera renvoyée.

Fonction(s) connexe(s) :
CopyObject, CreateItemOnObject, CreateTrapAtLocation, DestroyObject

CreateTrapAtLocation(...)

object CreateTrapAtLocation
(
    int nTrapType,
    location lLocation,
    float fSize = 2.0f,
    string sTag = "",
    int nFaction = STANDARD_FACTION_HOSTILE,
    string sOnDisarmScript = "",
    string sOnTrapTriggered = ""
)

Paramètres :
- nTrapType : Constante TRAP_BASE_TYPE_* définissant le type de piège à créer.
- lLocation : La localisation sur laquelle le piège sera créé.
- fSize : La taille d'un côté du piège (défaut : 2.0f).
- sTag : Le Tag à attribuer au piège (défaut : "").
- nFaction : Constante STANDARD_FACTION_* définissant la faction à laquelle appartient le piège (défaut : STANDARD_FACTION_HOSTILE).
- sOnDisarmScript : Le script à attribuer à l'événement "OnDisarm" du piège (défaut : "").
- sOnTrapTriggered : Le script à attribuer à l'événement "OnTrapTriggered" du piège (défaut : "").

Description :
Le piège dont le type est défini par nTrapType sera créé sur la localisation lLocation. Un piège créé de cette manière est un carré dont la largeur est égale à fSize. La valeur fSize ne doit pas être inférieure à 1.0f. Les pièges créés de cette manière n'ont aucun script par défaut. Si sOnDisarmScript ou sOnTrapTriggered est laissé vide, aucun script ne sera exécuté. Si la fonction s'est s'exécutée avec succès, la valeur du piège créé sera renvoyée. Sinon, la valeur OBJECT_INVALID sera renvoyée.

Fonction(s) connexe(s) :
CreateObject, CreateTrapOnObject, DestroyObject, SetTrapDisabled

CreateTrapOnObject(...)

void CreateTrapOnObject
(
    int nTrapType,
    object oObject,
    int nFaction = STANDARD_FACTION_HOSTILE,
    string sOnDisarmScript = "",
    string sOnTrapTriggered = ""
)

Paramètres :
- nTrapType : Constante TRAP_BASE_TYPE_* définissant le type de piège à créer.
- oObject : L'objet sur lequel le piège sera créé.
- nFaction : Constante STANDARD_FACTION_* définissant la faction à laquelle appartient le piège (défaut : STANDARD_FACTION_HOSTILE).
- sOnDisarmScript : Le script à attribuer à l'événement "OnDisarm" du piège (défaut : "").
- sOnTrapTriggered : Le script à attribuer à l'événement "OnTrapTriggered" du piège (défaut : "").

Description :
Le piège dont le type est défini par nTrapType sera créé sur l'objet oObjet. Si oObjet n'est ni un plaçable, ni une porte, ou si oObjet a déjà un piège défini dans ses propriétés, la fonction sera sans effet. Les pièges créés de cette manière n'ont aucun script par défaut. Si sOnDisarmScript ou sOnTrapTriggered est laissé vide, aucun script ne sera exécuté.

Fonction(s) connexe(s) :
CreateTrapAtLocation, SetTrapDisabled

d10(...)

int d10
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 10 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d100, d12, d2, d20, d3, d4, d6, d8, Random

d100(...)

int d100
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 100 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d12, d2, d20, d3, d4, d6, d8, Random

d12(...)

int d12
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 12 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d100, d2, d20, d3, d4, d6, d8, Random

d2(...)

int d2
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 2 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d100, d12, d20, d3, d4, d6, d8, Random

d20(...)

int d20
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 20 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d100, d12, d2, d3, d4, d6, d8, Random

d3(...)

int d3
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 3 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d100, d12, d2, d20, d4, d6, d8, Random

d4(...)

int d4
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 4 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d100, d12, d2, d20, d3, d6, d8, Random

d6(...)

int d6
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 6 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d100, d12, d2, d20, d3, d4, d8, Random

d8(...)

int d8
(
    int nNumDice = 1
)

Paramètres :
- nNumDice : Nombre de dés à "lancer" (défaut : 1).

Description :
Le résultat d'un nombre de dés à 8 faces défini par nNumDice sera calculé. Si nNumDice est plus petit ou égal à 0, la valeur 1 sera utilisée.

Fonction(s) connexe(s) :
d10, d100, d12, d2, d20, d3, d4, d6, Random

DayToNight(...)

void DayToNight
(
    object oPlayer,
    float fTransitionTime = 0.0f
)

Paramètres :
- oPlayer : Le joueur à affecter.
- fTransitionTime : Temps pendant lequel la transition jour-nuit procédera (défaut : 0.0f).

Description :
Une transition du jour à la nuit opérera pour le joueur désigné par oPlayer. Si le joueur se trouve dans une zone utilisant déjà un cycle jour/nuit, la fonction sera sans effet.

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

DebugPostString(...)

void DebugPostString
(
    object oTarget,
    string sMesg,
    int nX,
    int nY,
    float fDuration,
    int nColor = 4294901760
)

Paramètres :
- oTarget : Le joueur à affecter.
- sMesg : Le texte à afficher.
- nX : La position du texte sur l'axe horizontal.
- nY : La position du texte sur l'axe vertical.
- fDuration : Le temps pendant lequel le texte sera affiché.
- nColor : Couleur du texte (défaut : 4294901760).

Description :
Affiche une chaîne de caractères à l'écran du joueur désigné par oTarget. Cette chaîne s'affichera à un endroit défini par nX et nY, dans la couleur spécifiée par nColor, et pendant un temps défini par fDuration. L'affichage est contrôlé par les paramètres des fichiers nwn.ini ([Game Options]Debug Text) et nwnplayer.ini ([Server Options]Scripts Print To Screen).

DecrementRemainingFeatUses(...)

void DecrementRemainingFeatUses
(
    object oCreature,
    int nFeat
)

Paramètres :
- oCreature : La créature à affecter.
- nFeat : Constante FEAT_* définissant le don affecté.

Description :
Le nombre d'utilisation par jour du don défini par nFeat sera diminué de 1 pour la créature désignée par oCreature.

Fonction(s) connexe(s) :
DecrementRemainingSpellUses, IncrementRemainingFeatUses, ResetFeatUses

DecrementRemainingSpellUses(...)

void DecrementRemainingSpellUses
(
    object oCreature,
    int nSpell
)

Paramètres :
- oCreature : La créature à affecter.
- nSpell : Constante SPELL_* définissant le sort affecté.

Description :
Le nombre d'utilisation par jour du sort défini par nSpell sera diminué de 1 pour la créature désignée par oCreature.

Fonction(s) connexe(s) :
DecrementRemainingFeatUses

DelayCommand(...)

void DelayCommand
(
    float fSeconds,
    action aActionToDelay
)

Paramètres :
- fSeconds : Le temps à attribuer.
- aActionToDelay : La commande à effectuer avec un délai.

Description :
La commande définie par aActionToDelay sera retardée. Pour les commandes impliquant la création d'un effet (Effect...(...)), il est conseillé de mettre cet effet en variable avant de l'insérer dans la fonction "DelayCommand(...)". Le paramètre aActionToDelay peut contenir une commande de type "void".

Fonction(s) connexe(s) :
AssignCommand

DeleteCampaignVariable(...)

void DeleteCampaignVariable
(
    string sCampaignName,
    string sVarName,
    action oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : Le nom du fichier de la BDD.
- sVarName : Le nom de la variable à effacer.
- oPlayer : Le joueur de référence de la variable (défaut : OBJECT_INVALID).

Description :
La variable de campagne désignée par sVarName sera effacée de la base de données dont le fichier est défini par sCampaignName. La variable n'est pas réellement effacée, mais reçoit un indicateur "Deleted" qui la rend indisponible. Pour supprimer complètement une variable de campagne, il faudra passer par un moyen externe.

Fonction(s) connexe(s) :
DestroyCampaignDatabase, GetCampaign*, PackCampaignDatabase, SetCampaign*

DeleteLocalFloat(...)

void DeleteLocalFloat
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet à affecter.
- sVarName : Le nom de la variable locale de type "float" à effacer.

Description :
La variable locale de type "float" inscrite sur l'objet désigné par oObject sera effacée.

Fonction(s) connexe(s) :
DeleteLocalInt, DeleteLocalLocation, DeleteLocalObject, DeleteLocalString, SetLocalFloat

DeleteLocalInt(...)

void DeleteLocalInt
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet à affecter.
- sVarName : Le nom de la variable locale de type "int" à effacer.

Description :
La variable locale de type "int" inscrite sur l'objet désigné par oObject sera effacée.

Fonction(s) connexe(s) :
DeleteLocalFloat, DeleteLocalLocation, DeleteLocalObject, DeleteLocalString, SetLocalInt

DeleteLocalLocation(...)

void DeleteLocalLocation
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet à affecter.
- sVarName : Le nom de la variable locale de type "location" à effacer.

Description :
La variable locale de type "location" inscrite sur l'objet désigné par oObject sera effacée.

Fonction(s) connexe(s) :
DeleteLocalFloat, DeleteLocalInt, DeleteLocalObject, DeleteLocalString, SetLocalLocation

DeleteLocalObject(...)

void DeleteLocalObject
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet à affecter.
- sVarName : Le nom de la variable locale de type "object" à effacer.

Description :
La variable locale de type "object" inscrite sur l'objet désigné par oObject sera effacée.

Fonction(s) connexe(s) :
DeleteLocalFloat, DeleteLocalInt, DeleteLocalLocation, DeleteLocalString, SetLocalObject

DeleteLocalString(...)

void DeleteLocalString
(
    object oObject,
    string sVarName
)

Paramètres :
- oObject : L'objet à affecter.
- sVarName : Le nom de la variable locale de type "string" à effacer.

Description :
La variable locale de type "string" inscrite sur l'objet désigné par oObject sera effacée.

Fonction(s) connexe(s) :
DeleteLocalFloat, DeleteLocalInt, DeleteLocalLocation, DeleteLocalObject, SetLocalString

DespawnRosterMember(...)

int DespawnRosterMember
(
    string sRosterName
)

Paramètres :
- sRosterName : Le "nom de compagnon" du compagnon d'armes.

Description :
Le compagnon d'armes dont le "nom de compagnon" est référencé dans la "liste des compagnons" sera retiré du jeu. Tous les changements qu'aura subi ce compagnon d'arme seront sauvegardés.

Fonction(s) connexe(s) :
SpawnRosterMember

DestroyCampaignDatabase(...)

void DestroyCampaignDatabase
(
    string sCampaignName
)

Paramètres :
- sCampaignName : Le nom de la BDD à effacer.

Description :
La base de données désignée par sCampaignName sera entièrement supprimée. Les fichiers correspondant à cette base de données seront supprimés également.

Fonction(s) connexe(s) :
DeleteCampaignVariable, PackCampaignDatabase

DestroyObject(...)

void DestroyObject
(
    object oDestroy,
    float fDelay = 0.0f
)

Paramètres :
- oDestroy : L'objet à supprimer.
- fDelay : Le délai avant la suppression.

Description :
L'objet désigné par oDestroy sera retiré du jeu. Les objets sont supprimés et non "détruits"; ils ne déclencheront pas d'événement "OnDeath" s'ils en possèdent un. Si oDestroy désigne une zone ou le module, la fonction sera sans effet.

Fonction(s) connexe(s) :
CreateObject

DismountObject(...)

void DismountObject
(
    object oDismountingObject,
    object oObjectToDismount
)

Paramètres :
- oDismountingObject : Le cavalier.
- oObjectToDismount : La monture.

Description :
L'objet désigné par oDismountingObject déscendra de la monture oObjectToDismount. Fonction sans effet actuellement.

Fonction(s) connexe(s) :
MountObject

DisplayGuiScreen(...)

void DisplayGuiScreen
(
    object oPlayer,
    string sScreenName,
    int bModal,
    string sFileName = ""
)

Paramètres :
- oPlayer : Le joueur à affecter.
- sScreenName : Le nom de la fenêtre à afficher.
- bModal : aucune idée...
- sFileName : Le nom d'un éventuel fichier à utiliser (défaut : "").

Description :
La fenêtre désignée par sScreenName sera affichée à l'écran du joueur oPlayer. Si le nom de la fenêtre ne peut pas être trouvée dans la section [GuiScreen] du fichier ingamegui.ini ou pregamegui.ini, le fichier désigné par sFileName sera utilisé comme ressource. Si la fenêtre est déjà référencée, le paramètre sFileName sera ignoré.

Fonction(s) connexe(s) :
CloseGUIScreen, DisplayInputBox, DisplayMessageBox, SetScrollBarRanges

DisplayInputBox(...)

void DisplayInputBox
(
    object oPC,
    int nMessageStrRef,
    string sMessage = "",
    string sOKCB = "",
    string sCancelCB = "",
    int bShowCancel = FALSE,
    string sScreenName = "SCREEN_STRINGINPUT_MESSAGEBOX",
    int nOkStrRef = -1,
    string sOkString = "",
    int nCancelStrRef = -1,
    string sCancelString = "",
    string sDefaultString = "",
    string sUnusedString = ""
)

Paramètres :
- oPC : Le joueur à affecter.
- nMessageStrRef : La référence dans le fichier TLK du texte à afficher dans la fenêtre.
- sMessage : Le texte à afficher dans la fenêtre.
- sOKCB : Le nom du script que lancera le bouton "OK" (défaut : "").
- sCancelCB : Le nom du script que lancera le bouton "Cancel" (défaut : "").
- bShowCancel : Détermine si le bouton "Cancel" doit être affiché (défaut : FALSE).
- sScreenName : Le nom de référence de la fenêtre à afficher (défaut : SCREEN_STRINGINPUT_MESSAGEBOX).
- nOkStrRef : La référence du nom dans le fichier TLK que portera le bouton "OK" (défaut : -1).
- sOkString : Le nom que portera le bouton "OK" (défaut : "").
- nCancelStrRef : La référence du nom dans le fichier TLK que portera le bouton "Cancel" (défaut : -1).
- sCancelString : Le nom que portera le bouton "Cancel" (défaut : "").
- sDefaultString : Le texte affiché par défaut dans le champ d'entrée de texte (défaut : "").
- sUnusedString : Inconnu... (défaut : "").

Description :
Une fenêtre d'entrée de texte sera affichée sur l'écran du joueur désigné par oPC. Si un message est pris en référence, et qu'un texte est également paramétré, le texte aura priorité sur le message référencé. Les noms de script définis par sOKCB et sCancelCB devront commencer par les caractères "gui". Si sScreenName ne fait pas référence à un nom de fenêtre valide, la fonction sera sans effet. Les paramètre sOkString et sCancelString ont priorité sur nOkStrRef et nCancelStrRef.

Fonction(s) connexe(s) :
DisplayGuiScreen, DisplayMessageBox

DisplayMessageBox(...)

void DisplayMessageBox
(
    object oPC,
    int nMessageStrRef,
    string sMessage = "",
    string sOKCB = "",
    string sCancelCB = "",
    int bShowCancel = FALSE,
    string sScreenName = "SCREEN_MESSAGEBOX_DEFAULT",
    int nOkStrRef = -1,
    string sOkString = "",
    int nCancelStrRef = -1,
    string sCancelString = ""
)

Paramètres :
- oPC : Le joueur à affecter.
- nMessageStrRef : La référence dans le fichier TLK du texte à afficher dans la fenêtre.
- sMessage : Le texte à afficher dans la fenêtre.
- sOKCB : Le nom du script que lancera le bouton "OK" (défaut : "").
- sCancelCB : Le nom du script que lancera le bouton "Cancel" (défaut : "").
- bShowCancel : Détermine si le bouton "Cancel" doit être affiché (défaut : FALSE).
- sScreenName : Le nom de référence de la fenêtre à afficher (défaut : SCREEN_MESSAGEBOX_DEFAULT).
- nOkStrRef : La référence du nom dans le fichier TLK que portera le bouton "OK" (défaut : -1).
- sOkString : Le nom que portera le bouton "OK" (défaut : "").
- nCancelStrRef : La référence du nom dans le fichier TLK que portera le bouton "Cancel" (défaut : -1).
- sCancelString : Le nom que portera le bouton "Cancel" (défaut : "").

Description :
Une fenêtre d'information sera affichée sur l'écran du joueur désigné par oPC. Si un message est pris en référence, et qu'un texte est également paramétré, le texte aura priorité sur le message référencé. Les noms de script définis par sOKCB et sCancelCB devront commencer par les caractères "gui". Si sScreenName ne fait pas référence à un nom de fenêtre valide, la fonction sera sans effet. Les paramètre sOkString et sCancelString ont priorité sur nOkStrRef et nCancelStrRef.

Fonction(s) connexe(s) :
DisplayGuiScreen, DisplayInputBox

DoDoorAction(...)

void DoDoorAction
(
    object oTargetDoor,
    int nDoorAction
)

Paramètres :
- oTargetDoor : La porte avec laquelle l'interaction aura lieu.
- nDoorAction : Constante DOOR_ACTION_* définissant le type d'action à accomplir.

Description :
L'objet source accomplira l'action définie par nDoorAction sur la porte désignée par oTargetDoor.

Fonction(s) connexe(s) :
ActionCloseDoor, ActionOpenDoor, DoPlaceableObjectAction

DoPlaceableObjectAction(...)

void DoDoorAction
(
    object oPlaceable,
    int nPlaceableAction
)

Paramètres :
- oPlaceable : Le plaçable avec lequel l'interaction aura lieu.
- nPlaceableAction : Constante PLACEABLE_ACTION_* définissant le type d'action à accomplir.

Description :
L'objet source accomplira l'action définie par nPlaceableAction sur le plaçable désigné par oPlaceable.

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

DoSinglePlayerAutoSave()

void DoSinglePlayerAutoSave()

Description :
Procède à une sauvegarde de type "automatique". Ne fonctionne pas en mode multi-joueur.

Fonction(s) connexe(s) :
ExportAllCharacters, ExportSingleCharacter

DoWhirlwindAttack()

void DoWhirlwindAttack
(
    int bDisplayFeedback = TRUE,
    int bImproved = FALSE
)

Paramètres :
- bDisplayFeedback : Détermine si les messages correspondants doivent être affichés dans la fenêtre de dialogue/combat (défaut : TRUE).
- bImproved : Détermine si la version "améliorée" doit être utilisée (défaut : FALSE).

Description :
L'objet source réalise une attaque en rotation (sur toutes les créatures hostiles se trouvant à une distance maximum de 3 mètres). Si l'objet source est équipé d'un arme à distance, cette fonction sera sans effet.

LISTE DES FONCTIONS

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