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

Functions

function XEEventManager Tick (fDel, pWorld) end
 
function XEEventManager SendEvent (sender, executeable, pEventType, pWorld) end
 
function XEEventManager ConsumeEventNow (pEventToConsume, pWorld) end
 
function XEEventManager AddEventReceiver (pReceiver) end
 
function XEEventManager RemoveEventReceiver (pReceiver) end
 
function XEEventManager CreateEventList (pWorld, pListName) end
 
function XEEventManager GetEventListForWorld (pWorld) end
 
function XEEventManager GetEventListForName (pName) end
 
function XEEventManager GetEventReceiversForChannel (pChannelName) end
 
function XEEventManager FindEventReceiver (pChannelName, pReceiverName) end
 
function XEEventManager FindEventList (pWorld, pName) end
 
function XEEventManager GetValidEventListName (pPrefix) end
 
function XEEventManager GetValidEventReceiverName (pPrefix) end
 
function XEEventManager GetEventListIterator () end
 
function XEEventManager ReleaseEventsInWorld (pWorld) end
 

Variables

 XEEventManager = {}
 

Function Documentation

◆ AddEventReceiver()

function XEEventManager AddEventReceiver ( pReceiver  )

往广播接收者组中添加一个广播接收者pReceiver

Parameters
pReceiverXEEventReceiver
Returns
void

◆ ConsumeEventNow()

function XEEventManager ConsumeEventNow ( pEventToConsume  ,
pWorld   
)

手动删除某个世界中的某个事件（一般用于custom event，普通事件一般不用手动删除）

Parameters
pEventToConsumeXEEventBase 要删除的事件指针
pWorldXEWorld 事件所在的世界
Returns
boolean 是否删除成功

◆ CreateEventList()

function XEEventManager CreateEventList ( pWorld  ,
pListName   
)

创建事件列表

Parameters
pWorldXEWorld 创建某个世界的事件列表，如果为空，创建全局的事件列表
pListNamestring 事件列表名称，如果为空，会自动生成一个
Returns
XEEventList 创建的事件列表指针

◆ FindEventList()

function XEEventManager FindEventList ( pWorld  ,
pName   
)

根据世界和接受者名称查找接收者

Parameters
pWorldXEWorld 指定世界指针
pNamestring 指定的事件列表指针
Returns
XEEventList 查找到的事件列表指针

◆ FindEventReceiver()

function XEEventManager FindEventReceiver ( pChannelName  ,
pReceiverName   
)

根据通道名称和接受者名称查找接收者

Parameters
pChannelNamestring 指定通道名称
pReceiverNamestring 指定的接收者名称
Returns
XEEventReceiver 查找到的接收者指针

◆ GetEventListForName()

function XEEventManager GetEventListForName ( pName  )

获取某个名称的事件列表组

Parameters
pNamestring 指定的事件列表名称
Returns
XEEventList[]
number 获取到的事件列表数目

◆ GetEventListForWorld()

function XEEventManager GetEventListForWorld ( pWorld  )

获取某个世界的事件列表组

Parameters
pWorldXEWorld 指定的世界指针
Returns
XEEventList[]
number 获取到的事件列表数目

◆ GetEventListIterator()

function XEEventManager GetEventListIterator ( )

返回事件列表迭代器

Returns
IteratorWrapper<XEEventList*>

◆ GetEventReceiversForChannel()

function XEEventManager GetEventReceiversForChannel ( pChannelName  )

根据通道名称获取接收者列表组

Parameters
pChannelNamestring 指定通道名称
Returns
XEEventReceiver[]
number 获取到的接收者列表数目
Attention
需要手动释放接收者内存！

◆ GetValidEventListName()

function XEEventManager GetValidEventListName ( pPrefix  )

获取到一个有效的事件列表名称

Parameters
pPrefixstring 指定前缀，默认是"EventList"
Returns
string 获取到的有效名称

◆ GetValidEventReceiverName()

function XEEventManager GetValidEventReceiverName ( pPrefix  )

获取到一个有效的广播接收者名称

Parameters
pPrefixstring 指定前缀，默认是"EventReceiver"
Returns
string 获取到的有效名称

◆ ReleaseEventsInWorld()

function XEEventManager ReleaseEventsInWorld ( pWorld  )

释放指定的世界pWorld中的所有事件

Parameters
pWorldXEWorld
Returns
void

◆ RemoveEventReceiver()

function XEEventManager RemoveEventReceiver ( pReceiver  )

从广播接收者组中删除某个广播接收者

Parameters
pReceiverXEEventReceiver 要删除的接收者指针
Returns
boolean 是否删除成功

◆ SendEvent()

function XEEventManager SendEvent ( sender  ,
executeable  ,
pEventType  ,
pWorld   
)

生成一个事件，并放到对应的事件列表中

Parameters
senderuserdata 事件发送者
executeableuserdata 事件执行者
pEventTypestring 事件类型
pWorldXEWorld 事件所在的世界
Returns
XEEventBase 生成的事件指针

◆ Tick()

function XEEventManager Tick ( fDel  ,
pWorld   
)

更新某个世界的事件列表

Parameters
fDelnumber 间隔（s）
pWorldXEWorld 指定的世界指针
Returns
void

Variable Documentation

◆ XEEventManager

XEEventManager = {}
Generated by   doxygen 1.8.15