APIDocs.md

API v53 Documentation

Table of Contents

• Getting Started
• Notes on API Stability
• Preprocessor
• Data Types
• Stats
• Statuses
  • IterateCharacterStatuses
  • OnStatusAttempt
  • StatusPreventApply
  • StatusGetHandle
  • StatusGet
  • StatusSet
  • ApplyActiveDefense
• Hit Statuses
• Status Attributes
  • StatusHit Attributes
  • Hit Attributes
  • StatusHeal Attributes
  • StatusHealing Attributes
• Hits
• Projectiles
• Game Actions
• Characters
  • Character Stats
  • Base Stats
  • Custom Stats
  • Permanent Boosts
  • Skills
  • Actions
• Player
  • Player Customization
  • Skillbar
• Items
  • Item Stats
  • Item Cloning
• Misc Functions
• Math Functions
• String Functions
• Enumerations
  • DamageSourceType
  • HitType
  • CriticalRoll
  • HighGround
  • DeathType
  • AttackDirection
  • TalentType
  • AttributeFlags

Getting Started

To start using the extension in your mod, a configuration file must be created that describes what features are utilized by your mod.

Create a file at Mods\YourMod_11111111-2222-...\OsiToolsConfig.json with the following contents, then tweak the values as desired:

{
    "RequiredExtensionVersion": 52,
    "FeatureFlags": [
        "OsirisExtensions",
        "Lua"
    ]
}

Meaning of configuration keys:

Key	Meaning
RequiredExtensionVersion	Osiris Extender version required to run the mod. It is recommended to use the version number of the Script Extender you used for developing the mod since the behavior of new features and backwards compatibility functions depends on this version number.
ModTable	Name of the mod in the global mod table (Mods) when using Lua.
FeatureFlags	A list of features that the mod is using. For performance reasons it is recommended to only list features that are actually in use.

The following features are accepted in FeatureFlags:

Value	Meaning
OsirisExtensions	Enables the Osiris extension functions described here (functions with the prefix NRD_)
Lua	Enables scripting via the Lua runtime (see Lua API Documentation)
Preprocessor	Enables the use of preprocessor definitions in Story scripts. (See Preprocessor)
DisableFolding	Disable folding of dynamic item stats
CustomStats	Activates the custom stats system in non-GM mode (see Custom Stats for more details). Custom stats are always enabled in GM mode.
CustomStatsPane	Replaces the Tags tab with the Custom Stats tab on the character sheet

Notes on API stability

Functions without any TODO or Stability comments are considered to be final and will not change. (Minor behavior changes or bugfixes may happen, but the API will not break.) Functions marked Experimental might be removed in future versions, or may change without any restriction.

Preprocessor

To support mods that may not want to depend on the extender but want to take advantages of its features when available, two "preprocessor" constructs are provided that allow conditional compilation of code when the extender is present / not present. To make use of this feature, enable the PreprocessStory variable in your extension config.

The first construct allows defining code that only runs when the extender is loaded. To achieve this, the block comment /* ... */ is tagged so the extender can uncomment the code during compilation if it is present. Syntax:

/* [OSITOOLS_ONLY]
// Code in this block is normally commented out; however,
// the leading and trailing comment tags are removed if
// the extender is present.
IF
Whatever()
THEN
DB_NOOP(1);
*/

The second construct is the opposite, i.e. it only removes code when the extender is loaded. Syntax:

// [BEGIN_NO_OSITOOLS]
// This code is executed if the extender is not loaded.
// With the extender, the code between "// [BEGIN..." and "// [END..." is removed entirely.
IF
Whatever()
THEN
DB_NOOP(1);
// [END_NO_OSITOOLS]

Example usage:

IF
TextEventSet("preprocessor")
THEN
/* [OSITOOLS_ONLY]
DebugBreak("This code only runs if OsiTools is loaded");
*/
DebugBreak("This always runs");
// [BEGIN_NO_OSITOOLS]
DebugBreak("This only runs if OsiTools is *NOT* loaded");
// [END_NO_OSITOOLS]

Data Types

The data types mentioned in this document should be interpreted as follows:

Integer

A 32-bit signed integer; equivalent to the Osiris INTEGER type. Can be read/written using the XyzGetInt() and XyzSetInt() getter/setter functions.

Real

Equivalent to the Osiris REAL type. Can be read/written using the XyzGetReal() and XyzSetReal() getter/setter functions.

String

Equivalent to the Osiris STRING type. Can be read/written using the XyzGetString() and XyzSetString() getter/setter functions.

Flag

An integer value with two allowed values, 0 and 1. These are essentially boolean values, but since Osiris lacks boolean support, they are passed as integers. Can be read/written using the XyzGetInt() and XyzSetInt() getter/setter functions.

Enum

An integer value with a list of allowed values. The values can be found in Enumerations.xml if it is a standard enumeration, or in the Enumerations section of this document if it's a non-standard/undocumented enumeration.

An enum property can be read/written using its index with the XyzGetInt() and XyzSetInt() getter/setter functions, or using its textual label with the XyzGetString() and XyzSetString() getter/setter functions. Example:

// Set DamageSourceType to SurfaceCreate by ID
NRD_StatusSetInt(_Char, _Status, "DamageSourceType", 2);
// Set DamageSourceType to SurfaceCreate by name
NRD_StatusSetString(_Char, _Status, "DamageSourceType", "SurfaceCreate"); 
...
// GetDamageSourceType by ID (_Val == 2)
NRD_StatusGetInt(_Char, _Status, "DamageSourceType", _Val);
// GetDamageSourceType by name(_Val == "SurfaceCreate")
NRD_StatusGetString(_Char, _Status, "DamageSourceType", _Val); 

Stat functions

These functions can be used to query stats entries.

StatExists

query NRD_StatExists([in](STRING)_StatsId)

Checks whether the specified stat entry exists. The query succeeds if the stat entry exists, and fails if it does not.

StatAttributeExists

query NRD_StatAttributeExists([in](STRING)_StatsId, [in](STRING)_Attribute)

Checks whether the stat entry _StatsId has an attribute (data) named _Attribute. The query succeeds if the attribute exists, and fails if it does not.

StatGetInt

query NRD_StatGetInt([in](STRING)_StatsId, [in](STRING)_Attribute, [out](INTEGER)_Value)

Returns the specified _Attribute of the stat entry. If the stat entry does not exist, the stat entry doesn't have an attribute named _Attribute, or the attribute isn't convertible to integer, the query fails.

Notes:

• For enumerations, the function will return the index of the value in the enumeration. eg. for Damage Type Corrosive, it will return 3.

StatGetString

query NRD_StatGetString([in](STRING)_StatsId, [in](STRING)_Attribute, [out](STRING)_Value)

Returns the specified _Attribute of the stat entry. If the stat entry does not exist, the stat entry doesn't have an attribute named _Attribute, or the attribute isn't convertible to string, the query fails.

Notes:

• For enumerations, the function will return the name of the enumeration value (eg. Corrosive).

StatGetType

query NRD_StatGetType([in](STRING)_StatsId, [out](STRING)_Type)

Returns the type of the specified stat entry. If the stat entry does not exist, the query fails. Possible return values: Character, Potion, Armor, Object, Shield, Weapon, SkillData, StatusData.

StatGetExtraData

query NRD_StatGetExtraData([in](STRING)_Key, [out](REAL)_Value)

Returns the specified key from Data.txt. If the key does not exist, the query fails.

Status functions

IterateCharacterStatuses

call NRD_IterateCharacterStatuses((CHARACTERGUID)_CharacterGuid, (STRING)_Event)
event NRD_StatusIteratorEvent((STRING)_Event, (CHARACTERGUID)_Character, (STRING)_StatusId, (INTEGER64)_StatusHandle)

Throws status iterator event _Event for each status present on the character. Unlike regular events, NRD_StatusIteratorEvent events are not queued and are thrown immediately (i.e. during the NRD_IterateCharacterStatuses call), so there is no need for an additional cleanup/finalizer event.

Example usage:

// ...
NRD_IterateCharacterStatuses(Sandbox_Market_Ernest_Herringway_da8d55ba-0855-4147-b706-46bbc67ec8b6, "MyMod_Statuses");

IF
NRD_StatusIteratorEvent("MyMod_Statuses", _Char, _StatusId, _StatusIdx)
THEN
DebugBreak(_StatusId);

Notes:

• The call might not enumerate all statuses correctly (i.e. miss some statuses or iterate over them multiple times) if statuses are added or removed during the NRD_StatusIteratorEvent event
• The _StatusHandle is a persistent, unique value (like UUIDs) identifying the status instance. Unlike status names, it can be used to differentiate between two instances of the same status.

OnStatusAttempt

event NRD_OnStatusAttempt((GUIDSTRING)_Target, (STRING)_StatusId, (INTEGER64)_StatusHandle, (GUIDSTRING)_Instigator)

Thrown before a status is applied to the target character or item. Status attributes can be queried using the NRD_StatusGet[...] functions and updated using the NRD_StatusSet[...] functions. For a list of attributes, see Status attributes.

Notes:

• Unlike CharacterStatusAttempt, the rules for this event are triggered before the status is applied.
• Built-in status queries like HasActiveStatus, GetStatusTurns won't see this status, since it hasn't been applied yet.
• Since the event is thrown before the status prerequisite checks are performed, it is possible that the status won't be applied if it fails to pass a check.
• The status flags ForceStatus and ForceFailStatus can be set during the status attempt event to force a successful/failed prerequisite check result.

StatusPreventApply

call NRD_StatusPreventApply((GUIDSTRING)_Character, (INTEGER64)_StatusHandle, (INTEGER)_PreventApply)

Prevents a pending status from being applied to the character.

Notes:

• Can only be called during an OnStatusAttempt event; calling it after the status attempt event completed has no effect.
• Unlike the ForceFailStatus flag, stopping a status attempt using StatusPreventApply will also prevent the CharacterStatusAttempt and FetchCharacterApplyStatusData events.

StatusGetHandle

query NRD_StatusGetHandle([in](CHARACTERGUID)_Character, [in](STRING)_StatusId, [out](INTEGER64)_StatusHandle)

Returns the handle of the first status with the specified _StatusId. If no such status exists, the query fails.

The _StatusHandle is a persistent, unique value (like UUIDs) identifying the status instance.

Example usage:

// ...
AND
NRD_StatusGetHandle(Sandbox_Market_Ernest_Herringway_da8d55ba-0855-4147-b706-46bbc67ec8b6, "WET", _Handle)
THEN
NRD_DebugLog((STRING)_Handle);

StatusGet

query NRD_StatusGetInt([in](CHARACTERGUID)_Character, [in](INTEGER64)_StatusHandle, [in](STRING)_Attribute, [out](INTEGER)_Value)
query NRD_StatusGetReal([in](CHARACTERGUID)_Character, [in](INTEGER64)_StatusHandle, [in](STRING)_Attribute, [out](REAL)_Value)
query NRD_StatusGetString([in](CHARACTERGUID)_Character, [in](INTEGER64)_StatusHandle, [in](STRING)_Attribute, [out](STRING)_Value)
query NRD_StatusGetGuidString([in](CHARACTERGUID)_Character, [in](INTEGER64)_StatusHandle, [in](STRING)_Attribute, [out](GUIDSTRING)_Value)

Returns the specified status attribute. If the character or status does not exist, or if the attribute is not of the appropriate type, the query fails.

// ...
AND
NRD_StatusGetGuidString(_Char, _StatusIdx, "StatusSource", _Source)
AND
GetUUID(_Source, _SourceStr)
THEN
DebugBreak("Status source character:");
DebugBreak(_SourceStr);

StatusSet

call NRD_StatusSetInt((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle, (STRING)_Attribute, (INTEGER)_Value)
call NRD_StatusSetReal((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle, (STRING)_Attribute, (REAL)_Value)
call NRD_StatusSetString((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle, (STRING)_Attribute, (STRING)_Value)
call NRD_StatusSetGuidString((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle, (STRING)_Attribute, (GUIDSTRING)_Value)
call NRD_StatusSetVector3((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle, (STRING)_Attribute, (REAL)_X, (REAL)_Y, (REAL)_Z)

Updates the specified status attribute. See the "Status attributes" section below for a list of attributes that can be modified.

Stability: Additional real attributes (Strength, etc.) will be added when it has been determined that it's safe to update those values during the lifetime of the status.

Example usage:

// Extend status lifetime by 2 turns
// ...
AND
NRD_StatusGetHandle(_Character, "WET", _Handle)
AND
NRD_StatusGetReal(_Character, _Handle, "CurrentLifeTime", _CurrentLifeTime)
AND
RealSum(_CurrentLifeTime, 12.0, _NewLifeTime)
THEN
NRD_StatusSetReal(_Character, _Handle, "CurrentLifeTime", _NewLifeTime);

ApplyActiveDefense

query NRD_ApplyActiveDefense([in](CHARACTERGUID)_Character, [in](STRING)_StatusId, [in](REAL)_LifeTime, [out](INTEGER64)_StatusHandle)

Apply the specified ACTIVE_DEFENSE status on the character.

• _StatusId - Status to apply
• _LifeTime - Lifetime of status in seconds (one turn = 6 seconds)
• _StatusHandle - Handle of created status

ApplyDamageOnMove

query NRD_ApplyDamageOnMove([in](CHARACTERGUID)_Character, [in](STRING)_StatusId, [in](CHARACTERGUID)_SourceCharacter, [in](REAL)_LifeTime, [in](REAL)_DistancePerDamage, [out](INTEGER64)_StatusHandle)

Apply the specified DAMAGE_ON_MOVE status on the character.

• _StatusId - Status to apply
• _SourceCharacter - Character applying the status
• _LifeTime - Lifetime of status in seconds (one turn = 6 seconds)
• _DistancePerDamage - Distance the character has to pass before damage is triggered (specified in meters)
• _StatusHandle - Handle of created status

Hit status functions

HitStatusAddDamage

call NRD_HitStatusAddDamage((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle, (STRING)_DamageType, (INTEGER)_Amount)

Increases/decreases the amount of damage dealt by the HIT status.

• _StatusHandle - Handle of the HIT status
• _DamageType - Damage type to update; see Damage Type enumeration.
• _Amount - Damage amount. Positive values add, negative values remove damage.

HitStatusClearDamage

call NRD_HitStatusClearDamage((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle, (STRING)_DamageType)

Removes the specified damage type from the list of damages dealt by the HIT status.

• _StatusHandle - Handle of the HIT status
• _DamageType - Damage type to clear; see Damage Type enumeration.

HitStatusClearAllDamage

call NRD_HitStatusClearAllDamage((CHARACTERGUID)_Character, (INTEGER64)_StatusHandle)

Clears the list of damage types dealt by the HIT status.

• _StatusHandle - Handle of the HIT status

HitStatusGetDamage

query NRD_HitStatusGetDamage([in](CHARACTERGUID)_Character, [in](INTEGER64)_StatusHandle, [in](STRING)_DamageType, [out](INTEGER)_Amount)

Returns the amount of damage dealt by the HIT status.

• _StatusHandle - Handle of the HIT status
• _DamageType - Damage type to retrieve; see Damage Type enumeration.
• _Amount - Damage amount

Status attributes

Attribute	Type	Access	Description
StatusId	String	Read	Name of the associated stat entry
StatusHandle	Integer64	Read	Handle of this status
TargetHandle	Handle/GuidString	Read	Character or item that the status was applied to
StatusSourceHandle	Handle/GuidString	Read	Character or item that caused the status
StartTimer	Real	Read
LifeTime	Real	Read/Write	Total lifetime of the status, in seconds. -1 if the status does not expire.
CurrentLifeTime	Real	Read/Write	Remaining lifetime of the status, in seconds.
TurnTimer	Real	Read	Elapsed time in the current turn (0..6)
Strength	Real	Read/Write
StatsMultiplier	Real	Read/Write
CanEnterChance	Integer	Read	Chance of entering status (between 0 and 100)
DamageSourceType	Enum	Read	Cause of status (See DamageSourceType enum)
KeepAlive	Flag	Read
IsOnSourceSurface	Flag	Read
IsFromItem	Flag	Read
Channeled	Flag	Read
IsLifeTimeSet	Flag	Read	Does the status have a lifetime or is it infinite?
InitiateCombat	Flag	Read
Influence	Flag	Read
BringIntoCombat	Flag	Read
IsHostileAct	Flag	Read
IsInvulnerable	Flag	Read	The status turns the character invulnerable
IsResistingDeath	Flag	Read	The character can't die until the status expires
ForceStatus	Flag	Read/Write	Bypass immunity and status enter chance checks.
ForceFailStatus	Flag	Read/Write	Forces prerequisite checks to fail.
RequestDelete	Flag	Read	The status is being deleted (i.e. it's not active anymore)
RequestDeleteAtTurnEnd	Flag	Read	The status will be deleted at the end of the current turn
Started	Flag	Read

StatusHit attributes

Attribute	Type	Access	Description
SkillId	String	Read/Write	Stats ID of the skill (SkillData) that was used for the attack
HitByHandle	GuidString	Read
HitWithHandle	GuidString	Read
WeaponHandle	GuidString	Read
HitReason	Integer	Read/Write
Interruption	Flag	Read/Write
AllowInterruptAction	Flag	Read/Write
ForceInterrupt	Flag	Read/Write
DecDelayDeathCount	Flag	Read
ImpactPosition	Vector3	Read/Write
ImpactOrigin	Vector3	Read/Write
ImpactDirection	Vector3	Read/Write

Hit attributes

Attribute	Type	Access	Description
Equipment	Integer	Read/Write	TODO Meaning not known.
DeathType	Enum	Read/Write	A value from the Death Type enumeration
DamageType	Enum	Read/Write	A value from the Damage Type enumeration
AttackDirection	Enum	Read/Write	See AttackDirection enumeration. Purpose not known.
ArmorAbsorption	Integer	Read/Write
LifeSteal	Integer	Read/Write
HitWithWeapon	Integer	Read/Write
Hit	Flag	Read/Write	The attack hit
Blocked	Flag	Read/Write	The attack was blocked
Dodged	Flag	Read/Write	The attack was dodged
Missed	Flag	Read/Write	The attack missed
CriticalHit	Flag	Read/Write
Backstab	Flag	Read/Write	Indicates that the attack was a backstab
FromSetHP	Flag	Read/Write	Indicates that the hit was called from CharacterSetHitpointsPercentage (or similar)
DontCreateBloodSurface	Flag	Read/Write	Avoids creating a blood surface when the character is hit
Reflection	Flag	Read/Write
NoDamageOnOwner	Flag	Read/Write
FromShacklesOfPain	Flag	Read/Write
DamagedMagicArmor	Flag	Read/Write	Indicates that the hit damaged magic armor
DamagedPhysicalArmor	Flag	Read/Write	Indicates that the hit damaged physical armor
DamagedVitality	Flag	Read/Write	Indicates that the hit damaged the characters vitality
Flanking	Flag	Read/Write
PropagatedFromOwner	Flag	Read/Write
Surface	Flag	Read/Write	The hit is from a surface (HitType was Surface)
DoT	Flag	Read/Write	The hit is from a DoT attack (HitType was DoT)
ProcWindWalker	Flag	Read/Write	Hit should proc the Wind Walker talent
CounterAttack	Flag	Read/Write	Counterattack triggered by Gladiator talent
Poisoned	Flag	Read/Write	Character was poisoned when hit
Bleeding	Flag	Read/Write	Character was bleeding when hit
Burning	Flag	Read/Write	Character was burning when hit
NoEvents	Flag	Read/Write	Don't throw OnHit/OnPrepareHit events for this hit

StatusHeal attributes

Attribute	Type	Access	Description
EffectTime	Real	Read/Write
HealAmount	Integer	Read/Write
HealEffect	Enum	Read/Write
HealEffectId	String	Read/Write	Default RS3_FX_GP_ScriptedEvent_Regenerate_01
HealType	Enum	Read/Write	See StatusHealType enumeration
AbsorbSurfaceRange	Integer	Read/Write
TargetDependentHeal	Flag	Read/Write

StatusHealing attributes

Attribute	Type	Access	Description
HealAmount	Integer	Read/Write
TimeElapsed	Real	Read/Write
HealEffect	Enum	Read/Write
HealEffectId	String	Read/Write	Default RS3_FX_GP_ScriptedEvent_Regenerate_01
SkipInitialEffect	Flag	Read/Write
HealingEvent	Integer	Read/Write
HealStat	Enum	Read/Write
AbsorbSurfaceRange	Integer	Read/Write

Hit functions

query NRD_HitPrepare([in](GUIDSTRING)_Target, [in](GUIDSTRING)_Source, [out](INTEGER64)_HitHandle)
query NRD_HitQryExecute([in](INTEGER64)_HitHandle, [out](INTEGER64)_StatusHandle)
call NRD_HitSetInt((INTEGER64)_HitHandle, (STRING)_Property, (INTEGER)_Value)
query NRD_HitGetInt([in](INTEGER64)_HitHandle, [in](STRING)_Property, [out](INTEGER)_Value)
call NRD_HitSetString((INTEGER64)_HitHandle, (STRING)_Property, (STRING)_Value)
query NRD_HitGetString([in](INTEGER64)_HitHandle, [in](STRING)_Property, [out](STRING)_Value)
call NRD_HitSetVector3((INTEGER64)_HitHandle, (STRING)_Property, (REAL)_X, (REAL)_Y, (REAL)_Z)

The Hit API is an extension of ApplyDamage() with many additional features. Usage steps:

• Call NRD_HitPrepare(). This will clear the variables set by previous hit calls, and prepares a new hit call.
• Set hit parameters by calling the NRD_HitSet... functions
• Add one or more damage types by calling NRD_HitAddDamage()
• Apply the hit using NRD_HitExecute()

In addition to the parameters listed in Hit attributes the following table lists parameters that can be set when launching a hit. These parameters are only taken into account if the SimulateHit flag is set; otherwise the hit calculations must be done entirely in Osiris code.

Attribute	Type	Description
SimulateHit	Flag	Simulates a normal character hit; i.e. performs hit roll and sets Hit/Dodged/Missed flags; performs critical hit roll and sets CriticalHit flag; applies character resistances; applies Shackles of Pain and Lifesteal
HitType	Enum	For a list of values, see HitType enumeration
NoHitRoll	Flag	Determines whether the hit is guaranteed. 0 = An RNG roll determines whether the attack hits or is dodged/missed/blocked; the appropriate flag (Hit, Dodged, Missed, Blocked) is set automatically. 1 = No RNG roll is performed and the attack always hits; flag Hit is set automatically.
CriticalRoll	Enum	Determines the outcome of the critical hit roll. For a list of values, see CriticalRoll enumeration
ProcWindWalker	Flag
ForceReduceDurability	Flag
HighGround	Enum	High ground bonus indicator. For a list of values, see HighGround enumeration

Notes:

• The hit handles returned from NRD_HitPrepare are not persistent (i.e. they don't survive a save/load) and they can only be used for a single hit; they're destroyed after calling NRD_HitExecute.

Example usage (normal hit):

[...]
AND
NRD_HitPrepare(CHARACTERGUID_Sandbox_Arena_Shae_734e8ad4-c1ea-4c69-b5ad-310d28bf9462, CHARACTERGUID_Sandbox_Market_Ernest_Herringway_da8d55ba-0855-4147-b706-46bbc67ec8b6, _HitHandle)
THEN
NRD_HitAddDamage(_HitHandle, "Physical", 5);
NRD_HitSetInt(_HitHandle, "SimulateHit", 1);
NRD_HitExecute(_HitHandle);

Example usage (manually controlled hit):

[...]
AND
NRD_HitPrepare(CHARACTERGUID_Sandbox_Arena_Shae_734e8ad4-c1ea-4c69-b5ad-310d28bf9462, CHARACTERGUID_Sandbox_Market_Ernest_Herringway_da8d55ba-0855-4147-b706-46bbc67ec8b6, _HitHandle)
THEN
NRD_HitAddDamage(_HitHandle, "Corrosive", 50);
NRD_HitSetInt(_HitHandle, "Hit", 1);
NRD_HitSetInt(_HitHandle, "DamagedVitality", 1);
NRD_HitExecute(_HitHandle);

HitAddDamage

call NRD_HitAddDamage((INTEGER64)_HitHandle, (STRING)_DamageType, (INTEGER)_Amount)

Increases/decreases the amount of damage dealt by the hit.

• _HitHandle - Handle of hit
• _DamageType - Damage type to update; see Damage Type enumeration.
• _Amount - Damage amount. Positive values add, negative values remove damage.

HitClearDamage

call NRD_HitClearDamage((INTEGER64)_HitHandle, (STRING)_DamageType)

Removes the specified damage type from the list of damages dealt by the hit.

• _HitHandle - Handle of the hit
• _DamageType - Damage type to clear; see Damage Type enumeration.

HitClearAllDamage

call NRD_HitClearAllDamage((INTEGER64)_HitHandle)

Clears the list of damage types dealt by the hit.

• _HitHandle - Handle of the hit

HitGetDamage

query NRD_HitGetDamage([in](INTEGER64)_HitHandle, [in](STRING)_DamageType, [out](INTEGER)_Amount)

Returns the amount of damage dealt by the hit.

• _HitHandle - Handle of the hit
• _DamageType - Damage type to retrieve; see Damage Type enumeration.
• _Amount - Damage amount

OnPrepareHit

event NRD_OnPrepareHit((GUIDSTRING)_Target, (GUIDSTRING)_Instigator, (INTEGER)_Damage, (INTEGER64)_HitHandle)

Thrown before a hit damage calculation on a character takes place. Hit attributes can be queried using the NRD_HitGet[...] functions and updated using the NRD_HitSet[...] functions. For a list of attributes, see Hit attributes.

Note: The _HitHandle only works for the duration of the prepare event, it is destroyed afterwards.

OnHit

event NRD_OnHit((GUIDSTRING)_Target, (GUIDSTRING)_Instigator, (INTEGER)_Damage, (INTEGER64)_StatusHandle)

Thrown before a hit status is applied to the character (i.e. before the character is hit). Status attributes can be queried using the NRD_StatusGet[...] functions and updated using the NRD_StatusSet[...] functions. For a list of attributes, see Status attributes, StatusHit attributes and Hit attributes.

OnHeal

event NRD_OnHeal((GUIDSTRING)_Target, (GUIDSTRING)_Instigator, (INTEGER)_Amount, (INTEGER64)_StatusHandle)

Thrown before a character is healed. Status attributes can be queried using the NRD_StatusGet[...] functions. For a list of attributes, see Status attributes and StatusHeal attributes.

Projectile functions

call NRD_ProjectilePrepareLaunch()
call NRD_ProjectileLaunch()
call NRD_ProjectileSetInt((STRING)_Property, (INTEGER)_Value)
call NRD_ProjectileSetString((STRING)_Property, (STRING)_Value)
call NRD_ProjectileSetVector3((STRING)_Property, (REAL)_X, (REAL)_Y, (REAL)_Z)
call NRD_ProjectileSetGuidString((STRING)_Property, (GUIDSTRING)_Value)
call NRD_ProjectileAddDamage((STRING)_DamageType, (INTEGER)_Amount)

The projectile API is a set of functions for casting Projectile/ProjectileStrike skills. It is an extension of CreateProjectileStrikeAt and CreateExplosion.

Usage: A cast must be prepared by calling NRD_BeginProjectile(). Projectile parameters must be set by calling the NRD_ProjectileSetString/GuidString/Int/Vector3 functions. When all parameters are set, the skill is cast by calling NRD_EndProjectile().

Stability: Function signatures are final. Projectile parameters that are not documented are subject to change.

Projectile parameters:

Parameter	Type	Description
SkillId	String	Skill to cast. Must be a Projectile or ProjectileStrike skill
CleanseStatuses	String
CasterLevel	Integer
StatusClearChance	Integer
IsTrap	Flag
UnknownFlag1	Flag	Unknown; name subject to change
IsFromItem	Flag
IsStealthed	Flag
IgnoreObjects	Flag
AlwaysDamage	Flag
CanDeflect	Flag
SourcePosition	Vector3	Launch projectile from the specified position
SourcePosition	GuidString	Launch projectile from the position of the specified character/item
TargetPosition	Vector3	Launch projectile towards the specified position
TargetPosition	GuidString	Launch projectile towards the position of the specified character/item
HitObjectPosition	Vector3	Position of object to hit
HitObjectPosition	GuidString	Position of object to hit
Caster	GuidString	Caster character/item
Source	GuidString	Source character/item
Target	GuidString	Target character/item
HitObject	GuidString	Object to hit

Notes:

• For a successful cast, at least SkillId, SourcePosition and TargetPosition (either Vector3 or GuidString) must be set.
• Calling ProjectileSetGuidString with SourcePosition or TargetPosition is a shortcut for calling GetPosition() and NRD_ProjectileSetVector3() for the specified character/item.
• The character/item specified when setting SourcePosition is not considered to be the caster of the skill, and the cast will trigger no adverse reaction towards the caster. To set the caster character, set the Caster property as well.
• Make sure that you call NRD_ProjectilePrepareLaunch and NRD_ProjectileLaunch in the same rule/proc and that there are no calls between the two that might trigger other events, to ensure that other scripts can't interfere with the projectile.
• Optionally, it is possible to override skill damage calculation and replace it with custom damages by calling NRD_ProjectileAddDamage before launching the projectile

Example:

NRD_ProjectilePrepareLaunch();
NRD_ProjectileSetString("SkillId", "Projectile_Grenade_PoisonFlask");
NRD_ProjectileSetInt("CasterLevel", 3);
NRD_ProjectileSetGuidString("SourcePosition", Sandbox_Market_Ernest_Herringway_da8d55ba-0855-4147-b706-46bbc67ec8b6);
NRD_ProjectileSetGuidString("TargetPosition", Sandbox_Market_Ernest_Herringway_da8d55ba-0855-4147-b706-46bbc67ec8b6);
NRD_ProjectileLaunch();

Game Action functions

These functions create game actions (Rain/Storm/etc.), but bypass the skill casting system entirely (doesn't consume AP, doesn't play skill use animations, doesn't reset skill cooldowns). Each function needs a skill stats id of the same type (Rain skill id for NRD_CreateRain, etc.)

Stability:

• The following additional options may be added:
  • Global: ActivateTimer
  • Tornado: TurnTimer, IsFromItem, Finished
  • Storm: TurnTimer, LifeTime, IsFromItem, Finished
  • Rain: TurnTimer, LifeTime, Duration, IsFromItem, Finished
  • Wall: TurnTimer, LifeTime, IsFromItem, Finished
  • Dome: LifeTime, Finished

CreateRain

query NRD_CreateRain([in](CHARACTERGUID)_OwnerCharacter, [in](STRING)_SkillId, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER64)_GameActionHandle)

CreateStorm

query NRD_CreateStorm([in](CHARACTERGUID)_OwnerCharacter, [in](STRING)_SkillId, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER64)_GameActionHandle)

CreateWall

query NRD_CreateWall([in](CHARACTERGUID)_OwnerCharacter, [in](STRING)_SkillId, [in](REAL)_SourceX, [in](REAL)_SourceY, [in](REAL)_SourceZ, [in](REAL)_TargetX, [in](REAL)_TargetY, [in](REAL)_TargetZ, [out](INTEGER64)_GameActionHandle)

CreateTornado

query NRD_CreateTornado([in](CHARACTERGUID)_OwnerCharacter, [in](STRING)_SkillId, [in](REAL)_PositionX, [in](REAL)_PositionY, [in](REAL)_PositionZ, [in](REAL)_TargetX, [in](REAL)_TargetY, [in](REAL)_TargetZ, [out](INTEGER64)_GameActionHandle)

CreateDome

query NRD_CreateDome([in](CHARACTERGUID)_OwnerCharacter, [in](STRING)_SkillId, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER64)_GameActionHandle)

GameObjectMove

query NRD_CreateGameObjectMove([in](GUIDSTRING)_TargetObject, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [in](STRING)_BeamEffectName, [in](CHARACTERGUID)_CasterCharacter, [out](INTEGER64)_GameActionHandle)

GameActionDestroy

call NRD_GameActionDestroy((INTEGER64)_GameActionHandle)

Destroys the specified game action. _GameActionHandle is the handle returned from one of the game action create functions (CreateWall, CreateDome, etc).

Notes:

• The game action is not destroyed immediately, but on the next tick. This means that the game action might survive the current turn (up to 6 seconds) and will exit afterwards. This behavior might change in the future if a safer way is found to destroy game actions.

GameActionGetLifeTime

query NRD_GameActionGetLifeTime([in](INTEGER64)_GameActionHandle, [out](REAL)_LifeTime)

Returns the total lifetime of the specified game action.

Notes:

• Only Rain, Storm, Wall and Dome actions are supported.

GameActionSetLifeTime

call NRD_GameActionSetLifeTime((INTEGER64)_GameActionHandle, (REAL)_LifeTime)

Updates the total lifetime of the specified game action.

Notes:

• Only Rain, Storm and Dome actions are supported; the others cannot be controlled directly via the lifetime variable.

Summon

query NRD_Summon([in](CHARACTERGUID)_OwnerCharacter, [in](STRING)_Template, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [in](REAL)_Lifetime, [in](INTEGER)_Level, [in](INTEGER)_IsTotem, [in](INTEGER)_MapToAiGrid, [out](CHARACTERGUID)_Summon)

** TODO Documentation **

Character functions

General

CharacterSetGlobal

call NRD_CharacterSetGlobal((CHARACTERGUID)_Character, (INTEGER)_IsGlobal)

Transforms _Character into a global/local entity. The side effects of making a character global/local has not been studied, so this function is EXPERIMENTAL and potentially dangerous.

CharacterGet

query NRD_CharacterGetInt([in](CHARACTERGUID)_Character, [in](STRING)_Attribute, [out](INTEGER)_Value)
query NRD_CharacterGetReal([in](CHARACTERGUID)_Character, [in](STRING)_Attribute, [out](REAL)_Value)
query NRD_CharacterGetString([in](CHARACTERGUID)_Character, [in](STRING)_Attribute, [out](STRING)_Value)

Returns an attribute of the specified character. If _Character is not a valid character or the specified attribute does not exist, the query fails. _Attribute must be one of the following:

Attribute	Type	Access
Scale	Real	Read
AnimationOverride	String	Read
WalkSpeedOverride	Integer	Read
RunSpeedOverride	Integer	Read
NeedsUpdateCount	Integer	Read
ScriptForceUpdateCount	Integer	Read
ForceSynchCount	Integer	Read
SkillBeingPrepared	String	Read
LifeTime	Real	Read
PartialAP	String	Read
AnimType	Integer	Read
DelayDeathCount	Integer	Read
AnimationSetOverride	String	Read
CustomTradeTreasure	String	Read
Archetype	String	Read
EquipmentColor	String	Read
IsPlayer	Flag	Read
HostControl	Flag	Read
Activated	Flag	Read
OffStage	Flag	Read
Dead	Flag	Read
Charmed	Flag	Read
InDialog	Flag	Read
CharacterControl	Flag	Read
Transformed	Flag	Read
InArena	Flag	Read
PartyFollower	Flag	Read
Totem	Flag	Read
Global	Flag	Read
HasOsirisDialog	Flag	Read
HasDefaultDialog	Flag	Read
TreasureGeneratedForTrader	Flag	Read
Trader	Flag	Read
Resurrected	Flag	Read
IsPet	Flag	Read
IsSpectating	Flag	Read
NoReptuationEffects	Flag	Read
HasWalkSpeedOverride	Flag	Read
HasRunSpeedOverride	Flag	Read
IsGameMaster	Flag	Read
IsPossessed	Flag	Read

Stats

CharacterGetStat

query NRD_CharacterGetStatInt([in](CHARACTERGUID)_Character, [in](STRING)_Stat, [out](INTEGER)_Value)
query NRD_CharacterGetStatString([in](CHARACTERGUID)_Character, [in](STRING)_Stat, [out](STRING)_Value)

Returns a stat value of the specified character. _Stat must be one of the following: Name, Level, CurrentVitality, CurrentArmor, CurrentMagicArmor, ArmorAfterHitCooldownMultiplier, MagicArmorAfterHitCooldownMultiplier, CurrentAP, BonusActionPoints, Experience, Reputation, Flanked, Karma, MaxVitality, BaseMaxVitality, MaxArmor, BaseMaxArmor, MaxMagicArmor, BaseMaxMagicArmor, Sight, BaseSight, MaxSummons, BaseMaxSummons, MaxResistance, HasTwoHandedWeapon, CharacterGuid. In addition, any attribute from the AttributeFlags enumeration or StatCharacterFlags enumeration can be retrieved.

If _Character is a nonexistent character or no stat named _Stat exists, the query fails.

CharacterGetComputedStat

query NRD_CharacterGetComputedStat([in](CHARACTERGUID)_Character, [in](STRING)_Stat, [in](INTEGER)_ExcludeBoosts, [out](INTEGER)_Value)

Returns a computed stat value of the specified character. _Stat must be one of the following: MaxMp, APStart, APRecovery, APMaximum, Strength, Finesse, Intelligence, Vitality, Memory, Wits, Accuracy, Dodge, CriticalChance, PhysicalResistance, PiercingResistance, CorrosiveResistance, MagicResistance, FireResistance, EarthResistance, WaterResistance, AirResistance, PoisonResistance, ShadowResistance, CustomResistance, LifeSteal, Sight, Hearing, Movement, Initiative, ChanceToHitBoost.

If _Character is a nonexistent character or no stat named _Stat exists, the query fails.

Unlike stats returned by CharacterGetStat, these stats are computed on the fly and cannot be changed via CharacterSetStat. It is, however, possible to adjust them using permanent boosts using the CharacterSetPermanentBoost function. See this link for more details.

CharacterGetHitChance

query NRD_CharacterGetHitChance([in](CHARACTERGUID)_Attacker, [in](CHARACTERGUID)_Target, [out](INTEGER)_HitChance)

Returns the chance of the attacker character hitting the target character (in percentages). If either _Attacker or _Target is a nonexistent character, the query fails.

CharacterSetStat

call NRD_CharacterSetStatInt((CHARACTERGUID)_Character, (STRING)_Stat, (INTEGER)_Value)

Updates the stat value of _Stat to the specified value . _Stat must be one of the following: CurrentVitality, CurrentArmor, CurrentMagicArmor

Base Stats

Limitations: Base attribute/ability/talent changes don't show up immediately because of how client-server communication works in the game. To ensure that changes are synchronized a no-op call to CharacterAddCivilAbilityPoint must be performed. Example:

NRD_PlayerSetBaseAbility(_Character, "WarriorLore", 5);
NRD_PlayerSetBaseTalent(_Character, "AttackOfOpportunity", 1);
CharacterAddCivilAbilityPoint(_Character, 0); // Force PlayerUpgrade sync

PlayerSetBaseAttribute

call NRD_PlayerSetBaseAttribute((CHARACTERGUID)_Character, (STRING)_Attribute, (INTEGER)_Value)

Updates the level of the specified attribute. _Attribute must be one of Strength, Finesse, Intelligence, Constitution, Memory, Wits. After changing base attributes, boosts must be synchronized via a dummy CharacterAddCivilAbilityPoint call (see above).

PlayerSetBaseAbility

call NRD_PlayerSetBaseAbility((CHARACTERGUID)_Character, (STRING)_Ability, (INTEGER)_Value)

Updates the level of the specified ability. _Ability must be a value from the built-in enumeration Ability (see Enumerations.xml). After changing base abilities, boosts must be synchronized via a dummy CharacterAddCivilAbilityPoint call (see above).

PlayerSetBaseTalent

call NRD_PlayerSetBaseTalent((CHARACTERGUID)_Character, (STRING)_Talent, (INTEGER)_HasTalent)

Adds or removes a talent. _Talent must be a value from the TalentType enumeration. Unlike CharacterAddTalent and CharacterRemoveTalent, this function changes the base talent values, not the boost talent values. After changing talents, boosts must be synchronized via a dummy CharacterAddCivilAbilityPoint call (see above).

Custom Stats

Custom stats are a GM mode feature that allows creating custom stats on characters. The extender supports adding custom stats in adventure (non-GM) campaigns as well, and allows programmatic access to these stats via Osiris queries. To use custom stat functions in non-GM mode, enable the UseCustomStats variable in your extension config.

GetCustomStat

query NRD_GetCustomStat([in](STRING)_Name, [out](GUIDSTRING)_StatId) (2,1338,63,1)

Returns the GUID of the custom stat with the given name. If no stat exists with the given name, the query fails.

CreateCustomStat

query NRD_CreateCustomStat([in](STRING)_Name, [in](STRING)_Description, [out](GUIDSTRING)_StatId)

Creates a custom stat with the given name and description, and returns the GUID of the newly created stat. If a stat with the given name already exists, the GUID of the existing stat is returned.

CharacterGetCustomStat

query NRD_CharacterGetCustomStat([in](CHARACTERGUID)_Character, [in](GUIDSTRING)_StatId, [out](INTEGER)_Value)

Returns the value of the specified custom stat on the character. If the character does not exist or the custom stat does not exist, the query fails. If the custom stat value was not yet set on this character, the query returns 0.

CharacterSetCustomStat

call NRD_CharacterSetCustomStat((CHARACTERGUID)_Character, (GUIDSTRING)_StatId, (INTEGER)_Value)

Updates the value of the specified custom stat on the character.

Permanent Boosts

Permanent Boosts are stat bonuses or stat reductions that are applied to an item. They are permanent, i.e. are stored in the savegame.

The following stats are supported: SummonLifelinkModifier, Strength, Memory, Intelligence, Movement, MovementSpeedBoost, Finesse, Wits, Constitution, FireResistance, EarthResistance, WaterResistance, AirResistance, PoisonResistance, ShadowResistance, Willpower, Bodybuilding, PiercingResistance, PhysicalResistance, CorrosiveResistance, MagicResistance, CustomResistance, Sight, Hearing, FOV, APMaximum, APStart, APRecovery, CriticalChance, Initiative, Vitality, VitalityBoost, MagicPoints, Level, Gain, Armor, MagicArmor, ArmorBoost, MagicArmorBoost, ArmorBoostGrowthPerLevel, MagicArmorBoostGrowthPerLevel, DamageBoost, DamageBoostGrowthPerLevel, Accuracy, Dodge, MaxResistance, LifeSteal, Weight, ChanceToHitBoost, RangeBoost, APCostBoost, SPCostBoost, MaxSummons, BonusWeaponDamageMultiplier. In addition, any attribute from the AttributeFlags enumeration can be set.

Limitations: Permanent boosts don't show up immediately because of how client-server communication works in the game. To ensure that boosts are visible on the client boosts must be synced by performing a no-op call to CharacterAddAttribute. Example:

...
NRD_CharacterGetPermanentBoostInt(_Character, "PoisonResistance", _Resistance)
AND
IntegerSum(_Resistance, 10, _NewResistance)
THEN
NRD_CharacterSetPermanentBoostInt(_Character, "PoisonResistance", _NewResistance);
CharacterAddAttribute(_Character, "Dummy", 0); // Force boost sync

CharacterGetPermanentBoost

query NRD_CharacterGetPermanentBoostInt([in](CHARACTERGUID)_Character, [in](STRING)_Stat, [out](INTEGER)_Value)

Returns the permanent boost value applied to the specified character. _Stat must be one of the values listed above.

CharacterSetPermanentBoost

call NRD_CharacterSetPermanentBoostInt((CHARACTERGUID)_Character, (STRING)_Stat, (INTEGER)_Value)

Updates the permanent boost value of _Stat to the specified value . _Stat must be one of the values listed above. Both positive and negative boost values are supported.

CharacterSetPermanentBoostTalent

call NRD_CharacterSetPermanentBoostTalent((CHARACTERGUID)_Character, (STRING)_Talent, (INTEGER)_HasTalent)

Gives or removes a talent. _Talent must be a value from the TalentType enumeration. After updating talents, boosts must be synchronized via a dummy CharacterAddAttribute call (see above).

CharacterIsTalentDisabled

query NRD_CharacterIsTalentDisabled([in](CHARACTERGUID)_Character, [in](STRING)_Talent, [out](INTEGER)_IsDisabled)

Returns whether the specified talent is disabled. _Talent must be a value from the TalentType enumeration.

CharacterDisableTalent

call NRD_CharacterDisableTalent((CHARACTERGUID)_Character, (STRING)_Talent, (INTEGER)_IsDisabled)

Disables or re-enables a talent. This means that the talent cannot be selected on the character sheet, and the effects of the talent won't trigger even if the character has the talent / gets the talent via a boost or item. _Talent must be a value from the TalentType enumeration. After updating talents, boosts must be synchronized via a dummy CharacterAddAttribute call (see above).

Skill functions

CharacterIterateSkills

call NRD_CharacterIterateSkills((CHARACTERGUID)_Character, (STRING)_Event)
event NRD_SkillIteratorEvent((STRING)_Event, (CHARACTERGUID)_Character, (STRING)_SkillId, (INTEGER)_IsLearned, (INTEGER)_IsActivated)

Throws NRD_SkillIteratorEvent event for each skill that the character has. Events are not queued and are thrown immediately (i.e. during the NRD_CharacterIterateSkills call), so there is no need for an additional cleanup/finalizer event.

• _SkillId: the stats entry name of the skill.
• _IsLearned: 0 if the skill is from an item or status, 1 if the skill was learned by the character
• _IsActivated: 1 if the prerequisites for the skill are met, 0 if not

Example usage:

// ...
NRD_CharacterIterateSkills(Sandbox_Market_Ernest_Herringway_da8d55ba-0855-4147-b706-46bbc67ec8b6, "MyMod_Skills");

IF
NRD_SkillIteratorEvent("MyMod_Skills", _Character, _SkillId, _, _)
THEN
DebugBreak(_SkillId);

SkillSetCooldown

call NRD_SkillSetCooldown((CHARACTERGUID)_Character, (STRING)_SkillId, (REAL)_Cooldown)

Set the current cooldown timer of the skill (in seconds). Doesn't work on skills that can only be used once per combat.

SkillGetCooldown

query NRD_SkillGetCooldown([in](CHARACTERGUID)_Character, [in](STRING)_SkillId, [out](REAL)_Cooldown)

Returns the current cooldown timer of the skill (in seconds). For skills that can only be used once per combat -1.0 is returned.

SkillGetInt

query NRD_SkillGetInt([in](CHARACTERGUID)_Character, [in](STRING)_SkillId, [in](STRING)_Property, [out](INTEGER)_Value)

Returns a property of the specified character skill. If the character does not exist, the character doesn't have the specified skill or the property name is invalid, the query fails. The following properties are supported:

Property	Type	Notes
IsActivated	Flag	Is the skill usable by the character, i.e. all requirements are met and the skill is memorized
IsLearned	Flag	Was the skill learned by the character, or was it acquired via a status/item?
ZeroMemory	Flag	Indicates that the skill consumes no memory slots
OncePerCombat	Flag	Indicates that the skill can only be used once per combat
Charges	Integer	Number of skill uses left

Action State functions

OnActionStateEnter

event NRD_OnActionStateEnter((CHARACTERGUID)_Character, (STRING)_Action)

This event is thrown when a character starts performing an action. _Action can be one of the following: Attack, Die, Hit, PrepareSkill, UseSkill, PickUp, Drop, MoveItem, KnockedDown, Summoning, Polymorphing, UseItem, CombineItem, TeleportFall, Sheath, Unsheath, Identify, Repair, Lockpick, DisarmTrap, Incapacitated, JumpFlight. For performance reasons no events are thrown for Idle and Animation actions. Details about the action can be queried using NRD_ActionStateGetString*.

OnActionStateExit

event NRD_OnActionStateExit((CHARACTERGUID)_Character, (STRING)_Action)

This event is thrown when a character finishes performing an action. The event supports the same action types as OnActionStateEnter. Details about the action can be queried using NRD_ActionStateGetString*.

CharacterGetCurrentAction

query NRD_CharacterGetCurrentAction([in](CHARACTERGUID)_Character, [out](STRING)_Action

Retrieves the action the character is currently performing. If the character does not exist, the query fails. If the character is not performing any action, _Action will be an empty string ("").

ActionStateGet

query NRD_ActionStateGetInt([in](CHARACTERGUID)_Character, [in](STRING)_Property, [out](INTEGER)_Value)
query NRD_ActionStateGetReal([in](CHARACTERGUID)_Character, [in](STRING)_Property, [out](REAL)_Value)
query NRD_ActionStateGetString([in](CHARACTERGUID)_Character, [in](STRING)_Property, [out](STRING)_Value)
query NRD_ActionStateGetGuidString([in](CHARACTERGUID)_Character, [in](STRING)_Property, [out](GUIDSTRING)_Value)

Retrieves a property of the action the character is currently performing. This is currently only implemented for the PrepareSkill, UseSkill and Attack action states. If the character does not exist, the character is not performing any action, or the specified property does not exist for the current action type, the query fails.

The following property values can be retrieved:

PrepareSkill action state:

Property	Type
SkillId	String
PrepareAnimationInit	String
PrepareAnimationLoop	String
IsFinished	Flag
IsEntered	Flag

UseSkill action state:

Property	Type
SkillId	String
CharacterHandle	GuidString
SourceItemHandle	GuidString
CanEnter	Flag
IsFinished	Flag
IgnoreChecks	Flag
IsStealthed	Flag
PrepareTimerRemaining	Real
ShouldExit	Flag
CleanseStatuses	String
StatusClearChance	Integer
CharacterHasSkill	Flag

Attack action state:

Property	Type
TargetHandle	GuidString
TargetPosition	Vector3
IsFinished	Flag
AlwaysHit	Flag
TimeRemaining	Real
AnimationFinished	Flag
TotalHits	Integer
TotalHitOffHand	Integer
TotalShoots	Integer
TotalShootsOffHand	Integer
HitCount	Integer
HitCountOffHand	Integer
ShootCount	Integer
ShootCountOffHand	Integer
MainWeaponHandle	GuidString
OffWeaponHandle	GuidString
MainHandHitType	Integer
OffHandHitType	Integer
ProjectileUsesHitObject	Flag
ProjectileStartPosition	Vector3
ProjectileTargetPosition	Vector3
DamageDurability	Flag

Misc functions

CharacterEquipItem

call NRD_CharacterEquipItem((CHARACTERGUID)_Character, (ITEMGUID)_Item, (STRING)_Slot, (INTEGER)_CheckAP, (INTEGER)_CheckRequirements, (INTEGER)_UpdateVitality, (INTEGER)_UseWeaponAnimType)

Equips an item in the specified equipment slot. If _Slot is empty, the appropriate default slot for the item is used. If _CheckAP is set, a check is made to ensure that the character has sufficient AP for the action, and the required amount of AP is consumed afterwards. If _CheckRequirements is set, the item is only equipped if the character meets its requirements. If _UpdateVitality is set, the current vitality of the character is updated based on the stat changed during equip. If _UseWeaponAnimType is set, the current animation set of the character is updated to match that of the weapon.

Player functions

Player Customization functions

PlayerGetCustomData

query NRD_PlayerGetCustomDataInt([in](CHARACTERGUID)_Player, [in](STRING)_Property, [out](INTEGER)_Value)
query NRD_PlayerGetCustomDataString([in](CHARACTERGUID)_Player, [in](STRING)_Property, [out](STRING)_Value)

Returns the player customization property specified in _Property. If the property is not a valid player customization property, the specified character does not exist, the character is not a player, or the player customization data is not initialized, the query fails. (See below for a list of available properties.)

PlayerSetCustomData

call NRD_PlayerSetCustomDataInt((CHARACTERGUID)_Player, (STRING)_Property, (INTEGER)_Value)
call NRD_PlayerSetCustomDataString((CHARACTERGUID)_Player, (STRING)_Property, (STRING)_Value)

Updates the player customization property specified in _Property. If the property is not a valid player customization property, the specified character does not exist, the character is not a player, or the player customization data is not initialized, the call will do nothing.

Player Customization Parameters

Attribute	Type	Access
CustomLookEnabled	Flag	Read
Name	String	Read/Write
ClassType	String	Read/Write
SkinColor	Integer	Read/Write
HairColor	Integer	Read/Write
ClothColor1	Integer	Read/Write
ClothColor2	Integer	Read/Write
ClothColor3	Integer	Read/Write
IsMale	Flag	Read/Write
Race	String	Read/Write
OriginName	String	Read/Write
Icon	String	Read/Write
MusicInstrument	String	Read/Write

Skillbar functions

Notes:

• The skill bar functions can only be used on player characters
• The skill bar slot (_Slot) must be an integer between 0 and 144.

SkillBarGetItem

query NRD_SkillBarGetItem([in](CHARACTERGUID)_Character, [in](INTEGER)_Slot, [out](ITEMGUID)_Item)

Retrieves the item in skill bar slot _Slot. If the character is not a player, the skill bar slot is empty, or if the skill bar slot is occupied by a skill, the query fails.

SkillBarGetSkill

query NRD_SkillBarGetSkill([in](CHARACTERGUID)_Character, [in](INTEGER)_Slot, [out](STRING)_Skill)

Retrieves the skill in skill bar slot _Slot. If the character is not a player, the skill bar slot is empty, or if the skill bar slot is occupied by an item, the query fails.

SkillBarFindSkill

query NRD_SkillBarFindSkill([in](CHARACTERGUID)_Character, [in](STRING)_Skill, [out](INTEGER)_Slot)

Checks whether the player has the skill _Skill on the skill bar, and returns the slot number of its first occurrence in _Slot. If the character is not a player or the skill is not on the skill bar, the query fails.

SkillBarFindItem

query NRD_SkillBarFindItem([in](CHARACTERGUID)_Character, [in](ITEMGUID)_Item, [out](INTEGER)_Slot)

Checks whether the player has the item _Item on the skill bar, and returns the slot number of its first occurrence in _Slot. If the character is not a player or the item is not on the skill bar, the query fails.

SkillBarSetSkill

call NRD_SkillBarSetSkill((CHARACTERGUID)_Character, (INTEGER)_Slot, (STRING)_SkillId)

Removes any item or skill that's currently in the skill bar slot and replaces it with the specified skill.

Notes:

• It is possible to pin any skill to the skill bar, not just ones that the character currently has.

SkillBarSetItem

call NRD_SkillBarSetItem((CHARACTERGUID)_Character, (INTEGER)_Slot, (ITEMGUID)_Item)

Removes any item or skill that's currently in the skill bar slot and replaces it with the specified item.

SkillBarClear

call NRD_SkillBarClear((CHARACTERGUID)_Character, (INTEGER)_Slot)

Removes any item or skill that's currently in the specified skill bar slot.

Item functions

ItemSetIdentified

call NRD_ItemSetIdentified((ITEMGUID)_Item, (INTEGER)_IsIdentified)

Sets whether the item is identified or not. Marking common items (that cannot be identified) as unidentified has no effect.

ItemGetStatsId

query NRD_ItemGetStatsId([in](ITEMGUID)_Item, [out](STRING)_StatsId)

Return the stats entry ID of the specified item.

ItemGetGenerationParams

query NRD_ItemGetGenerationParams([in](ITEMGUID)_Item, [out](STRING)_Base, [out](STRING)_ItemType, [out](INTEGER)_Level)
query NRD_ItemGetGenerationParams([in](ITEMGUID)_Item, [out](STRING)_Base, [out](STRING)_ItemType, [out](INTEGER)_Level, [out](INTEGER)_Random)

Return the stats generation parameters of the specified item.

ItemHasDeltaModifier

query NRD_ItemHasDeltaModifier([in](ITEMGUID)_Item, [in](STRING)_DeltaMod, [out](INTEGER)_Count)

Return the number of DeltaMods on the item with the specified boost name. Unlike vanilla ItemHasDeltaModifier, this also takes into account the boosts added by item generation.

ItemIterateDeltaModifiers

call NRD_ItemIterateDeltaModifiers((ITEMGUID)_Item, (STRING)_EventName)
event NRD_ItemDeltaModIteratorEvent((STRING)_Event, (ITEMGUID)_Item, (STRING)_DeltaMod, (INTEGER)_IsGenerated)

Throws delta mod iterator event _Event for each delta modifier present on the item. Unlike regular events, NRD_ItemDeltaModIteratorEvent events are not queued and are thrown immediately (i.e. during the NRD_ItemIterateDeltaModifiers call), so there is no need for an additional cleanup/finalizer event.

Example usage:

// ...
THEN
NRD_ItemIterateDeltaModifiers(ITEM_da8d55ba-0855-4147-b706-46bbc67ec8b6, "MyMod_IterDeltaMods");
DebugBreak("Finished"); // Do finalizer stuff here

IF
NRD_ItemDeltaModIteratorEvent("MyMod_IterDeltaMods", _Item, _DeltaMod, _IsGenerated)
THEN
DebugBreak(_DeltaMod);

ItemGet

query NRD_ItemGetInt([in](ITEMGUID)_Item, [in](STRING)_Property, [out](INTEGER)_Value)
query NRD_ItemGetString([in](ITEMGUID)_Item, [in](STRING)_Property, [out](STRING)_Value)
query NRD_ItemGetGuidString([in](ITEMGUID)_Item, [in](STRING)_Property, [out](GUIDSTRING)_Value)

Returns the specified property of the item. _Property must be one of the values listed below. If the item or property does not exist, the query fails. If an attempt is made to fetch a stat property on an item that has no stats, the query fails.

Item properties (can be fetched on all items):

Attribute	Type	Description
CurrentLevel	String	Level the item is currently on (eg. FJ_FortJoy_Main)
CustomDisplayName	String
CustomDescription	String
CustomBookContent	String
StatsId	String	Stats entry (eg. WPN_Dagger)
Slot	Integer
Amount	Integer
Vitality	Integer
InUseByCharacterHandle	GuidString	Character currently using the item
Key	String	Key used to open the container
LockLevel	Integer
ItemType	Integer
GoldValueOverwrite	Integer
WeightValueOverwrite	Integer
TreasureLevel	Integer
LevelOverride	Integer
ForceSynch	Flag

Stat properties (can only be fetched on items with a stats entry):

Attribute	Type	Description
ItemType	Enum	EquipmentStatType value
ItemSlot	String	ItemSlot value
WeaponType	Enum	WeaponType value
AnimType	Integer
WeaponRange	Real
IsIdentified	Flag
IsTwoHanded	Flag
ShouldSyncStats	Flag
HasModifiedSkills	Flag
Skills	String
DamageTypeOverwrite	Enum	DamageType value
Durability	Integer
DurabilityCounter	Integer
ItemTypeReal	String
MaxCharges	Integer
Charges	Integer

In addition, any attribute from the AttributeFlags enumeration can be retrieved.

ItemGetParent

query NRD_ItemGetParent([in](ITEMGUID)_Item, [out](GUIDSTRING)_Parent)

Returns the parent container of the item (a character or an item). If the item does not exist or the item is not in an inventory, the query fails.

Permanent Boosts

Permanent Boosts are stat bonuses or stat reductions that are applied to an item. They are permanent, i.e. are stored in the savegame.

Attribute	Type	Item Type
Durability	Integer	Any
DurabilityDegradeSpeed	Integer	Any
StrengthBoost	Integer	Any
FinesseBoost	Integer	Any
IntelligenceBoost	Integer	Any
ConstitutionBoost	Integer	Any
Memory	Integer	Any
WitsBoost	Integer	Any
SightBoost	Integer	Any
HearingBoost	Integer	Any
VitalityBoost	Integer	Any
SourcePointsBoost	Integer	Any
MaxAP	Integer	Any
StartAP	Integer	Any
APRecovery	Integer	Any
AccuracyBoost	Integer	Any
DodgeBoost	Integer	Any
AccuracyBoost	Integer	Any
LifeSteal	Integer	Any
CriticalChance	Integer	Any
ChanceToHitBoost	Integer	Any
MovementSpeedBoost	Integer	Any
RuneSlots	Integer	Any
RuneSlots_V1	Integer	Any
FireResistance	Integer	Any
AirResistance	Integer	Any
WaterResistance	Integer	Any
EarthResistance	Integer	Any
PoisonResistance	Integer	Any
ShadowResistance	Integer	Any
PiercingResistance	Integer	Any
CorrosiveResistance	Integer	Any
PhysicalResistance	Integer	Any
MagicResistance	Integer	Any
CustomResistance	Integer	Any
Movement	Integer	Any
Initiative	Integer	Any
Willpower	Integer	Any
Bodybuilding	Integer	Any
MaxSummons	Integer	Any
Value	Integer	Any
Weight	Integer	Any
Skills	String	Any
ItemColor	String	Any
DamageType	Enum	Weapon
MinDamage	Integer	Weapon
MaxDamage	Integer	Weapon
DamageBoost	Integer	Weapon
DamageFromBase	Integer	Weapon
CriticalDamage	Integer	Weapon
WeaponRange	Real	Weapon
CleaveAngle	Integer	Weapon
CleavePercentage	Real	Weapon
AttackAPCost	Integer	Weapon
ArmorValue	Integer	Armor/Shield
ArmorBoost	Integer	Armor/Shield
MagicArmorValue	Integer	Armor/Shield
MagicArmorBoost	Integer	Armor/Shield
Blocking	Integer	Shield

Limitations: Permanent boosts don't show up immediately because of how client-server communication works in the game. To ensure that boosts are visible on the client:

• For new items, the item and the permanent boost should be created in the same tick (e.g. an ItemSetPermanentBoost call immediately after CreateItemTemplateAtPosition)
• For existing items, the item should be cloned after calling ItemSetPermanentBoost, and the original item should be replaced by the clone. (The permanent boosts are visible on the clone, but not on the original item.)
• A save/reload also makes boosts visible

ItemGetPermanentBoost

query NRD_ItemGetPermanentBoostInt([in](ITEMGUID)_Item, [in](STRING)_Stat, [out](INTEGER)_Value)
query NRD_ItemGetPermanentBoostReal([in](ITEMGUID)_Item, [in](STRING)_Stat, [out](REAL)_Value)
query NRD_ItemGetPermanentBoostString([in](ITEMGUID)_Item, [in](STRING)_Stat, [out](STRING)_Value)

Returns the permanent boost value applied to the specified item. _Stat must be one of the values listed above. If the specified item does not exist or _Stat is not a recognized stat identifier, the query fails.

ItemGetPermanentBoostTalent

query NRD_ItemGetPermanentBoostTalent([in](ITEMGUID)_Item, [in](STRING)_Talent, [out](INTEGER)_Enabled)

Returns whether the specified talent is boosted by the item via a permanent boost. _Talent must be a value from the TalentType enumeration. If the specified item does not exist or _Talent is not a valid talent identifier, the query fails.

ItemGetPermanentBoostAbility

query NRD_ItemGetPermanentBoostAbility([in](ITEMGUID)_Item, [in](STRING)_Ability, [out](INTEGER)_Level)

Returns the level the item grants via permanent boosts for the given ability. _Ability must be a value from the Ability enumeration (see Enumerations.xml). If the specified item does not exist or _Ability is not a valid ability identifier, the query fails.

ItemSetPermanentBoost

call NRD_ItemSetPermanentBoostInt((ITEMGUID)_Item, (STRING)_Stat, (INTEGER)_Value)
call NRD_ItemSetPermanentBoostReal((ITEMGUID)_Item, (STRING)_Stat, (REAL)_Value)
call NRD_ItemSetPermanentBoostString((ITEMGUID)_Item, (STRING)_Stat, (STRING)_Value)

Updates the permanent boost value of _Stat to the specified value . _Stat must be one of the values listed above. Both positive and negative boost values are supported.

ItemSetPermanentBoostTalent

call NRD_ItemSetPermanentBoostTalent((ITEMGUID)_Item, (STRING)_Talent, (INTEGER)_Enabled)

Gives or removes a talent. _Talent must be a value from the TalentType enumeration. After updating talents, boosts must be synchronized via one of the methods described in the Limitations section above.

ItemSetPermanentBoostAbility

call NRD_ItemSetPermanentBoostAbility((ITEMGUID)_Item, (STRING)_Ability, (INTEGER)_Level)

Updates the boost level the item grants via permanent boosts for the given ability. _Ability must be a value from the Ability enumeration (see Enumerations.xml). After updating ability boosts, boosts must be synchronized via one of the methods described in the Limitations section above.

Cloning items

call NRD_ItemCloneBegin((ITEMGUID)_Item)
call NRD_ItemCloneSetInt((STRING)_Property, (INTEGER)_Value)
call NRD_ItemCloneSetString((STRING)_Property, (STRING)_Value)
call NRD_ItemCloneAddBoost((STRING)_BoostType, (STRING)_Boost)
query NRD_ItemClone([out](ITEMGUID)_NewItem)

Usage: The clone API creates a copy of a specific item. To start cloning an item, call NRD_ItemCloneBegin(). Additional modifications can be applied to the newly created item by calling NRD_ItemCloneSetXyz(...). After the parameter modifications were performed, the clone operation is finished by calling NRD_ItemClone().

NRD_ItemCloneAddBoost() can be used to add various boosts to the item before cloning. The _BoostType parameter accepts three values: Generation (adds a generated boost), DeltaMod (equivalent to adding a DeltaMod via ItemAddDeltaModifier), Rune (equivalent to adding a rune to the item).

Clone parameters (passed to NRD_ItemCloneSetXyz):

Attribute	Type	Description
RootTemplate	GuidString	Root template of the new item
OriginalRootTemplate	GuidString	Original root template (to be used for items that are already transformed during cloning)
Amount	Integer	Number of items
Slot	Integer	Original inventory slot of item
GoldValueOverwrite	Integer	Overrides the gold value of the item
WeightValueOverwrite	Integer	Overrides the weight of the item
DamageTypeOverwrite	Integer	Overrides the damage type of the item
ItemType	String	Item rarity (eg. Uncommon)
CustomDisplayName	String
CustomDescription	String
CustomBookContent	String
GenerationBase	String
GenerationStatsId	String	Stats used to generate the item (eg. WPN_Shield)
GenerationItemType	String	Item rarity used to generate the item (eg. Uncommon)
GenerationRandom	Integer	Random seed for item generation
GenerationLevel	Integer	Level of generated item
StatsLevel	Integer	Stats entry level
Key	String	Key used to open container
LockLevel	Integer
StatsEntryName	String	Stats ID of the item (eg. WPN_Shield)
HasModifiedSkills	Flag	Indicates that the skills of the item were overridden
Skills	String	Item skills
HasGeneratedStats	Flag	Indicates that stats were already generated for this item (boost randomization, leveling, etc.)
IsIdentified	Flag	Is the item identified?
GMFolding	Flag	Enable/disable stats folding in GM mode

Example usage:

[...]
NRD_ItemCloneBegin(_Item);
NRD_ItemCloneSetInt("Level", 10);
NRD_ItemCloneSetInt("GoldValueOverwrite", 1000);
NRD_ItemCloneAddBoost("DeltaMod", "Boost_Weapon_Secondary_Dodge_TwoHanded")
PROC_XYZ_ItemCloneFinish();

PROC
PROC_XYZ_ItemCloneFinish()
AND
NRD_ItemClone(_NewItem)
AND
CharacterGetHostCharacter(_Character)
THEN
ItemToInventory((ITEMGUID)_NewItem, _Character, 1, 1, 0);

Root Template functions

RootTemplateGet

query NRD_RootTemplateGetInt([in](GUIDSTRING)_Object, [in](STRING)_Property, [out](INTEGER)_Value)
query NRD_RootTemplateGetReal([in](GUIDSTRING)_Object, [in](STRING)_Property, [out](REAL)_Value)
query NRD_RootTemplateGetString([in](GUIDSTRING)_Object, [in](STRING)_Property, [out](STRING)_Value)

Returns the specified root template property of the specified game object (character or item). _Property must be one of the values listed below. If the game object or property does not exist, the query fails.

Shared properties (can be fetched on characters, items, projectiles):

Attribute	Type	Notes
Id	String
Name	String
TemplateName	String
IsGlobal	Flag
IsDeleted	Flag
LevelName	String
ModFolder	String
GroupID	String
VisualTemplate	String
PhysicsTemplate	String
CastShadow	Flag
ReceiveDecal	Flag
AllowReceiveDecalWhenAnimated	Flag
IsReflecting	Flag
IsShadowProxy	Flag
RenderChannel	Int
CameraOffset	Vector3
HasParentModRelation	Flag
HasGameplayValue	Flag
DevComment	String
AIBoundsRadius	Real
AIBoundsHeight	Real
DisplayName	String
Opacity	Real
Fadeable	Flag
FadeIn	Flag
SeeThrough	Flag
FadeGroup	String
GameMasterSpawnSection	Integer
GameMasterSpawnSubSection	String

Character-only properties:

Attribute	Type	Notes
Icon	String
Stats	String
SkillSet	String
Equipment	String
LightID	String
HitFX	String
DefaultDialog	String
SpeakerGroup	String
GeneratePortrait	String
WalkSpeed	Real
RunSpeed	Real
ClimbAttachSpeed	Real
ClimbLoopSpeed	Real
ClimbDetachSpeed	Real
CanShootThrough	Flag
WalkThrough	Flag
CanClimbLadders	Flag
IsPlayer	Flag
Floating	Flag
SpotSneakers	Flag
CanOpenDoors	Flag
AvoidTraps	Flag
InfluenceTreasureLevel	Flag
HardcoreOnly	Flag
NotHardcore	Flag
JumpUpLadders	Flag
NoRotate	Flag
IsHuge	Flag
EquipmentClass	Int
ExplodedResourceID	String
ExplosionFX	String
VisualSetResourceID	String
VisualSetIndices	Int
TrophyID	String
SoundInitEvent	String
SoundAttachBone	String
SoundAttenuation	Int
CoverAmount	Int
LevelOverride	Int
ForceUnsheathSkills	Flag
CanBeTeleported	Flag
ActivationGroupId	String
SoftBodyCollisionTemplate	String
RagdollTemplate	String
DefaultState	Int
GhostTemplate	String
IsLootable	Flag
IsEquipmentLootable	Flag
InventoryType	Int
IsArenaChampion	Flag
FootstepWeight	String

Item-only properties:

Attribute	Type	Notes
Icon	String
CanBePickedUp	Flag
CanBeMoved	Flag
CoverAmount	Int
CanShootThrough	Flag
CanClickThrough	Flag
Destroyed	Flag
WalkThrough	Flag
WalkOn	Flag
Wadable	Flag
IsInteractionDisabled	Flag
IsPinnedContainer	Flag
StoryItem	Flag
FreezeGravity	Flag
IsKey	Flag
IsTrap	Flag
IsSurfaceBlocker	Flag
IsSurfaceCloudBlocker	Flag
TreasureOnDestroy	Flag
IsHuge	Flag
HardcoreOnly	Flag
NotHardcore	Flag
UsePartyLevelForTreasureLevel	Flag
Unimportant	Flag
Hostile	Flag
UseOnDistance	Flag
UseRemotely	Flag
IsBlocker	Flag
IsPointerBlocker	Flag
UnknownDisplayName	Flag
Tooltip	Int
Stats	String
OnUseDescription	String
DefaultState	String
Owner	String
Key	String
HitFX	String
LockLevel	Int
Amount	Int
MaxStackAmount	Int
TreasureLevel	Int
DropSound	String
PickupSound	String
UseSound	String
EquipSound	String
UnequipSound	String
InventoryMoveSound	String
LoopSound	String
SoundInitEvent	String
SoundAttachBone	String
SoundAttenuation	Int
Description	String
UnknownDescription	String
Speaker	String
AltSpeaker	String
SpeakerGroup	String
ActivationGroupId	String
Race	Int
IsWall	Flag
LevelOverride	Int
Floating	Flag
IsSourceContainer	Flag
MeshProxy	String
IsPublicDomain	Flag
AllowSummonTeleport	Flag

Projectile-only properties:

Attribute	Type	Notes
LifeTime	Real
Speed	Real
Acceleration	Real
CastBone	String
ImpactFX	String
TrailFX	String
DestroyTrailFXOnImpact	Flag
BeamFX	String
PreviewPathMaterial	String
PreviewPathImpactFX	String
PreviewPathRadius	Real
ImpactFXSize	Real
RotateImpact	Flag
IgnoreRoof	Flag
DetachBeam	Flag
NeedsArrowImpactSFX	Flag
ProjectilePath	Flag
PathShift	String
PathRadius	Real
PathMinArcDist	Real
PathMaxArcDist	Real
PathRepeat	Int

Miscellaneous functions

IsModLoaded

query NRD_IsModLoaded([in](GUIDSTRING)_ModUuid, [out](INTEGER)_IsLoaded)

Returns whether the mod with UUID _ModUuid is loaded.

ShowErrorMessage

call NRD_ShowErrorMessage((STRING)_Message)

Displays an error dialog box with the text _Message.

DebugLog

call NRD_DebugLog((STRING)_Message)

Functionally equivalent to DebugBreak(), except that the _Message argument accepts any type, not only strings. To use non-string arguments, cast the variable to the appropriate type.

Example usage:

IF
StoryEvent((ITEMGUID)_Item, "TEST")
THEN
NRD_DebugLog((STRING)_Item);

ForLoop

call NRD_ForLoop((STRING)_Event, (INTEGER)_Count)
call NRD_ForLoop((GUIDSTRING)_Object, (STRING)_Event, (INTEGER)_Count)
event NRD_Loop((STRING)_Event, (INTEGER)_Num)
event NRD_Loop((GUIDSTRING)_Object, (STRING)_Event, (INTEGER)_Num)

Counts from 0 up to _Count - 1 and throws loop event _Event for each value. Unlike regular events, NRD_Loop are not queued and are thrown immediately (i.e. during the NRD_ForLoop call), so there is no need for an additional cleanup/finalizer event.

Example usage:

// ...
NRD_ForLoop("MyMod_SomeLoopEvent", 10);

IF
NRD_Loop("MyMod_SomeLoopEvent", _Int)
THEN
NRD_DebugLog((STRING)_Int);

Example usage with GUIDs:

// ...
NRD_ForLoop(CHARACTERGUID_S_GLO_CharacterCreationDummy_001_da072fe7-fdd5-42ae-9139-8bd4b9fca406, "MyMod_SomeLoopEvent", 10);
  
IF
NRD_Loop((CHARACTERGUID)_Char, "MyMod_SomeLoopEvent", _Int)
THEN
NRD_DebugLog((STRING)_Char);
NRD_DebugLog((STRING)_Int);

Math functions

Sin

query NRD_Sin([in](REAL)_In, [out](REAL)_Out)

Computes the sine of the argument _In (measured in radians).

Cos

query NRD_Cos([in](REAL)_In, [out](REAL)_Out)

Computes the cosine of the argument _In (measured in radians).

Tan

query NRD_Tan([in](REAL)_In, [out](REAL)_Out)

Computes the tangent of the argument _In (measured in radians).

Round

query NRD_Round([in](REAL)_In, [out](REAL)_Out)

Computes the nearest integer value to the argument _In, rounding halfway cases away from zero.

Ceil

query NRD_Ceil([in](REAL)_In, [out](REAL)_Out)

Computes the smallest integer value not less than the argument.

Floor

query NRD_Floor([in](REAL)_In, [out](REAL)_Out)

Computes the largest integer value not greater than the argument.

Abs

query NRD_Abs([in](REAL)_In, [out](REAL)_Out)

Computes the absolute value of the argument.

Pow

query NRD_Pow([in](REAL)_Base, [in](INTEGER)_Exp, [out](REAL)_Out)

Computes the value of _Base raised to the power _Exp.

Sqrt

query NRD_Sqrt([in](REAL)_In, [out](REAL)_Out)

Computes the square root of _In.

Exp

query NRD_Exp([in](REAL)_In, [out](REAL)_Out)

Computes e (Euler's number, 2.7182818...) raised to the given power _In.

Log

query NRD_Log([in](REAL)_In, [out](REAL)_Out)

Computes the natural (base e) logarithm of _In.

Factorial

query NRD_Factorial([in](INTEGER)_In, [out](INTEGER)_Out)

Computes the factorial of the value _In.

Random

query NRD_Random([in](INTEGER)_Min, [in](INTEGER)_Max, [out](INTEGER)_Result)
query NRD_RandomReal([in](REAL)_Min, [in](REAL)_Max, [out](REAL)_Result)

Returns uniformly distributed random numbers in the range [_Min ... _Max].

Min

query NRD_Min([in](INTEGER)_A, [in](INTEGER)_B, [in](INTEGER)_C, [out](INTEGER)_Result)
query NRD_Min([in](INTEGER)_A, [in](INTEGER)_B, [in](INTEGER)_C, [in](INTEGER)_D, [out](INTEGER)_Result)
query NRD_MinReal([in](REAL)_A, [in](REAL)_B, [in](REAL)_C, [out](REAL)_Result)
query NRD_MinReal([in](REAL)_A, [in](REAL)_B, [in](REAL)_C, [in](REAL)_D, [out](REAL)_Result)

Returns the smallest input value (_A, _B, _C or _D).

Max

query NRD_Max([in](INTEGER)_A, [in](INTEGER)_B, [in](INTEGER)_C, [out](INTEGER)_Result)
query NRD_Max([in](INTEGER)_A, [in](INTEGER)_B, [in](INTEGER)_C, [in](INTEGER)_D, [out](INTEGER)_Result)
query NRD_MaxReal([in](REAL)_A, [in](REAL)_B, [in](REAL)_C, [out](REAL)_Result)
query NRD_MaxReal([in](REAL)_A, [in](REAL)_B, [in](REAL)_C, [in](REAL)_D, [out](REAL)_Result)

Returns the greatest input value (_A, _B, _C or _D).

String functions

StringCompare

query NRD_StringCompare([in](STRING)_A, [in](STRING)_B, [out](INTEGER)_Result)

Compare strings A and B using lexicographic ordering. Value of Result:

• -1, if A comes before B
• 0, if A is equal to B
• 1, if A comes after B

StringLength

query NRD_StringLength([in](STRING)_String, [out](INTEGER)_Length)

Computes the length of the string _String, and returns it in _Length.

StringFormat

query NRD_StringFormat([in](STRING)_Format, [out](STRING)_Result, [_Arg1], [_Arg2], [_Arg3], ...)

Substitutes the placeholders [1], [2], ... with the function arguments _Arg1, _Arg2 and returns the formatted string in _Result. The arguments accept any type (INTEGER, REAL, ...) as long as it is passed using a STRING typecast (i.e. (STRING)_IntVariable).

Example:

...
Random(_Modulo, _Random)
AND
NRD_StringFormat("Random modulo [1], number [2]", _Fmt, (STRING)_Modulo, (STRING)_Random)
THEN
DebugBreak(_Fmt);

Substring

query NRD_Substring([in](STRING)_String, [in](INTEGER)_From, [in](INTEGER)_Length, [out](STRING)_Result

Returns a substring of length _Length from the position _From. Rules:

• If _From is past the end of the string an empty string is returned.
• If _Length is past the end of the string, the portion of the string between _From and the end of the string is returned.
• If _From is negative, _From is treated as an offset from the end of the string (i.e. for a 8 character string, a _From value of -2 means offset 6); this rule is helpful for fetching the last N characters of a string
• If _Length is negative, _Length is treated as an offset from the end of the string

Examples:

NRD_Substring("ABCDEFGH", 0, 3, _Res) // "ABC"
NRD_Substring("ABCDEFGH", 9999, 3, _Res) // ""
NRD_Substring("ABCDEFGH", 0, 9999, _Res) // "ABCDEFGH"
NRD_Substring("ABCDEFGH", -2, 2, _Res) // "GH"
NRD_Substring("ABCDEFGH", 0, -2, _Res) // "ABCDEF"
NRD_Substring("ABCDEFGH", 3, -2, _Res) // "DEF"

RegexMatch

query NRD_RegexMatch([in](STRING)_String, [in](STRING)_Regex, [in](INTEGER)_FullMatch, [out](INTEGER)_Result)

Matches the string _String against the ECMAScript regex pattern _Regex. If _FullMatch is 1, the whole string much match the pattern, otherwise a partial match is allowed. The query fails if the specified pattern is not a valid ECMAScript regex pattern . The query returns 1 if the pattern matches the string and 0 otherwise. Because of limitations in the Osiris parser, the character ^ must be replaced with #.

Examples:

NRD_RegexMatch("GetValue", "Get|GetValue", 0, _Ret) // _Ret = 1
NRD_RegexMatch("GetValues", "Get|GetValue", 1, _Ret) // _Ret = 0

RegexReplace

query NRD_RegexReplace([in](STRING)_String, [in](STRING)_Regex, [in](STRING)_Replacement, [out](STRING)_Result)

Replaces all occurrences of the ECMAScript regex pattern _Regex in _String with the replacement pattern _Replacement and returns the result in _Result. The query fails if the specified pattern is not a valid ECMAScript regex.

Examples:

NRD_RegexReplace("Quick brown fox", "a|e|i|o|u", "[$&]", (STRING)_Ret)
// _Ret = "Q[u][i]ck br[o]wn f[o]x"

GuidString

query NRD_GuidString([in](STRING)_String, [out](GUIDSTRING)_Result)

Attempts to convert _String to a GuidString. If the conversion succeeds (i.e. the string is a valid NameGUID), the value is returned in _Result. If _String is not a valid NameGUID, the query fails.

StringToInt

query NRD_StringToInt([in](STRING)_String, [out](INTEGER)_Result)

Attempts to convert _String to an integer value. If the conversion succeeds (i.e. the string is a valid integer), the integer value is returned in _Result. If _String is not a valid integer, the query fails.

For detailed rules check the reference

StringToReal

query NRD_StringToReal([in](STRING)_String, [out](REAL)_Result)

Attempts to convert _String to a real value. If the conversion succeeds (i.e. the string is a valid real), the real value is returned in _Result. If _String is not a valid real value, the query fails.

For detailed rules see check the reference

IntegerToString

query NRD_IntegerToString([in](INTEGER)_Integer, [out](STRING)_Result)

Converts _Integer to a string value.

RealToString

query NRD_RealToString([in](REAL)_Real, [out](STRING)_Result)

Converts _Real to a string value.

Enumerations

DamageSourceType

Value	Label
0	None
1	SurfaceMove
2	SurfaceCreate
3	SurfaceStatus
4	StatusEnter
5	StatusTick
6	Attack
7	Offhand
8	GM

HitType

Value	Label
0	Melee
1	Magic
2	Ranged
3	WeaponDamage
4	Surface
5	DoT
6	Reflected

CriticalRoll

Value	Label	Meaning
0	Roll	An RNG roll determines whether the attack is a critical hit; flag CriticalHit is set depending on the result
1	Critical	The hit is always a critical hit; flag CriticalHit is set automatically.
2	NotCritical	The hit is never a critical hit.

HighGround

Value	Label	Meaning
0	Unknown	High ground test not performed
1	HighGround	Attacker is on high ground
2	EvenGround	Attacker is on even ground
3	LowGround	Attacker is on low ground

DeathType

Value	Label
0	None
1	Physical
2	Piercing
3	Arrow
4	DoT
5	Incinerate
6	Acid
7	Electrocution
8	FrozenShatter
9	PetrifiedShatter
10	Explode
11	Surrender
12	Hang
13	KnockedDown
14	Lifetime
15	Sulfur
16	Sentinel (default value)

StatCharacterFlags

Value	Label
1	IsPlayer
2	InParty
4	Visible
8	Invisible
16	Blind
32	DrinkedPotion
64	EquipmentValidated

AttackDirection

Value	Label
0	FrontToBack_Upper
1	FrontToBack_Lower
2	LeftToRight_Upper
3	LeftToRight_Lower
4	RightToLeft_Upper
5	RightToLeft_Lower
6	UpToDown
7	DownToUp

TalentType

Value	Label
1	ItemMovement
2	ItemCreation
3	Flanking
4	AttackOfOpportunity
5	Backstab
6	Trade
7	Lockpick
8	ChanceToHitRanged
9	ChanceToHitMelee
10	Damage
11	ActionPoints
12	ActionPoints2
13	Criticals
14	IncreasedArmor
15	Sight
16	ResistFear
17	ResistKnockdown
18	ResistStun
19	ResistPoison
20	ResistSilence
21	ResistDead
22	Carry
23	Throwing
24	Repair
25	ExpGain
26	ExtraStatPoints
27	ExtraSkillPoints
28	Durability
29	Awareness
30	Vitality
31	FireSpells
32	WaterSpells
33	AirSpells
34	EarthSpells
35	Charm
36	Intimidate
37	Reason
38	Luck
39	Initiative
40	InventoryAccess
41	AvoidDetection
42	AnimalEmpathy
43	Escapist
44	StandYourGround
45	SurpriseAttack
46	LightStep
47	ResurrectToFullHealth
48	Scientist
49	Raistlin
50	MrKnowItAll
51	WhatARush
52	FaroutDude
53	Leech
54	ElementalAffinity
55	FiveStarRestaurant
56	Bully
57	ElementalRanger
58	LightningRod
59	Politician
60	WeatherProof
61	LoneWolf
62	Zombie
63	Demon
64	IceKing
65	Courageous
66	GoldenMage
67	WalkItOff
68	FolkDancer
69	SpillNoBlood
70	Stench
71	Kickstarter
72	WarriorLoreNaturalArmor
73	WarriorLoreNaturalHealth
74	WarriorLoreNaturalResistance
75	RangerLoreArrowRecover
76	RangerLoreEvasionBonus
77	RangerLoreRangedAPBonus
78	RogueLoreDaggerAPBonus
79	RogueLoreDaggerBackStab
80	RogueLoreMovementBonus
81	RogueLoreHoldResistance
82	NoAttackOfOpportunity
83	WarriorLoreGrenadeRange
84	RogueLoreGrenadePrecision
85	WandCharge
86	DualWieldingDodging
87	Human_Inventive
88	Human_Civil
89	Elf_Lore
90	Elf_CorpseEating
91	Dwarf_Sturdy
92	Dwarf_Sneaking
93	Lizard_Resistance
94	Lizard_Persuasion
95	Perfectionist
96	Executioner
97	ViolentMagic
98	QuickStep
99	Quest_SpidersKiss_Str
100	Quest_SpidersKiss_Int
101	Quest_SpidersKiss_Per
102	Quest_SpidersKiss_Null
103	Memory
104	Quest_TradeSecrets
105	Quest_GhostTree
106	BeastMaster
107	LivingArmor
108	Torturer
109	Ambidextrous
110	Unstable
111	ResurrectExtraHealth
112	NaturalConductor
113	Quest_Rooted
114	PainDrinker
115	DeathfogResistant
116	Sourcerer
117	Rager
118	Elementalist
119	Sadist
120	Haymaker
121	Gladiator
122	Indomitable
123	WildMag
124	Jitterbug
125	Soulcatcher
126	MasterThief
127	GreedyVessel
128	MagicCycles

AttributeFlags

Value	Label
0	None
1	FreezeImmunity
2	BurnImmunity
3	StunImmunity
4	PoisonImmunity
5	CharmImmunity
6	FearImmunity
7	KnockdownImmunity
8	MuteImmunity
9	ChilledImmunity
10	WarmImmunity
11	WetImmunity
12	BleedingImmunity
13	CrippledImmunity
14	BlindImmunity
15	CursedImmunity
16	WeakImmunity
17	SlowedImmunity
18	DiseasedImmunity
19	InfectiousDiseasedImmunity
20	PetrifiedImmunity
21	DrunkImmunity
22	SlippingImmunity
23	FreezeContact
24	BurnContact
25	StunContact
26	PoisonContact
27	ChillContact
28	Torch
29	Arrow
30	Unbreakable
31	Unrepairable
32	Unstorable
33	Grounded
34	HastedImmunity
35	TauntedImmunity
36	SleepingImmunity
37	AcidImmunity
38	SuffocatingImmunity
39	RegeneratingImmunity
40	DisarmedImmunity
41	DecayingImmunity
42	ClairvoyantImmunity
43	EnragedImmunity
44	BlessedImmunity
45	ProtectFromSummon
46	Floating
47	DeflectProjectiles
48	IgnoreClouds
49	MadnessImmunity
50	ChickenImmunity
51	IgnoreCursedOil
52	ShockedImmunity
53	WebImmunity
54	LootableWhenEquipped
55	PickpocketableWhenEquipped
56	LoseDurabilityOnCharacterHit
57	EntangledContact
58	ShacklesOfPainImmunity
59	MagicalSulfur
60	ThrownImmunity
61	InvisibilityImmunity