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

Functions

function XELevel Load (pRelativePath, bUseDefaultLevelPathAsHome) end
 
function XELevel Present () end
 
function XELevel UnPresent () end
 
function XELevel PresentThisOnly () end
 
function XELevel IsPresent () end
 
function XELevel PresentPhysicsForActors (fDelSecond) end
 
function XELevel Release () end
 
function XELevel Tick (fDelSecond) end
 
function XELevel Render (pViewport) end
 
function XELevel GetActorValidName (strActorType) end
 
function XELevel GetLevelName () end
 
function XELevel IsDefaultLevel () end
 
function XELevel GetOwner () end
 
function XELevel RayPickOne (HitResult) end
 

Variables

 XELevel = {}
 

Function Documentation

◆ GetActorValidName()

function XELevel GetActorValidName ( strActorType  )

获取关卡一个有效的Actor名称

Parameters
strActorTypestring
Returns
string

◆ GetLevelName()

function XELevel GetLevelName ( )

获取关卡名称

Returns
string

◆ GetOwner()

function XELevel GetOwner ( )

获取关卡所在世界

Returns
XEWorld

◆ IsDefaultLevel()

function XELevel IsDefaultLevel ( )

判定该关卡是否为世界的默认关卡

Returns
boolean

◆ IsPresent()

function XELevel IsPresent ( )

这个关卡为是否可在世界中表示的状态,

Returns
boolean 是否可表示

◆ Load()

function XELevel Load ( pRelativePath  ,
bUseDefaultLevelPathAsHome   
)

为这个关卡加载场景内容, 关卡可用.xscene文件进行加载。如果在xscene文件中有同名的关卡,则加载这个关卡,否则将加载默认关卡 in the format of "xx.xscene", if you don't want to use the relative as home path, set it to xfalse.

Parameters
pRelativePathstring 场景文件的相对路径,此处的相对路径是指xscene文件相对于工程文件夹的路径。
bUseDefaultLevelPathAsHomeboolean 是否使用默认关卡里的场景路径作为根路径
Returns
boolean 成功与否

◆ Present()

function XELevel Present ( )

设置这个关卡为可在世界中表示的状态,

Returns
void

◆ PresentPhysicsForActors()

function XELevel PresentPhysicsForActors ( fDelSecond  )

为这个关卡的非删除Actor表示物理世界

Parameters
fDelSecondnumber
Returns
void

◆ PresentThisOnly()

function XELevel PresentThisOnly ( )

只使该关卡在所属世界中生效

Returns
void

◆ RayPickOne()

function XELevel RayPickOne ( HitResult  )

当前可表示关卡中,射线拾取,返回一个排序后最优结果

Parameters
HitResultXEHitResult [in][out]拾取结果结构体,包含输入的射线起始位置和方向;输出的拾取到的XEActor、拾取到的3D场景的坐标点等,具体参考XEHitResult的介绍.
Returns
boolean 是否拾取成功

◆ Release()

function XELevel Release ( )

释放关卡

Returns
void

◆ Render()

function XELevel Render ( pViewport  )

渲染 1 渲染当前世界的Actor列表中未被标记为删除和隐藏状态的Actor; 2 如果当前世界的物理场景对象不为空,也会对物理场景执行渲染操作; 3 执行绑定脚本编辑器中Render响应函数。

Parameters
pViewportXEViewport
Returns
void

◆ Tick()

function XELevel Tick ( fDelSecond  )

更新关卡Actor列表中未被标记为delete的Actor,更新物理世界、执行事件回调以及执行绑定脚本编辑器中的Tick响应函数等。

Parameters
fDelSecondnumber
Returns
void

◆ UnPresent()

function XELevel UnPresent ( )

设置这个关卡为可在世界中不可表示的状态,

Returns
void

Variable Documentation

◆ XELevel

XELevel = {}