GetActiveEffects

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns an array_var containing all the effects currently active on the calling actor. The optional filter parameter may be used for specifying which types of effects are returned.

Syntax

[help]
(activeEffects:array_var) reference.GetActiveEffects filter:int

Effect-Type Filter Values

1	Object Effects
2	Actor Effects
4	Ingestibles

Example

let aEffects := actorRef.GetActiveEffects

Will return all effects, of all types, currently active on actorRef.

let aEffects := actorRef.GetActiveEffects 2

Will return all Actor Effects currently active on actorRef.

let aEffects := actorRef.GetActiveEffects 5

Will return all Object Effects and Ingestibles currently active on actorRef.

See Also