NCScriptsObjectEventHandling

[Main] [Lua Examples]

Event Handler & Examples

Arrived Params bool - true if mobile arrives successfully at the end location

Fires on a mobile when he arrives or fails to arrive at his path or move end point.

Example

 function OnPatrolArrived(arriveSuccess)
 
     if( AI.StateMachine.CurState ~= "Patrol" ) then
         -- ignore this message if we are no longer patrolling
         return
     end
 
     -- TODO: Handle the case where he fails to path properly
     -- for now we just move on to the next point in the patrol
     if not(arriveSuccess) then
     end
 
     DoPatrol()
 end
 RegisterEventHandler(EventType.Arrived, "patrol", OnPatrolArrived)

CharacterListRequestResult Params eventid - event identifier passed to the character list request Returns table - list of character name and associated character id

This message fires when a character list request either succeeds or fails.

Example

 function CharacterListRequestResult(characterlist)
     if(characterlist) then
         for k,v in pairs(table_name) do
 	      print(k,v)
         end
     end
 end
 RegisterEventHandler(EventType.CharacterListRequestResult, "request", CharacterListRequestResult)

ClientObjectCommand Params (...) If arguments are specified, they are sent in a parameterized list of strings

Fires on an object specified by the client with the client supplied data. Object messages are ways to execute script directly on specified object from the client. See the client specific reference NEED REF to see which commands the client can send. EventIdentifier:.

Example

 RegisterEventHandler(EventType.ClientObjectCommand,"arena", function (user,commandName,...)		
     if(commandName ~= nil and arenaCommandHandlers[commandName] ~= nil) then			
         --DebugMessage("command found")
         arenaCommandHandlers[commandName](user,...)
     end
 end)

ClientTargetAnyObjResponse Params EventId - specified when RequestClientTargetAnyObj(...) is called

This is a response from the client from the RequestClientTargetAnyObj(...) function. Gameobject - object user selected, nil if user cancelled

Example

 function HandleInteract(objRef,user)
     print(objRef:GetName().. " was targeted by " .. user:GetName())
 end
 
 RegisterEventHandler(EventType.ClientTargetAnyObjResponse, "targetObj", function (objRef,user)
     HandleInteract(objRef,user)
 end)  

ClientTargetGameObjResponse Params EventId - Specified when RequestClientTargetGameObj(...) is called gameobject - Object user selected. nil if user cancelled

This is a response from the client from the RequestClientTargetGameObj(...) function.

Example

 function HandleInteract(objRef,user)
     print(objRef:GetName().. " was targeted by " .. user:GetName())
 end
 
 RegisterEventHandler(EventType.ClientTargetGameObjResponse, "targetObj", function (objRef,user)
     HandleInteract(objRef,user)
 end)  

ContextMenuResponse Params EventId - ResponseId specified when OpenCustomContextMenu() is called gameobject - user the menu was sent too menuid - menu option id ("" if canceled)

This is a response from the client from the OpenCustomContextMenu() function.

Example

 function HandleInteract(objRef,menuId)
     print(objRef:GetName().. " used their context menu option" .. menuId)
 end
 
 RegisterEventHandler(EventType.ContextMenuResponse, "contextMenuUsed", function (objRef,menuId)
     HandleInteract(objRef,menuId)
 end) 

CreatedObject

.

Example

 CODE BLOCK

DestroyAllComplete

.

Example

 CODE BLOCK

DestroyedObject

.

Example

 CODE BLOCK

DynamicWindowResponse

.

Example

 CODE BLOCK

EnterView

.

Example

 CODE BLOCK

GetBanListResult

.

Example

 CODE BLOCK

GlobalVarUpdateResult

.

Example

 CODE BLOCK

ItemEquipped

.

Example

 CODE BLOCK

ItemUnEquipped

.

Example

 CODE BLOCK

LoadedFromBackup

.

Example

 CODE BLOCK

LeaveView

.

Example

 CODE BLOCK

CreatedObject

.

Example

 CODE BLOCK

ModuleAttached

.

Example

 CODE BLOCK

PathingInterrupted

.

Example

 CODE BLOCK

PlayerSpeech

.

Example

 CODE BLOCK

RequestEquip

.

Example

 CODE BLOCK

RequestPickUp

.

Example

 CODE BLOCK

StartMoving

.

Example

 CODE BLOCK

StopMoving

.

Example

 CODE BLOCK

Timer

.

Example

 CODE BLOCK

Use

.

Example

 CODE BLOCK

UserLogin

.

Example

 CODE BLOCK

UserLogout

.

Example

 CODE BLOCK