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

SaveGlobalVariables(...)

int SaveGlobalVariables
(
    string sSaveName = ""
)

Paramètres :
- sSaveName : Le nom du fichier de sauvegarde (défaut : "").

Description :
Sauvegarde toutes les variables globales de la partie en cours dans le fichier désigné par sSaveName.

Fonction(s) connexe(s) :
LoadGlobalVariables, SetGlobal*

SendChatMessage(...)

void SendChatMessage
(
    object oSender,
    object oReceiver,
    int nChannel,
    string sMessage,
    int bInvokeCallback = FALSE
)

Paramètres :
- oSender : L'objet désigné comme origine du message.
- oReceiver : L'objet désigné comme destinataire du message.
- nChannel : Cosntante CHAT_MODE_* définissant le canal à employer.
- sMessage : Le message à envoyer.
- bInvokeCallback : Détermine si le script OnChat du module doit filtrer le message (défaut : FALSE).

Description :
Simule l'envoi d'un message, comme s'il était envoyé par un joueur ou par le serveur. A moins d'employer le canal CHAT_MODE_SERVER, oSender DOIT être un joueur valide afin que le message puisse être envoyé. Si le canal CHAT_MODE_SERVER est utilisé, on peut utiliser la valeur OBJECT_INVALID pour définir oSender. Si le canal CHAT_MODE_TELL ou CHAT_MODE_SERVER est utilisé, oReceiver DOIT être un joueur valide.

Attention à bien utiliser le paramètre bInvokeCallback avec précaution, sous peine de déclencher une boucle infinie qui bloquerait le fonctionnement du module.

Fonction(s) connexe(s) :
SendMessageToAllDMs, SendMessageToPC, SendMessageToPCByStrRef

SendCreatureToLimbo(...)

void SendCreatureToLimbo
(
    object oCreature
)

Paramètres :
- oCreature : La créature à envoyer dans les limbes.

Description :
Envoie la créature désignée par oCreature dans les limbes. Elle sera considérée comme étant dans les limbes une fois seulement que le script qui inclut cette fonction ait fini de s'exécuter. Cette fonction n'a aucun effet sur les joueurs, les MDs, ou les familiers.

Fonction(s) connexe(s) :
GetCreatureInLimbo, GetLimboCreatureCount, RecallCreatureFromLimboToLocation

SendMessageToAllDMs(...)

void SendMessageToAllDMs
(
    string szMessage
)

Paramètres :
- szMessage : La chaîne de caractères à envoyer.

Description :
Envoie une chaîne de caractères à tous les MDs connectés sur module, sous la forme d'un message système.

Fonction(s) connexe(s) :
SendChatMessage, SendMessageToPC, SendMessageToPCByStrRef

SendMessageToPC(...)

void SendMessageToPC
(
    object oPlayer,
    string szMessage
)

Paramètres :
- oPlayer : Le joueur concerné.
- szMessage : La chaîne de caractères à envoyer.

Description :
Envoie une chaîne de caractères au joueur désigné par oPlayer, sous la forme d'un message système.

Fonction(s) connexe(s) :
FloatingTextStringOnCreature, SendMessageToAllDMs, SendMessageToPCByStrRef, SetNoticeText

SendMessageToPCByStrRef(...)

void SendMessageToPCByStrRef
(
    object oPlayer,
    int nStrRef
)

Paramètres :
- oPlayer : Le joueur concerné.
- nStrRef : La référence TLK de la chaîne de caractères à envoyer.

Description :
Envoie une chaîne de caractères indexée dans le fichier TLK au joueur désigné par oPlayer, sous la forme d'un message système.

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

SetActionMode(...)

void SetActionMode
(
    object oCreature,
    int nMode,
    int nStatus
)

Paramètres :
- oCreature : La créature concernée.
- nMode : Constante ACTION_MODE_* définissant le mode d'action concerné.
- nStatus : Détermine si le mode doit être activé ou désactivé.

Description :
Active/désactive le mode d'action défini par nMode, pour la créature définie par oCreature. Si nStatus est égal à TRUE, le mode sera activé.

Fonction(s) connexe(s) :
GetActionMode, GetDetectMode, GetStealthMode

SetAILevel(...)

void SetAILevel
(
    object oTarget,
    int nAILevel
)

Paramètres :
- oTarget : La créature concernée.
- nAILevel : Constante AI_LEVEL_* définissant le niveau d'intelligence artificielle.

Description :
Définit le niveau d'intelligence artificielle de la créature désignée par oTarget. La valeur AI_LEVEL_DEFAULT permettra au jeu en cours de définir le niveau approprié selon les circonstances dans lesquelles la créature se trouve. Définir un autre niveau remplacera l'intelligence artificielle par défaut de la créature, jusqu'à ce que la valeur AI_LEVEL_DEFAULT soit à nouveau attribué. Les différents niveaux peuvent avoir un impact sur la consommation de ressources en jeu :
- AI_LEVEL_DEFAULT : Niveau par défaut. Le jeu en cours choisira automatiquement le niveau selon les cas rencontrés.
- AI_LEVEL_VERY_LOW : Niveau très bas. La créature sera "très stupide", mais l'usage CPU sera le moindre.
- AI_LEVEL_LOW : Niveau bas. La créature sera "stupide", mais l'usage CPU sera bas.
- AI_LEVEL_NORMAL : Niveau moyen. Utilisé en général pendant les combat. L'usage CPU sera moyen.
- AI_LEVEL_HIGH : Niveau élevé. La créature sera "intelligente", mais l'usage CPU sera élevé. Utilisé notamment pendant les cinématiques.

Fonction(s) connexe(s) :
GetAILevel

SetAreaTransitionBMP(...)

void SetAreaTransitionBMP
(
    int nPredefinedAreaTransition,
    string sCustomAreaTransitionBMP = ""
)

Paramètres :
- nPredefinedAreaTransition : Constante AREA_TRANSITION_* définissant la référence de l'image de transition.
- sCustomAreaTransitionBMP : Le nom du fichier BMP dans le cas d'une image personnalisée (défaut : "").

Description :
Définit l'image de chargement lors d'une transition vers une zone. Cette fonction s'utilise lors de l'événement "OnClick" d'une transition de zone, en l'assignant au joueur concerné via la commande "AssignCommand(...)". Si une image personnalisée est définie, il faudra attribuer la valeur AREA_TRANSITION_USER_DEFINED au paramètre nPredefinedAreaTransition.

Fonction(s) connexe(s) :
GetTransitionTarget

SetArmorRulesType(...)

void SetArmorRulesType
(
    object oItem,
    int nType
)

Paramètres :
- oItem : L'item concerné.
- nType : Le type de règles d'armure auxquelles l'item doit obéir.

Description :
Modifie le type de règles d'armure pour l'item désigné par oItem. nType désigne la ligne du fichier 2DA armorrulesstats.2da comportant les règles d'armure que l'on souhaite appliquer. Si l'armure était équipée, les modifications ne seront prises en compte qu'une fois l'armure retirée puis réinsérée dans son emplacement d'équipement.

Fonction(s) connexe(s) :
GetArmorRulesType">GetArmorRulesType

SetAssociateListenPatterns(...)

void SetAssociateListenPatterns
(
    object oTarget = OBJECT_SELF
)

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

Description :
Initialise la créature désignée par oTarget, lui permettant de réagir lorsqu'un ordre lui est donné.

Fonction(s) connexe(s) :
GetLastAssociateCommand, SetListening, SetListenPattern

SetBaseAbilityScore(...)

void SetBaseAbilityScore
(
    object oCreature,
    int nAbilityType,
    int nScore
)

Paramètres :
- oCreature : La créature concernée.
- nAbilityType : La caractéristique à remplacer.
- nScore : La nouvelle valeur.

Description :
Définit une nouvelle valeur d'une caractéristique désignée par nAbilityType, pour la créature désignée par oCreature. Ces modifications ne sont pas annulées si la créature subit une baisse de niveau(x). Un joueur ainsi affecté ne pourra plus être considéré comme "joueur légal" sur un serveur imposant cette restriction.

Fonction(s) connexe(s) :
GetAbilityScore

SetBaseAttackBonus(...)

void SetBaseAttackBonus
(
    int nBaseAttackBonus,
    object oCreature = OBJECT_SELF
)

Paramètres :
- nBaseAttackBonus : Le nombre d'attaques de base.
- oCreature : La créature concernée (défaut : OBJECT_SELF).

Description :
Définit le nombre d'attaques de base pour la créature désignée par oCreature. La valeur de nBaseAttackBonus doit être comprise entre 1 et 6. Ne s'applique pas aux joueurs.

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

SetBaseSkillRank(...)

void SetBaseAbilityScore
(
    object oCreature,
    int nSkill,
    int nRank,
    int bTrackWithLevel = TRUE
)

Paramètres :
- oCreature : La créature concernée.
- nSkill : La compétence à remplacer.
- nRank : La nouvelle valeur.
- bTrackWithLevel : Détermine si la modification doit être associée au niveau en cours (défaut : TRUE).

Description :
Définit une nouvelle valeur d'une compétence désignée par nSkill, pour la créature désignée par oCreature. Si bTrackWithLevel est à TRUE, la modification sera annulée si la créature perd le niveau auquel cette modification a été liée. Un joueur ainsi affecté peut ne plus être considéré comme "joueur légal" sur un serveur imposant cette restriction.

Fonction(s) connexe(s) :
GetSkillRank

SetBumpState(...)

void SetBumpState
(
    object oCreature,
    int nBumpState
)

Paramètres :
- oCreature: La créature concernée.
- nBumpState : Constante BUMPSTATE_* définissant le statut de collision.

Description :
Définit le statut de collision de la créature désignée par oCreature (Cf. paramètre "Statut collision" dans l'éditeur).

Fonction(s) connexe(s) :
GetBumpState

SetCalendar(...)

void SetCalendar
(
    int nYear,
    int nMonth,
    int nDay
)

Paramètres :
- nYear : L'année (de 0 à 32000).
- nMonth : Le mois (de 1 à 12).
- nDay : Le jour (de 1 à 28).

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 date strictement inférieure sera impossible. 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 nMonth est égal à 18, l'année en cours sera avancée, et le mois sera égal à 7). A partir de l'année 32000, le temps poursuit son cours, mais il sera impossible de redéfinir la date.

Fonction(s) connexe(s) :
GetCalendarMonth, GetCalendarYear, GetCampaignFloat, SetTime

SetCameraFacing(...)

void SetCameraFacing
(
    float fDirection,
    float fDistance = -1.0f,
    float fPitch = -1.0f,
    int nTransitionType = CAMERA_TRANSITION_TYPE_SNAP
)

Paramètres :
- fDirection : L'orientation de la caméra souhaitée.
- fDistance : La distance souhaitée (défaut : -1.0f).
- fPitch : L'angle souhaité (défaut : -1.0f).
- nTransitionType : Constante CAMERA_TRANSITION_TYPE_* définissant le type de transition à appliquer (défaut : CAMERA_TRANSITION_TYPE_SNAP).

Description :
Définit la position de la caméra selon les paramètres choisis. Si la valeur d'un paramètre est égal à -1.0f, la caméra gardera la valeur précédente. L'orientation se calcule dans le sens inverse des aiguilles d'une montre, en partant de l'est (est = 0.0f; nord = 90.0f; ouest = 180.0f; sud = 270.0f). La valeur de fDistance dépend du mode de camera actuel : en plongée ou en poursuite, la valeur devra être comprise entre 1.0f et 25.0f; en "caméra embarquée", la valeur devra être strictement égale à 6.0f. La valeur fPitch doit être comprise entre 1.0f et 89.0f. La transition se fera progressivement, à moins que nTransitionType soit égal à CAMERA_TRANSITION_TYPE_SNAP (transition directe). Cette fonction doit être assignée à un joueur via la fonction "AssignCommand(...)".

Fonction(s) connexe(s) :
RestoreCameraFacing, SetCameraHeight, SetCameraMode, StoreCameraFacing

SetCameraHeight(...)

void SetCameraHeight
(
    object oPlayer,
    float fHeight = 0.0f
)

Paramètres :
- oPlayer : Le joueur concerné.
- fHeight : La hauteur souhaitée (défaut : 0.0f).

Description :
Définit la hauteur de la caméra du joueur désigné par oPlayer. Si fHeight est égal à 0.0f, la hauteur de la caméra sera réinitialisée selon la race du personnage joueur.

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

SetCameraMode(...)

void SetCameraMode
(
    object oPlayer,
    int nCameraMode
)

Paramètres :
- oPlayer : Le joueur concerné.
- nCameraMode : Constante CAMERA_MODE_* définissant le mode de caméra souhaité.

Description :
Définit le mode de caméra du joueur désigné par oPlayer.

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

SetCampaignFloat(...)

void SetCampaignFloat
(
    string sCampaignName,
    string sVarName,
    float flFloat,
    object oPlayer = OBJECT_INVALID
)

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

Description :
Sauvegarde une variable de type "float" 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.

Fonction(s) connexe(s) :
GetCampaignFloat, SetCampaignInt, SetCampaignLocation, SetCampaignString, SetCampaignVector, StoreCampaignObject

SetCampaignInt(...)

void SetCampaignInt
(
    string sCampaignName,
    string sVarName,
    int nInt,
    object oPlayer = OBJECT_INVALID
)

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

Description :
Sauvegarde une variable de type "int" 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.

Fonction(s) connexe(s) :
GetCampaignInt, SetCampaignFloat, SetCampaignLocation, SetCampaignString, SetCampaignVector, StoreCampaignObject

SetCampaignLocation(...)

void SetCampaignLocation
(
    string sCampaignName,
    string sVarName,
    location locLocation,
    object oPlayer = OBJECT_INVALID
)

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

Description :
Sauvegarde une variable de type "location" 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.

Fonction(s) connexe(s) :
GetCampaignLocation, SetCampaignFloat, SetCampaignInt, SetCampaignString, SetCampaignVector, StoreCampaignObject

SetCampaignString(...)

void SetCampaignString
(
    string sCampaignName,
    string sVarName,
    string sString,
    object oPlayer = OBJECT_INVALID
)

Paramètres :
- sCampaignName : Le nom de la base de données à modifier.
- sVarName : Le nom de la variable inscrire/modifier.
- sString : La chaîne de caractères à inscrire.
- oPlayer : Le joueur rattaché à la variable (défaut : OBJECT_INVALID).

Description :
Sauvegarde une chaîne de caractères 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.

Fonction(s) connexe(s) :
GetCampaignString, SetCampaignFloat, SetCampaignInt, SetCampaignLocation, SetCampaignVector, StoreCampaignObject

SetCampaignVector(...)

void SetCampaignVector
(
    string sCampaignName,
    string sVarName,
    vector vVector,
    object oPlayer = OBJECT_INVALID
)

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

Description :
Sauvegarde une variable de type "vector" 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.

Fonction(s) connexe(s) :
GetCampaignVector, SetCampaignFloat, SetCampaignInt, SetCampaignLocation, SetCampaignString, StoreCampaignObject

SetCanTalkToNonPlayerOwnedCreatures(...)

void SetCanTalkToNonPlayerOwnedCreatures
(
    object oObject,
    int nStatus
)

Paramètres :
- oCreature : L'objet concerné.
- bCanTalk : Détermine si le mode doit être activé ou désactivé.

Description :
Active/désactive la possibilité de conversation entre l'objet désigné par oObject et une créature n'étant pas le personnage principal d'un joueur (Cf. paramètre "Possibilité de parler avec une créature non contrôlée par un joueur ?" dans l'éditeur).

Fonction(s) connexe(s) :
GetCanTalkToNonPlayerOwnedCreatures

SetCollision(...)

void SetCollision
(
    object oTarget,
    int bCollision
)

Paramètres :
- oTarget : L'objet concerné.
- bCollision : Détermine si le statut de collision doit être activé ou désactivé.

Description :
Active/désactive le paramètre de collision dynamique pour l'objet désigné par oTarget. Ne fonctionne que sur les objets ayant un paramètre "Statut collision" effectif dans l'éditeur.

Fonction(s) connexe(s) :
GetCollision

SetCombatOverrides(...)

void SetCombatOverrides
(
    object oCreature,
    object oTarget,
    int nOnHandAttacks,
    int nOffHandAttacks,
    int nAttackResult,
    int nMinDamage,
    int nMaxDamage,
    int bSuppressBroadcastAOO,
    int bSuppressMakeAOO,
    int bIgnoreTargetReaction,
    int bSuppressFeedbackText
)

Paramètres :
- oCreature : La créature concernée.
- oTarget : La cible de oCreature.
- nOnHandAttacks : Le nombre d'attaques pour l'arme principale.
- nOffHandAttacks : Le nombre d'attaques pour l'arme secondaire.
- nAttackResult : Détermine si les attaques doivent se dérouler normalement (jet d'attaque normal, etc.).
- nMinDamage : Le nombre minimum de points de dégâts à infliger.
- nMaxDamage : Le nombre maximum de points de dégâts à infliger.
- bSuppressBroadcastAOO : Détermine si oCreature peut subir des attaques d'opportunités.
- bSuppressMakeAOO : Détermine si oCreature peut bénéficier d'attaques d'opportunités.
- bIgnoreTargetReaction : Détermine si oCreature peut attaquer des cibles hostiles ou neutres.
- bSuppressFeedbackText : Détermine si les informations de combat doivent être affichée dans la fenêtre de discussion/combat.

Description :
Force un mode de combat spécifique pour la créature désignée par oCreature vis-à-vis de l'objet désigné par oTarget. Cette fonction est utilisée principalement lors d'une cinématique, et n'est "peut-être" pas adaptée à un combat face à un joueur. oTarget peut être une créature, un plaçable, ou une porte; si la valeur OBJECT_INVALID est utilisée, oCreature choisira sa cible normalement. Ce mode de combat peut être annulé grâce à la fonction "ClearCombatOverrides(...)". nOnHandAttacks et nOffHandAttacks doivent être compris entre 1 et 6; si les deux valeurs sont égales à -1, la créature utilisera ses attaques normales. Si les valeurs nMinDamage et nMaxDamage sont égales à 0, la créature n'infligera aucun dégât; la valeur -1 signifiera que la créature infligera les dégâts normaux.

Fonction(s) connexe(s) :
ClearCombatOverrides

SetCommandable(...)

void SetCommandable
(
    int bCommandable,
    object oTarget = OBJECT_SELF
)

Paramètres :
- bCommandable : Détermine si la modification de la file d'action doit être autorisée/interdite.
- oTarget : Le joueur rattaché à la variable (défaut : OBJECT_SELF).

Description :
Autorise/interdit la modification de la file d'actions de l'objet désigné par oTarget. La valeur TRUE autorise les modifications.

Fonction(s) connexe(s) :
GetCommandable

SetCreatureAppearanceType(...)

void SetCreatureAppearanceType
(
    object oCreature,
    int nAppearanceType
)

Paramètres :
- oCreature : La créature concernée.
- nAppearanceType : Constante APPEARANCE_TYPE_* définissant l'apparence désirée.

Description :
Change l'apparence de la créature désignée par oCreature, de manière permanente.

Fonction(s) connexe(s) :
GetAppearanceType

SetCreatureScriptsToSet(...)

void SetCreatureScriptsToSet
(
    object oCreature,
    int nScriptSet
)

Paramètres :
- oCreature : La créature concernée.
- nScriptSet : Constante SCRIPTSET_* définissant l'ensemble de scripts à assigner.

Description :
Assigne un nouvel ensemble de scripts à la créature désignée par oCreature. Les ensembles de scripts peuvent être consultés dans le fichier NWN2_ScriptSet.2da. Si la créature est possédée par un MD, les nouveaux scripts seront utilisés lorsque le MD relachera la créature.

Fonction(s) connexe(s) :
SetEventHandler

SetCustomHeartbeat(...)

void SetCustomHeartbeat
(
    object oTarget,
    int nMSeconds
)

Paramètres :
- oTarget : L'objet concerné.
- nMSeconds : Temps en millisecondes.

Description :
Définit un temps en millisecondes entre deux activations de l'événement "OnHeartbeat" de l'objet désigné par oTarget (1000 millisecondes = 1 seconde). Notez que réduire ce temps sur un grand nombre d'objets du jeu aura un impact sur les performances. Toutefois, concernant les créatures, un temps aléatoire allant jusqu'à 1 seconde est automatiquement rajouté. L'intervalle de temps entre deux événements "OnHeartbeat" ne sera donc pas précis pour ce type d'objet.

Fonction(s) connexe(s) :
GetCustomHeartbeat

SetCustomToken(...)

void SetCustomToken
(
    int nCustomTokenNumber,
    string sTokenValue
)

Paramètres :
- nCustomTokenNumber : Le numéro de référence à assigner.
- sTokenValue : La chaîne de caractères concernée.

Description :
Assigne un numéro de variable à la chaîne de caractères définie par sTokenValue. Cette fonction s'utilise en général dans un script de condition lors d'une discussion; la variable peut être alors utilisée dans une entrée de discussion sous la forme <CUSTOM##>, où "##" est le numéro de référence assigné.

SetCutsceneCameraMoveRate(...)

void SetCutsceneCameraMoveRate
(
    object oCreature,
    float fRate
)

Paramètres :
- oCreature : La créature désignée comme "cameraman".
- fRate : Le facteur de vitesse de déplacement à attribuer.

Description :
Modifie la vitesse de déplacement du "cameraman" représenté par oCreature lors d'une cinématique. La valeur de fRate doit être comprise entre 0.1f (10% de la vitesse normale) et 2.0 (200% de la vitesse normale).

Fonction(s) connexe(s) :
GetCutsceneCameraMoveRate, SetCutsceneMode

SetCutsceneMode(...)

void SetCutsceneMode
(
    object oCreature,
    int nInCutscene = TRUE
)

Paramètres :
- oCreature : La créature concernée.
- nInCutscene : Détermine si le mode "cinématique" doit être activé ou désactivé (défaut : TRUE).

Description :
Active/désactive le mode "cinématique" pour la créature désignée par oCreature. La valeur TRUE active le mode "cinématique". Cette fonction peut désactiver les commandes d'interface et de caméra d'un joueur.

Fonction(s) connexe(s) :
SetCutsceneCameraMoveRate

SetDeity(...)

void SetDeity
(
    object oCreature,
    string sDeity
)

Paramètres :
- oCreature : La créature concernée.
- sDeity : Le nom de la divinité à attribuer.

Description :
Attribue un nouveau nom de divinité à la créature désignée par oCreature (Cf. paramètre "Divinité" dans l'éditeur).

Fonction(s) connexe(s) :
GetDeity

SetDescription(...)

void SetDescription
(
    object oTarget,
    string sDescription
)

Paramètres :
- oTarget : L'objet concerné.
- sDescription : La description à attribuer.

Description :
Attribue une nouvelle description à la créature désignée par oCreature (Cf. paramètre "Description localisée" dans l'éditeur). Ne s'applique qu'aux créatures, aux plaçables, et aux portes.

Fonction(s) connexe(s) :
GetDescription

SetDroppableFlag(...)

void SetDroppableFlag
(
    object oItem,
    int bDroppable
)

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

Description :
Active/désactive la possibilité d'abandonner l'item désigné par oItem. La valeur TRUE autorise l'abandon de l'item.

Fonction(s) connexe(s) :
GetDroppableFlag

SetEffectSpellId(...)

effect SetEffectSpellId
(
    effect eTest,
    int nSpellId
)

Paramètres :
- eTest : L'effet concerné.
- nSpellId : Constante SPELL_* définissant le sort à indexer.

Description :
Indexe l'identifiant d'un sort sur l'effet désigné par eEffect.

Fonction(s) connexe(s) :
GetEffectSpellId

SetEncounterActive(...)

void SetEncounterActive
(
    int nNewValue,
    object oEncounter = OBJECT_SELF
)

Paramètres :
- nNewValue : Détermine si la rencontre doit être activée ou désactivée.
- oEncounter : La rencontre concernée (défaut : OBJECT_SELF).

Description :
Active/désactive la rencontre désignée par oEncounter (Cf. paramètre "Actif" dans l'éditeur).

Fonction(s) connexe(s) :
GetEncounterActive, SetEncounter*

SetEncounterDifficulty(...)

void SetEncounterDifficulty
(
    int nEncounterDifficulty,
    object oEncounter = OBJECT_SELF
)

Paramètres :
- nEncounterDifficulty : Constante ENCOUNTER_DIFFICULTY_* définissant la difficulté à assigner.
- oEncounter : La rencontre concernée (défaut : OBJECT_SELF).

Description :
Modifie la difficulté de la rencontre désignée par oEncounter (Cf. paramètre "Difficulté" dans l'éditeur).

Fonction(s) connexe(s) :
GetEncounterDifficulty, SetEncounter*

SetEncounterSpawnsCurrent(...)

void SetEncounterSpawnsCurrent
(
    int nNewValue,
    object oEncounter = OBJECT_SELF
)

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

Description :
Met à jour le nombre de fois où la rencontre désignée par oEncounter a été activée, et le remplace par nNewValue.

Fonction(s) connexe(s) :
GetEncounterSpawnsCurrent, SetEncounter*, SetEncounterSpawnsMax

SetEncounterSpawnsMax(...)

void SetEncounterSpawnsMax
(
    int nNewValue,
    object oEncounter = OBJECT_SELF
)

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

Description :
Met à jour le nombre maximum d'activation de la rencontre désignée par oEncounter, et le remplace par nNewValue.

Fonction(s) connexe(s) :
GetEncounterSpawnsMax, SetEncounter*, SetEncounterSpawnsCurrent

SetEventHandler(...)

void SetEventHandler
(
    object oObject,
    int iEventID,
    string sScriptName
)

Paramètres :
- oObject : L'objet concerné.
- iEventID : Constante CREATURE_SCRIPT_* ou SCRIPT_* définissant l'événement concerné.
- sScriptName : Le nom du script à attribuer.

Description :
Attribue un script à l'événement iEventID de l'objet désigné par oObject. Le groupe de constante est différent selon le type de l'objet concerné (ex. si l'objet est un plaçable, le groupe de constantes sera SCRIPT_PLACEABLE_*).

Fonction(s) connexe(s) :
GetEventHandler, SetCreatureScriptsToSet

SetFacing(...)

void SetFacing
(
    float fDirection,
    int bLockToThisOrientation = FALSE
)

Paramètres :
- fDirection : L'orientation à assigner.
- bLockToThisOrientation : Détermine si l'orientation assignée doit être prioritaire lors d'une conversation (défaut : FALSE).

Description :
L'objet source changera d'orientation. L'orientation se calcule dans le sens inverse des aiguilles d'une montre, en partant de l'est (est = 0.0f; nord = 90.0f; ouest = 180.0f; sud = 270.0f). Si bLockToThisOrientation est égl à TRUE, et que l'objet source est impliqué dans une conversation, la nouvelle orientation sera prioritaire et l'objet source ne se remettra pas face à son interlocuteur; ce verrouillage ne sera effectif que pendant la durée de la conversation. Il est possible d'utiliser les constantes DIRECTION_* avec le paramètre fDirection.

Fonction(s) connexe(s) :
GetFacing, SetFacingPoint

SetFacingPoint(...)

void SetFacingPoint
(
    vector vTarget,
    int bLockToThisOrientation = FALSE
)

Paramètres :
- vTarget : L'orientation à assigner.
- bLockToThisOrientation : Détermine si l'orientation assignée doit être prioritaire lors d'une conversation (défaut : FALSE).

Description :
L'objet source fera face au point désigné par vTarget. Si bLockToThisOrientation est égl à TRUE, et que l'objet source est impliqué dans une conversation, la nouvelle orientation sera prioritaire et l'objet source ne se remettra pas face à son interlocuteur; ce verrouillage ne sera effectif que pendant la durée de la conversation.

Fonction(s) connexe(s) :
SetFacing

SetFactionLeader(...)

void SetFactionLeader
(
    object oNewLeader
)

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

Description :
Définit la créature désignée par oNewLeader comme nouveau chef du groupe, ou de la faction dans laquelle elle appartient.

SetFirstName(...)

void SetFirstName
(
    object oTarget,
    string sFirstName
)

Paramètres :
- oTarget : L'objet concerné.
- sFirstName : Le prénom à attribuer.

Description :
Remplace le prénom de l'objet désigné par oTarget. Ne s'applique qu'aux créatures, aux items et aux plaçables.

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

SetFog(...)

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

Paramètres :
- oTarget : L'objet concerné.
- nFogType : Constante FOG_TYPE_* 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 pour oTarget. 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).

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

SetFortitudeSavingThrow(...)

void SetFortitudeSavingThrow
(
    object oObject,
    string nNewFortSave
)

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

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

Fonction(s) connexe(s) :
GetFortitudeSavingThrow, SetReflexSavingThrow, SetWillSavingThrow

SetGender(...)

void SetGender
(
    object oCreature,
    int nGender
)

Paramètres :
- oCreature : La créature concernée.
- nGender : Constante GENDER_* désignant le nouveau sexe de la créature.

Description :
Modifie le genre de la créature désignée par oCreature. Seules les valeurs GENDER_MALE et GENDER_FEMALE peuvent être utilisées, ou la fonction sera sans effet. Si un joueur est modifié, il devra quitter et se reconnecter au module. Si un PNJ est modifié, il devra quitter et rentrer à nouveau dans la zone.

Fonction(s) connexe(s) :
GetGender

SetGlobalBool(...)

int SetGlobalBool
(
    string sName,
    int bValue
)

Paramètres :
- sName : Le nom de la variable à modifer/inscrire.
- bValue : La valeur à inscrire.

Description :
Modifie/inscrit une valeur booléenne de type "int" dans une variable globale. Cette valeur est comprise entre 0 (FALSE) et 1 (TRUE).

Fonction(s) connexe(s) :
GetGlobalBool, SaveGlobalVariables, SetGlobalFloat, SetGlobalInt, SetGlobalString

SetGlobalFloat(...)

int SetGlobalFloat
(
    string sName,
    float fValue
)

Paramètres :
- sName : Le nom de la variable à modifer/inscrire.
- fValue : La valeur à inscrire.

Description :
Modifie/inscrit une valeur de type "float" dans une variable globale.

Fonction(s) connexe(s) :
GetGlobalFloat, SaveGlobalVariables, SetGlobalBool, SetGlobalInt, SetGlobalString

SetGlobalGUIVariable(...)

void SetGlobalGUIVariable
(
    object oPlayer,
    int nVarIndex,
    string sVarValue
)

Paramètres :
- oPlayer : Le joueur concerné.
- nVarIndex : L'index de la variable (de 100 à 400 inclus).
- sVarValue : La valeur à inscrire.

Description :
Modifie/inscrit une valeur de type "string" dans une variable globale disponible pour tous les éléments d'interface du joueur désigné par oPlayer. Cette variable peut être utilisée par la fonction d'interface UIRadialNode_OnInit_TestGlobalVar. nVarIndex doit être compris entre 100 et 400 inclus, ou la fonction sera sans effet.

Fonction(s) connexe(s) :
SetLocalGUIVariable

SetGlobalInt(...)

int SetGlobalInt
(
    string sName,
    int nValue
)

Paramètres :
- sName : Le nom de la variable à modifer/inscrire.
- nValue : La valeur à inscrire.

Description :
Modifie/inscrit une valeur de type "int" dans une variable globale.

Fonction(s) connexe(s) :
GetGlobalInt, SaveGlobalVariables, SetGlobalBool, SetGlobalFloat, SetGlobalString

SetGlobalString(...)

int SetGlobalString
(
    string sName,
    string sValue
)

Paramètres :
- sName : Le nom de la variable à modifer/inscrire.
- sValue : La chaîne de caractères à inscrire.

Description :
Modifie/inscrit une chaîne de caractères dans une variable globale.

Fonction(s) connexe(s) :
GetGlobalString, SaveGlobalVariables, SetGlobalBool, SetGlobalFloat, SetGlobalInt

SetGUIObjectDisabled(...)

void SetGUIObjectDisabled
(
    object oPlayer,
    string sScreenName,
    string sUIObjectName,
    int bDisabled
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de la fenêtre concernée.
- sUIObjectName : Le nom de l'élément de la fenêtre concernée.
- bDisabled : Détermine si l'utilisation de l'élément d'interface doit être activé/désactivé.

Description :
Active/Désactive l'utilisation d'une fenêtre d'interface pour le joueur désigné par oPlayer.

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

SetGUIObjectHidden(...)

void SetGUIObjectHidden
(
    object oPlayer,
    string sScreenName,
    string sUIObjectName,
    int bHidden
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de la fenêtre concernée.
- sUIObjectName : Le nom de l'élément de la fenêtre concernée.
- bHidden : Détermine si l'élément d'interface doit être masqué ou non.

Description :
Masque/démasque un élément de l'interface du joueur désigné par oPlayer. Lélément doit être référencé dans la section "[ScriptGUI]" du fichier ingamegui.ini. L'élément doit également avoir été mis en mémoire cache (... la fin de la description reste incompréhensible).

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

SetGUIObjectText(...)

void SetGUIObjectText
(
    object oPlayer,
    string sScreenName,
    string sUIObjectName,
    int nStrRef,
    string sText
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de la fenêtre concernée.
- sUIObjectName : Le nom de l'élément de la fenêtre concernée.
- nStrRef : La référence TLK du texte à afficher.
- sText : Le texte à afficher.

Description :
Attribue/modifie le texte de l'élément de l'interface du joueur désigné par oPlayer. Si nStrRef et sText ont chacun une valeur définie, sText sera prioritaire. Attribuer la valeur -1 à nStrRef ET la valeur "" à sText effacera le texte actuel.

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

SetGUIProgressBarPosition(...)

void SetGUIProgressBarPosition
(
    object oPlayer,
    string sScreenName,
    string sUIObjectName,
    float fPosition
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de la fenêtre concernée.
- sUIObjectName : Le nom de l'élément de la fenêtre concernée.
- fPosition : Le pourcentage de progression à attribuer.

Description :
Attribue un pourcentage à une barre de progression dans l'interface du joueur désigné par oPlayer. fPosition est une valeur comprise entre 0.0f (0%) et 1.0f (100%). Pour que cette fonction ait un effet, l'attribut "scriptloadable" de la fenêtre concernée doit être égal à TRUE.

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

SetGUITexture(...)

void SetGUITexture
(
    object oPlayer,
    string sScreenName,
    string sUIObjectName,
    string sTexture
)

Paramètres :
- oPlayer : Le joueur concerné.
- sScreenName : Le nom de la fenêtre concernée.
- sUIObjectName : Le nom de l'élément de la fenêtre concernée.
- sTexture : Dépend de l'élément d'interface concerné.

Description :
Modifie l'apparence d'un icône, d'un bouton ou du fond de la fenêtre d'interface du joueur désigné par oPlayer. S'il s'agit d'un icône, sTexture sera le nom de l'icône à attribuer. S'il s'agit d'une texture concernant un "bouton appuyé", ou d'un "bouton relevé", sTexture remplacera la texture concernée. S'il s'agit d'une fenêtre, sTexture remplacera la texture de fond de cette fenêtre. Pour que cette fonction ait un effet, l'attribut "scriptloadable" de la fenêtre concernée doit être égal à TRUE.

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

SetHardness(...)

void SetHardness
(
    string nHardness,
    object oObject
)

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

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

Fonction(s) connexe(s) :
GetHardness

SetIdentified(...)

void SetIdentified
(
    object oItem,
    int bIdentified
)

Paramètres :
- oItem : L'item concerné.
- bIdentified : Détermine si l'objet doit être identifié ou non.

Description :
Définit l'item désigné par oItem comme étant identifié/non-identifié. La valeur TRUE marque l'item comme identifié.

Fonction(s) connexe(s) :
GetIdentified

SetImmortal(...)

void SetImmortal
(
    object oCreature,
    int bImmortal
)

Paramètres :
- oCreature : La créature concernée.
- bImmortal : Détermine si la créature doit être immortelle ou non.

Description :
Active/désactive l'immortalité sur la créature désignée par oCreature. Une créature immortelle peut subir des dégâts, mais ses points de vie ne descendront jamais en dessous de 1. La valeur TRUE active l'immortalité.

Fonction(s) connexe(s) :
GetImmortal

SetInfiniteFlag(...)

void SetInfiniteFlag
(
    object oItem,
    int bInfinite = TRUE
)

Paramètres :
- oItem : L'item concerné.
- bInfinite : Détermine si l'objet est en quantité illimitée ou non (défaut : TRUE).

Description :
Active/désactive la limitation de l'item désigné par oItem dans une échoppe. La valeur TRUE indique que l'item est en quantité illimitée dans l'échoppe (Cf. paramètre "Illimité" dans l'éditeur).

Fonction(s) connexe(s) :
GetInfiniteFlag

SetIsCompanionPossessionBlocked(...)

void SetIsCompanionPossessionBlocked
(
    object oCreature,
    int bBlocked
)

Paramètres :
- oCreature : La créature concernée.
- bBlocked : Détermine si la possession de la créature est possible/impossible.

Description :
Rend possible/impossible la possession de la créature désignée par oCreature. Une créature dont la possession est bloquée ne peut être possédée, excepté par un MD. Un personnage joueur ne peut pas être "dépossédé". La valeur TRUE rendra la possession impossible.

Fonction(s) connexe(s) :
GetIsCompanionPossessionBlocked

SetIsDestroyable(...)

void SetIsDestroyable
(
    int bDestroyable,
    int bRaiseable = TRUE,
    int bSelectableWhenDead = FALSE
)

Paramètres :
- bDestroyable : Détermine si la créature doit disparaître ou non à sa mort.
- bRaiseable : Détermine si la créature peut être réssuscitée (défaut : TRUE).
- bSelectableWhenDead : Détermine s'il est possible de sélectionner la créature si elle est morte (défaut : FALSE).

Description :
Active/désactive la disparition d'une créature lors de sa mort (Cf. paramètre "Decays" dans l'éditeur). Si une créature ne disparaît pas, son corps reste étendu en jeu. Si bDestroyable est égal à TRUE, la créature disparaîtra.

SetIsRosterMemberCampaignNPC(...)

int SetIsRosterMemberCampaignNPC
(
    string sRosterName,
    int nCampaignNPC
)

Paramètres :
- sRosterName : Le nom du membre de la "liste des compagnons".
- nCampaignNPC : Détermine si le compagnon doit être persistant.

Description :
Marque le membre inscrit dans la "liste des compagnons" comme étant persistant. Si la valeur nCampaignNPC est égale à TRUE, l'état du compagnon sera sauvegardé entre deux modules. Cependant, il n'apparaîtra pas dans la "liste des compagnons", bien que la commande "AddRosterMemberToParty(...)" puisse le rajouter dans un groupe. La valeur FALSE sera renvoyée en cas d'echec.

Fonction(s) connexe(s) :
GetIsRosterMemberCampaignNPC

SetIsRosterMemberSelectable(...)

int SetIsRosterMemberSelectable
(
    string sRosterName,
    int bSelectable
)

Paramètres :
- sRosterName : Le nom du membre de la "liste des compagnons".
- bSelectable : Détermine si le compagnon peut être sélectionné.

Description :
Rend possible/impossible la sélection du membre de la "liste des compagnons", dont le nom de compagnon est défini par sRosterName. Un membre pouvant être "sélectionné" n'est pas forcément "disponible". Il est effectivement possible qu'un compagnon soit "disponible" mais "non-sélectionnable", pour des raisons liées à l'intrigue par exemple.

Fonction(s) connexe(s) :
GetIsRosterMemberSelectable

SetIsTemporaryEnemy(...)

void SetIsTemporaryEnemy
(
    object oTarget,
    object oSource = OBJECT_SELF,
    int bDecays = FALSE,
    float fDurationInSeconds = 180.0f
)

Paramètres :
- oTarget : La créature cible.
- oSource : La créature concernée (défaut : OBJECT_SELF).
- bDecays : Détermine si la créature revient à son état initial (défaut : FALSE).
- fDurationInSeconds : Définit le temps d'hostilité, si bDecays est égal à TRUE (défaut : 180.0f).

Description :
Rend la créature désignée par oSource hostile vis-à-vis de oTarget. Cette fonction modifie uniquement la réputation personnelle, en lui attribuant la valeur REPUTATION_TYPE_ENEMY. Si bDecays est égal à TRUE, la réputation personnelle augmentera progressivement jusqu'à ce que la réputation [de faction + personnelle] remonte au dessus de "hostile", et proportionnellement par rapport à fDurationInSeconds.

Fonction(s) connexe(s) :
GetIsEnemy, SetIsTemporaryFriend, SetIsTemporaryNeutral

SetIsTemporaryFriend(...)

void SetIsTemporaryFriend
(
    object oTarget,
    object oSource = OBJECT_SELF,
    int bDecays = FALSE,
    float fDurationInSeconds = 180.0f
)

Paramètres :
- oTarget : La créature cible.
- oSource : La créature concernée (défaut : OBJECT_SELF).
- bDecays : Détermine si la créature revient à son état initial (défaut : FALSE).
- fDurationInSeconds : Définit le temps d'hostilité, si bDecays est égal à TRUE (défaut : 180.0f).

Description :
Rend la créature désignée par oSource amicale vis-à-vis de oTarget. Cette fonction modifie uniquement la réputation personnelle, en lui attribuant la valeur REPUTATION_TYPE_FRIEND. Si bDecays est égal à TRUE, la réputation personnelle diminuera progressivement jusqu'à ce que la réputation [de faction + personnelle] retombe en dessous de "amical", et proportionellement par rapport à fDurationInSeconds.

Fonction(s) connexe(s) :
GetIsFriend, SetIsTemporaryEnemy, SetIsTemporaryNeutral

SetIsTemporaryNeutral(...)

void SetIsTemporaryNeutral
(
    object oTarget,
    object oSource = OBJECT_SELF,
    int bDecays = FALSE,
    float fDurationInSeconds = 180.0f
)

Paramètres :
- oTarget : La créature cible.
- oSource : La créature concernée (défaut : OBJECT_SELF).
- bDecays : Détermine si la créature revient à son état initial (défaut : FALSE).
- fDurationInSeconds : Définit le temps d'hostilité, si bDecays est égal à TRUE (défaut : 180.0f).

Description :
Rend la créature désignée par oSource amicale vis-à-vis de oTarget. Cette fonction modifie uniquement la réputation personnelle, en lui attribuant la valeur REPUTATION_TYPE_NEUTRAL. Si bDecays est égal à TRUE, la réputation personnelle diminuera/augmentera progressivement jusqu'à ce que la réputation [de faction + personnelle] corresponde à "hostile" / "amical", et proportionnellement par rapport à fDurationInSeconds.

Fonction(s) connexe(s) :
GetIsNeutral, SetIsTemporaryEnemy, SetIsTemporaryFriend

SetItemBaseMaterialType(...)

void SetItemBaseMaterialType
(
    object oItem,
    int nMaterialType
)

Paramètres :
- oItem : L'item concerné.
- nMaterialType : Le type de matériau à définir.

Description :
Attribue un nouveau type de matériau à l'item désigné par oItem. nMaterialType désignera une ligne du fichier 2DA iprp_materials.2da, représentant le type de matériau désiré.

Fonction(s) connexe(s) :
GetItemBaseMaterialType

SetItemCharges(...)

void SetItemCharges
(
    object oItem,
    int nCharges
)

Paramètres :
- oItem : L'item concerné.
- nCharges : Le nombre de charges restantes à attribuer.

Description :
Attribue un nombre de charges restantes à l'item désigné par oItem. Le nombre de charges ne pourra pas dépasser le maximum. Si la valeur 0 est attribuée, le nombre de charges tombera à 0 et l'item sera supprimé.

Fonction(s) connexe(s) :
GetItemCharges

SetItemCursedFlag(...)

void SetItemCursedFlag
(
    object oItem,
    int nCursed
)

Paramètres :
- oItem : L'item concerné.
- nCursed : Détermine si l'item doit être maudit ou non.

Description :
Attribue/retire la malédiction d'un item (Cf. paramètre "Maudit" dans l'éditeur). L'item sera maudit si nCursed est égal à TRUE. Un item maudit ne peut pas être abandonné par son possesseur.

Fonction(s) connexe(s) :
GetItemCursedFlag

SetItemIcon(...)

void SetItemIcon
(
    object oItem,
    int nIcon
)

Paramètres :
- oItem : L'item concerné.
- nIcon : Le nouvel icône à attribuer.

Description :
Attribue un nouvel icône à l'item désigné par oItem. nIcon fait référence aux lignes du fichier itemicon.2da, et l'icône sera de type "inconnu" si la ligne désignée n'est pas valide. Afin que les changements soient effectifs, l'item peut avoir à transiter d'une zone à une autre. Si l'item est dans l'inventaire d'un joueur, celui-ci devra obligatoirement changer de zone pour voir les changements.

Fonction(s) connexe(s) :
GetItemIcon

SetItemPropActivation(...)

void SetItemPropActivation
(
    object oItem,
    int nPref
)

Paramètres :
- oItem : L'item concerné.
- nPref : Définit les préférences d'activation.

Description :
Définit le type de préférence d'activation des propriétés de l'item désigné par oItem. La valeur définie par nPref devra être 0 si l'item doit seulement être équipé, 1 si l'item doit uniquement se trouver dans l'inventaire, 2 si les deux sont valables (cf. paramètre "Préférences pour l'activation des propriétés de l'objet" dans les propriétés d'un item). Si oItem n'est pas un item, la fonction sera sans effet.

Fonction(s) connexe(s) :
GetItemPropActivation

SetItemStackSize(...)

void SetItemStackSize
(
    object oItem,
    int nSize
)

Paramètres :
- oItem : L'item concerné.
- nSize : La taille de la pile.

Description :
Fixe la pile de l'item empilable désigné par oItem à la valeur définie par nSize. nSize doit être au moins égal à 1. La taille de la pile ne pourra pas dépasser le maximum.

Fonction(s) connexe(s) :
GetItemStackSize

SetKeyRequiredFeedbackMessage(...)

void SetKeyRequiredFeedbackMessage
(
    object oObject,
    string sFeedback
)

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

Description :
Attribue un nouveau message qui sera affiché lorsqu'un joueur tente d'ouvrir la porte ou le plaçable désigné par oObject, et qu'il n'y parvient pas. Ne s'applique qu'aux portes et aux plaçables.

Fonction(s) connexe(s) :
GetKeyRequiredFeedbackMessage

SetLastName(...)

void SetLastName
(
    object oTarget,
    string sLastName
)

Paramètres :
- oTarget : L'objet concerné.
- sFirstName : Le nom de famille à attribuer.

Description :
Remplace le nom de famille de l'objet désigné par oTarget. Ne s'applique qu'aux créatures, aux items et aux plaçables.

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

LISTE DES FONCTIONS

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

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