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:
| Parameter | Type | Description |
|---|---|---|
| filename | string | The filename of the effect. |
| pos | Vec2 | [optional] The XY position to play the effect at. |
| z | number | [optional] The Z position to play the effect at. |
Returns:
| Return Type | Description |
|---|---|
| integer | The handle of the effect. |
stop
Type: Function.
Description:
Stops an Effekseer effect.
Signature:
stop: function(self: EffekNode, handle: integer)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| handle | integer | The handle of the effect. |
onEffekEnd
Type: Function.
Description:
Registers a callback for when an Effekseer effect has ended.
Signature:
onEffekEnd: function(self: EffekNode, callback: function(handle: integer))
Parameters:
| Parameter | Type | Description |
|---|---|---|
| callback | function | The callback function for when the effect has ended. |