NWScript - Fonctions de J à R

JumpPartyToArea(...)

void JumpPartyToArea
(
    object oPartyMember,
    object oDestination
)

Paramètres :
- oPartyMember : Le membre du groupe concerné.
- oDestination: L'objet inclus dans la zone concernée.

Description :
Transfère le groupe de la créature désignée par oPartyMember vers un objet désigné par oDestination situé dans la zone souhaitée. L'écran de chargement restera affiché jusqu'à ce que tous les membres du groupe aient été transférés. Si le groupe est déjà dans la zone concernée, ils seront transféré vers oDestination sans déclencher l'événement "OnClientEnter" de la zone. Les créatures "incontrôlables" seront transférées. Une créature "morte" ne peut pas être transférée d'un lieu vers un autre.

Fonction(s) connexe(s) :
FiredFromPartyTransition, GetIsPartyTransition, GetTransitionTarget, JumpToLocation, JumpToObject

JumpToLocation(...)

void JumpPartyToArea
(
    location lDestination
)

Paramètres :
- lDestination: La localisation de destination.

Description :
Transfère instantanément l'objet source vers la localisation désignée par lDestination. Cette action est prioritaire par rapport à liste d'action en cours.

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

JumpToObject(...)

void JumpToObject
(
    object oToJumpTo,
    int nWalkStraightLineToPoint = 1
)

Paramètres :
- oToJumpTo : L'objet de destination.
- nWalkStraightLineToPoint : Paramètre inconnu (défaut : 1).

Description :
Transfère instantanément l'objet source vers la l'objet désigné par oToJumpTo. Cette action est prioritaire par rapport à liste d'action en cours.

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

LevelUpHenchman(...)

int LevelUpHenchman
(
    object oCreature,
    int nClass = CLASS_TYPE_INVALID,
    int bReadyAllSpells = FALSE,
    int nPackage = PACKAGE_INVALID
)

Paramètres :
- oCreature : La créature concernée.
- nClass : Constante CLASS_TYPE_* définissant la classe désirée (défaut : CLASS_TYPE_INVALID).
- bReadyAllSpells : Détermine si tous les sorts et capacités spéciales relatives à la classe et au niveau doivent être prêts à être utilisés (défaut : FALSE).
- nPackage : Constante PACKAGE_* désignant l'archétype désiré (défaut : PACKAGE_INVALID).

Description :
Procède à une montée de niveau pour la créature désignée par oCreature. nClass désigne la classe souhaitée dans laquelle la créature doit progresser. Le niveau suivra la configuration définie par l'archétype défini par nPackage, ou suivra l'archétype de la classe par défaut. Mettre la valeur TRUE à bReadyAllSpells permettra à la créature de mémoriser les sorts sans avoir à se reposer. La valeur renvoyée sera le nouveau niveau de la créature. La fonction renverra la valeur 0 en cas d'echec.

Fonction(s) connexe(s) :
GetLevelUpPackage, ResetCreatureLevelForXP, SetUnrestrictedLevelUp

LineOfSightObject(...)

int LineOfSightObject
(
    object oSource,
    object oTarget
)

Paramètres :
- oSource : La première créature de repère.
- oTarget : La seconde créature de repère.

Description :
Détermine s'il y a une ligne de vue directe entre les deux créatures désignées par oSource et oTarget. Cette fonction consomme plus de ressources que la normale (à éviter dans une boucle).

Fonction(s) connexe(s) :
LineOfSightVector

LineOfSightVector(...)

int LineOfSightVector
(
    vector vSource,
    vector vTarget
)

Paramètres :
- vSource : La première position de repère.
- vTarget : La seconde position de repère.

Description :
Détermine s'il y a une ligne de vue directe entre les deux positions désignées par vSource et vTarget. Cette fonction consomme plus de ressources que la normale (à éviter dans une boucle).

Fonction(s) connexe(s) :
LineOfSightObject

LoadGlobalVariables(...)

int LoadGlobalVariables
(
    string sLoadName = ""
)

Paramètres :
- sLoadName : Le nom du fichier XML (seulement le nom, et pas "nom.xml") dans lequel sont sauvegardées des variables globales (défaut : "").

Description :
Charge les variables globales sauvegardées dans le fichier XML désigné par sLoadName (très peu de précisions à travers internet...).

Fonction(s) connexe(s) :
GetGlobal*, SaveGlobalVariables

LoadNewModule(...)

void LoadNewModule
(
    string sModuleName,
    string sWaypoint = ""
)

Paramètres :
- sModuleName : Le nom du module à charger.
- sWaypoint: Le Tag du point de passage de connexion (défaut : "").

Description :
Ferme la partie en cours, et charge le module dont le nom est désigné par sModuleName. Tous les joueurs connectés seront transférés vers le point de passage de ce module, dont le Tag est désigné par sWaypoint. Si aucun point de passage n'est défini, les joueurs seront transférés vers le point de départ. Le statut du module en cours est sauvegardé.

Fonction(s) connexe(s) :
EndGame, StartNewModule

Location(...)

location Location
(
    object oArea,
    vector vPosition,
    float fOrientation
)

Paramètres :
- oArea : Une zone du module.
- vPosition : Une position dans la zone du module.
- fOrientation : Une orientation.

Description :
Crée une nouvelle localisation à partire d'une zone, d'une position et d'une orientation.

Fonction(s) connexe(s) :
Vector

log(...)

float log
(
    float fValue
)

Paramètres :
- fValue : La valeur à convertir.

Description :
Renvoie le résultat du logarithme naturel (ou népérien) de la valeur désignée par fValue. Si fValue est inférieur ou égal à 0, la valeur 0 sera renvoyée.

MagicalEffect(...)

effect MagicalEffect
(
    effect eEffect
)

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

Description :
Convertit l'effet désigné par eEffect en effet de sous-catégorie "magique". Par défaut, si aucune sous-catégorie n'est définie, un effet sera toujours de type "magique". Un effet de type "magique" peut être dissipé par un effet de type "dissipation", et/ou par une phase de repos.

Fonction(s) connexe(s) :
ExtraordinaryEffect, SupernaturalEffect, VersusAlignmentEffect, VersusRacialTypeEffect, VersusTrapEffect

ModifyListBoxRow(...)

void ModifyListBoxRow
(
    object oPlayer,
    string sScreenName,
    string sListBox,
    string sRowName,
    string sTextFields,
    string sTextures,
    string sVariables,
    string sHideUnhide
)

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.
- sRowName : Le nom de la rangée à modifier.
- sTextFields : La liste des champs de texte et des valeurs à insérer.
- sTextures : La liste des éléments de texture à insérer, ainsi que leurs noms.
- sVariables : La liste des index des variables, ainsi que leurs valeurs.
- sHideUnhide : La liste des éléments à masquer ou afficher.

Description :
Modifie une rangée dans une liste d'un élément de l'interface du joueur désigné par oPlayer. La syntaxe à respecter est la suivante :
[nom de l'élément d'interface]=[valeur], excepté pour la variable "sVariables", où l'on utilisera [index]=[valeur].
Les entrées multiples devront être séparées par un point-virgule.
Afin d'affecter le niveau principal du champ, il suffira d'inscrire une entrée commençant directement par le symbole d'égalité.
Exemple 1 : "textfield1= Texte rangée 1;textfield2=Texte rangée 2"; ceci aura pour résultat d'attribuer le texte "Texte rangée 1" pour "textfield1", et "Texte rangée 2" pour "textfield1".
Exemple 2 : "=Texte rangée"; ceci aura pour effet d'attribuer directement le texte "Texte rangée" à la rangée principale.

Le grand vide de l'incompréhension m'envahit.

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

MountObject(...)

void MountObject
(
    object oMountingObject,
    object oObjectToMount
)

Paramètres :
- oMountingObject : La créature concernée.
- oObjectToMount : La monture concernée.

Description :
L'objet désigné par oMountingObject montera sur la monture désignée par oObjectToMount. Fonction sans effet actuellement (mais on rêve... oui oui, on rêve).

Fonction(s) connexe(s) :
DismountObject

MusicBackgroundChangeDay(...)

void MusicBackgroundChangeDay
(
    object oArea,
    int nTrack
)

Paramètres :
- oArea : La zone concernée.
- nTrack : Constante TRACK_* définissant la musique d'ambiance de jour concernée.

Description :
Remplace la musique d'ambiance de jour de la zone désignée par oArea, par celle définie par nTrack.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundChangeNight, MusicBattle*, MusicBattleChange

MusicBackgroundChangeNight(...)

void MusicBackgroundChangeNight
(
    object oArea,
    int nTrack
)

Paramètres :
- oArea : La zone concernée.
- nTrack : Constante TRACK_* définissant la musique d'ambiance de jour concernée.

Description :
Remplace la musique d'ambiance de nuit de la zone désignée par oArea, par celle définie par nTrack.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundChangeDay, MusicBattle*, MusicBattleChange

MusicBackgroundGetBattleTrack(...)

void MusicBackgroundGetBattleTrack
(
    object oArea
)

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

Description :
Renvoie la référence de la musique de combat de la zone désignée par oArea. La valeur renvoyée peut être comparée aux constantes TRACK_*.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundGetDayTrack, MusicBackgroundGetNightTrack, MusicBattle*

MusicBackgroundGetDayTrack(...)

void MusicBackgroundGetDayTrack
(
    object oArea
)

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

Description :
Renvoie la référence de la musique d'ambiance de jour de la zone désignée par oArea. La valeur renvoyée peut être comparée aux constantes TRACK_*.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundGetBattleTrack, MusicBackgroundGetNightTrack, MusicBattle*

MusicBackgroundGetNightTrack(...)

void MusicBackgroundGetNightTrack
(
    object oArea
)

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

Description :
Renvoie la référence de la musique d'ambiance de nuit de la zone désignée par oArea. La valeur renvoyée peut être comparée aux constantes TRACK_*.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundGetBattleTrack, MusicBackgroundGetDayTrack, MusicBattle*

MusicBackgroundPlay(...)

void MusicBackgroundPlay
(
    object oArea
)

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

Description :
Joue la musique d'ambiance de la zone désignée par oArea. La musique jouée dépendra de l'heure du module, et pourra être celle de jour ou de nuit.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundStop, MusicBattle*, MusicBattlePlay

MusicBackgroundSetDelay(...)

void MusicBackgroundSetDelay
(
    object oArea,
    int nDelay
)

Paramètres :
- oArea : La zone concernée.
- nDelay : Délai à attribuer, en millisecondes.

Description :
Remplace la valeur de l'intervalle entre deux musiques d'ambiances par celle définie par nDelai, pour la zone désignée par oArea (Cf. paramètre "Intervalle musique" dans l'éditeur).

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBattle*

MusicBackgroundStop(...)

void MusicBackgroundStop
(
    object oArea
)

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

Description :
Stoppe la lecture de la musique d'ambiance de la zone désignée par oArea.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundPlay, MusicBattle*, MusicBattleStop

MusicBattleChange(...)

void MusicBattleChange
(
    object oArea,
    int nTrack
)

Paramètres :
- oArea : La zone concernée.
- nTrack : Constante TRACK_* définissant la musique d'ambiance de jour concernée.

Description :
Remplace la musique de combat de la zone désignée par oArea, par celle définie par nTrack.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundChangeDay, MusicBackgroundChangeNight, MusicBattle*

MusicBattlePlay(...)

void MusicBattlePlay
(
    object oArea
)

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

Description :
Joue la musique de combat de la zone désignée par oArea.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundPlay, MusicBattle*, MusicBattleStop

MusicBattleStop(...)

void MusicBattleStop
(
    object oArea
)

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

Description :
Stoppe la lecture de la musique de combat de la zone désignée par oArea.

Fonction(s) connexe(s) :
AmbientSound*, MusicBackground*, MusicBackgroundStop, MusicBattle*, MusicBattlePlay

NightToDay(...)

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

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

Description :
Une transition de la nuit au jour 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) :
DayToNight, GetIsNight

NWNXGetFloat(...)

float NWNXGetFloat
(
    string sPlugin,
    string sFunction,
    string sParam1,
    int nParam2
)

Paramètres :
- sPlugin : Le nom du plug-in NWNX.
- sFunction : La commande à exécuter.
- sParam1 : Paramètre dépendant du plugin NWNX utilisé.
- nParam2 : Paramètre dépendant du plugin NWNX utilisé.

Description :
Renvoie une valeur "float" à partir d'une commande NWNX. Vous trouverez plus de détail en explorant [CE SITE].

Fonction(s) connexe(s) :
NWNXGetInt, NWNXGetString, NWNXSetFloat

NWNXGetInt(...)

int NWNXGetInt
(
    string sPlugin,
    string sFunction,
    string sParam1,
    int nParam2
)

Paramètres :
- sPlugin : Le nom du plug-in NWNX.
- sFunction : La commande à exécuter.
- sParam1 : Paramètre dépendant du plugin NWNX utilisé.
- nParam2 : Paramètre dépendant du plugin NWNX utilisé.

Description :
Renvoie une valeur "int" à partir d'une commande NWNX. Vous trouverez plus de détail en explorant [CE SITE].

Fonction(s) connexe(s) :
NWNXGetFloat, NWNXGetString, NWNXSetInt

NWNXGetString(...)

string NWNXGetString
(
    string sPlugin,
    string sFunction,
    string sParam1,
    int nParam2
)

Paramètres :
- sPlugin : Le nom du plug-in NWNX.
- sFunction : La commande à exécuter.
- sParam1 : Paramètre dépendant du plugin NWNX utilisé.
- nParam2 : Paramètre dépendant du plugin NWNX utilisé.

Description :
Renvoie une valeur "string" à partir d'une commande NWNX. Vous trouverez plus de détail en explorant [CE SITE].

Fonction(s) connexe(s) :
NWNXGetFloat, NWNXGetInt, NWNXSetString

NWNXSetFloat(...)

void NWNXSetFloat
(
    string sPlugin,
    string sFunction,
    string sParam1,
    int nParam2,
    float fValue
)

Paramètres :
- sPlugin : Le nom du plug-in NWNX.
- sFunction : La commande à exécuter.
- sParam1 : Paramètre dépendant du plugin NWNX utilisé.
- nParam2 : Paramètre dépendant du plugin NWNX utilisé.
- fValue : La valeur à inscrire.

Description :
Inscrit une valeur "float" à partir d'une commande NWNX. Vous trouverez plus de détail en explorant [CE SITE].

Fonction(s) connexe(s) :
NWNXGetFloat, NWNXSetInt, NWNXSetString

NWNXSetInt(...)

void NWNXSetInt
(
    string sPlugin,
    string sFunction,
    string sParam1,
    int nParam2,
    int nValue
)

Paramètres :
- sPlugin : Le nom du plug-in NWNX.
- sFunction : La commande à exécuter.
- sParam1 : Paramètre dépendant du plugin NWNX utilisé.
- nParam2 : Paramètre dépendant du plugin NWNX utilisé.
- nValue : La valeur à inscrire.

Description :
Inscrit une valeur "int" à partir d'une commande NWNX. Vous trouverez plus de détail en explorant [CE SITE].

Fonction(s) connexe(s) :
NWNXGetInt, NWNXSetFloat, NWNXSetString

NWNXSetString(...)

void NWNXSetString
(
    string sPlugin,
    string sFunction,
    string sParam1,
    int nParam2,
    string sValue
)

Paramètres :
- sPlugin : Le nom du plug-in NWNX.
- sFunction : La commande à exécuter.
- sParam1 : Paramètre dépendant du plugin NWNX utilisé.
- nParam2 : Paramètre dépendant du plugin NWNX utilisé.
- sValue : La valeur à inscrire.

Description :
Inscrit une valeur "string" à partir d'une commande NWNX. Vous trouverez plus de détail en explorant [CE SITE].

Fonction(s) connexe(s) :
NWNXGetString, NWNXSetFloat, NWNXSetInt

ObjectToInt(...)

int ObjectToInt
(
    object oObject
)

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

Description :
Convertit la valeur "object" de l'objet désigné par oObj en valeur de type "int".

Fonction(s) connexe(s) :
IntToObject, ObjectToString

ObjectToString(...)

string ObjectToString
(
    object oObject
)

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

Description :
Convertit la valeur "object" de l'objet désigné par oObj en une chaîne de caractères, sous un format hexadécimal.

Fonction(s) connexe(s) :
ObjectToInt, StringToObject

OpenInventory(...)

void OpenInventory
(
    object oCreature,
    object oPlayer
)

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

Description :
Affiche la fenêtre d'inventaire de la créature désignée par oCreature sur l'interface du joueur désigné par oPlayer. Notez qu'un MD peut voir l'inventaire de toutes les créatures. Un joueur peut avoir accès à l'inventaire d'un compagnon d'arme, d'un familier ou d'un compagnon animal.

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

OpenStore(...)

void OpenStore
(
    object oStore,
    object oPC,
    int nBonusMarkUp = 0,
    int nBonusMarkDown = 0
)

Paramètres :
- oStore : L'échoppe concernée.
- oPC : Le joueur concerné.
- nBonusMarkUp : Le pourcentage ajouté aux prix des items que l'échoppe vend (défaut : 0).
- nBonusMarkDown : Le pourcentage ajouté aux prix des items que l'échoppe achête (défaut : 0).

Description :
Affiche la fenêtre de l'échoppe désignée par oStore sur l'interface du joueur désigné par oPC.

Fonction(s) connexe(s) :
OpenInventory

PackCampaignDatabase(...)

void PackCampaignDatabase
(
    string sCampaignName
)

Paramètres :
- sCampaignName : Le nom de la base de données concernée.

Description :
Supprime toutes les variables ayant un indicateur "Deleted", dans la base de donnée désignée par sCampaignName.

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

PlayAnimation(...)

void PlayAnimation
(
    int nAnimation,
    float fSpeed = 1.0f,
    float fSeconds = 0.0f
)

Paramètres :
- nAnimation : Constante ANIMATION_* désignant l'animation à effectuer.
- fSpeed : Vitesse à laquelle l'animation s'effectuera (défaut : 1.0f).
- fDurationSeconds : Durée pendant laquelle l'animation s'effectuera (défaut : 0.0f).

Description :
L'objet source effectuera instantanément l'animation désignée par nAnimation. Les animations de type "boucle" (ou loop) ne tiendront pas compte du paramètre fSpeed. Les animations préprogrammées (ou fire-and-forget / FNF) ne tiendront pas compte du paramètre fDurationSeconds. Cette action est prioritaire par rapport à liste d'action en cours.

Fonction(s) connexe(s) :
ActionPlayAnimation, PlayCustomAnimation

PlayCustomAnimation(...)

void PlayCustomAnimation
(
    object oObject,
    string sAnimationName,
    int nLooping,
    float fSpeed = 1.0f
)

Paramètres :
- oObject : L'objet concerné.
- sAnimationName : Le nom de du fichier GR2 de l'animation souhaitée.
- nLooping : Détermine si l'animation doit être jouée en boucle.
- fSpeed : Vitesse à laquelle l'animation s'effectuera (défaut : 1.0f).

Description :
L'objet désigné par oObject effectuera instantanément l'animation désignée par sAnimationName. Si fSpeed est une valeur négative, l'animation sera jouée de manière inversée. La valeur FALSE sera renvoyée si le fichier contenant les paramètres de l'animation personnalisée n'a pas pu être trouvée. Cette action est prioritaire par rapport à liste d'action en cours.

Fonction(s) connexe(s) :
ActionPlayAnimation, PlayAnimation

PlaySound(...)

void PlaySound
(
    string sSoundName
)

Paramètres :
- sSoundName : Le nom du son à jouer.

Description :
Joue le son désigné par sSoundName à l'endroit où se trouve l'objet source.

Fonction(s) connexe(s) :
PlaySoundByStrRef, PlayVoiceChat

PlaySoundByStrRef(...)

void PlaySoundByStrRef
(
    int nStrRef,
    int nRunAsAction = TRUE
)

Paramètres :
- nStrRef : La référence du son à jouer.
- nRunAsAction : Détermine si l'objet source doit "jouer" le son en tant qu'action (défaut : TRUE).

Description :
Joue le son référencé par nStrRef à l'endroit où se trouve l'objet source. Si nRunAsAction est égal à FALSE, le son sera joué instantanément.

Fonction(s) connexe(s) :
PlaySound, PlayVoiceChat

PlayVoiceChat(...)

void PlayVoiceChat
(
    int nVoiceChatID,
    object oTarget = OBJECT_SELF
)

Paramètres :
- nVoiceChatID : Constante VOICE_CHAT_* définissant l'emote sonore à jouer.
- oTarget : L'objet concerné.

Description :
L'objet désigné par oTarget jouera le son de l'emote défini par nVoiceChatID.

Fonction(s) connexe(s) :
PlaySound, PlaySoundByStrRef

PopUpDeathGUIPanel(...)

void PopUpDeathGUIPanel
(
    object oPC,
    int bRespawnButtonEnabled = TRUE,
    int bWaitForHelpButtonEnabled = TRUE,
    int nHelpStringReference = 0,
    string sHelpString = ""
)

Paramètres :
- oPC : Le joueur concerné.
- bRespawnButtonEnabled : Détermine si le bouton "Respawn" est activé (défaut : TRUE).
- bWaitForHelpButtonEnabled : Détermine si le bouton "Attendre de l'aide" est activé (défaut : TRUE).
- nHelpStringReference : La référence TLK du texte d'appel à l'aide que le joueur enverra (défaut : 0).
- sHelpString : Le texte d'appel à l'aide que le joueur enverra (défaut : "").

Description :
Fait apparaître la fenêtre de "mort" sur l'interface du joueur désigné par oPC. Cette fenêtre peut être affichée par la fonction "PopUpGUIPanel(...)", mais cette dernière ne permet pas la désactivation des boutons "Respawn" et "Attendre de l'aide".

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

PopUpGUIPanel(...)

void PopUpGUIPanel
(
    object oPC,
    int nGUIPanel
)

Paramètres :
- oPC : Le joueur concerné.
- nGUIPanel : Constante GUI_PANEL_* définissant la fenêtre à afficher.

Description :
Fait apparaître la fenêtre définie par nGUIPanel sur l'interface du joueur désigné par oPC.

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

pow(...)

float pow
(
    float fValue,
    float fExponent
)

Paramètres :
- fValue : La valeur initiale.
- fExponent : L'exposant.

Description :
Renvoie le résultat de la valeur définie par fValue, élevée à l'exposant défini par fExponent.

Fonction(s) connexe(s) :
sqrt

PrintFloat(...)

void PrintFloat
(
    float fFloat,
    int nWidth = 18,
    int nDecimals = 9
)

Paramètres :
- fFloat : La valeur concernée.
- nWidth : Le nombre de chiffres avant la virgule (défaut : 18).
- nDecimals : Le nombre de chiffres après la virgule (défaut : 9).

Description :
Inscrit la valeur "float" désignée par fFloat, dans le fichier log. Dépend du paramètre "[Server Options]Scripts Print To LoG" du fichier nwnplayer.ini.

Fonction(s) connexe(s) :
PrintInteger, PrintObject, PrintString, PrintVector, WriteTimestampedLogEntry

PrintInteger(...)

void PrintInteger
(
    int nInteger
)

Paramètres :
- nInteger : La valeur concernée.

Description :
Inscrit la valeur "int" désignée par nInteger, dans le fichier log. Dépend du paramètre "[Server Options]Scripts Print To Log" du fichier nwnplayer.ini.

Fonction(s) connexe(s) :
PrintFloat, PrintObject, PrintString, PrintVector, WriteTimestampedLogEntry

PrintObject(...)

void PrintObject
(
    object oObject
)

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

Description :
Inscrit l'identifiant de l'objet désigné par oObject, dans le fichier log. Dépend du paramètre "[Server Options]Scripts Print To Log" du fichier nwnplayer.ini.

Fonction(s) connexe(s) :
PrintFloat, PrintInteger, PrintString, PrintVector, WriteTimestampedLogEntry

PrintString(...)

void PrintString
(
    string sString
)

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

Description :
Inscrit la chaîne de caractères désignée par oObject, dans le fichier log. Dépend du paramètre "[Server Options]Scripts Print To Log" du fichier nwnplayer.ini.

Fonction(s) connexe(s) :
PrintFloat, PrintInteger, PrintObject, PrintVector, WriteTimestampedLogEntry

PrintVector(...)

void PrintVector
(
    vector vVector,
    int bPrepend
)

Paramètres :
- vVector : Le vecteur concerné.
- bPrepend : Détermine si la valeur doit être précédée par "PRINTVECTOR:".

Description :
Inscrit le vecteur désigné par vVector, dans le fichier log. Dépend du paramètre "[Server Options]Scripts Print To Log" du fichier nwnplayer.ini.

Fonction(s) connexe(s) :
PrintFloat, PrintInteger, PrintObject, PrintString, WriteTimestampedLogEntry

Random(...)

int Random
(
    int nMaxInteger
)

Paramètres :
- nMaxInteger : La valeur maximum à renvoyer.

Description :
Renvoie une valeur calculée aléatoirement, entre 0 et la valeur définie par nMaxInteger moins 1.

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

RandomName()

string RandomName()

Description :
Génére et renvoie un nom aléatoire.

RecallCreatureFromLimboToLocation(...)

void RecallCreatureFromLimboToLocation
(
    object oCreature,
    location lLoc
)

Paramètres :
- oCreature : La créature concernée.
- lLoc : La localisation de destination.

Description :
Envoie la créature située dans les limbes, et désignée par oCreature, à la localisation définie par lLoc. oCreature DOIT désigner une créature, et cette créature DOIT se trouver dans les limbes.

Fonction(s) connexe(s) :
SendCreatureToLimbo

RecomputeStaticLighting(...)

void RecomputeStaticLighting
(
    object oArea
)

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

Description :
Met à jour les informations des lumières statiques de la zone désignée par oArea, pour tous les joueurs présents dans cette zone. Cette fonction peut être utile lors du paramétrage en jeu des lumières de la zone, ou si des plaçables "illuminés" ont été créés/supprimés.

Fonction(s) connexe(s) :
SetPlaceableIllumination, SetTileMainLightColor, SetTileSourceLightColor

ReflexSave(...)

int ReflexSave
(
    object oCreature,
    int nDC,
    int nSaveType = SAVING_THROW_TYPE_NONE,
    int oSaveVersus = OBJECT_SELF
)

Paramètres :
- oCreature : La créature devant effectuer le jet de sauvegarde.
- nDC : Le seuil de difficulté du jet de sauvegarde.
- nSaveType : Constante SAVING_THROW_TYPE_* définissant le type de sauvegarde à exécuter.
- oSaveVersus : La créature opposée au jet de sauvegarde (défaut : OBJECT_SELF).

Description :
La créature désignée par oCreature effectuera un jet de réflexes selon les paramètres imposés. La fonction renverra la valeur 0 si le jet est un echec, 1 si le jet est réussi, ou 2 si la créature bénéficie d'une immunité face au type de sauvegarde demandé. Si le jet de sauvegarde doit être effectué par rapport à une zone d'effet, oSaveVersus devra absolument être désigné grâce à la fonction "GetAreaOfEffectCreator(...)". La valeur renvoyée peut être comparé aux constantes SAVING_THROW_CHECK_*.

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

RefreshSpellEffectDurations(...)

void RefreshSpellEffectDurations
(
    object oTarget,
    int nSpellId,
    float fDuration
)

Paramètres :
- oTarget : L'objet concerné.
- nSpellId : Constante SPELL_* définissant le sort concerné.
- fDuration : La nouvelle durée à appliquer (?).

Description :
La durée des effets du sort défini par nSpellID, et actifs sur l'objet désigné par oTarget, sera réinitialisée (ou remplacée par la durée fDuration ?).

Fonction(s) connexe(s) :
GetHasSpellEffect

RemoveEffect(...)

void RemoveEffect
(
    object oCreature,
    effect eEffect
)

Paramètres :
- oCreature : La créature concernée.
- eEffect : L'effet concerné.

Description :
L'effet désigné par eEffect, et actif sur la créature désignée par oCreature, sera supprimé.

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

RemoveFromParty(...)

void RemoveFromParty
(
    object oPC
)

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

Description :
Le joueur désigné par oPC sera retiré du groupe auquel il appartient. Cette fonction ne s'applique qu'aux joueurs.

Fonction(s) connexe(s) :
AddToParty, RemoveRosterMemberFromParty

RemoveHenchman(...)

void RemoveHenchman
(
    object oMaster,
    object oHenchman = OBJECT_SELF,
)

Paramètres :
- oMaster : La créature à laquelle le compagnon d'arme est rattaché.
- oHenchman : Le compagnon d'armes concerné (défaut : OBJECT_SELF).

Description :
Retire le compagnon d'arme désigné par oHenchman du service de oMaster, le rattachant à sa faction d'origine.

Fonction(s) connexe(s) :
AddHenchman, RemoveSummonedAssociate

RemoveItemProperty(...)

void RemoveItemProperty
(
    object oItem,
    itemproperty ipProperty
)

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

Description :
La propriété d'item désignée par ipProperty sera retirée de l'item désigné par oItem.

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

RemoveJournalQuestEntry(...)

void RemoveJournalQuestEntry
(
    string szPlotID,
    object oCreature,
    int bAllPartyMembers = TRUE,
    int bAllPlayers = FALSE
)

Paramètres :
- szPlotID : Le Tag de la quête concernée.
- oCreature : Le joueur dont le journal de quête sera mis à jour.
- bAllPartyMembers : Détermine si le journal doit être mis à jour pour tous les membres du groupe de oCreature (défaut : TRUE).
- bAllPlayers : Détermine si le journal doit être mis à jour pour tous les joueur du module (défaut : FALSE).

Description :
La quête dont le tag est défini par szPlotID sera retirée du journal du joueur désigné par oCreature.

Fonction(s) connexe(s) :
AddJournalQuestEntry, GetJournalEntry

RemoveListBoxRow(...)

void RemoveListBoxRow
(
    object oPlayer,
    string sScreenName,
    string sListBox,
    string sRowName
)

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.
- sRowName : Le nom de la rangée à supprimer.

Description :
Supprime une rangée dans une liste d'un élément de l'interface du joueur désigné par oPlayer.

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

RemoveRosterMember(...)

int RemoveRosterMember
(
    string sRosterName
)

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

Description :
Le compagnon dont le nom est défini par sRosterName sera retiré de la "liste des compagnons". La valeur FALSE sera renvoyée si le nom ne correspond à aucun compagnon existant.

Fonction(s) connexe(s) :
AddRosterMemberByCharacter, AddRosterMemberByTemplate, GetFirstRosterMember, GetNextRosterMember

RemoveRosterMemberFromParty(...)

void RemoveRosterMemberFromParty
(
    string sRosterName,
    object oPC,
    int bDespawnNPC = TRUE
)

Paramètres :
- sRosterName : Le nom du compagnon concerné.
- oPC : Un joueur du groupe concerné.
- bDespawnNPC : Détermine si le compagnon doit être retiré de la partie (défaut : TRUE).

Description :
Le compagnon dont le nom est défini par sRosterName sera retiré du groupe auquel appartient le joueur désigné par oPlayer. Si le paramètre bDespawnNPC est égal à TRUE, l'état du compagnon ne sera pas sauvegardé. Pour effectuer une sauvegarde du compagnon, il faudra utiliser la valeur FALSE et faire suivre la fonction "DespawnRosterMember(...)".

Fonction(s) connexe(s) :
AddRosterMemberToParty, RemoveFromParty

RemoveSEFFromObject(...)

void RemoveSEFFromObject
(
    object oObject,
    string sSEFName
)

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

Description :
Retire un effet spécial issu d'un fichier spécifique, de l'objet désigné par oObject. A partir du moment où un objet ne devrait avoir qu'un seul effet spécial issu du même fichier, cette fonction retire tout effet provenant de ce fichier.

Fonction(s) connexe(s) :
EffectNWN2ParticleEffectFile, EffectNWN2SpecialEffectFile

RemoveSummonedAssociate(...)

void RemoveSummonedAssociate
(
    object oMaster,
    object oAssociate = OBJECT_SELF
)

Paramètres :
- oMaster : La créature à laquelle oAssociate est rattaché.
- oAssociate : La créature concernée (défaut : OBJECT_SELF).

Description :
Retire la créature désignée par oAssociate du service de oMaster, et la rattache à sa faction d'origine.

Fonction(s) connexe(s) :
EffectSummonCreature, EffectSwarm, RemoveHenchman

ResetCreatureLevelForXP(...)

void ResetCreatureLevelForXP
(
    object oTargetCreature,
    int nExperience,
    int bUseXPMods
)

Paramètres :
- oTargetCreature : La créature concernée.
- nExperience : Le montant d'expérience désiré.
- bUseXPMods : Détermine si un modificateur d'expérience doit être appliqué avant d'attribuer l'expérience.

Description :
Le niveau de la créature désignée par oTargetCreature sera mis à 0, et le montant d'expérience défini par nExperience lui sera attribué. La créature montera automatiquement au niveau correspondant à l'expérience définie, en utilisant l'archétype défini dans ses propriétés.

Fonction(s) connexe(s) :
LevelUpHenchman

ResetFeatUses(...)

void ResetFeatUses
(
    object oCreature,
    int nFeatID,
    int bResetDailyUses,
    int bResetLastUseTime
)

Paramètres :
- oCreature : La créature concernée.
- nFeatID : Constante FEAT_* définissant le don concerné.
- bResetDailyUses : Détermine si la mise à jour doit affecter le nombre d'utilisations par jour.
- bResetLastUseTime : Détermine si la mise à jour doit affecter le temps d'attente entre deux utilisations.

Description :
Le don défini par nFeatID sera réinitialisé pour la créature désignée par oCreature.

Fonction(s) connexe(s) :
DecrementRemainingFeatUses, GetHasFeat, IncrementRemainingFeatUses

ResetNWN2Fog(...)

void ResetNWN2Fog
(
    object oTarget,
    int nFogType
)

Paramètres :
- oTarget : L'objet concerné.
- nFogType : Constante FOG_TYPE_* définissant le type de brouillard concerné.

Description :
Cette fonction doit probablement réinitialiser le brouillard, en utilisant les valeurs d'origine (Aucune description...).

Fonction(s) connexe(s) :
SetFog, SetNWN2Fog

ResistSpell(...)

int ResistSpell
(
    object oCaster,
    object oTarget
)

Paramètres :
- oCaster : Le lanceur de sorts concerné.
- oTarget : La cible du lanceur de sorts.

Description :
Effectue un test de resistance basé sur les caractéristiques de la créature désignée par oCaster, face à la résistance magique de l'objet désigné par oTarget. Le jet de résistance est représenté par 1d20, plus le niveau du lanceur de sorts, auquel se rajoutent d'éventuels dons. La valeur renvoyée sera égale à 0 si les deux objets ne sont pas valides, à -1 si le sort lancé ne correspond pas à un sort "de joueur", à 1 si le test est un échec, à 2 si oTarget bénéficie d'une immunité magique, et à 3 si le sort a été "absorbé". Cette fonction s'utilise en général dans un script de sorts.

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

RestoreBaseAttackBonus(...)

void RestoreBaseAttackBonus
(
    object oCreature = OBJECT_SELF
)

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

Description :
Remet le nombre d'attaques de base de la créature désignée par oCreature à son état d'origine.

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

RestoreCameraFacing()

void RestoreCameraFacing()

Description :
Remet le mode de caméra à l'état où il était lorsque la fonction "StoreCameraFacing()" a été utilisée. Cette fonction ne peut être utilisée qu'une seule fois, en retour à la fonction "StoreCameraFacing()".

Fonction(s) connexe(s) :
SetCameraFacing, StoreCameraFacing

RetrieveCampaignObject(...)

string RetrieveCampaignObject
(
    string sCampaignName,
    string sVarName,
    location locLocation,
    object oOwner = OBJECT_INVALID,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : Le nom de la base de données à consulter.
- sVarName : Le nom de la variable à consulter.
- locLocation : La localisation où intégrer l'objet si oOwner n'est pas défini.
- oOwner : Le nouveau possesseur de l'objet si locLocation n'est pas défini (défaut : OBJECT_INVALID).
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Met en jeu l'objet dont la valeur "object" a été stocké dans la variable définie par sVarName, et 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. Si oOwner est un objet et qu'un item est remis en jeu, cet item sera transféré dans l'inventaire de oOwner. Si oOwner n'a pas d'inventaire, ou que l'objet remis en jeu n'est pas un item, cet objet sera créé à la localisation où se trouve oOwner. 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, GetCampaignLocation, GetCampaignString, GetCampaignVector, StoreCampaignObject

RoundsToSeconds(...)

float RoundsToSeconds
(
    int nRounds
)

Paramètres :
- nRounds : Le nombre de rounds à convertir.

Description :
Convertit le nombre de rounds défini par nRounds en secondes.

Fonction(s) connexe(s) :
HoursToSeconds, TurnsToSeconds

LISTE DES FONCTIONS

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