NDGIA

[Main] [Lua Examples]

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Global Functions & Examples

AddView(eventid,searcher,frequency) eventid - Event identifier for events searcher - Object searcher that defines the view frequency - Update frequency check in seconds.

The frequency argument may be omitted, the View will default to 0.25 seconds for the frequency. The minimum value of frequency is 0.1 seconds.

Example of adding a view to a object

 --this will add a view that will interact with players within 30 units
 --It will check and update every 0.5 seconds
 AddView("UniqueViewHandler",SearchPlayerInRange(30,true),0.5)

Example of handling a object entering a view

 --- OnEnterView - this function is triggered by the EventHandler EnterView
 --@ param: enteringObject - this is the object in the world that moves within the 30 unit view
 function OnEnterView(enteringObject)
     If(enteringObject:IsPlayer()) then
         enteringObject:SystemMessage("you have entered " .. this:GetName() .. " view.")
     end
 end
 
 --Register the event handler for the "UniqueViewHandler" when a player enters the view
 RegisterEventHandler(EventType.EnterView, "UniqueViewHandler", OnEnterView)

Example of handling a object leaving a view

 --- OnLeaveView - this function is triggered by the EventHandler LeaveView
 --@ param: enteringObject - this is the object in the world that moves within the 30 unit view
 function OnLeaveView (leavingObject)
     If(leavingObject:IsPlayer()) then
         leavingObject:SystemMessage("you have left " .. this:GetName() .. " view.")
     end
 end
 
 --Register the event handler for the "UniqueViewHandler" when a player leaves the view
 RegisterEventHandler(EventType.EnterView, "UniqueViewHandler", OnLeaveView)