NWScript - Fonctions de T à Y

TakeGoldFromCreature(...)

void TakeGoldFromCreature
(
    int nAmount,
    object oCreatureToTakeFrom,
    int bDestroy = FALSE,
    int bDisplayFeedback = TRUE
)

Paramètres :
- nAmount : Le montant d'or à retirer.
- oCreatureToTakeFrom : La créature concernée.
- bDestroy : Détermine si l'or doit être supprimé (défaut : FALSE).
- bDisplayFeedback : Détermine si un message doit s'afficher dans la fenêtre de discussion/combat (défaut : TRUE).

Description :
Retire une somme d'or à la créature désignée par oCreatureToTakeFrom. Cette fonction s'utilise avec la fonction "AssignCommand(...)", afin de transférer une somme d'or d'une créature vers une autre, ou de supprimer une somme d'or. La méthode suivante permet de supprimer 100 pièces du total d'or d'un joueur :

AssignCommand(oJoueur, TakeGoldFromCreature(100, oJoueur, TRUE));

Fonction(s) connexe(s) :
GetGold, GiveGoldToCreature

TalentFeat(...)

talent TalentFeat
(
    int nFeat
)

Paramètres :
- nFeat : Constante FEAT_* définissant le don à convertir.

Description :
Crée une valeur "talent" à partir d'un don.

Fonction(s) connexe(s) :
ActionUseTalentAtLocation, ActionUseTalentOnObject, GetHasFeat

TalentSkill(...)

talent TalentSkill
(
    int nSkill
)

Paramètres :
- nFeat : Constante SKILL_* définissant la compétence à convertir.

Description :
Crée une valeur "talent" à partir d'une compétence.

Fonction(s) connexe(s) :
ActionUseTalentAtLocation, ActionUseTalentOnObject, GetHasSkill

TalentSpell(...)

talent TalentSpell
(
    int nSpell
)

Paramètres :
- nFeat : Constante SPELL_* définissant le sort à convertir.

Description :
Crée une valeur "talent" à partir d'un sort.

Fonction(s) connexe(s) :
ActionUseTalentAtLocation, ActionUseTalentOnObject, GetHasSpell

tan(...)

float tan
(
    float fValue
)

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

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

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

TestStringAgainstPattern(...)

int TestStringAgainstPattern
(
    string sPattern,
    string sStringToTest
)

Paramètres :
- sPattern : La chaîne de caractères concernée.
- sStringToTest : La chaîne de caractères désirée.

Description :
Détermine si la chaîne de caractères sPattern contient la chaîne de caractères sStringToTest. Tout comme la fonction "GetMatchedSubstring(...)", il est possible d'utiliser des sortes de "commandes", au sein de la chaîne de caractères sStringToTest :
** reconnaîtra un nombre infini de caractères.
*w permettra de déterminer s'il y a au moins un espace.
*n permettra de déterminer s'il y a au moins un chiffre.
*p permettra de déterminer s'il y a au moins un signe de ponctuation.
*a permettra de déterminer s'il y a au moins un caractère compris entre a et z.
| est l'opérateur "ou".
( ) inclus un ensemble de caractères à vérifier.

Comme c'est quand même très flou, voici quelques exemples que je pourrais utiliser en paramètre sStringToTest :

Si je mets "**voiture**", je pourrai déterminer si sPattern contient le mot "voiture".
Si je mets "**voiture**cheval**", je pourrai déterminer si sPatern contient le mot "voiture" ET le mot cheval".
Si je mets "**(voiture|cheval)**", je pourrai déterminer si sPattern contient le mot "voiture" OU le mot "cheval".
Si je mets "**route**(voiture|cheval)**", je pourrai déterminer si d'une part sPatern contient le mot "route", ET s'il contient "voiture" ou "cheval".

La valeur TRUE sera renvoyée si sStringToTest (ou un élément de sStringToTest) a été reconnu dans la chaîne de caractères sPattern.

Fonction(s) connexe(s) :
FindSubString, GetMatchedSubstring, GetString*

TouchAttackMelee(...)

int TouchAttackMelee
(
    object oTarget,
    int bDisplayFeedback = TRUE,
    int nBonus = 0
)

Paramètres :
- oTarget : La cible de l'attaque.
- bDisplayFeedback : Détermine si les informations relatives à l'attaque doivent être affichées dans la fenêtre de discussion/combat (défaut : TRUE).
- nBonus : Bonus additionné au jet d'attaque (défaut : 0).

Description :
L'objet source effectuera un jet d'attaque "de contact au corps à corps" sur la cible désignée par oTarget. Cette attaque n'est pas une action, et considèrera que l'objet source est à portée de sa cible. La valeur renvoyée sera égale à 0 si l'attaque est ratée, à 1 si elle est réussie, et à 2 s'il s'agit d'un jet critique. La valeur renvoyée pourra être comparée aux constantes TOUCH_ATTACK_RESULT_*.

Fonction(s) connexe(s) :
TouchAttackRanged

TouchAttackRanged(...)

int TouchAttackRanged
(
    object oTarget,
    int bDisplayFeedback = TRUE,
    int nBonus = 0
)

Paramètres :
- oTarget : La cible de l'attaque.
- bDisplayFeedback : Détermine si les informations relatives à l'attaque doivent être affichées dans la fenêtre de discussion/combat (défaut : TRUE).
- nBonus : Bonus additionné au jet d'attaque (défaut : 0).

Description :
L'objet source effectuera un jet d'attaque "de contact à distance" sur la cible désignée par oTarget. Cette attaque n'est pas une action. La valeur renvoyée sera égale à 0 si l'attaque est ratée, à 1 si elle est réussie, et à 2 s'il s'agit d'un jet critique. La valeur renvoyée pourra être comparée aux constantes TOUCH_ATTACK_RESULT_*.

Fonction(s) connexe(s) :
TouchAttackMelee

TriggerEncounter(...)

void TriggerEncounter
(
    object oEncounter,
    object oPlayer,
    int iCRFlag,
    float fCR
)

Paramètres :
- oEncounter : La rencontre concernée.
- oPlayer : Le joueur concerné.
- iCRFlag : Constante ENCOUNTER_CALC_* définissant la manière de calculer la difficulté (paramètre non-entièrement implanté).
- fCR : Le facteur de puissance à considérer.

Description :
Cette fonction permet d'activer la rencontre désignée par oEncounter, comme si le joueur désigné par oPlayer était entré dans la surface de cette rencontre. La valeur de fCR détermine le facteur de puissance que la rencontre prendra en compte pour générer les créatures. Si fCR est égal à -1.0f, la rencontre tentera de calculer le facteur de puissance correct, en se basant sur les joueurs à proximité.

TurnsToSeconds(...)

float TurnsToSeconds
(
    int nTurns
)

Paramètres :
- nTurns : Le nombre de "tours de jeu" à convertir.

Description :
Convertit un nombre de "tours de jeu" en secondes. Un tour est toujours égal à 60 secondes.

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

UnlinkDoor(...)

void UnlinkDoor
(
    object oDoor
)

Paramètres :
- oDoor : La porte concernée.

Description :
La destination de la porte désignée par oDoor sera supprimée, et celle-ci ne sera plus considérée comme "porte de transition". Cette fonction est nécessaire pour détruire une "porte de transition".

Fonction(s) connexe(s) :
RoundsToSeconds

UnpossessFamiliar(...)

void UnpossessFamiliar
(
    object oCreature
)

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

Description :
Si le familier désigné par oCreature est possédé par un joueur, celui-ci relachera immédiatement son contrôle. Ne fonctionne pas sur une créature possédée par un MD.

Fonction(s) connexe(s) :
GetIsPossessedFamiliar

Vector(...)

vector Vector
(
    float x = 0.0f,
    float y = 0.0f,
    float z = 0.0f
)

Paramètres :
- x : La valeur de l'abscisse.
- y : La valeur de l'ordonnée.
- z : La valeur de la cote.

Description :
Calcule les coordonnées cartésiennes d'un point à partir des valeur x, y et z (pour les non-matheux : un point dans l'espace à partir de trois points sur les axes longueur/largeur/hauteur).

Fonction(s) connexe(s) :
AngleToVector, Location, VectorMagnitude, VectorNormalize, VectorToAngle

VectorMagnitude(...)

float VectorMagnitude
(
    vector vVector
)

Paramètres :
- vVector : Le vecteur concerné.

Description :
Calcule la taille du vecteur désigné par vVector. Peut être utilisé pour déterminer la distance entre deux points. La valeur 0.0f sera renvoyée en cas d'erreur.

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

VectorNormalize(...)

vector VectorNormalize
(
    vector vVector
)

Paramètres :
- vVector : Le vecteur à normaliser.

Description :
Normalise le vecteur désigné par vVector, en lui donnant une taille de 1.

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

VectorToAngle(...)

float VectorToAngle
(
    vector vVector
)

Paramètres :
- vVector : Le vecteur à convertir.

Description :
Convertit le vecteur désigné par vVector en angle, par rapport au point d'origine [0.0,0.0,0.0].

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

VersusAlignmentEffect(...)

effect VersusAlignmentEffect
(
    effect eEffect,
    int nLawChaos = ALIGNMENT_ALL,
    int nGoodEvil = ALIGNMENT_ALL
)

Paramètres :
- eEffect : L'effet concerné.
- nLawChaos : Constante ALIGNMENT_* définissant l'alignement de Chaotique à Loyal (défaut : ALIGNMENT_ALL).
- nGoodEvil : Constante ALIGNMENT_* définissant l'alignement de Mauvais à Bon (défaut : ALIGNMENT_ALL).

Description :
Convertit l'effet désigné par eEffect en effet de sous-catégorie "contre alignement". Seuls certains effets pourront être convertis de telle manière (Cf. description de la fonction dans l'éditeur de script).

Fonction(s) connexe(s) :
MagicalEffect, SupernaturalEffect, VersusRacialTypeEffect, VersusTrapEffect

VersusRacialTypeEffect(...)

effect VersusRacialTypeEffect
(
    effect eEffect,
    int nRacialType
)

Paramètres :
- eEffect : L'effet concerné.
- nRacialType : Constante RACIAL_TYPE_* définissant le groupe racial concernée.

Description :
Convertit l'effet désigné par eEffect en effet de sous-catégorie "contre groupe racial".

Fonction(s) connexe(s) :
MagicalEffect, SupernaturalEffect, VersusAlignmentEffect, VersusTrapEffect

VersusTrapEffect(...)

effect VersusTrapEffect
(
    effect eEffect
)

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

Description :
Convertit l'effet désigné par eEffect en effet de sous-catégorie "contre les pièges".

Fonction(s) connexe(s) :
MagicalEffect, SupernaturalEffect, VersusAlignmentEffect, VersusRacialTypeEffect

WillSave(...)

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

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

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

Fonction(s) connexe(s) :
FortitudeSave, GetWillSavingThrow, ReflexSave

WriteTimestampedLogEntry(...)

void WriteTimestampedLogEntry
(
    string sLogEntry
)

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

Description :
Rajoute un indicateur horaire devant la chaîne de caractères désignée par sLogEntry, qui sera envoyée dans le fichier "log". Dépend du paramètre "[Server Options]Scripts Print To LoG" du fichier nwnplayer.ini.

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

YardsToMeters(...)

float YardsToMeters
(
    float fYards
)

Paramètres :
- fYards : La distance en yards à convertir.

Description :
Renvoie la valeur métrique de la distance en yard définie par fYards.

Fonction(s) connexe(s) :
FeetToMeters

LISTE DES FONCTIONS

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