Effect Class

• Fields
  • Configuration: table @readonly
  • IsDestroyed: boolean @readonly
  • DestroyOnEnd: boolean
  • MaxLifetime: number
  • DestroyOnLifecycleEnd: boolean
  • DisableLeakWarning: boolean
• Constructors
  • new(...) -> ServerProxy
  • locally(...) -> ClientProxy
• Methods
  • OnStart() @override
  • OnConstruct() @override
  • OnDestroy() @override

Fields

Configuration: table @readonly

A table of arguments passed to .new() or .locally().

IsDestroyed: boolean @readonly

DestroyOnEnd: boolean

Determines if skill should get automatically destroyed when OnStart() finishes executing.

MaxLifetime: number

A maximum amount of seconds your effect can exist. -> Read here.

DestroyOnLifecycleEnd: boolean

Determines if skill should get automatically destroyed when reaches its MaxLifetime.

DisableLeakWarning: boolean

If true, disables a memory leak warning from lifetime checker.

Constructors

new(...) -> ServerProxy

Used on server. Creates an effect proxy and broadcasts every called method to clients.

locally(...) -> ClientProxy

Used on client. Creates your effect locally and returns a client proxy.

Methods

OnStart() @override

Invokes when your effect starts.

OnConstruct() @override

Invokes when your effect gets constructed, before OnStart().

OnDestroy() @override

Invokes when your effect gets destroyed.