AR_Engine_SDK
函数 | 变量
XELevel.lua 文件参考

#include <XELevel.h>

类 XELevel 继承关系图:
Inheritance graph

函数

function XELevel Load (pRelativePath, bUseDefaultLevelPathAsHome) end
 
function XELevel Present (bSyncExclusingRenderObjectsToWorld) end
 
function XELevel UnPresent () end
 
function XELevel PresentThisOnly () end
 
function XELevel IsPresent () end
 
function XELevel Init () 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 RayPickOne (HitResult) end
 
function XELevel SetOrder (nOrder) end
 
function XELevel GetOrder () end
 
function XELevel GetScriptContainerInstance () end
 
function XELevel AttachBindingScriptAsset (pAssetPath) end
 
function XELevel DetachBindingScriptInstance () end
 
function XELevel GetPatchGraphMgr () end
 
function XELevel ReleasePatchManager () end
 
function XELevel SetRenderOption (ro) end
 
function XELevel GetRenderOption () end
 

变量

 XELevel = {}
 

函数说明

◆ AttachBindingScriptAsset()

function XELevel AttachBindingScriptAsset ( pAssetPath  )

根据给定路径创建一个绑定脚本实例

参数
pAssetPathstring
返回
boolean

◆ DetachBindingScriptInstance()

function XELevel DetachBindingScriptInstance ( )

移除绑定脚本实例

返回
void

◆ GetActorValidName()

function XELevel GetActorValidName ( strActorType  )

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

参数
strActorTypestring
返回
string

◆ GetLevelName()

function XELevel GetLevelName ( )

获取关卡名称

返回
string

◆ GetOrder()

function XELevel GetOrder ( )

获取当前Level的序号

返回
number

◆ GetPatchGraphMgr()

function XELevel GetPatchGraphMgr ( )

获取蓝图管理器

返回
XEPatchGraphManager

◆ GetRenderOption()

function XELevel GetRenderOption ( )

获取图层的渲染选项

返回
number

◆ GetScriptContainerInstance()

function XELevel GetScriptContainerInstance ( )

获取绑定脚本实例指针

返回
XEScriptContainerInstance

◆ Init()

function XELevel Init ( )

初始化关卡

返回
void

◆ IsDefaultLevel()

function XELevel IsDefaultLevel ( )

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

返回
boolean

◆ IsPresent()

function XELevel IsPresent ( )

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

返回
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.

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

◆ Present()

function XELevel Present ( bSyncExclusingRenderObjectsToWorld  )

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

参数
bSyncExclusingRenderObjectsToWorldboolean 是否将互斥渲染对象同步更新到World中,如Camera,lights等。
返回
void

◆ PresentThisOnly()

function XELevel PresentThisOnly ( )

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

返回
void

◆ RayPickOne()

function XELevel RayPickOne ( HitResult  )

XELevel_RayPickOne00

参数
HitResultXEHitResult
返回
boolean

◆ Release()

function XELevel Release ( )

释放关卡

返回
void

◆ ReleasePatchManager()

function XELevel ReleasePatchManager ( )

释放所有的蓝图实例

返回
void

◆ Render()

function XELevel Render ( pViewport  )

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

参数
pViewportXEViewport
返回
void

◆ SetOrder()

function XELevel SetOrder ( nOrder  )

设置当前Level的序号,用于排序使用

参数
nOrdernumber
返回
void

◆ SetRenderOption()

function XELevel SetRenderOption ( ro  )

设置图层的渲染选项

参数
ronumber
返回
void

◆ Tick()

function XELevel Tick ( fDelSecond  )

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

参数
fDelSecondnumber
返回
void

◆ UnPresent()

function XELevel UnPresent ( )

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

返回
void

变量说明

◆ XELevel

XELevel = {}