class
NpcAction (client-side)
Available since version: 0.3.0
This class represents script NPC action.
Properties
No properties.
Methods
getResult
This method is triggered after action was finished and initialized successfully. Used to determine action result.
bool getResult(int npc_id)
Parameters:
int
npc_id: the remote npc identifier.
Returns bool
:
true
if action was finished, otherwise false
to continue.
onInit
This method is triggered when NPC action is being initialized. Used to determine if action was initialized successfully.
bool onInit(int npc_id)
Parameters:
int
npc_id: the remote npc identifier.
Returns bool
:
true
if action was initialized successfully, otherwise false
.
onUpdate
This method is triggered every frame. Used to execute action logic.
bool onUpdate(int npc_id)
Parameters:
int
npc_id: the remote npc identifier.
Returns bool
:
true
if action was finished, otherwise false
to continue.
static
onDeserialize
This method is triggered after client receives NPC action. Used to deserialize data from packet.
instance onDeserialize(instance packet)
Parameters:
instance
packet: the packet containing information about action.
Returns instance
:
Created instance of NPC action, otherwise null
for failure.