Skip to main content

EffekNode

Description:

  A class for playing Effekseer effects.

Class Object: EffekNode Class.

Inherits from: Node.

play

Type: Function.

Description:

  Plays an Effekseer effect.

Signature:

play: function(self: EffekNode, filename: string, pos?: Vec2, z?: number): integer

Parameters:

ParameterTypeDescription
filenamestringThe filename of the effect.
posVec2[optional] The XY position to play the effect at.
znumber[optional] The Z position to play the effect at.

Returns:

Return TypeDescription
integerThe handle of the effect.

stop

Type: Function.

Description:

  Stops an Effekseer effect.

Signature:

stop: function(self: EffekNode, handle: integer)

Parameters:

ParameterTypeDescription
handleintegerThe handle of the effect.