class Effect

class Effect
ToString()

Converts an effect to a formatted string.

GetCreator()
Return type:Object
GetDuration()

Gets the duration of an effect.

Return type:The duration specified when applied for the effect. The value of this is undefined for effects which are not of DURATION_TYPE_TEMPORARY.
GetDurationRemaining()

Gets the remaing duration of an effect

Return type:The remaining duration of the specified effect. The value of this is undefined for effects which are not of DURATION_TYPE_TEMPORARY.
GetDurationType()

Get duration type

Return type:DURATION_TYPE_*
GetFloat(index)

Get effect float value.

Parameters:
  • index (int) – Index
GetId()

Gets the specifed effects Id

GetIsValid()

Determines whether an effect is valid.

GetInt(index)

Get effect integer value at the index specified.

Parameters:
  • index (int) – Index
GetObject(index)

Get effect object value.

Parameters:
  • index (int) – Index
GetSpellId()

Gets Spell Id associated with effect

Return type:SPELL_* constant.
GetString(index)

Gets a string on an effect.

Parameters:
  • index (int) – Index to store the string. [0, 5]
GetSubType()

Get the subtype of the effect.

Return type:SUBTYPE_* constant.
GetType()

Gets effects internal ‘true’ type.

SetAllInts(val)

Set all integers to a specified value

SetCreator(object)

Sets the effects creator

Parameters:
  • object (Object) – New effect creator.
SetDuration(dur)
SetDurationType(dur)
SetFloat(index, float)

Set effect float

Parameters:
  • index (int) – Index. [0, 3]
  • float (float) – Float
SetInt(index, value)

Sets the internal effect integer at the specified index to the value specified. Source: nwnx_structs by Acaos

SetNumIntegers(num)

Set number of integers stored on an effect. Calling this on an effect will erase any integers already stored on the effect.

Parameters:
  • num (int) – Number of integers.
SetObject(index, object)

Set effect object

Parameters:
  • index (int) – Index. [0, 3]
  • object (Object) – Object
SetSpellId(spellid)

Sets the effect’s spell id as specified, which will later be returned with Effect:GetSpellId().

Parameters:
  • spellid (int) – SPELL_* constant.
SetString(index, str)

Sets a string on an effect.

Parameters:
  • index (int) – Index to store the string. [0, 5]
  • str (string) – String to store.
SetSubType(value)

Set the subtype of the effect.

Parameters:
  • value (int) – SUBTYPE_*
SetType(value)

Sets effects type.

Parameters:
  • value (int) – EFFECT_TYPE_*
SetExposed(val)

Set exposed.

Parameters:
  • val (boolean) – Value
SetIconShown(val)

Set icon shown.

Parameters:
  • val (boolean) – Value