NWScript - Fonctions S (... fin)

SetLevelUpPackage(...)

void SetLevelUpPackage
(
    object oCreature,
    int nPackage
)

Paramètres :
- oCreature : La créature concernée.
- nPackage : Constante PACKAGE_* définissant l'archétype à attribuer.

Description :
Attribue un archétype à la créature désignée par oCreature. Cet archetype sera utilisé les prochaines fois où la créature montera en niveau. Ne s'applique pas aux joueurs. Les archétypes peuvent être consultés dans le fichier packages.2da.

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

SetLightActive(...)

void SetLightActive
(
    object oLight,
    int bActive
)

Paramètres :
- oLight : La lumière placée concernée.
- bActive : Détermine si la lumière doit être activée ou désactivée (respectivement "TRUE" ou "FALSE").

Description :
Active/désactive la lumière désignée par oLight.

SetListBoxRowSelected(...)

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

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de l'élément d'interface concerné.
- sListBox : Le nom de la liste concernée.
- sRowName : Le nom de la ligne concernée.

Description :
Désigne une ligne dans la liste d'un élément de l'interface du joueur désigné par oPlayer, et la définit comme étant "sélectionnée".

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

SetListening(...)

void SetListening
(
    object oObject,
    int bValue
)

Paramètres :
- oObject : L'objet concerné.
- bValue : Détermine si l'objet doit être en mode "écoute" ou non.

Description :
Active/désactive le mode "écoute" de l'objet défini par oObject.

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

SetListenPattern(...)

void SetListenPattern
(
    object oObject,
    string sPattern,
    int nNumber = 0
)

Paramètres :
- oObject : L'objet concerné.
- sPattern : La chaîne de caractère à indexer.
- nNumber : Le numéro d'indexation à attribuer.

Description :
Indexe la chaîne de caractère définie par sPattern, pour oObject. Cette fonction n'active pas le mode "écoute", pour lequel il faudra utiliser la fonction "SetListening(...)".

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

SetLocalFloat(...)

void SetLocalFloat
(
    object oObject,
    string sVarName,
    float fValue
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable à modifier/inscrire.
- fValue : La valeur à inscrire.

Description :
Inscrit/modifie une variable locale de type "float" sur l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalFloat, SetLocalInt, SetLocalLocation, SetLocalObject, SetLocalString

SetLocalGUIVariable(...)

void SetLocalGUIVariable
(
    object oPlayer,
    string sScreenName,
    int nVarIndex,
    string sVarValue
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de le la fenêtre concernée.
- nVarIndex : L'index de la variable à modifier.
- sVarValue : La valeur à inscrire.

Description :
Modifie la valeur "string" d'une variable locale sur une fenêtre de l'interface du joueur désigné par oPlayer.

Fonction(s) connexe(s) :
SetGUIObjectDisabled, SetGUIObjectHidden, SetGUIObjectText, SetGUIProgressBarPosition, SetGUITexture

SetLocalInt(...)

void SetLocalInt
(
    object oObject,
    string sVarName,
    int nValue
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable à modifier/inscrire.
- nValue : La valeur à inscrire.

Description :
Inscrit/modifie une variable locale de type "int" sur l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalInt, SetLocalFloat, SetLocalLocation, SetLocalObject, SetLocalString

SetLocalLocation(...)

void SetLocalLocation
(
    object oObject,
    string sVarName,
    location lValue
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable à modifier/inscrire.
- lValue : La valeur à inscrire.

Description :
Inscrit/modifie une variable locale de type "location" sur l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalLocation, SetLocalFloat, SetLocalInt, SetLocalObject, SetLocalString

SetLocalObject(...)

void SetLocalObject
(
    object oObject,
    string sVarName,
    object oValue
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable à modifier/inscrire.
- oValue : La valeur à inscrire.

Description :
Inscrit/modifie une variable locale de type "object" sur l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalObject, SetLocalFloat, SetLocalInt, SetLocalLocation, SetLocalString

SetLocalString(...)

void SetLocalString
(
    object oObject,
    string sVarName,
    string sValue
)

Paramètres :
- oObject : L'objet concerné.
- sVarName : Le nom de la variable à modifier/inscrire.
- sValue : La valeur à inscrire.

Description :
Inscrit/modifie une variable locale de type "string" sur l'objet désigné par oObject.

Fonction(s) connexe(s) :
GetLocalString, SetLocalFloat, SetLocalInt, SetLocalLocation, SetLocalObject

SetLocked(...)

void SetLocked
(
    object oTarget,
    int bLocked
)

Paramètres :
- oTarget : L'objet concerné.
- bLocked : Détermine si l'objet doit être verrouillé/déverrouillé.

Description :
Verrouille/déverrouille l'objet désigné par oTarget (Cf. paramètre "Verrouillée" dans l'éditeur). La valeur TRUE verrouillera l'objet. Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLocked, SetLock*

SetLockKeyRequired(...)

void SetLockKeyRequired
(
    object oObject,
    int nKeyRequired = TRUE
)

Paramètres :
- oObject : L'objet concerné.
- nKeyRequired : Détermine si une clé est nécessaire ou non (défaut : TRUE).

Description :
Définit si une clé est nécessaire ou non, pour déverrouiller l'objet désigné par oObject (Cf. paramètre "KeyRequired" dans l'éditeur). La valeur TRUE signifiera qu'une clé est nécessaire. Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLockKeyRequired, SetLock*

SetLockKeyTag(...)

void SetLockKeyTag
(
    object oObject,
    string sKeyTag
)

Paramètres :
- oObject : L'objet concerné.
- sKeyTag : Le Tag de la clé à attribuer.

Description :
Attribue une clé dont le Tag est défini par sKeyTag à l'objet défini par oObject (Cf. paramètre "KeyName" dans l'éditeur). Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLockKeyTag, SetLock*

SetLockLockable(...)

void SetLockLockable
(
    object oObject,
    int nLockable = TRUE
)

Paramètres :
- oObject : L'objet concerné.
- nLockable : Détermine si l'objet peut être verrouillé (défaut : TRUE).

Description :
Définit si l'objet désigné par oObject peut être verrouillé ou non (Cf. paramètre "Verrouillable" dans l'éditeur). La valeur TRUE signifiera que l'objet est verrouillable. Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLockLockable, SetLock*

SetLockLockDC(...)

void SetLockLockDC
(
    object oObject,
    int nNewLockDC
)

Paramètres :
- oObject : L'objet concerné.
- nNewLockDC: Le seuil de difficulté à attribuer.

Description :
Attribue un seuil de difficulté pour le verrouillage de l'objet désigné par oObject (Cf. paramètre "DD verrouillage" dans l'éditeur). Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLockLockDC, SetLock*

SetLockUnlockDC(...)

void SetLockUnlockDC
(
    object oObject,
    int nNewLockDC
)

Paramètres :
- oObject : L'objet concerné.
- nNewLockDC: Le seuil de difficulté à attribuer.

Description :
Attribue un seuil de difficulté pour le déverrouillage de l'objet désigné par oObject (Cf. paramètre "DD déverrouillage" dans l'éditeur). Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetLockUnlockDC, SetLock*

SetLookAtTarget(...)

void SetLookAtTarget
(
    object oObject,
    vector vTarget,
    int nType = 0
)

Paramètres :
- oObject : L'objet concerné.
- vTarget : La position ciblée.
- nType : Destiné à un usage futur (défaut : 0).

Description :
Cette fonction, destinée principalement aux problèmes lors des cinématiques, permet à une créature de fixer un point précis et de le considérer comme "visible".

SetLootable(...)

void SetLootable
(
    object oCreature,
    int bLootable
)

Paramètres :
- oCreature : L'objet concerné.
- bLootable : Détermine si la créature sera détroussable ou non.

Description :
Définit si la créature désignée par oCreature sera détroussable à sa mort, ou pas (Cf. paramètre "Corps détroussable" dans l'éditeur). La valeur TRUE rend la créature détroussable. Ne s'applique ni aux joueurs, ni aux créatures mortes.

Fonction(s) connexe(s) :
GetLootable

SetMapPinEnabled(...)

void SetMapPinEnabled
(
    object oMapPin,
    int nEnabled
)

Paramètres :
- oMapPin : Le point de passage concerné.
- nEnabled : Détermine si la note carte doit être activée/désactivée.

Description :
Active/désactive la note carte du point de passage désigné par oMapPin (Cf. paramètre "A une indication carte ?" dans l'éditeur). La valeur TRUE active la note carte.

SetMaxHenchmen(...)

void SetMaxHenchmen
(
    int nNumHenchmen
)

Paramètres :
- nNumHenchmen : La valeur à attribuer.

Description :
Définit le nombre de compagnons d'arme qu'un joueur peut avoir sous ses ordres.

Fonction(s) connexe(s) :
GetMaxHitPoints

SetModuleXPScale(...)

void SetModuleXPScale
(
    int nXPScale
)

Paramètres :
- nXPScale : La valeur à attribuer.

Description :
Définit le facteur d'expérience du module. La valeur de nXPScale doit être comprise entre 0 et 200.

Fonction(s) connexe(s) :
GetModuleXPScale

SetMovementRateFactor(...)

void SetMovementRateFactor
(
    object oCreature,
    float fFactor
)

Paramètres :
- oCreature : La créature à affecter.
- fFactor : Le facteur de vitesse à attribuer.

Description :
Définit un nouveau facteur de vitesse pour la créature désignée par oCreature. Cette nouvelle valeur est ainsi prise en compte lors d'une modification de la vitesse due à un effet, à l'encombrement, etc.

Fonction(s) connexe(s) :
GetMovementRateFactor

SetNoticeText(...)

void SetNoticeText
(
    object oPlayer,
    string sText
)

Paramètres :
- oPlayer : Le joueur concerné.
- sText : Le texte à afficher, ne doit pas être une chaîne de caractères vide.

Description :
Affiche une chaîne de caractères dans la fenêtre de notification de l'interface du joueur désigné par oPlayer. Une fenêtre de notification peut être n'importe quel zone de texte comportant un paramètre "UIText_OnUpdate_DisplayNoticeText()" actif (si ça peut vous aider : par défaut, le jeu utilise cette zone pour afficher l'état d'une quête).

Fonction(s) connexe(s) :
FloatingTextStringOnCreature, SendMessageToPC

SetNWN2Fog(...)

void SetNWN2Fog
(
    object oTarget,
    int nFogType,
    int nColor,
    float fFogStart,
    float fFogEnd,
    float fFarClipPlaneDistance
)

Paramètres :
- oTarget : L'objet concerné.
- nFogType : Constante FOG_TYPE_NWN2_* définissant le type de brouillard à modifier.
- nColor : Constante FOG_COLOR_* définissant la couleur à attribuer.
- fFogStart : La distance de départ du brouillard.
- fFogEnd : La distance de fin du brouillard (et où il atteint la couleur).
- fFarClipPlaneDistance : La distance à laquelle le terrain n'est plus affiché.

Description :
Modifie les paramètres du brouillard. Si oTarget désigne le module, toutes les zones seront affectées. Si oTarget désigne une zone, seule cette zone sera affectée. nColor peut être une valeur numérique (équivalent au nombre hexadécimal que représente les valeurs RGB).

Oui, "SetFog(...)" fait exactement la même chose, mais en moins bien... Donc cette fonction est mieux.

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

SetOrientOnDialog(...)

void SetOrientOnDialog
(
    object oCreature,
    int bActive
)

Paramètres :
- oCreature : La créature concernée.
- bActive : Détermine si la créature doit changer d'orientation ou non.

Description :
Définit si la créature désignée par oCreature changera automatiquement d'orientation lors d'une discussion. La valeur TRUE permettra à oCreature de faire face à l'interlocuteur d'une discussion. Ne s'applique qu'aux créatures, bien entendu.

SetOwnersControlledCompanion(...)

void SetOwnersControlledCompanion
(
    object oCurrentCreature,
    object oTargetCreature = OBJECT_INVALID
)

Paramètres :
- oCurrentCreature : La créature concernée.
- oTargetCreature : La créature à contrôler (défaut : OBJECT_INVALID).

Description :
Transfère le contrôle d'un joueur de oCurrentCreature vers oTargetCreature. Si oTargetCreature est égal à OBJECT_INVALID, le joueur reprendra le contrôle de son personnage principal. La valeur "object" de la créature à laquelle le joueur a été rattaché sera renvoyée. Si oCurrentCreature n'était pas sous le contrôle d'un joueur, la valeur OBJECT_INVALID sera renvoyée.

Fonction(s) connexe(s) :
GetIsOwnedByPlayer

SetPanelButtonFlash(...)

void SetPanelButtonFlash
(
    object oPlayer,
    int nButton,
    int nEnableFlash
)

Paramètres :
- oPlayer : Le joueur concerné.
- nButton : Constante PANEL_BUTTON_* définissant le bouton d'interface concerné.
- nEnableFlash : Détermine si le bouton doit s'illuminer ou s'éteindre.

Description :
Illumine/éteint un bouton de l'interface du joueur désigné par oPlayer. La valeur TRUE illuminera un bouton.

SetPause(...)

int SetPause
(
    int bState
)

Paramètre :
- bState : Détermine si la pause doit être activée ou non.

Description :
Active ou désactive la pause. Les joueurs connectés à un serveur pourront utiliser cette fonction si les paramètres du serveur les y autorisent.

Fonction(s) connexe(s) :
GetPause

SetPCDislike(...)

void SetPCDislike
(
    object oPlayer,
    object oTarget
)

Paramètres :
- oPlayer : Le joueur concerné.
- oTarget : La créature cible.

Description :
Le joueur désigné par oPlayer considèrera l'objet désigné par oTarget comme hostile.

Fonction(s) connexe(s) :
SetPCLike

SetPCLike(...)

void SetPCLike
(
    object oPlayer,
    object oTarget
)

Paramètres :
- oPlayer : Le joueur concerné.
- oTarget : La créature cible.

Description :
Le joueur désigné par oPlayer considèrera l'objet désigné par oTarget comme alliée.

Fonction(s) connexe(s) :
SetPCDislike

SetPickpocketableFlag(...)

void SetPickpocketableFlag
(
    object oItem,
    int bPickpocketable
)

Paramètres :
- oItem : L'item concerné.
- bPickpocketable : Détermine si l'item peut être volé ou non.

Description :
Définit si l'item désigné par oItem peut être volé lors d'une action d'escamotage (Cf. paramètre "Vol possible ?" dans l'éditeur). La valeur TRUE signifiera que l'item peut être volé.

Fonction(s) connexe(s) :
GetPickpocketableFlag

SetPlaceableIllumination(...)

void SetPlaceableIllumination
(
    object oPlaceable = OBJECT_SELF,
    int bIlluminate = TRUE
)

Paramètres :
- oPlaceable : Le plaçable concerné (défaut : OBJECT_SELF).
- bIlluminate : Détermine si l'illumination doit être activée/désactivée (défaut : TRUE).

Description :
Active/désactive l'illumination du plaçable désigné par oPlaceable. La valeur TRUE activera l'illumination. Pour prendre en compte l'éclairage et les ombres pouvant être générées, il faudra utiliser la fonction "RecomputeStaticLighting(...)" pour la zone concernée. Comme cette fonction consomme plus de ressources que la normale, il est préférable de modifier un maximum de plaçables avant de l'utiliser.

Fonction(s) connexe(s) :
GetPlaceableIllumination, RecomputeStaticLighting

SetPlayerGUIHidden(...)

void SetPlayerGUIHidden
(
    object oPlayer,
    int bHidden
)

Paramètres :
- oPlayer : Le joueur concerné.
- bHidden : Détermine si l'interface doit être masquée/affichée.

Description :
Masque/affiche l'interface du joueur désigné par oPlayer. La valeur TRUE masquera l'interface. Si le joueur appuie sur la touche "echap" (esc) l'interface sera automatiquement affichée. Le joueur dont l'interface est masquée pourra toujours voir les textes flottants.

Fonction(s) connexe(s) :
SetGUIObjectHidden

SetPlotFlag(...)

void SetPlotFlag
(
    object oTarget,
    int nPlotFlag
)

Paramètres :
- oTarget : L'objet concerné.
- nPlotFlag : Détermine si l'objet doit faire partie de l'intrigue ou non.

Description :
Définit si l'objet désigné par oTarget doit faire partie de l'intrigue, ou pas. La valeur TRUE fera de l'objet une partie de l'intrigue. Un tel objet ne peut pas être endommagé, détruit, vendu, etc.

Fonction(s) connexe(s) :
GetPlotFlag

SetReflexSavingThrow(...)

void SetReflexSavingThrow
(
    object oObject,
    int nNewReflexSave
)

Paramètres :
- oObject : L'objet concerné.
- nNewReflexSave : La valeur à attribuer.

Description :
Remplace la valeur de "réflèxes" de l'objet désigné (Cf. paramètre "Jet de Réflexes" dans l'éditeur). nNewReflexSave doit être une valeur comprise entre 0 et 250. Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetReflexSavingThrow, SetFortitudeSavingThrow, SetWillSavingThrow

SetRenderWaterInArea(...)

void SetRenderWaterInArea
(
    object oArea,
    int bRender
)

Paramètres :
- oArea : La zone concernée.
- bRender : Détermine si les effets de l'eau doivent être activés/désactivés.

Description :
Active/désactive les effets de l'eau dans la zone désignée par oArea. La valeur TRUE activera les effets de l'eau.

SetRosterNPCPartyLimit(...)

void SetRosterNPCPartyLimit
(
    int nLimit
)

Paramètres :
- nLimit : La valeur à attribuer.

Description :
Définit le nombre de membres de la "liste des compagnons" pouvant être intégrés dans un groupe, à partir de la fenêtre de sélection du groupe. Ce nombre est égal à 3 par défaut, et ne peut être modifié que par cette fonction.

Fonction(s) connexe(s) :
GetRosterNPCPartyLimit

SetScale(...)

void SetScale
(
    object oObject,
    float fX,
    float fY,
    float fZ
)

Paramètres :
- oObject : L'objet concerné.
- fX : Largeur.
- fY : Longueur.
- fZ : Hauteur.

Description :
Modifie l'échelle de l'objet désigné par oObject. Cette fonction n'applique pas un effet comme le ferait la fonction "EffectSetScale(...)", mais change l'échelle de base de l'objet ciblé. Si l'objet ciblé a déjà subi une modification à l'aide de la fonction "SetScale(...)", le résultat final sera probablement légèrement différent que celui espéré.

Fonction(s) connexe(s) :
GetScale, EffectSetScale

SetScriptHidden(...)

void SetScriptHidden
(
    object oCreature,
    int bHidden,
    int bDisableUI = TRUE
)

Paramètres :
- oCreature : La créature concernée.
- bHidden : Détermine si les scripts doivent être désactivés/activés.
- bDisableUI : Détermine si l'intelligence artificielle doit être désactivée (défaut : TRUE).

Description :
Active/désactive l'utilisation des scripts pour la créature définie par oCreature. La valeur TRUE désactivera les scripts. De surcroît, une telle créature ne s'affichera pas, ne sera pas sujette aux collisions, et ne pourra pas être sélectionnée par un joueur. Activer les scripts rendra également à la créature son état initial.

Fonction(s) connexe(s) :
GetScriptHidden

SetScrollBarRanges(...)

void SetScrollBarRanges
(
    object oPlayer,
    string sScreenName,
    string sScrollBarName,
    int nMinSize,
    int nMaxSize,
    int nMinValue,
    int nMaxValue
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de l'élément d'interface concerné, comportant une barre de progression.
- sScrollBarName : Le nom d'interface de la barre de progression.
- nMinSize / nMaxSize : Détermine nombre d'étapes que la barre de progression comporte.
- nMinValue / nMaxValue : Détermine ce que le pourcentage de la progression de la barre représente en terme de valeur.

Description :
Définit la portée d'une barre de progression spécifique, sur l'interface du joueur désigné par oPlayer. Utiliser la valeur -1 pour l'un des paramètres conservera sa valeur actuelle. Afin de fonctionner correctment, l'élément d'interface comportant la barre de progression doit aussi comporter le paramètre "ScriptLoadable=true" dans la section <UIScene>.

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

SetScrollBarValue(...)

void SetScrollBarValue
(
    object oPlayer,
    string sScreenName,
    string sScrollBarName,
    int nValue
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de l'élément d'interface concerné, comportant une barre de progression.
- sScrollBarName : Le nom d'interface de la barre de progression.
- nValue : La valeur à définir pour la barre de progression.

Description :
Définit une nouvelle valeur pour la barre de progression d'un élément de l'interface. Afin de fonctionner correctment, l'élément d'interface comportant la barre de progression doit aussi comporter le paramètre "ScriptLoadable=true" dans la section <UIScene>.

Fonction(s) connexe(s) :
SetScrollBarRanges

SetSkillPointsRemaining(...)

void SetSkillPointsRemaining
(
    object oPC,
    int nPoints
)

Paramètres :
- oPC : Le joueur concerné.
- nPoints : Le nombre de points à attribuer.

Description :
Définit le nombre de points disponibles dont disposera le joueur désigné par oPC lorsqu'il atteindra le niveau supérieur. Attention, si trop de points sont attribués, le joueur ne pourra pas valider son niveau s'il ne peut pas tous les dépenser.

Fonction(s) connexe(s) :
GetSkillPointsRemaining

SetSpellKnown(...)

void SetSpellKnown
(
    object oCreature,
    int nClassPosition,
    int nSpell,
    int bKnown = TRUE,
    int bTrackWithLevel = TRUE
)

Paramètres :
- oCreature : La créature concernée.
- nClassPosition : La position de la classe à lier au sort.
- nSpell : Le sort concerné.
- bKnown : Détermine si le sort doit être connu ou oublié (défaut : TRUE).
- bTrackWithLevel : Détermine si la modification est liée au niveau (défaut : TRUE).

Description :
Rajoute, ou supprime, le sort défini par nSpell dans la liste des sorts connus par la créature désignée par oCreature. Si nClassPosition désigne un emplacement où aucune classe n'est déterminée, la fonction sera sans effet. Si bKnown est à TRUE, le sort est rajouté au personnage. Si sa valeur est FALSE, le sort lui sera retiré, en admettant que la classe concernée ne connaisse pas l'intégralité des sorts par défaut (comme un prêtre). Si bTrackWithLevel est à TRUE, le changement sera lié au niveau du personnage, et sera annulé si celui-ci perd ce niveau.

Cette fonction est à utiliser avec le plus de précautions possibles, sous peine de rendre un personnage joueur totalement inutilisable. Des règles précises sont liées aux classes de personnage ayant des restrictions vis à vis au gain de nouveaux sorts. De plus, un personnage modifié à l'aide de cette fonction peut ne plus être considéré comme légal par les serveurs imposant cette restriction.

Fonction(s) connexe(s) :
GetSkillPointsRemaining

SetStandardFactionReputation(...)

void SetStandardFactionReputation
(
    int nStandardFaction,
    int nNewReputation,
    object oCreature = OBJECT_SELF
)

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

Description :
Définit la réputation qu'entretiendra la créature désignée par oCreature, vis-à-vis de la faction de base désignée par nStandardFaction. nNewReputation doit être une valeur comprise entre 0 (hostile) et 100 (amical).

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

SetStolenFlag(...)

void SetStolenFlag
(
    object oItem,
    int nStolenFlag
)

Paramètres :
- oItem : La zone concernée.
- nStolenFlag : Détermine si l'item doit être marqué comme ayant été volé ou non.

Description :
Définit si l'item désigné par oItem est signalé comme ayant été volé, ou pas (Cf. paramètre "Volé ?" dans l'éditeur).

Fonction(s) connexe(s) :
GetStolenFlag

SetStoreGold(...)

void SetStoreGold
(
    object oidStore,
    int nGold
)

Paramètres :
- oidStore : L'échoppe concernée.
- nGold : La valeur à attribuer.

Description :
Attribue un montant de pièces d'or à l'échoppe désignée par oidStore. Si nGold est égal à -1, l'échoppe n'utilisera pas d'or.

Fonction(s) connexe(s) :
GetStoreGold, SetStoreIdentifyCost, SetStoreMaxBuyPrice

SetStoreIdentifyCost(...)

void SetStoreIdentifyCost
(
    object oidStore,
    int nCost
)

Paramètres :
- oidStore : L'échoppe concernée.
- nCost : La valeur à attribuer.

Description :
Définit le prix d'identification des items que l'échoppe désignée par oidStore pratiquera. Si nCost est égal à -1, l'échoppe ne permettra pas l'identification des items.

Fonction(s) connexe(s) :
GetStoreIdentifyCost, SetStoreGold, SetStoreMaxBuyPrice

SetStoreMaxBuyPrice(...)

void SetStoreMaxBuyPrice
(
    object oidStore,
    int nMaxBuy
)

Paramètres :
- oidStore : L'échoppe concernée.
- nMaxBuy : La valeur à attribuer.

Description :
Définit le prix maximum que l'échoppe désignée par oidStore paiera lors du rachat d'un item. Si nCost est égal à -1, l'échoppe rachètera les items quelque soit le prix.

Fonction(s) connexe(s) :
GetStoreMaxBuyPrice, SetStoreGold, SetStoreIdentifyCost

SetSubRace(...)

void SetSubRace
(
    object oCreature,
    string sSubRace
)

Paramètres :
- oCreature : La créature concernée.
- sSubRace : La sous-race à attribuer.

Description :
Attribue un nouveau nom de sous-race pour la créature désignée par oCreature (cette fonction n'est peut-être plus d'actualité, mais elle est là).

Fonction(s) connexe(s) :
GetSubRace

SetTag(...)

void SetSubRace
(
    object oObject,
    string sNewTag
)

Paramètres :
- oObject : L'objet concerné.
- sNewTag : Le nouveau tag à attribuer.

Description :
Attribue un nouveau tag à l'objet désigné par oObject. Un tag peut contenir jusqu'à 64 caractères alphanumériques, mais ne doit pas être une chaîne de caractères vide. Cette fonction affecte également les joueurs.

Fonction(s) connexe(s) :
GetTag

SetTileMainLightColor(...)

void SetTileMainLightColor
(
    location lTileLocation,
    int nMainLight1Color,
    int nMainLight2Color
)

Paramètres :
- lTileLocation : La localisation incluse dans la parcelle de terrain concernée (tile, tuile, gros carré, au choix).
- nMainLight1Color : Constante TILE_MAIN_LIGHT_COLOR_* définissant la première couleur principale à attribuer.
- nMainLight2Color : Constante TILE_MAIN_LIGHT_COLOR_* définissant la seconde couleur principale à attribuer.

Description :
Attribue une nouvelle couleur principale à la parcelle de terrain dont la localisation désignée par lTileLocation fait partie.

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

SetTileSourceLightColor(...)

void SetTileSourceLightColor
(
    location lTileLocation,
    int nSourceLight1Color,
    int nSourceLight2Color
)

Paramètres :
- lTileLocation : La localisation incluse dans la parcelle de terrain concernée (tile, tuile, gros carré, au choix).
- nSourceLight1Color : Constante TILE_SOURCE_LIGHT_COLOR_* définissant la première couleur principale à attribuer.
- nSourceLight2Color : Constante TILE_SOURCE_LIGHT_COLOR_* définissant la seconde couleur principale à attribuer.

Description :
Attribue une nouvelle couleur source à la parcelle de terrain dont la localisation désignée par lTileLocation fait partie.

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

SetTime(...)

void SetTime
(
    int nHour,
    int nMinute,
    int nSecond,
    int nMillisecond
)

Paramètres :
- nHour : Les heures (de 0 à 23).
- nMinute : Les minutes (de 0 à 59 maximum).
- nSecond :Les secondes (de 0 à 59).
- nMillisecond :Les millisecondes (de 0 à 999).

Description :
Définit une nouvelle date pour la partie en cours (ne s'ajoute pas aux valeurs en cours). Le temps ne peut qu'avancer, et définir une heure strictement inférieure avancera la date du jeu d'un jour. Si un paramètre est supérieur aux valeurs dont il dépend, la valeur en trop sera prise en compte et rajoutée (si nMinutes est égal à 75, l'heure en cours sera avancée, et les minutes seront égales à 15). Le nombre de minutes par heures n'est pas forcément égal à 60, et dépend du paramètre "Minutes par heure de jeu" dans l'éditeur. Si une heure de jeu doit durer 2 minutes, il y faudra littérallement 2 minutes pour passer à l'heure suivante.

Fonction(s) connexe(s) :
GetTimeHour, GetTimeMillisecond, GetTimeMinute, GetTimeSecond, SetCalendar

SetTrapActive(...)

void SetTrapActive
(
    object oTrap,
    int bActive
)

Paramètres :
- oTrap : Le piège concerné.
- bActive : Détermine si le piège doit être activé/désactivé.

Description :
Active/désactive le piège désigné par oTrap (Cf. paramètre "TrapActive" dans l'éditeur). Un piège désactivé est toujours présent, mais ne se déclenche pas. La valeur TRUE permet d'activer le piège. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapActive, SetTrap*

SetTrapDetectable(...)

void SetTrapDetectable
(
    object oTrap,
    int nDetectable = TRUE
)

Paramètres :
- oTrap : Le piège concerné.
- nDetectable : Détermine si le piège est détectable ou non (défaut : TRUE).

Description :
Définit si le piège désigné par oTrap est détectable, ou pas (Cf. paramètre "Piège détectable ?" dans l'éditeur). La valeur TRUE permet de rendre le piège détectable. La valeur FALSE ne permet pas à un piège déjà détecté de disparaître. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapDetectable, SetTrap*

SetTrapDetectDC(...)

void SetTrapDetectDC
(
    object oTrap,
    int nDetectDC
)

Paramètres :
- oTrap : Le piège concerné.
- nDetectDC : Le seuil de difficulté à attribuer.

Description :
Attribue un seuil de difficulté pour la détection du piège désigné par oTrap (Cf. paramètre "DD détection des pièges" dans l'éditeur). nDetectDC doit être une valeur comprise entre 0 et 250. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapDetectDC, SetTrap*

SetTrapDetectedBy(...)

int SetTrapDetectedBy
(
    object oTrap,
    object oDetector
)

Paramètres :
- oTrap : Le piège concerné.
- oDetector : La créature concernée.

Description :
Signale la présence du piège désigné par oTrap à la créature désignée par oDetector. oTrap doit être un déclencheur de type "piège", un plaçable ou une porte.

Fonction(s) connexe(s) :
GetTrapDetectedBy, SetTrap*

SetTrapDisabled(...)

int SetTrapDisabled
(
    object oTrap
)

Paramètres :
- oTrap : Le piège concerné.

Description :
Désarme le piège désigné par oTrap. Si oTrap est un déclencheur de type "piège", il sera retiré du jeu. S'il s'agit d'un plaçable ou d'une porte, le piège sera désarmé. En outre, l'événement "OnDisarm" de oTrap sera déclenché. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
CreateTrapOnObject, SetTrap*

SetTrapDisarmable(...)

void SetTrapDisarmable
(
    object oTrap,
    int nDisarmable = TRUE
)

Paramètres :
- oTrap : Le piège concerné.
- nDisarmable : Détermine si le piège est désamorçable ou non (défaut : TRUE).

Description :
Définit si le piège désigné par oTrap est désamorçable, ou pas (Cf. paramètre "Piège désamorçable ?" dans l'éditeur). La valeur TRUE permet de rendre le piège désamorçable. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapDisarmable, SetTrap*

SetTrapDisarmDC(...)

void SetTrapDisarmDC
(
    object oTrap,
    int nDisarmDC
)

Paramètres :
- oTrap : Le piège concerné.
- nDisarmDC : Le seuil de difficulté à attribuer.

Description :
Attribue un seuil de difficulté pour le désamorçage du piège désigné par oTrap (Cf. paramètre "DD désarmement" dans l'éditeur). nDisarmDC doit être une valeur comprise entre 0 et 250. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapDisarmDC, SetTrap*

SetTrapKeyTag(...)

void SetTrapKeyTag
(
    object oTrap,
    string sKeyTag
)

Paramètres :
- oTrap : Le piège concerné.
- sKeyTag : Le Tag de la clé à attribuer.

Description :
Attribue une clé permettant le désamorçage du piège désigné par oTrap (Cf. paramètre "KeyName" dans l'éditeur). Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapKeyTag, SetTrap*

SetTrapOneShot(...)

void SetTrapOneShot
(
    object oTrap,
    int nOneShot = TRUE
)

Paramètres :
- oTrap : Le piège concerné.
- nOneShot : Détermine si le piège est à usage unique ou non (défaut : TRUE).

Description :
Définit si le piège désigné par oTrap est à usage unique, ou pas (Cf. paramètre "Piège à déclenchement unique ?" dans l'éditeur). La valeur TRUE permet un usage unique du piège. Un piège à usage multiple se réinitialise s'il est déclenché, à moins d'être désamorçé. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapOneShot, SetTrap*

SetTrapRecoverable(...)

void SetTrapRecoverable
(
    object oTrap,
    int nRecoverable = TRUE
)

Paramètres :
- oTrap : Le piège concerné.
- nRecoverable : Détermine si le piège peut être récupéré ou non (défaut : TRUE).

Description :
Définit si le piège désigné par oTrap peut être récupéré, ou pas (Cf. paramètre "TrapRecoverable" dans l'éditeur). La valeur TRUE autorise la récupération du piège. Ne s'applique qu'aux déclencheurs de type "piège", aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetTrapRecoverable, SetTrap*

SetUnrestrictedLevelUp(...)

void SetUnrestrictedLevelUp
(
    object oCreature
)

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

Description :
Accorde à la créature désignée par oCreature la possibilité de passer son prochain niveau sans aucune restriction, quelque soit son archétype.

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

SetUseableFlag(...)

void SetUseableFlag
(
    object oPlaceable,
    int nUseableFlag
)

Paramètres :
- oPlaceable : Le paçable concerné.
- nUseableFlag : Détermine si le plaçable est utilisable ou non.

Description :
Définit si le plaçable désigné par oTrap peut être autorise une interaction, ou pas (Cf. paramètre "Utilisable ?" dans l'éditeur). La valeur TRUE autorise une interaction avec le plaçable.

Fonction(s) connexe(s) :
GetUseableFlag

SetWeaponVisibility(...)

void SetWeaponVisibility
(
    object oObject,
    int nVisibile,
    int nType = 0
)

Paramètres :
- oObject : L'objet concerné.
- nVisibile : Détermine si l'arme et/ou le casque doivent être masqués/affichés.
- nType : Définit si l'arme, le casque ou les deux doivent être masqués/affichés.

Description :
Masque/affiche l'arme et/ou le casque de la créature désignée par oObject. Si nVisible est égal à 0, les items seront masqués; la valeur 1 signifie que les items doivent être affichés; la valeur 4 est la valeur par défaut. Si nType est égal à 0, l'arme sera masquée; la valeur 1 signifie que le casque doit être masqué; la valeur 2 signifie que l'arme ET le casque doivent être masqués. Cette fonction est principalement utilisée lors des cinématiques. La valeur TRUE sera renvoyée si l'arme et/ou le casque ont été masqués/affichés avec succès.

SetWeather(...)

void SetWeather
(
    object oTarget,
    int nWeatherType,
    int nPower = WEATHER_POWER_MEDIUM
)

Paramètres :
- oTarget : L'objet concerné.
- nWeatherType : Constante WEATHER_TYPE_* définissant le type d'intempérie à modifier.
- nPower : Constante WEATHER_POWER_* définissant la puissance à attribuer.

Description :
Modifie les conditions météos pour l'objet désigné par oTarget. Si oTarget désigne le module, les conditions météos seront modifiés pour toutes les zones extérieures du module. Si oTarget désigne une zone, et qu'il s'agit d'une zone extérieure, seule cette zone subira les changements. Si la valeur de nPower est égale à WEATHER_POWER_USE_AREA_SETTINGS, la zone utilisera les paramètres qui lui ont été attribués dans l'éditeur.

Fonction(s) connexe(s) :
GetWeather

SetWillSavingThrow(...)

void SetWillSavingThrow
(
    object oObject,
    int nNewWillSave
)

Paramètres :
- oObject : L'objet concerné.
- nNewWillSave : La valeur à attribuer.

Description :
Remplace la valeur de "volonté" de l'objet désigné (Cf. paramètre "Jet de Volonté" dans l'éditeur). nNewWillSave doit être une valeur comprise entre 0 et 250. Ne s'applique qu'aux plaçables et aux portes.

Fonction(s) connexe(s) :
GetWillSavingThrow, SetFortitudeSavingThrow, SetReflexSavingThrow

SetXP(...)

void SetXP
(
    object oCreature,
    int nXpAmount
)

Paramètres :
- oCreature : La créature concernée.
- nXpAmount : La valeur à attribuer.

Description :
Remplace le total d'expérience accumulé par oCreature, par celui défini par nXpAmount. Pour rajouter des points d'expérience, il faudra utiliser la fonction "GiveXPToCreature(...)".

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

ShowWorldMap(...)

void ShowWorldMap
(
    string sWorldMap,
    object oPlayer,
    string sTag
)

Paramètres :
- sWorldMap : Le nom de la carte générale à afficher.
- oPlayer : Le joueur concerné.
- sTag : Tag définissant l'endroit où le joueur se trouve.

Description :
Affiche la fenêtre de la "carte du monde" sur l'interface du joueur désigné par oPlayer.

SignalEvent(...)

void SignalEvent
(
    object oObject,
    event evToRun
)

Paramètres :
- oObject : L'objet concerné.
- evToRun : L'événement à signaler.

Description :
Signale un événement à l'objet désigné par oObject, et force le déclenchement de l'événement correspondant.

Fonction(s) connexe(s) :
EventActivateItem, EventConversation, EventSpellCastAt, EventUserDefined

sin(...)

float sin
(
    float fValue
)

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

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

Fonction(s) connexe(s) :
asin, cos, tan

SoundObjectPlay(...)

void SoundObjectPlay
(
    object oSound
)

Paramètres :
- oSound : Le son concerné.

Description :
Joue le son défini par l'objet de type "son" désigné par oSound.

Fonction(s) connexe(s) :
SoundObjectSetPosition, SoundObjectSetVolume, SoundObjectStop

SoundObjectSetPosition(...)

void SoundObjectSetPosition
(
    object oSound,
    vector vPosition
)

Paramètres :
- oSound : Le son concerné.
- vPosition : La position à attribuer.

Description :
Attribue une position à l'objet de type "son" désigné par oSound.

Fonction(s) connexe(s) :
SoundObjectPlay, SoundObjectSetVolume, SoundObjectStop

SoundObjectSetVolume(...)

void SoundObjectSetVolume
(
    object oSound,
    int nVolume
)

Paramètres :
- oSound : Le son concerné.
- nVolume : Le volume sonore à attribuer.

Description :
Attribue un volume sonore à l'objet de type "son" désigné par oSound. La valeur de nVolume doit être comprise entre 0 et 127.

Fonction(s) connexe(s) :
SoundObjectPlay, SoundObjectSetPosition, SoundObjectStop

SoundObjectStop(...)

void SoundObjectStop
(
    object oSound
)

Paramètres :
- oSound : Le son concerné.

Description :
Stoppe la lecture du son défini par l'objet de type "son" désigné par oSound.

Fonction(s) connexe(s) :
SoundObjectPlay, SoundObjectSetPosition, SoundObjectSetVolume

SpawnBloodHit(...)

void SpawnBloodHit
(
    object oCreature,
    int bCriticalHit,
    object oAttacker
)

Paramètres :
- oCreature : La créature concernée.
- bCriticalHit : Détermine si la fonction doit simuler un coup critique.
- oAttacker : L'attaquant de repère.

Description :
Génére un effet de saignement, comme si la créature désignée par oCreature venait de subir des dégâts. La couleur du sang dépendra de l'apparence de la créature. La position de oAttacker permet de simuler l'objet à l'origine de l'attaque, afin de déterminer la direction des particules. Il est possible d'attribuer la valeur OBJECT_INVALID à oAttacker. Cette fonction ne cause aucun dégât, et n'a aucun impact sur un éventuel combat en cours.

Fonction(s) connexe(s) :
SpawnItemProjectile, SpawnSpellProjectile

SpawnItemProjectile(...)

void SpawnItemProjectile
(
    object oSource,
    object oTarget,
    location lSource,
    location lTarget,
    int nBaseItemID,
    int nProjectilePathType,
    int nAttackType,
    int nDamageTypeFlag
)

Paramètres :
- oSource : L'objet d'origine.
- oTarget : L'objet de destination.
- lSource : Le point d'origine.
- lTarget : Le point de destination.
- nBaseItemID : Constante BASE_ITEM_* définissant le type d'arme à distance, afin de déterminer l'apparence du projectile.
- nProjectilePathType : Constante PROJECTILE_PATH_TYPE_* définissant le type de trajectoire du projectile.
- nAttackType : Constante OVERRIDE_ATTACK_RESULT_* définissant l'issue de l'attaque à simuler.
- nDamageTypeFlag : Constante DAMAGE_TYPE_* définissant le type de dégâts à simuler.

Description :
Génére un effet de tir à distance, comme si un projectile avait été lancé de oSource (ou lSource) vers oTarget (ou lTarget). nAttackType permet de définir si l'attaque a été réussie, parée, ratée, ou s'il s'agit d'un coup critique. nDamageTypeFlag ne prend en compte que les dégâts acides, de froid, électriques, de feu et de son. Cette fonction ne cause aucun dégât, et n'a aucun impact sur un éventuel combat en cours.

Fonction(s) connexe(s) :
SpawnBloodHit, SpawnSpellProjectile

SpawnRosterMember(...)

object SpawnRosterMember
(
    string sRosterName,
    location lLocation
)

Paramètres :
- sRosterName : Le nom du compagnon à créer.
- lLocation : La localisation où le compagnon sera créé.

Description :
Crée la créature correspondant au nom du compagnon inscrit dans la "liste des compagnons". Si le compagnon est déjà en jeu, il sera simplement transféré vers la localisation définie par lLocation. La valeur "object" du compagnon sera renvoyée. La fonction renverra la valeur OBJECT_INVALID en cas d'erreur.

Fonction(s) connexe(s) :
DespawnRosterMember

SpawnScriptDebugger()

void SpawnScriptDebugger()

Description :
Met en route le "debugger de script". Si le script n'est pas compilé de façon à pouvoir être soumis à un "debug", la fonction sera sans effet.

SpawnSpellProjectile(...)

void SpawnSpellProjectile
(
    object oSource,
    object oTarget,
    location lSource,
    location lTarget,
    int nSpellID,
    int nProjectilePathType
)

Paramètres :
- oSource : L'objet d'origine.
- oTarget : L'objet de destination.
- lSource : Le point d'origine.
- lTarget : Le point de destination.
- nSpellID : Constante SPELL_* définissant le sort à consulter, afin de déterminer l'apparence du projectile.
- nProjectilePathType : Constante PROJECTILE_PATH_TYPE_* définissant le type de trajectoire du projectile.

Description :
Génére un effet de tir à distance, comme si un projectile magique avait été lancé de oSource (ou lSource) vers oTarget (ou lTarget). Cette fonction ne cause aucun dégât, et n'a aucun impact sur un éventuel combat en cours. Si la valeur de nProjectilePathType est égale à PROJECTILE_PATH_TYPE_DEFAULT, le type de trajectoire sera celui défini pour le sort désigné.

Fonction(s) connexe(s) :
SpawnBloodHit, SpawnItemProjectile

SpeakOneLinerConversation(...)

void SpeakOneLinerConversation
(
    string sDialogResRef = "",
    object oTokenTarget = OBJECT_INVALID,
    int nTalkVolume = TALKVOLUME_TALK
)

Paramètres :
- sDialogResRef : Le nom du dialogue concerné (défaut : "").
- oTokenTarget : L'objet de référence en cas de marqueur(s) (défaut : OBJECT_INVALID).
- nTalkVolume : Constante TALKVOLUME_* définissant le canal de discussion utilisé (défaut : TALKVOLUME_TALK).

Description :
L'objet source "prononcera" immédiatement la phrase unique d'une conversation. Si des marqueurs sont utilsés dans la phrase, oTokenTarget fera office de référence pour ceux-ci. Cette action est prioritaire par rapport à la file d'action.

Fonction(s) connexe(s) :
SpeakString

SpeakString(...)

void SpeakString
(
    string sStringToSpeak,
    int nTalkVolume = TALKVOLUME_TALK
)

Paramètres :
- sStringToSpeak : La chaîne de caractères à afficher.
- nTalkVolume : Constante TALKVOLUME_* définissant le canal de discussion utilisé (défaut : TALKVOLUME_TALK).

Description :
L'objet source "prononcera" immédiatement la chaîne de caractères définie par sStringToSpeak. Cette action est prioritaire par rapport à la file d'action.

Fonction(s) connexe(s) :
ActionSpeakString, SpeakStringByStrRef

SpeakStringByStrRef(...)

void SpeakStringByStrRef
(
    int nStrRef,
    int nTalkVolume = TALKVOLUME_TALK
)

Paramètres :
- nStrRef : La référence TLK du texte à afficher.
- nTalkVolume : Constante TALKVOLUME_* définissant le canal de discussion utilisé (défaut : TALKVOLUME_TALK).

Description :
L'objet source "prononcera" immédiatement le texte référencé dans le fichier TLK. Cette action est prioritaire par rapport à la file d'action.

Fonction(s) connexe(s) :
ActionSpeakStringByStrRef, SpeakString

sqrt(...)

float sqrt
(
    float fValue
)

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

Description :
Renvoie la racine carrée de la valeur définie par fValue. Si fValue est une valeur négative, la valeur 0.0f sera renvoyée.

Fonction(s) connexe(s) :
pow

StartNewModule(...)

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

Paramètres :
- sModuleName : La référence TLK du texte à afficher.
- sWaypoint : Le Tag du point d'arrivée (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. Contrairement à la fonction "LoadNewModule(...)", le statut du module en cours ne sera pas sauvegardé.

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

StopFade(...)

void StopFade
(
    object oCreature
)

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

Description :
Met fin à un fondu d'ecran, ou à un écran noir, pour le joueur désigné par oCreature.

Fonction(s) connexe(s) :
BlackScreen, FadeFromBlack, FadeToBlack

StoreCameraFacing()

void StoreCameraFacing()

Description :
Mémorise la position et le mode de caméra actuel. La fonction "RestoreCameraFacing()" permettra de restaurer les valeurs mémorisées.

Fonction(s) connexe(s) :
RestoreCameraFacing

StoreCampaignObject(...)

void StoreCampaignObject
(
    string sCampaignName,
    string sVarName,
    object oObject,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : Le nom de la base de données à modifier.
- sVarName : Le nom de la variable à inscrire/modifier.
- oObject : La valeur "object" à inscrire.
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Sauvegarde une variable de type "object" dans la base de donnée sCampaignName. 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. Si la base de donnée n'existe pas, une nouvelle sera créée. Seules les créatures et les items peuvent être stockés. La fonction renverra la valeur FALSE en cas d'erreur, et TRUE en cas de succès.

Fonction(s) connexe(s) :
RetrieveCampaignObject, SetCampaignFloat, SetCampaignInt, SetCampaignLocation, SetCampaignString, SetCampaignVector

StringCompare(...)

void StringCompare
(
    string sString1,
    string sString2,
    int nCaseSensitive = FALSE
)

Paramètres :
- sString1 : La première chaîne de caractères à comparer.
- sString2 : La seconde chaîne de caractères à comparer.
- nCaseSensitive : Détermine si les majuscules et les minuscules doivent être prises en compte (défaut : FALSE).

Description :
Compare deux chaînes de caractères. La valeur 0 sera renvoyée si les deux chaînes sont identiques. La valeur renvoyée sera négative si sString1 est plus petit que sString2. La valeur renvoyée sera positive si sString1 est plus grande que sString2.

StringToFloat(...)

float StringToFloat
(
    string sNumber
)

Paramètres :
- sNumber : La chaîne de caractères à convertir.

Description :
Convertit une chaîne de caractères en valeur de type "float". La chaîne devra au préalable avoir un format de type "float", et les unités doivent être séparées des décimales par un point.

Fonction(s) connexe(s) :
FloatToString, StringToInt, StringToObject

StringToInt(...)

int StringToInt
(
    string sNumber
)

Paramètres :
- sNumber : La chaîne de caractères à convertir.

Description :
Convertit une chaîne de caractères en valeur de type "int". La chaîne devra au préalable représenter un nombre entier.

Fonction(s) connexe(s) :
IntToString, IntToHexString, StringToFloat, StringToObject

StringToObject(...)

object StringToObject
(
    string sNumber
)

Paramètres :
- sNumber : La chaîne de caractères à convertir.

Description :
Convertit une chaîne de caractères en valeur de type "object". Rien ne garantit que la valeur "object" obtenue sera valide.

Fonction(s) connexe(s) :
ObjectToString, StringToFloat, StringToInt

SummonAnimalCompanion(...)

void SummonAnimalCompanion
(
    object oMaster = OBJECT_SELF
)

Paramètres :
- oMaster : Le maître d'un compagnon animal.

Description :
Fait apparaître le compagnon animal de la créature désignée par oMaster.

Fonction(s) connexe(s) :
SummonFamiliar

SummonFamiliar(...)

void SummonFamiliar
(
    object oMaster = OBJECT_SELF
)

Paramètres :
- oMaster : Le maître d'un familier.

Description :
Fait apparaître le familier de la créature désignée par oMaster.

Fonction(s) connexe(s) :
SummonAnimalCompanion

SupernaturalEffect(...)

effect SupernaturalEffect
(
    effect eEffect
)

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

Description :
Convertit l'effet désigné par eEffect en effet de sous-catégorie "surnaturel". Un effet de ce type peut être dissipé par un effet de type "dissipation", mais reste actif après une phase de repos.

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

SurrenderToEnemies()

void SurrenderToEnemies()

Description :
La créature à laquelle est assignée cette fonction va "se rendre" et stopper toutes les actions hostiles à son égard. Les créatures hostiles dans un périmètre de 10 mètres de rayon seront neutres avec la créature concernée pendant environ 3 minutes. Si cette fonction est assignée à un joueur, elle n'aura aucun effet. Cette fonction ne s'assigne qu'aux créatures.

LISTE DES FONCTIONS

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

de "SaveGlobalVariables(...)" à "SetLastName(...)"
de "SetLevelUpPackage(...)" à "SurrenderToEnemies()"