DURATION_TYPE_* Constant Group

From NWN Lexicon
Jump to navigationJump to search

Duration types for ApplyEffectAtLocation() and ApplyEffectToObject() functions when applying effects (retrievable by GetEffectDurationType.

Also used for item properties AddItemProperty and GetItemPropertyDurationType although this omits the DURATION_TYPE_INSTANT option.

Constants

Constant Value Description
DURATION_TYPE_INSTANT 0 Instantaneous. This would apply to any effect that is both immediate and permanent and cannot be removed. EffectDamage would be one example, as well as any of the 'fire-and-forget' visual effects. If used on permanent or temporary effects it might have unforeseen consequences such as being stuck on and not removable.
DURATION_TYPE_PERMANENT 2 Permanent duration. This is as it sounds... the effect lasts until removed (by resting depending on the subtype, or RemoveEffect) or dispelled if magical.
DURATION_TYPE_TEMPORARY 1 A temporary duration means that the effect must have a duration specified in the command (and is the only time this is so). Once the time has expired, the effect will be removed. It can also be removed by resting depending on the subtype, or RemoveEffect, or dispelled if magical.

See Also

functions: 

ApplyEffectAtLocation

ApplyEffectToObject

GetEffectDurationType

AddItemProperty

GetItemPropertyDurationType