AR_Engine_SDK
Functions | Variables
XEEventBase.lua File Reference
类 XEEventBase 继承关系图:
Inheritance graph

Functions

function XEEventBase new () end
 
function XEEventBase Tick (fInterval) end
 
function XEEventBase Release () end
 
function XEEventBase Execute (pWorld) end
 
function XEEventBase IsReceiverInChannel (szChannelName) end
 
function XEEventBase GetEventList (pWorld, pHasTheEvent) end
 
function XEEventBase GetTypeName () end
 
function XEEventBase SetData (val) end
 
function XEEventBase GetData () end
 
function XEEventBase SetSender (who) end
 
function XEEventBase GetSender () end
 
function XEEventBase SetExcutable (what) end
 
function XEEventBase GetExcutable () end
 
function XEEventBase SetName (szName) end
 
function XEEventBase GetName () end
 
function XEEventBase AddListener (pListener) end
 
function XEEventBase RemoveListener (pListener) end
 
function XEEventBase SetRemove () end
 
function XEEventBase IsRemoved () end
 
function XEEventBase SetRemoveMode (erm) end
 
function XEEventBase GetRemoveMode () end
 
function XEEventBase SetExecuteMode (eem) end
 
function XEEventBase GetExecuteMode () end
 
function XEEventBase SetReserve () end
 
function XEEventBase SetTickable (bEnable) end
 
function XEEventBase IsTickable () end
 
function XEEventBase SetCountdownTime (fMilliseconds) end
 
function XEEventBase GetCountdownTime () end
 
function XEEventBase SetEventStatus (erm) end
 
function XEEventBase GetEventStatus () end
 

Variables

 EVENT_STATUS_READY = 0
 
 EVENT_STATUS_EXPLAIN = 0
 
 EVENT_STATUS_ENTRANCE = 0
 
 EVENT_STATUS_TRIGGER = 0
 
 EVENT_STATUS_RESTORE = 0
 
 EVENT_STATUS_CUSTOM = 0
 
 EVENT_STATUS_RELEASE = 0
 
 XEEventBase = {}
 
XEEventBase ERM_AUTO = 0
 
XEEventBase ERM_MANUAL = 0
 
XEEventBase EEM_AUTO = 0
 
XEEventBase EEM_MANUAL = 0
 

Function Documentation

◆ AddListener()

function XEEventBase AddListener ( pListener  )

添加事件监听者

Parameters
pListenerXEEventBase::Listener
Returns
void

◆ Execute()

function XEEventBase Execute ( pWorld  )

执行事件

Parameters
pWorldXEWorld
Returns
void

◆ GetCountdownTime()

function XEEventBase GetCountdownTime ( )

获取当前事件的倒计时时刻

Returns
number

◆ GetData()

function XEEventBase GetData ( )

获取事件数据

Returns
XEVariant

XEEventBase_GetData01

Returns
XEVariant

◆ GetEventList()

function XEEventBase GetEventList ( pWorld  ,
pHasTheEvent   
)

获取事件列表

Parameters
pWorldXEWorld 世界指针，如果为空，返回全局事件列表；如果不为空，返回对应这个世界的事件列表
pHasTheEventboolean 返回列表中是否包含当前这个事件
Returns
XEEventList

◆ GetEventStatus()

function XEEventBase GetEventStatus ( )

获取当前事件的状态

Returns
number

◆ GetExcutable()

function XEEventBase GetExcutable ( )

判断事件是否可执行

Returns
userdata

◆ GetExecuteMode()

function XEEventBase GetExecuteMode ( )

获取事件被执行的方式（手动/自动）

Returns
number

◆ GetName()

function XEEventBase GetName ( )

获取事件名称

Returns
string

◆ GetRemoveMode()

function XEEventBase GetRemoveMode ( )

获取事件被移除的方式（手动/自动）

Returns
number

◆ GetSender()

function XEEventBase GetSender ( )

获取事件发送者

Returns
userdata

◆ GetTypeName()

function XEEventBase GetTypeName ( )

返回当前事件类型

Returns
string

◆ IsReceiverInChannel()

function XEEventBase IsReceiverInChannel ( szChannelName  )

判断事件的广播接受者是否跟当前事件在同一个通道内

Parameters
szChannelNamestring
Returns
boolean
Attention
如果广播接收者和当前事件在同一个通道内，广播接收者响应事件执行的函数才会被调用

◆ IsRemoved()

function XEEventBase IsRemoved ( )

判断被移除的状态

Returns
boolean

◆ IsTickable()

function XEEventBase IsTickable ( )

判断当前事件是否启用Tick

Returns
boolean

◆ new()

function XEEventBase new ( )

XEEventBase_new00

Returns
XEEventBase

◆ Release()

function XEEventBase Release ( )

释放事件资源

Returns
void

◆ RemoveListener()

function XEEventBase RemoveListener ( pListener  )

移除事件监听者

Parameters
pListenerXEEventBase::Listener
Returns
boolean

◆ SetCountdownTime()

function XEEventBase SetCountdownTime ( fMilliseconds  )

设置当前事件的倒计时时刻，如果事件设置了延时触发，则会启用倒计时，倒计时为0时，该事件被执行

Parameters
fMillisecondsnumber
Returns
void

◆ SetData()

function XEEventBase SetData ( val  )

设置事件数据

Parameters
valXEVariant
Returns
void

◆ SetEventStatus()

function XEEventBase SetEventStatus ( erm  )

设置当前事件的状态

Parameters
ermnumber
Returns
void

◆ SetExcutable()

function XEEventBase SetExcutable ( what  )

设置事件是否可执行

Parameters
whatuserdata
Returns
void

◆ SetExecuteMode()

function XEEventBase SetExecuteMode ( eem  )

设置事件被执行的方式（手动/自动）

Parameters
eemnumber
Returns
void

◆ SetName()

function XEEventBase SetName ( szName  )

设置事件名称

Parameters
szNamestring
Returns
void

◆ SetRemove()

function XEEventBase SetRemove ( )

设置被移除的状态（事件被移除状态为true，表明当前事件该被执行了）

Returns
void

◆ SetRemoveMode()

function XEEventBase SetRemoveMode ( erm  )

设置事件被移除的方式（手动/自动）

Parameters
ermnumber
Returns
void

◆ SetReserve()

function XEEventBase SetReserve ( )

恢复事件（设置事件被删除的状态为false）

Returns
void

◆ SetSender()

function XEEventBase SetSender ( who  )

设置事件发送者

Parameters
whouserdata
Returns
void

◆ SetTickable()

function XEEventBase SetTickable ( bEnable  )

设置当前事件是否启用Tick

Parameters
bEnableboolean
Returns
void

◆ Tick()

function XEEventBase Tick ( fInterval  )

更新事件

Parameters
fIntervalnumber 间隔（ms）
Returns
void

Variable Documentation

◆ EEM_AUTO

XEEventBase EEM_AUTO = 0

◆ EEM_MANUAL

XEEventBase EEM_MANUAL = 0

◆ ERM_AUTO

XEEventBase ERM_AUTO = 0

◆ ERM_MANUAL

XEEventBase ERM_MANUAL = 0

◆ EVENT_STATUS_CUSTOM

EVENT_STATUS_CUSTOM = 0

◆ EVENT_STATUS_ENTRANCE

EVENT_STATUS_ENTRANCE = 0

◆ EVENT_STATUS_EXPLAIN

EVENT_STATUS_EXPLAIN = 0

◆ EVENT_STATUS_READY

EVENT_STATUS_READY = 0

◆ EVENT_STATUS_RELEASE

EVENT_STATUS_RELEASE = 0

◆ EVENT_STATUS_RESTORE

EVENT_STATUS_RESTORE = 0

◆ EVENT_STATUS_TRIGGER

EVENT_STATUS_TRIGGER = 0

◆ XEEventBase

XEEventBase = {}
Generated by   doxygen 1.8.15