NWScript - Fonctions de A à... A

abs(...)

int abs
(
    int nValue
)

Paramètres :
- nValue : Valeur de type "int" dont on souhaite connaître la valeur absolue.

Description :
Renvoie la valeur absolue (non-négative, distance numérique à partir de 0) de nValue.

Par exemple, si nValue est égal à 4, la valeur renvoyée sera égale à 4 (à partir de 0). Si nValue est égal à -3, la valeur renvoyée sera égale à 3 (jusqu'à 0).

Fonction(s) connexe(s) :
fabs

acos(...)

float acos
(
    float fValue
)

Paramètres :
- fValue : Cosinus de l'angle que l'on souhaite retrouver.

Description :
Permet de retrouver la valeur d'un angle à partir d'une valeur Cosinus (côté adjacent/hypoténuse). La valeur fValue doit être comprise entre -1 et 1 (inclus).

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

ActionAttack(...)

void ActionAttack
(
    object oAttackee,
    int bPassive = FALSE
)

Paramètres :
- oAttackee : La créature ou l'objet devant être attaqué.
- bPassive : Détermine si l'attaque doit être en mode passif (Défaut : FALSE).

Description :
L'objet source attaquera oAttackee, quelque soit l'arme équipée. En elle-même, la fonction ActionAttack(...) ne modifie pas la réputation, à moins que l'événement "OnPhysicalAttacked" de la cible ne s'en charge. Si la valeur de bPassive est TRUE, l'attaquant ne se déplacera pas jusqu'à sa cible. S'il n'a qu'une arme de mélée, ou s'il est trop éloigné, il restera sur place.

Fonction(s) connexe(s) :
ClearAllActions

ActionCastFakeSpellAtLocation(...)

void ActionCastFakeSpellAtLocation
(
    int nSpell,
    location lTarget,
    int nProjectilePathType = PROJECTILE_PATH_TYPE_DEFAULT
)

Paramètres :
- nSpell : Constante SPELL_* définissant le sort à simuler.
- lTarget : la localisation ciblée.
- nProjectilePathType : Constante PROJECTILE_PATH_TYPE_* définissant le type de trajectoire que le sort emploiera (défaut : PROJECTILE_PATH_TYPE_DEFAULT).

Description :
L'objet source simulera l'envoi d'un sort vers la localisation définie par lTarget, sans appliquer les effets du sort. Il semblerait que la simulation d'un sort en combat puisse provoquer une attaque d'opportunité. La créature n'a pas besoin de connaître le sort pour le simuler.

Exemple :

// Dans l'événement "OnHeartbeat" d'un plaçable.
// * Un PNJ ensorceleur dont le tag est "PNJ_ENSORCELEUR"
//   simule le sort "Boule de feu" pour une animation.
//   de type "entrainement".
void main()
{
    object oPNJ = GetObjectByTag("PNJ_ENSORCELEUR");

    if(!GetIsInCombat(oPNJ) && !IsInConversation(oPNJ))
    {
        location lLocation = GetLocation(OBJECT_SELF);

        // 58 correspond à SPELL_FIREBALL (Boule de feu)
        // 2 correspond à PROJECTILE_PATH_TYPE_HIGH_BALLISTIC
        AssignCommand(oPNJ,ActionCastFakeSpellAtLocation(58,lLocation,2));
    }
}

Fonction(s) connexe(s) :
ActionCastFakeSpellAtObject, ActionCastSpellAtLocation

ActionCastFakeSpellAtObject(...)

void ActionCastFakeSpellAtObject
(
    int nSpell,
    object oTarget,
    int nProjectilePathType = PROJECTILE_PATH_TYPE_DEFAULT
)

Paramètres :
- nSpell : Constante SPELL_* définissant le sort à simuler.
- oTarget : l'objet ciblé.
- nProjectilePathType : Constante PROJECTILE_PATH_TYPE_* définissant le type de trajectoire que le sort emploiera (défaut : PROJECTILE_PATH_TYPE_DEFAULT).

Description :
L'objet source simulera l'envoi d'un sort sur l'objet défini par oTarget, sans appliquer les effets du sort. Il semblerait que la simulation d'un sort en combat puisse provoquer une attaque d'opportunité. La créature n'a pas besoin de connaître le sort pour le simuler.

Exemple :

// Dans l'événement "OnHeartbeat" d'un plaçable.
// * Un PNJ ensorceleur dont le tag est "PNJ_ENSORCELEUR"
//   simule le sort "Boule de feu" pour une animation.
//   de type "entrainement".
void main()
{
    object oPNJ = GetObjectByTag("PNJ_ENSORCELEUR");

    if(!GetIsInCombat(oPNJ) && !IsInConversation(oPNJ))
    {
        // 58 correspond à SPELL_FIREBALL (Boule de feu)
        // 2 correspond à PROJECTILE_PATH_TYPE_HIGH_BALLISTIC
        AssignCommand(oPNJ,ActionCastFakeSpellAtObject(58,OBJECT_SELF,2));
    }
}

Fonction(s) connexe(s) :
ActionCastFakeSpellAtLocation, ActionCastSpellAtObject

ActionCastSpellAtLocation(...)

void ActionCastSpellAtLocation
(
    int nSpell,
    location lTargetLocation,
    int nMetaMagic = METAMAGIC_ANY,
    int bCheat = FALSE,
    int nProjectilePathType = PROJECTILE_PATH_TYPE_DEFAULT,
    int bInstantSpell = FALSE,
    int nDomainLevel = 0
)

Paramètres :
- nSpell : Constante SPELL_* définissant le sort à lancer.
- lTargetLocation : la localisation ciblée.
- nMetaMagic : Constante METAMAGIC_* définissant le type de métamagie à utiliser (défaut : METAMAGIC_ANY).
- bCheat : Si TRUE, le lanceur du sort n'a pas besoin de connaître ce sort (défaut : FALSE).
- nProjectilePathType : Constante PROJECTILE_PATH_TYPE_* définissant le type de trajectoire que le sort emploiera (défaut : PROJECTILE_PATH_TYPE_DEFAULT).
- bInstantSpell : Si TRUE, le lanceur du sort ne passera pas par la phase d'incantation avant de lancer ce sort.
- nDomainLevel : Définit le niveau de lanceur de sorts (défaut : 0).

Description :
L'objet source lancera un sort vers la localisation définie par lTargetLocation. Le sort lancé par cette fonction appliquera normalement les dégâts et/ou les ffets visuels.

Fonction(s) connexe(s) :
ActionCastFakeSpellAtLocation, ActionCastSpellAtObject

ActionCastSpellAtObject(...)

void ActionCastSpellAtObject
(
    int nSpell,
    object oTarget,
    int nMetaMagic = METAMAGIC_ANY,
    int bCheat = FALSE,
    int nDomainLevel = 0,
    int nProjectilePathType = PROJECTILE_PATH_TYPE_DEFAULT,
    int bInstantSpell = FALSE,
)

Paramètres :
- nSpell : Constante SPELL_* définissant le sort à lancer.
- oTarget : l'objet ciblé.
- nMetaMagic : Constante METAMAGIC_* définissant le type de métamagie à utiliser (défaut : METAMAGIC_ANY).
- bCheat : Si TRUE, le lanceur du sort n'a pas besoin de connaître ce sort (défaut : FALSE).
- nDomainLevel : Définit le niveau de lanceur de sorts (défaut : 0).
- nProjectilePathType : Constante PROJECTILE_PATH_TYPE_* définissant le type de trajectoire que le sort emploiera (défaut : PROJECTILE_PATH_TYPE_DEFAULT).
- bInstantSpell : Si TRUE, le lanceur du sort ne passera pas par la phase d'incantation avant de lancer ce sort.

Description :
L'objet source lancera un sort sur l'objet défini par oTarget. Le sort lancé par cette fonction appliquera normalement les dégâts et/ou les ffets visuels.

Fonction(s) connexe(s) :
ActionCastFakeSpellAtObject, ActionCastSpellAtLocation

ActionCloseDoor(...)

void ActionCloseDoor
(
    object oDoor
)

Paramètres :
- oDoor : La porte devant être fermée.

Description :
L'objet source fermera la porte définie par oDoor. S'il est mobile, il se déplacera jusqu'à la porte avant de la fermer.

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

ActionCounterSpell(...)

void ActionCounterSpell
(
    object oCounterSpellTarget
)

Paramètres :
- oCounterSpellTarget : La cible du mode "Contresort".

Description :
L'objet source entrera en mode "Contresort" contre l'adversaire défini par oCounterSpellTarget.

Fonction(s) connexe(s) :
GetActionMode

ActionDoCommand(...)

void ActionDoCommand
(
    action aActionToDo
)

Paramètres :
- aAction : La commande devant être exécutée en tant qu'action.

Description :
L'objet source exécutera une commande en tant qu'action, dépendante de la liste des actions en cours.

Exemple :

// L'objet source prononcera la phrase en même temps
// que l'action de se déplacer vers le point de passage.
ActionMoveToObject(GetWaypointByTag("POINT_DE_PASSAGE"));
SpeakString("J'y vais.",TALKVOLUME_SPEAK);

// L'objet source prononcera la phrase
// après être arrivé au point de passage.
ActionMoveToObject(GetWaypointByTag("POINT_DE_PASSAGE"));
ActionDoCommand(SpeakString("J'y suis.",TALKVOLUME_SPEAK));

Fonction(s) connexe(s) :
AssignCommand

ActionEquipItem(...)

void ActionEquipItem
(
    object oItem,
    int nInventorySlot
)

Paramètres :
- oItem : L'item devant être équipé.
- nInventorySlot : Constante INVENTORY_SLOT_* définissant l'emplacement dans lequel l'item doit être équipé.

Description :
L'objet source équipera l'item désigné à l'emplacement désigné. S'il ne peut pas équiper l'item pour une raison quelconque, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionUnequipItem

ActionEquipMostDamagingMelee(...)

void ActionEquipMostDamagingMelee
(
    object oVersus = OBJECT_INVALID,
    int bOffHand = FALSE
)

Paramètres :
- oVersus : La cible, en fonction de laquelle l'arme de mélée sera choisie (défaut : OBJECT_INVALID).
- bOffHand : Détermine si l'arme de mélée doit être équipée en tant qu'arme de seconde main (défaut : FALSE).

Description :
L'objet source équipera l'arme de mélee la plus efficace qu'il possède vis-à-vis de la cible désignée par oVersus. S'il n'a pas d'arme de mélée, l'arme à distance la plus efficace sera équipée. Si bOffHand est déclarée comme TRUE et que l'objet source n'a aucune arme équipée, l'arme de mélée sera équipée en main principale.

Fonction(s) connexe(s) :
ActionEquipItem, ActionEquipMostDamagingRanged, ActionEquipMostEffectiveArmor

ActionEquipMostDamagingRanged(...)

void ActionEquipMostDamagingRanged
(
    object oVersus = OBJECT_INVALID,
)

Paramètres :
- oVersus : La cible, en fonction de laquelle l'arme de mélée sera choisie (défaut : OBJECT_INVALID).

Description :
L'objet source équipera l'arme à distance la plus efficace qu'il possède vis-à-vis de la cible désignée par oVersus. S'il n'a pas d'arme à distance, l'arme de mélée la plus efficace sera équipée.

Fonction(s) connexe(s) :
ActionEquipItem, ActionEquipMostDamagingMelee, ActionEquipMostEffectiveArmor

ActionEquipMostEffectiveArmor()

void ActionEquipMostEffectiveArmor()

Description :
L'objet source équipera l'armure ayant la meilleure CA qu'il possède. Ne prend pas en compte les armures ayant une CA de base égale à 0.

Fonction(s) connexe(s) :
ActionEquipItem, ActionEquipMostDamagingMelee, ActionEquipMostDamagingRanged

ActionExamine(...)

void ActionExamine
(
    object oExamine
)

Paramètres :
- oExamine : L'objet devant être examiné.

Description :
L'objet source examinera l'objet désigné par oExamine, faisant apparaître la fenêtre concernée.

ActionForceFollowObject(...)

void ActionForceFollowObject
(
    object oFollow,
    float fFollowDistance = 0.5f,
    int iFollowPosition = 0
)

Paramètres :
- oFollow : L'objet devant être suivi.
- fFollowDistance : Distance à laquelle oFollow sera suivi (défaut : 0.5f).
- iFollowPosition : Position latérale par rapport à oFollow (défaut : 0).

Description :
L'objet source suivra l'objet désigné par oFollow. Cette action s'effectuant en boucle, il faudra utiliser la fonction "ClearAllActions(...)" pour l'abandonner.

Fonction(s) connexe(s) :
ActionForceMoveToLocation, ActionForceMoveToObject, ClearAllActions

ActionForceMoveToLocation(...)

void ActionForceMoveToLocation
(
    location lDestination,
    int bRun = FALSE,
    float fTimeout = 30.0f
)

Paramètres :
- lDestination : La localisation de la destination.
- bRun : Détermine si l'objet source doit courir ou non (défaut : FALSE).
- fTimeout : Le temps alloué au calcul du trajet à effectuer (défaut : 30.0f).

Description :
L'objet source se rendra à la destination désignée par lDestination. Si le chemin est bloqué, un temps défini par fTimeout sera pris pour calculer une trajectoire. Si aucune trajectoire n'a pu être calculée au bout de ce temps, l'action sera abandonnée.

Fonction(s) connexe(s) :
ActionForceFollowObject, ActionForceMoveToObject

ActionForceMoveToObject(...)

void ActionForceMoveToObject
(
    object oMoveTo,
    int bRun = FALSE,
    float fRange = 1.0f
    float fTimeout = 30.0f
)

Paramètres :
- oMoveTo : La cible de la destination.
- bRun : Détermine si l'objet source doit courir ou non (défaut : FALSE).
- fRange : Distance minimum à laquelle l'objet source se rapprochera de oMoveTo (défaut : 1.0f).
- fTimeout : Le temps alloué au calcul du trajet à effectuer (défaut : 30.0f).

Description :
L'objet source se rapprochera de l'objet désigné par oMoveTo, à une distance définie par fRange. Si le chemin est bloqué, un temps défini par fTimeout sera pris pour calculer une trajectoire. Si aucune trajectoire n'a pu être calculée au bout de ce temps, l'action sera abandonnée.

Fonction(s) connexe(s) :
ActionForceFollowObject, ActionForceMoveToLocation

ActionGiveItem(...)

void ActionGiveItem
(
    object oItem,
    object oGiveTo,
    int bDisplayFeedback = TRUE
)

Paramètres :
- oItem : L'item devant être transféré.
- oGiveTo : La créature, ou le contenant, vers qui l'item sera transféré.
- bDisplayFeedback : Détermine si un message doit être transmis via la fenêtre de discussion pour un objet acquis/perdu (défaut : TRUE).

Description :
L'item désigné par oItem sera transféré de l'inventaire de l'objet source vers celui de l'objet défini par oGiveTo. Si oItem ou oGiveTo ne sont pas des objets valides, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionTakeItem

ActionInteractObject(...)

void ActionInteractObject
(
    object oPlaceable
)

Paramètres :
- oPlaçable : Le plaçable devant être utilisé.

Description :
L'objet source utilisera le plaçable désigné par oPlaçable. Si le plaçable n'est pas utilisable, la fonction sera sans effet.

Fonction(s) connexe(s) :
DoPlaceableObjectAction

ActionJumpToLocation(...)

void ActionJumpToLocation
(
    location lLocation
)

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

Description :
L'objet source sera instantanément transféré vers la localisation désignée par lLocation. Si lLocation n'est pas valide, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionJumpToObject, JumpToLocation

ActionJumpToObject(...)

void ActionJumpToObject
(
    object oToJumpTo,
    int bWalkStraightLineToPoint = TRUE
)

Paramètres :
- oToJumpTo : L'objet de destination.
- bWalkStraightLineToPoint : inconnu (défaut : TRUE).

Description :
L'objet source sera instantanément transféré vers l'objet désigné par oToJumpTo. Si oToJumpTo n'est pas valide, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionJumpToLocation, JumpToObject

ActionLockObject(...)

void ActionLockObject
(
    object oTarget
)

Paramètres :
- oTarget : L'objet devant être verrouillé.

Description :
L'objet source verrouillera l'objet désigné par oTarget. oTarget peut être un plaçable ou une porte.

Fonction(s) connexe(s) :
ActionUnlockObject

ActionMoveAwayFromLocation(...)

void ActionMoveAwayFromLocation
(
    location lMoveAwayFrom,
    int bRun = FALSE,
    float fMoveAwayRange = 40.0f
)

Paramètres :
- lMoveAwayFrom : La localisation de laquelle l'objet source devra s'éloigner.
- bRun : Détermine si l'objet source doit courir (défaut : FALSE).
- fMoveAwayRange : Distance jusqu'à laquelle l'objet source devra s'éloigner (défaut : 40.0f).

Description :
L'objet source s'éloignera de la localisation désigné par lMoveAwayFrom.

Fonction(s) connexe(s) :
ActionMoveAwayFromObject, ActionMoveToLocation

ActionMoveAwayFromObject(...)

void ActionMoveAwayFromObject
(
    object oFleeFrom,
    int bRun = FALSE,
    float fMoveAwayRange = 40.0f
)

Paramètres :
- oFleeFrom : L'objet cible, duquel l'objet source devra s'éloigner.
- bRun : Détermine si l'objet source doit courir (défaut : FALSE).
- fMoveAwayRange : Distance jusqu'à laquelle l'objet source devra s'éloigner (défaut : 40.0f).

Description :
L'objet source s'éloignera de l'objet désigné par oFleeFrom. Si oFleeFrom est dans une zone différente, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionMoveAwayFromLocation, ActionMoveToObject

ActionMoveToLocation(...)

void ActionMoveToLocation
(
    location lDestination,
    int bRun = FALSE
)

Paramètres :
- lDestination : La localisation de la destination.
- bRun : Détermine si l'objet source doit courir (défaut : FALSE).

Description :
L'objet source se déplacera jusqu'à la localisation définie par lDestination. Si la localisation n'est pas valide, ou si un chemin ne peut pas être déterminé, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionMoveAwayFromLocation, ActionMoveToObject

ActionMoveToObject(...)

void ActionMoveToObject
(
    object oMoveTo,
    int bRun = FALSE,
    float fRange = 1.0f
)

Paramètres :
- oMoveTo : L'objet cible, jusqu'auquel l'objet source devra se déplacer.
- bRun : Détermine si l'objet source doit courir (défaut : FALSE)
- fRange : Distance jusqu'à laquelle l'objet source se rapprochera (défaut : 1.0f).

Description :
L'objet source se déplacera jusqu'à l'objet défini par oMoveTo. Si oMoveTo n'est pas valide, ou qu'un chemin ne peut pas être déterminé, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionMoveAwayFromObject, ActionMoveToLocation

ActionOpenDoor(...)

void ActionOpenDoor
(
    object oDoor
)

Paramètres :
- oDoor : La porte devant être ouverte.

Description :
L'objet source ouvrira la porte désignée par oDoor. Si l'objet source est une créature, il se déplacera vers la porte avant de l'ouvir. Une porte verrouillée restera fermée.

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

ActionPauseConversation()

void ActionPauseConversation()

Description :
Met en pause la conversation dans laquelle l'objet source est impliqué. Si aucune conversation n'est engagée, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionPauseCutscene, ActionResumeConversation, ActionStartConversation

ActionPauseCutscene(...)

void ActionPauseCutscene
(
    int nTimeoutSecs,
    int bPurgeCutsceneActionsOnTimeout = FALSE
)

Paramètres :
- nTimeoutSecs : Temps maximum au bout duquel la cinématique reprendra.
- bPurgeCutsceneActionsOnTimeout : Détermine si la file d'actions en rapport avec la cinématique doit être remise à zéro (défaut : FALSE).

Description :
Met en pause la cinématique dans laquelle l'objet source est impliqué.

Fonction(s) connexe(s) :
ActionPauseConversation

ActionPickUpItem(...)

void ActionPickUpItem
(
    object oItem
)

Paramètres :
- oItem : L'item que l'objet source devra ramasser.

Description :
L'objet source ramassera l'item au sol désigné par oItem. Si l'objet source est éloigné de l'item, il se déplacera vers celui-ci.

Fonction(s) connexe(s) :
ActionPutDownItem

ActionPlayAnimation(...)

void ActionPlayAnimation
(
    int nAnimation,
    float fSpeed = 1.0f,
    float fDurationSeconds = 0.0f
)

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

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

Fonction(s) connexe(s) :
PlayAnimation

ActionPutDownItem(...)

void ActionPutDownItem
(
    object oItem
)

Paramètres :
- oItem : L'item que l'objet source devra poser au sol.

Description :
L'objet source déposera au sol l'item de son inventaire désigné par oItem.

Fonction(s) connexe(s) :
ActionPickUpItem

ActionRandomWalk()

void ActionRandomWalk()

Description :
L'objet source se déplacera de manière aléatoire à une destination non loin de l'endroit où il se trouve. Cette action s'effectuant en boucle, il faudra utiliser la fonction "ClearAllActions(...)" pour l'abandonner.

Fonction(s) connexe(s) :
ClearAllActions

ActionRest(...)

void ActionRest
(
    int bIgnoreNoRestFlag = FALSE
)

Paramètres :
- bIgnoreNoRestFlag : Détermine si le repos est possible malgré un environement hostile (défaut : FALSE).

Description :
L'objet source entrera en repos. Si bIgnoreNoRestFlag est égal à TRUE, le repos sera possible même si des créatures hostiles sont à proximité, ou si l'option "Repos non autorisé" de la zone concernée est à TRUE. Si l'objet source est impliqué dans un combat, la fonction sera sans effet.

Fonction(s) connexe(s) :
ForceRest

ActionResumeConversation()

void ActionResumeConversation()

Description :
Reprend une conversation qui a été mise en pause, et dans laquelle l'objet source est impliqué.

Fonction(s) connexe(s) :
ActionPauseConversation, ActionStartConversation

ActionSit(...)

void ActionSit
(
    object oChair
)

Paramètres :
- oChair : La chaise sur laquelle l'objet source devra s'asseoir.

Description :
L'objet source s'asseoira sur la chaise désignée par oChair.

ActionSpeakString(...)

void ActionSpeakString
(
    string sStringToSpeak,
    int nTalkVolume = TALKVOLUME_TALK
)

Paramètres :
- sStringToSpeak : Le texte devant être "prononcé".
- nTalkVolume : Constante TALKVOLUME_* définissant le mode de discussion (défaut : TALKVOLUME_TALK).

Description :
L'objet source prononcera le texte défini par sStringToSpeak, celui-ci apparaissant à l'ecran ainsi que dans la boîte de dialogue. Selon le paramètre choisi pour nTalkVolume, le texte pourra être "parlé", "chuchotté", ou encore "crié".

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

ActionSpeakStringByStrRef(...)

void ActionSpeakStringByStrRef
(
    int nStrRef,
    int nTalkVolume = TALKVOLUME_TALK
)

Paramètres :
- nStrRef : La référence du texte devant être "prononcé".
- nTalkVolume : Constante TALKVOLUME_* définissant le mode de discussion (défaut : TALKVOLUME_TALK).

Description :
L'objet source prononcera un texte inclus dans le fichier TLK, dont la référence sera définie par nStrRef. Ce texte apparaîtra à l'ecran ainsi que dans la boîte de dialogue. Selon le paramètre choisi pour nTalkVolume, le texte pourra être "parlé", "chuchotté", ou encore "crié".

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

ActionStartConversation(...)

void ActionStartConversation
(
    object oObjectToConverseWith,
    string sDialogResRef = "",
    int bPrivateConversation = FALSE,
    int bPlayHello = TRUE,
    int bIgnoreStartDistance = FALSE,
    int bDisableCutsceneBars = FALSE
)

Paramètres :
- oObjectToConverseWith : L'objet cible, avec lequel l'objet source engagera une conversation.
- sDialogResRef : Le nom de la conversation à exécuter (défaut : "").
- bPrivateConversation : Détermine si la conversation est privée, ou visible pour quiconque se trouve à portée (défaut : FALSE).
- bPlayHello : Détermine si une phrase de bienvenue est prononcée (défaut : TRUE).
- bIgnoreStartDistance : Détermine si la conversation peut être engagée, quelque soit la distance (défaut : FALSE).
- bDisableCutsceneBars : Détermine si la conversation doit être engagée en mode cinématique (défaut : FALSE).

Description :
L'objet source engagera une conversation avec l'objet désigné par oObjectToConverseWith. Si le paramètre sDialogResRef n'est pas rempli, l'objet source utilisera la conversation définie dans ses propriétés.

Fonction(s) connexe(s) :
ActionPauseConversation, ActionResumeConversation, BeginConversation

ActionTakeItem(...)

void ActionTakeItem
(
    object oItem,
    object oTakeFrom,
    int bDisplayFeedback = TRUE
)

Paramètres :
- oItem : L'item devant être transféré.
- oTakeFrom : La créature, ou le contenant, à partir duquel l'item sera transféré.
- bDisplayFeedback : Détermine si un message doit être transmis via la fenêtre de discussion pour un objet acquis/perdu (défaut : TRUE).

Description :
L'item désigné par oItem sera transféré de l'inventaire de oTakeFrom, vers celui de l'objet source. Si oItem ou oTakeFrom ne sont pas des objets valides, la fonction sera sans effet.

Fonction(s) connexe(s) :
ActionGiveItem

ActionUnequipItem(...)

void ActionUnequipItem
(
    object oItem
)

Paramètres :
- oItem : L'item équipé devant être rangé.

Description :
L'objet source rangera dans son inventaire l'item équipé désigné par oItem.

Fonction(s) connexe(s) :
ActionEquipItem

ActionUnlockObject(...)

void ActionUnlockObject
(
    object oTarget
)

Paramètres :
- oTarget : La porte ou le plaçable à déverrouiller.

Description :
L'objet source déverrouillera le plaçable ou la porte désigné par oTarget. Si oTarget est trop éloigné, l'objet source se déplacera.

Fonction(s) connexe(s) :
ActionLockObject

ActionUseFeat(...)

void ActionUseFeat
(
    int nFeat,
    object oTarget
)

Paramètres :
- nFeat : Constante FEAT_* définissant le don à utiliser.
- oTarget : La cible du don.

Description :
L'objet source utilisera le don désigné par nFeat sur oTarget. Seuls les dons nécessitant une cible fonctionneront.

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

ActionUseSkill(...)

int ActionUseSkill
(
    int nSkill,
    object oTarget,
    int nSubSkill = 0,
    object oItemUsed = OBJECT_INVALID
)

Paramètres :
- nSkill : Constante SKILL_* définissant la compétence à utiliser.
- oTarget : La cible de la compétence.
- nSubSkill : Constante SUBSKILL_* définissant une sous-compétence précise (défaut : 0).
- oItemUsed : Item utilisé en parallèle avec la compétence (défaut : OBJECT_INVALID).

Description :
L'objet source utilisera la compétence désignée par nSkill sur oTarget. Le paramètre nSubSkill peut être utilisé dans des cas tels que le désamorçage, où il est possible d'examiner/désamorcer/récupérer/signaler un piège.

Fonction(s) connexe(s) :
ActionUseFeat, GetHasSkill

ActionUseTalentAtLocation(...)

void ActionUseTalentAtLocation
(
    talent tChosenTalent,
    location lTargetLocation
)

Paramètres :
- tChosenTalent : le talent à utiliser.
- lTargetLocation : La localisation où le talent sera utilisé.

Description :
L'objet source utilisera le talent désigné par tChosenTalent à la localisation définie par lTargetLocation. Un talent est déterminé grâce aux fonctions "TalentFeat(...)", "TalentSkill(...)", et "TalentSpell(...)".

Fonction(s) connexe(s) :
ActionUseTalentOnObject, GetCreatureTalent*, Talent*

ActionUseTalentOnObject(...)

void ActionUseTalentOnObject
(
    talent tChosenTalent,
    object oTarget
)

Paramètres :
- tChosenTalent : le talent à utiliser.
- oTarget : L'objet cible sur lequel le talent sera utilisé.

Description :
L'objet source utilisera le talent désigné par tChosenTalent sur l'objet défini par oTarget. Un talent est déterminé grâce aux fonctions "TalentFeat(...)", "TalentSkill(...)", et "TalentSpell(...)".

Fonction(s) connexe(s) :
ActionUseTalentAtLocation, GetCreatureTalent*, Talent*

ActionWait(...)

void ActionWait
(
    float fSeconds
)

Paramètres :
- fSeconds : le temps pendant lequel l'objet source sera en attente.

Description :
L'objet source entrera en attente pendant un temps déterminé par fSeconds. L'attente est une action, elle ne met pas en pause le script.

ActivatePortal(...)

void ActivatePortal
(
    object oTarget,
    string sIPaddress = "",
    string sPassword = "",
    string sWaypointTag = "",
    int bSeemless = FALSE
)

Paramètres :
- oTarget : Joueur à transférer vers un serveur NWN2.
- sIPaddress : Adresse du serveur NWN2 de destination (défaut : "").
- sPassword : Mot de passe du serveur NWN2 de destination (défaut : "").
- sWaypointTag : Point de passage au niveau duquel le joueur apparaîtra (défaut : "").
- bSeemless : Détermine si la fenêtre d'informations de connexion doit être masquée. Si bSeemless est égal à TRUE, et que le joueur utilise un personnage local, celui-ci ne sera pas sauvegardé (défaut : FALSE).

Description :
Le joueur désigné par oTarget sera transféré vers un serveur NWN2 local ou distant. Le parametre sIPaddress peut contenir une adresse IP (123.123.123.123), ou un nom de domaine (www.serveur-nwn2.fr). Le numéro du port qu'utilise le serveur peut également être inséré ([adresse.ip]:[port] / [nom.de.domaine]:[port]).

Fonction(s) connexe(s) :
BootPC

AddHenchman(...)

void AddHenchman
(
    object oMaster,
    object oHenchman = OBJECT_SELF
)

Paramètres :
- oMaster : Créature à laquelle le compagnon d'arme obéira.
- oHenchman : Créature destinée à devenir compagnon d'armes (défaut : OBJECT_SELF).

Description :
La créature désignée par oHenchman deviendra le compagnon d'armes de oMaster. Il réagira aux ordres que pourra lui donner ce dernier.

Fonction(s) connexe(s) :
RemoveHenchman

AddItemProperty(...)

void AddItemProperty
(
    int nDurationType,
    itemproperty ipProperty,
    object oItem,
    float fDuration = 0.0f
)

Paramètres :
- nDurationType : Constante DURATION_TYPE_* définissant le type de durée à appliquer.
- ipProperty : La propriété d'item à rajouter.
- oItem : L'item sur lequel doit être rajoutée la propriété.
- fDuration : Temps pendant lequel la propriété sera appliquée (défaut : 0.0f).

Description :
Une propriété d'item sera rajoutée sur l'item désigné par oItem. Si nDurationType est égal à DURATION_TYPE_PERMANENT, le paramètre fDuration sera sans effet. Si nDurationType est égal à DURATION_TYPE_INSTANT, la fonction sera sans effet.

Fonction(s) connexe(s) :
RemoveItemProperty

AddJournalQuestEntry(...)

void AddJournalQuestEntry
(
    string szPlotID,
    int nState,
    object oCreature,
    int bAllPartyMembers = TRUE,
    int bAllPlayers = FALSE,
    int bAllowOverrideHigher = FALSE
)

Paramètres :
- szPlotID : Le Tag de la quête concernée.
- nState : L'identifiant de l'étape de la quête concernée.
- oCreature : Le joueur dont le journal de quête sera mis à jour.
- bAllPartyMembers : Détermine si le journal doit être mis à jour pour tous les membres du groupe de oCreature (défaut : TRUE).
- bAllPlayers : Détermine si le journal doit être mis à jour pour tous les joueur du module (défaut : FALSE).
- bAllowOverrideHigher : Détermine si la quête doit régresser à une étape précédente (défaut : FALSE).

Description :
La quête dont le tag est défini par szPlotID sera mise à jour dans le journal du joueur désigné par oCreature.

Fonction(s) connexe(s) :
GetJournalEntryRemoveJournalQuestEntry

AddListBoxRow(...)

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

Paramètres :
- oPlayer : Le joueur dont l'interface sera affectée.
- sScreenName : Le nom de l'élément d'interface contenant la liste.
- sListBox : Le nom de la liste à affecter.
- sRowName : Le nom de la nouvelle rangée.
- sTextFields : La liste des champs de texte et des valeurs à insérer.
- sTextures : La liste des éléments de texture à insérer, ainsi que leurs noms.
- sVariables : La liste des index des variables, ainsi que leurs valeurs.
- sHideUnhide : La liste des éléments à masquer ou afficher.

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

J'avoue que je n'ai rien compris du tout.

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

AddRosterMemberByCharacter(...)

int AddRosterMemberByCharacter
(
    string sRosterName,
    object oCharacter
)

Paramètres :
- sRosterName : Le nom de référence qu'aura la créature.
- oCharacter : La créature à ajouter dans la "liste des compagnons".

Description :
La créature désignée par oCharacter sera rajoutée dans la "liste des compagnons", sous un nom défini par sRosterName. La valeur TRUE sera renvoyée si la fonction s'est exécutée avec succès.

Fonction(s) connexe(s) :
AddRosterMemberByTemplate, RemoveRosterMember

AddRosterMemberByTemplate(...)

int AddRosterMemberByTemplate
(
    string sRosterName,
    string sTemplate
)

Paramètres :
- sRosterName : Le nom de référence qu'aura la créature.
- sTemplate : Le ResRef (ou Blueprint) de la créature à ajouter dans la "liste des compagnons".

Description :
La créature dont le ResRef est désigné par sTemplate sera rajoutée dans la "liste des compagnons", sous un nom défini par sRosterName. La valeur TRUE sera renvoyée si la fonction s'est exécutée avec succès.

Fonction(s) connexe(s) :
AddRosterMemberByCharacter, RemoveRosterMember

AddRosterMemberToParty(...)

int AddRosterMemberToParty
(
    string sRosterName,
    object oPC
)

Paramètres :
- sRosterName : Le nom de référence du compagnon.
- oPC : Le joueur auquel le compagnon d'armes sera rattaché.

Description :
La créature dont le nom de compagnon est référencé dans la "liste des compagnons" sera rattaché à oPC, et rajouté dans son groupe. La valeur TRUE sera renvoyée si la fonction s'est exécutée avec succès.

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

AddScriptParameterFloat(...)

void AddScriptParameterFloat
(
    float fParam
)

Paramètres :
- fParam : Le paramètre de type float à définir.

Description :
Définit un paramètre de type float désigné par fParam, destiné à être utilisé par la fonction ExecuteScriptEnhanced.

Fonction(s) connexe(s) :
AddScriptParameterInt, AddScriptParameterObject, AddScriptParameterString, ClearScriptParams, ExecuteScriptEnhanced

AddScriptParameterInt(...)

void AddScriptParameterInt
(
    int nParam
)

Paramètres :
- nParam : Le paramètre de type int à définir.

Description :
Définit un paramètre de type int désigné par nParam, destiné à être utilisé par la fonction ExecuteScriptEnhanced.

Fonction(s) connexe(s) :
AddScriptParameterFloat, AddScriptParameterObject, AddScriptParameterString, ClearScriptParams, ExecuteScriptEnhanced

AddScriptParameterObject(...)

void AddScriptParameterObject
(
    object oParam
)

Paramètres :
- oParam : Le paramètre de type object à définir.

Description :
Définit un paramètre de type object désigné par oParam, destiné à être utilisé par la fonction ExecuteScriptEnhanced.

Fonction(s) connexe(s) :
AddScriptParameterFloat, AddScriptParameterInt, AddScriptParameterString, ClearScriptParams, ExecuteScriptEnhanced

AddScriptParameterString(...)

void AddScriptParameterString
(
    string sParam
)

Paramètres :
- sParam : Le paramètre de type string à définir.

Description :
Définit un paramètre de type string désigné par sParam, destiné à être utilisé par la fonction ExecuteScriptEnhanced.

Fonction(s) connexe(s) :
AddScriptParameterFloat, AddScriptParameterInt, AddScriptParameterObject, ClearScriptParams, ExecuteScriptEnhanced

AddToParty(...)

void AddToParty
(
    object oPC,
    object oPartyLeader
)

Paramètres :
- oPC : Le joueur à rajouter dans le groupe.
- oPartyLeader : Le chef du groupe dans lequel le joueur sera rajouté.

Description :
Le joueur désigné par oPC sera rajouté dans le groupe de oPartyLeader. Si oPC ou oPartyLeader ne sont pas des personnages joueurs, la fonction sera sans effet.

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

AdjustAlignment(...)

void AdjustAlignment
(
    object oSubject,
    int nAlignment,
    int nShift
)

Paramètres :
- oSubject : La créature dont l'alignement doit être ajusté.
- nAlignment : Constante ALIGNMENT_* définissant le type de modification à appliquer.
- nShift : La valeur à rajouter/enlever à l'alignement.

Description :
L'alignement de la créature désignée par oSubject sera ajusté. L'alignement est défini par deux valeurs, [Chaotique/Loyal] et [Mauvais/Bon], chacune comprise entre 0 et 100. Selon le type de modification defini par nAlignement, l'ajustement se fera de différentes manières (cf.exemple).

Exemple :

void main()
{
    // Admettons que le joueur soit Neutre strict (50 / 50).
    object oJoueur = GetTrucMuchePourFaireExemple();

    // L'alignement sera ici ajusté de 25 points vers Mauvais :
    AdjustAlignment(oJoueur, ALIGNMENT_EVIL, 25);
    // Le joueur deviendra Neutre / Mauvais (50 / 25).

    // Puis il sera ajusté de 25 points vers Loyal :
    AdjustAlignment(oJoueur, ALIGNMENT_LAW, 25);
    // Le joueur deviendra Loyal / Mauvais (75 / 25).

    // L'alignement général sera ici augmenté de 25 points :
    AdjustAlignment(oJoueur, ALIGNMENT_ALL, 25);
    // Le joueur deviendra Loyal / Neutre (100 / 50).

    // Puis il sera diminué de 25 points :
    AdjustAlignment(oJoueur, ALIGNMENT_ALL, -25);
    // Le joueur redeviendra Loyal / Mauvais (75 / 25).

    // Puis il sera ajusté de 25 points vers la neutralité :
    AdjustAlignment(oJoueur, ALIGNMENT_NEUTRAL, 25);
    // Le joueur redeviendra Neutre strict (50 / 50).
}

Fonction(s) connexe(s) :
AdjustReputation, GetAlignmentGoodEvil, GetAlignmentLawChaos, GetGoodEvilValue, GetLawChaosValue

AdjustReputation(...)

void AdjustReputation
(
    object oTarget,
    object oSourceFactionMember,
    int nAdjustment
)

Paramètres :
- oTarget : La créature dont la réputation doit être ajustée.
- oSourceFactionMember : Créature représentant la faction par rapport à laquelle la réputation sera ajustée.
- nAdjustment : La valeur à rajouter/enlever à la réputation.

Description :
La réputation de la créature désignée par oTarget vis-à-vis de la faction de oSourceFactionMember sera ajustée. La réputation est définie par une valeur entre 0 et 100 (hostile/amical).

Fonction(s) connexe(s) :
AdjustAlignment, ClearPersonalReputation, GetReputation

AmbientSoundChangeDay(...)

void AmbientSoundChangeDay
(
    object oArea,
    int nTrack
)

Paramètres :
- oArea : La zone à affecter.
- nTrack : Constante TRACK_* définissant le son d'ambiance.

Description :
Le son d'ambiance de jour défini par nTrack sera affecté à la zone désignée par oArea.

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

AmbientSoundChangeNight(...)

void AmbientSoundChangeNight
(
    object oArea,
    int nTrack
)

Paramètres :
- oArea : La zone à affecter.
- nTrack : Constante TRACK_* définissant le son d'ambiance.

Description :
Le son d'ambiance de nuit défini par nTrack sera affecté à la zone désignée par oArea.

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

AmbientSoundPlay(...)

void AmbientSoundPlay
(
    object oArea
)

Paramètres :
- oArea : La zone à affecter.

Description :
Le son d'ambiance de la zone désigné par oArea sera joué.

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

AmbientSoundSetDayVolume(...)

void AmbientSoundSetDayVolume
(
    object oArea,
    int nVolume
)

Paramètres :
- oArea : La zone à affecter.
- nVolume : La valeur à ajouter/enlever au volume de la musique d'ambiance.

Description :
Le volume du son d'ambiance de jour de la zone désignée par oArea sera ajusté.

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

AmbientSoundSetNightVolume(...)

void AmbientSoundSetNightVolume
(
    object oArea,
    int nVolume
)

Paramètres :
- oArea : La zone à affecter.
- nVolume : La valeur à ajouter/enlever au volume de la musique d'ambiance.

Description :
Le volume du son d'ambiance de nuit de la zone désignée par oArea sera ajusté.

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

AmbientSoundStop(...)

void AmbientSoundPlay
(
    object oArea
)

Paramètres :
- oArea : La zone à affecter.

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

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

AngleToVector(...)

vector AngleToVector
(
    float fAngle
)

Paramètres :
- fAngle : La valeur de l'angle à convertir.

Description :
La valeur de l'angle définie par fAngle sera convertie en valeur de type "vector".

Fonction(s) connexe(s) :
Vector, VectorMagnitude, VectorNormalize, VectorToAngle

ApplyEffectAtLocation(...)

void ApplyEffectAtLocation
(
    int nDurationType,
    effect eEffect,
    location lLocation,
    float fDuration = 0.0f
)

Paramètres :
- nDurationType : Constante DURATION_TYPE_* définissant le type de durée à appliquer.
- eEffect : L'effet à appliquer.
- lLocation : La localisation où l'effet doit être appliqué.
- fDuration : La durée à appliquer (défaut : 0.0f).

Description :
L'effet désigné par eEffect sera appliqué à une localistion définie par lLocation. Si nDurationType est égal à DURATION_TYPE_INSTANT ou DURATION_TYPE_PERMANENT, le paramètre fDuration sera sans effet.

Fonction(s) connexe(s) :
ApplyEffectToObject

ApplyEffectToObject(...)

void ApplyEffectToObject
(
    int nDurationType,
    effect eEffect,
    object oTarget,
    float fDuration = 0.0f
)

Paramètres :
- nDurationType : Constante DURATION_TYPE_* définissant le type de durée à appliquer.
- eEffect : L'effet à appliquer.
- oTarget : L'objet sur lequel l'effet doit être appliqué.
- fDuration : La durée à appliquer (défaut : 0.0f).

Description :
L'effet désigné par eEffect sera appliqué sur l'objet désigné par oTarget. Si nDurationType est égal à DURATION_TYPE_INSTANT ou DURATION_TYPE_PERMANENT, le paramètre fDuration sera sans effet.

Fonction(s) connexe(s) :
ApplyEffectAtLocation, RemoveEffect

asin(...)

float asin
(
    float fValue
)

Paramètres :
- fValue : Sinus de l'angle que l'on souhaite retrouver.

Description :
Permet de retrouver la valeur d'un angle à partir d'une valeur Sinus (côté opposé/hypoténuse). La valeur fValue doit être comprise entre -1 et 1 (inclus).

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

AssignCommand(...)

void AssignCommand
(
    object oActionSubject,
    action aActionToAssign
)

Paramètres :
- oActionSubject : L'objet devant exécuter la commande.
- aActionToAssign : La commande à assigner.

Description :
L'objet désigné par oActionSubject exécutera la commande définie par aActionToAssign. oActionSubject devient l'objet source pour toute commande assignée.

Fonction(s) connexe(s) :
ActionDoCommand, AssignCutsceneActionToObject, DelayCommand

AssignCutsceneActionToObject(...)

void AssignCutsceneActionToObject
(
    object oObject,
    action aAction
)

Paramètres :
- oObject : L'objet devant exécuter la commande.
- aAction : La commande à assigner.

Description :
L'objet désigné par oObject exécutera la commande définie par aAction en mode cinématique. oActionSubject devient l'objet source pour toute commande assignée.

Fonction(s) connexe(s) :
AssignCommand

atan(...)

float atan
(
    float fValue
)

Paramètres :
- fValue : Tangente de l'angle que l'on souhaite retrouver.

Description :
Permet de retrouver la valeur d'un angle à partir d'une valeur Tangente (côté opposé/côté adjacent). La valeur fValue doit être comprise entre -1 et 1 (inclus).

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

LISTE DES FONCTIONS

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