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

Functions

function XELevel AddIgnoreLoadingActor (pActorName) end
 
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 ReleaseActor (pActor) end
 
function XELevel Tick (fDelSecond) end
 
function XELevel Render (pViewport) end
 
function XELevel SortActorInRenderOrder () end
 
function XELevel AddActorToRenderOrder (pActor) end
 
function XELevel RemoveActorFromRenderOrder (pActor) end
 
function XELevel MakeActorInRenderOrderSafe () end
 
function XELevel FindActor (strActorName) end
 
function XELevel CreateActor (strActorType) end
 
function XELevel CreateActor (strActorType, strActorName) end
 
function XELevel HasActor (pActor, bIgnoreDeleted) end
 
function XELevel GetActorCount (strActorType) end
 
function XELevel GetActorsOfType (strActorType, actorList) end
 
function XELevel GetActorsOfType (strActorType) end
 
function XELevel UpdateNameOfActor (strActorOldName, strActorNewName) end
 
function XELevel GetActorValidName (strActorType) end
 
function XELevel GetLevelName () end
 
function XELevel GetActorValidOrder () end
 
function XELevel GetAllActors () end
 
function XELevel GetActorFastMap () end
 
function XELevel IsDefaultLevel () end
 
function XELevel GetOwner () end
 
function XELevel RayPickOne (HitResult) end
 
function XELevel RayPickOne () end
 
function XEWorld Init () end
 
function XEWorld LoadScene (pRelativePath, bUseRelPathAsHome) end
 
function XEWorld DeleteActor (pActor) end
 
function XEWorld MergeActorHiddenStatus (pCurSelectActor) end
 
function XEWorld CreateLevel (strLevelName) end
 
function XEWorld AssignDefaultLevel () end
 
function XEWorld DeleteLevel (pLevel) end
 
function XEWorld ClearLevels () end
 
function XEWorld FindLevel (strLevelName) end
 
function XEWorld FindLevel (nLevelIndex) end
 
function XEWorld HasLevel (pLevel) end
 
function XEWorld GetLevelForActor (pActor) end
 
function XEWorld GetLevelCount () end
 
function XEWorld IsTickable () end
 
function XEWorld SetTickable (bEnable) end
 
function XEWorld IsTickPhysics () end
 
function XEWorld SetTickPhysicsable (bEnable) end
 
function XEWorld IsRenderPhysics () end
 
function XEWorld SetRenderPhysicsable (bEnable) end
 
function XEWorld ClearTickState () end
 
function XEWorld SetWorldMode (mode) end
 
function XEWorld GetWorldMode () end
 
function XEWorld SetWorldName (szName) end
 
function XEWorld GetWorldName () end
 
function XEWorld IsAssetRelativeToPackage () end
 
function XEWorld SetPreviewRenderMode (bSet) end
 
function XEWorld IsInPreviewRenderMode () end
 
function XEWorld GetScriptContainerInstance () end
 
function XEWorld GetSceneAssetPath () end
 
function XEWorld SetSceneAssetPath (pAssetPath) end
 
function XEWorld GetAssetPackage () end
 
function XEWorld SetAssetPackage (pPackagePath) end
 
function XEWorld SetOnActorTickCallback (func) end
 
function XEWorld SetOnActorRenderCallback (func) end
 
function XEWorld GetLevelValidName () end
 
function XEWorld AddTemporalObject (pDestroyer) end
 
function XEWorld RestoreActiveCamera (pViewport) end
 
function XEWorld GetOneActiveCamera () end
 
function XEWorld GetPhysicsSceneName () end
 
function XEWorld CreatePhysicsScene (szSceneName) end
 
function XEWorld GetPhysicsScene () end
 
function XEWorld ReleasePhysicsScene () end
 
function XEWorld CreateWorldProperty (pWorld) end
 
function XEWorld ReleaseWorldProperty () end
 
function XEWorld GetWorldParam () end
 
function XEWorld SetWorldPropertyModified (bIsModified) end
 
function XEWorld IsWorldPropertyModified () end
 
function XEWorld SetSceneType (eSceneType) end
 
function XEWorld GetSceneType () end
 
function XEWorld GetSceneVersionValue () end
 
function XEWorld GetSceneVersion () end
 
function XEWorld SetSceneVersion (strVersion) end
 
function XEWorld AttachBindingScriptAsset (pAssetPath) end
 
function XEWorld DetachBindingScriptInstance () end
 
function XEWorld RayPick (vScreenPosition, HitResult, pHitResultList, pRayCollisionChannel, pActorsExclude) end
 
function XEWorld RayPick (HitResult, pHitResultList, pRayCollisionChannel, pActorsExclude) end
 
function XEWorld GetWorldExtendParamList () end
 
function XEWorld AddWorldExtendParam (pExtendParam) end
 
function XEWorld RemoveWorldExtendParam (pExtendParam, bDeleteMemory) end
 
function XEWorld GetWorldExtendParam (nIndex) end
 
function XEWorld GetWorldExtendParam (strExtendParamType) end
 
function XEWorld CopySelectedActors (aActors, bIsChangeCopyName, bIsResetActorProperty) end
 
function XEWorld PasteSelectedActors () end
 
function XEWorld ReAttachToActor (pSourceActor, pParentActor, pBindUesrNode) end
 
function XEWorld GetAttachedViewport () end
 
function XEWorld CreateSubview (szSubViewName) end
 
function XEWorld GetSubview (szSubViewName) end
 
function XEWorld GetSubviewByAlias (szSubviewAlias) end
 
function XEWorld ApplySubviewParam (pSubview) end
 
function XEWorld SetSubviewBgTexture (pSubview, pTex, fLeftTexcoord, fTopTexcoord, fWidthTexcoord, fHeightTexcoord) end
 
function XEWorld RemoveSubview (pSubview) end
 
function XEWorld ReleaseSubview (pSubview) end
 
function XEWorld GetAllSubviews () end
 
function XEWorld GetAllSubviewsFromAllWorld () end
 

Variables

 WM_EDITTING = 0
 
 WM_RUNTIME = 0
 
 XELevel = {}
 

Function Documentation

◆ AddActorToRenderOrder()

function XEWorld AddActorToRenderOrder ( pActor  )

添加某个Actor到渲染队列

Parameters
pActorXEActor Actor指针
Returns
boolean 是否添加成功

◆ AddIgnoreLoadingActor()

function XELevel AddIgnoreLoadingActor ( pActorName  )

在为关卡加载场景之前,需要忽略序列化的某个Actor

Parameters
pActorNamestring
Returns
void

◆ AddTemporalObject()

function XEWorld AddTemporalObject ( pDestroyer  )

添加XETemporalObject,一般用于延迟销毁

Parameters
pDestroyerXEUtility::XETemporalObject XETemporalObject指针
Returns
void

◆ AddWorldExtendParam()

function XEWorld AddWorldExtendParam ( pExtendParam  )

添加新的世界扩展参数

Parameters
pExtendParamIXEWorldExtendParam
Returns
number

◆ ApplySubviewParam()

function XEWorld ApplySubviewParam ( pSubview  )

将当前世界中视口的灯光、相机(如果子视图指定了内部相机,则使用内部相机)设置到指定子视图

Parameters
pSubviewXESubview 子视图对象
Returns
boolean

◆ AssignDefaultLevel()

function XEWorld AssignDefaultLevel ( )

为世界分配默认关卡(关卡索引值为0),如果关卡不存在,则创建

Returns
XELevel 关卡对象

◆ AttachBindingScriptAsset()

function XEWorld AttachBindingScriptAsset ( pAssetPath  )

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

Parameters
pAssetPathstring
Returns
boolean

◆ ClearLevels()

function XEWorld ClearLevels ( )

清空关卡

Returns
void

◆ ClearTickState()

function XEWorld ClearTickState ( )

清除Tick状态(表示是否已经Tick)

Returns
void

◆ CopySelectedActors()

function XEWorld CopySelectedActors ( aActors  ,
bIsChangeCopyName  ,
bIsResetActorProperty   
)

当前所有关卡中, 拷贝选中的Actor

Parameters
aActorsXEActor[] 要拷贝的Actor列表
bIsChangeCopyNameboolean 是否改变Actor名称,默认为true
bIsResetActorPropertyboolean 是否重置Actor属性,默认为true
Returns
void

◆ CreateActor() [1/2]

function XEWorld CreateActor ( strActorType  )

创建指定类型的XEActor,并添加进当前所有关卡中

Parameters
strActorTypestring Actor类型名称
Returns
XEActor

◆ CreateActor() [2/2]

function XEWorld CreateActor ( strActorType  ,
strActorName   
)

创建指定类型和指定名称的XEActor,并添加进当前所有关卡中

Parameters
strActorTypestring Actor类型名称
strActorNamestring Actor名称
Returns
XEActor

◆ CreateLevel()

function XEWorld CreateLevel ( strLevelName  )

创建一个关卡(世界中关卡>1将会有额外的序列化操作)

Parameters
strLevelNamestring 关卡名称
Returns
XELevel 关卡对象

◆ CreatePhysicsScene()

function XEWorld CreatePhysicsScene ( szSceneName  )

根据给定的物理场景名称创建物理场景

Parameters
szSceneNamestring
Returns
void

◆ CreateSubview()

function XEWorld CreateSubview ( szSubViewName  )

创建一个subview, 如果不指定subviewname, 则自动创建一个,前缀为SubView_[$snowid]

Parameters
szSubViewNamestring
Returns
XESubview

◆ CreateWorldProperty()

function XEWorld CreateWorldProperty ( pWorld  )

给当前世界创建一个世界属性结构体指针,并初始化。对于世界属性结构体XEWorldParam,参见XEWorldParam.h中的介绍

Parameters
pWorldXEWorld
Returns
void

◆ DeleteActor()

function XEWorld DeleteActor ( pActor  )

功能同ReleaseActor

Parameters
pActorXEActor
Returns
void

◆ DeleteLevel()

function XEWorld DeleteLevel ( pLevel  )

从关卡队列中删除一个关卡

Parameters
pLevelXELevel 关卡对象
Returns
boolean 是否成功

◆ DetachBindingScriptInstance()

function XEWorld DetachBindingScriptInstance ( )

移除绑定脚本实例

Returns
void

◆ FindActor()

function XEWorld FindActor ( strActorName  )

XELevel_FindActor00

Parameters
strActorNamestring
Returns
XEActor

XEWorld_FindActor00

Parameters
strActorNamestring
Returns
XEActor

◆ FindLevel() [1/2]

function XEWorld FindLevel ( strLevelName  )

获取一个关卡

Parameters
strLevelNamestring 关卡名称
Returns
XELevel 关卡对象

◆ FindLevel() [2/2]

function XEWorld FindLevel ( nLevelIndex  )

获取一个关卡

Parameters
nLevelIndexnumber 关卡索引
Returns
XELevel 关卡对象

◆ GetActorCount()

function XEWorld GetActorCount ( strActorType  )

返回关卡中Actor的个数

Parameters
strActorTypestring
Returns
number

◆ GetActorFastMap()

function XEWorld GetActorFastMap ( )

获取关卡中的Actor map,保存了Actor的名称和指针

Returns
xhashtable_XString_and_XEActor_p_

◆ GetActorsOfType() [1/2]

function XEWorld GetActorsOfType ( strActorType  ,
actorList   
)

查找关卡中某种类型的Actor

Parameters
strActorTypestring 要查找的Actor类型
actorListXEActor[] [out]找到的对应类型的Actor列表
Returns
void

◆ GetActorsOfType() [2/2]

function XEWorld GetActorsOfType ( strActorType  )

查找当前所有关卡中某种类型的Actor

Parameters
strActorTypestring 要查找的Actor类型
Returns
XEActor[]
void

◆ GetActorValidName()

function XEWorld GetActorValidName ( strActorType  )

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

Parameters
strActorTypestring
Returns
string

◆ GetActorValidOrder()

function XEWorld GetActorValidOrder ( )

获取关卡一个有效的Actor排序索引

Returns
number

◆ GetAllActors()

function XEWorld GetAllActors ( )

获取关卡中的全部Actor

Returns
XEActor[]

◆ GetAllSubviews()

function XEWorld GetAllSubviews ( )

获取所有子视图

Returns
XESubview[]

◆ GetAllSubviewsFromAllWorld()

function XEWorld GetAllSubviewsFromAllWorld ( )

从所有世界中获取所有的subview

Returns
XESubview[]

◆ GetAssetPackage()

function XEWorld GetAssetPackage ( )

获取Asset路径

Returns
string

◆ GetAttachedViewport()

function XEWorld GetAttachedViewport ( )

获取当前所有关卡Attach的Viewport指针

Returns
XEViewport

◆ GetLevelCount()

function XEWorld GetLevelCount ( )

获取该世界中的关卡数量

Returns
number

◆ GetLevelForActor()

function XEWorld GetLevelForActor ( pActor  )

获取该世界中的Actor的所属关卡

Parameters
pActorXEActor 该世界中的Actor
Returns
XELevel 关卡对象

◆ GetLevelName()

function XELevel GetLevelName ( )

获取关卡名称

Returns
string

◆ GetLevelValidName()

function XEWorld GetLevelValidName ( )

获取当前所有关卡一个有效的关卡名称

Returns
string

◆ GetOneActiveCamera()

function XEWorld GetOneActiveCamera ( )

获取世界的一个激活相机

Returns
XBaseCamera

◆ GetOwner()

function XELevel GetOwner ( )

获取关卡所在世界

Returns
XEWorld

◆ GetPhysicsScene()

function XEWorld GetPhysicsScene ( )

获取物理场景指针

Returns
IXPhysicsScene

◆ GetPhysicsSceneName()

function XEWorld GetPhysicsSceneName ( )

获取物理场景名称

Returns
string

◆ GetSceneAssetPath()

function XEWorld GetSceneAssetPath ( )

获取xscene文件路径

Returns
string

◆ GetSceneType()

function XEWorld GetSceneType ( )

获取场景(或者说工程)类型(default/facetracker/mobile_ar/arads)

Returns
number

◆ GetSceneVersion()

function XEWorld GetSceneVersion ( )

获取工程版本号(XString)

Returns
string

◆ GetSceneVersionValue()

function XEWorld GetSceneVersionValue ( )

获取工程版本号(xint32)

Returns
number

◆ GetScriptContainerInstance()

function XEWorld GetScriptContainerInstance ( )

获取绑定脚本实例指针

Returns
XEScriptContainerInstance

◆ GetSubview()

function XEWorld GetSubview ( szSubViewName  )

根据名字找到subview

Parameters
szSubViewNamestring
Returns
XESubview

◆ GetSubviewByAlias()

function XEWorld GetSubviewByAlias ( szSubviewAlias  )

根据subview的别名获取subview

Parameters
szSubviewAliasstring
Returns
XESubview

◆ GetWorldExtendParam() [1/2]

function XEWorld GetWorldExtendParam ( nIndex  )

根据在扩展参数列表中的索引获取对应的扩展参数指针

Parameters
nIndexnumber
Returns
IXEWorldExtendParam

◆ GetWorldExtendParam() [2/2]

function XEWorld GetWorldExtendParam ( strExtendParamType  )

根据扩展参数的类型获取对应的扩展参数指针

Parameters
strExtendParamTypestring
Returns
IXEWorldExtendParam

◆ GetWorldExtendParamList()

function XEWorld GetWorldExtendParamList ( )

获取当前世界的扩展参数列表

Returns
IXEWorldExtendParam[]

◆ GetWorldMode()

function XEWorld GetWorldMode ( )

获取当前世界模式

Returns
number

◆ GetWorldName()

function XEWorld GetWorldName ( )

获取当前世界名称

Returns
string

◆ GetWorldParam()

function XEWorld GetWorldParam ( )

获取当前世界的世界属性结构体指针

Returns
XEWorldParam

◆ HasActor()

function XEWorld HasActor ( pActor  ,
bIgnoreDeleted   
)

判断关卡中是否存在某个Actor 当为true时,表示查找时如果找到了该Actor,不论它是否被标记为删除,都返回true; 当为false时,表示即使查找到了该Actor,但是它被标记为删除,那么返回false。

Parameters
pActorXEActor 判断的Actor指针
bIgnoreDeletedboolean 是否忽略Actor被删除的标记,默认为true。
Returns
boolean 是否找到

◆ HasLevel()

function XEWorld HasLevel ( pLevel  )

是否存在指定一个关卡

Parameters
pLevelXELevel
Returns
boolean

◆ Init()

function XEWorld Init ( )

函数用来初始化当前世界的世界属性

Returns
void

◆ IsAssetRelativeToPackage()

function XEWorld IsAssetRelativeToPackage ( )

在world里加载的资源是否会自动拼接xscene文件所在路径为物理路径

Returns
boolean

◆ IsDefaultLevel()

function XELevel IsDefaultLevel ( )

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

Returns
boolean

◆ IsInPreviewRenderMode()

function XEWorld IsInPreviewRenderMode ( )

判断是否是预览模式

Returns
boolean

◆ IsPresent()

function XELevel IsPresent ( )

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

Returns
boolean 是否可表示

◆ IsRenderPhysics()

function XEWorld IsRenderPhysics ( )

判断物理是否渲染

Returns
boolean

◆ IsTickable()

function XEWorld IsTickable ( )

判断是否可以Tick

Returns
boolean

◆ IsTickPhysics()

function XEWorld IsTickPhysics ( )

判断物理是否Tick

Returns
boolean

◆ IsWorldPropertyModified()

function XEWorld IsWorldPropertyModified ( )

判断世界属性是否有改变

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 成功与否

◆ LoadScene()

function XEWorld LoadScene ( pRelativePath  ,
bUseRelPathAsHome   
)

为默认关卡加载场景文件和创建物理场景对象。 XECoreSDK指定的场景文件是.xscene 格式的文件,其内部实现是执行反序列化函数Deserialize.

Parameters
pRelativePathstring 代表场景文件的相对路径,此处的相对路径是指xscene文件相对于工程文件夹的路径。
bUseRelPathAsHomeboolean 默认为true,如果为true,在world里加载的资源会自动拼接上这个xscene文件所在的路径,作为物理路径;否则不会拼接。
Returns
boolean

◆ MakeActorInRenderOrderSafe()

function XEWorld MakeActorInRenderOrderSafe ( )

当前所有关卡中, 确保渲染队列中的Actor都是有效的,把无效的都删除掉

Returns
void

◆ MergeActorHiddenStatus()

function XEWorld MergeActorHiddenStatus ( pCurSelectActor  )

从当前所有关卡中,合并显隐状态值

Parameters
pCurSelectActorXEActor 设置的Actor指针
Returns
void

◆ PasteSelectedActors()

function XEWorld PasteSelectedActors ( )

当前所有关卡中, 黏贴选中的Actors

Returns
XEActor[] 返回黏贴的Actors指针列表

◆ Present()

function XELevel Present ( )

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

Returns
void

◆ PresentPhysicsForActors()

function XELevel PresentPhysicsForActors ( fDelSecond  )

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

Parameters
fDelSecondnumber
Returns
void

◆ PresentThisOnly()

function XELevel PresentThisOnly ( )

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

Returns
void

◆ RayPick() [1/2]

function XEWorld RayPick ( vScreenPosition  ,
HitResult  ,
pHitResultList  ,
pRayCollisionChannel  ,
pActorsExclude   
)

@manual 当前可表示关卡中,射线拾取 XEWorld_RayPick_manual

Parameters
vScreenPositionXVECTOR2
HitResultXEHitResult
pHitResultListXEHitResult[] 拾取结果列表.
pRayCollisionChannelnumber[] 过滤的碰撞通道,表示这些通道不进行拾取测试.
pActorsExcludeXEActor[] 过滤的Actor数组.
Returns
boolean 是否拾取成功

◆ RayPick() [2/2]

function XEWorld RayPick ( HitResult  ,
pHitResultList  ,
pRayCollisionChannel  ,
pActorsExclude   
)

@manual 当前可表示关卡中,射线拾取 XEWorld_RayPick_manual

Parameters
HitResultXEHitResult
pHitResultListXEHitResult[] 拾取结果列表.
pRayCollisionChannelnumber[] 过滤的碰撞通道,表示这些通道不进行拾取测试.
pActorsExcludeXEActor[] 过滤的Actor数组.
Returns
boolean 是否拾取成功

◆ RayPickOne() [1/2]

function XELevel RayPickOne ( HitResult  )

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

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

◆ RayPickOne() [2/2]

function XELevel RayPickOne ( )

XELevel_RayPickOne01

Returns
XEHitResult
boolean

◆ ReAttachToActor()

function XEWorld ReAttachToActor ( pSourceActor  ,
pParentActor  ,
pBindUesrNode   
)

当前所有关卡中, 重新绑定Actor到父节点Actor上

Parameters
pSourceActorXEActor 子Actor指针
pParentActorXEActor 父Actor指针
pBindUesrNodeuserdata 绑定的UserNode节点信息
Returns
void

◆ Release()

function XELevel Release ( )

释放关卡

Returns
void

◆ ReleaseActor()

function XEWorld ReleaseActor ( pActor  )

释放一个Actor

Parameters
pActorXEActor
Returns
void

◆ ReleasePhysicsScene()

function XEWorld ReleasePhysicsScene ( )

释放物理场景

Returns
void

◆ ReleaseSubview()

function XEWorld ReleaseSubview ( pSubview  )

释放subview, 如果不指定 pSubview,则重置所有

Parameters
pSubviewXESubview
Returns
void

◆ ReleaseWorldProperty()

function XEWorld ReleaseWorldProperty ( )

释放当前世界中的世界属性结构体指针

Returns
void

◆ RemoveActorFromRenderOrder()

function XEWorld RemoveActorFromRenderOrder ( pActor  )

当前所有关卡中从渲染队列中去掉某个Actor

Parameters
pActorXEActor Actor指针
Returns
boolean 是否删除成功

◆ RemoveSubview()

function XEWorld RemoveSubview ( pSubview  )

删除subview,如果不指定 pSubview,则删除所有

Parameters
pSubviewXESubview
Returns
boolean

◆ RemoveWorldExtendParam()

function XEWorld RemoveWorldExtendParam ( pExtendParam  ,
bDeleteMemory   
)

移除世界扩展参数

Parameters
pExtendParamIXEWorldExtendParam
bDeleteMemoryboolean
Returns
boolean

◆ Render()

function XELevel Render ( pViewport  )

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

Parameters
pViewportXEViewport
Returns
void

◆ RestoreActiveCamera()

function XEWorld RestoreActiveCamera ( pViewport  )

当前所有关卡中, 恢复指定Viewport对应的激活相机

Parameters
pViewportXEViewport 当前世界绑定的视口指针.
Returns
boolean

◆ SetAssetPackage()

function XEWorld SetAssetPackage ( pPackagePath  )

设置Asset路径

Parameters
pPackagePathstring
Returns
void

◆ SetOnActorRenderCallback()

function XEWorld SetOnActorRenderCallback ( func  )

设置Actor Render回调函数,如果设置了此回调函数,在Render中对每个未被标记为删除的Actor,执行此回调函数

Parameters
funcstd::function<void(XEActor*, XEViewport*)>
Returns
void

◆ SetOnActorTickCallback()

function XEWorld SetOnActorTickCallback ( func  )

设置Actor Tick回调函数,如果设置了此回调函数,在Tick中对每个未被标记为删除的Actor,执行此回调函数

Parameters
funcstd::function<void(XEActor*, xfloat32)>
Returns
void

◆ SetPreviewRenderMode()

function XEWorld SetPreviewRenderMode ( bSet  )

设置是否是预览模式

Parameters
bSetboolean
Returns
void

◆ SetRenderPhysicsable()

function XEWorld SetRenderPhysicsable ( bEnable  )

设置物理是否渲染

Parameters
bEnableboolean
Returns
void

◆ SetSceneAssetPath()

function XEWorld SetSceneAssetPath ( pAssetPath  )

设置xscene文件路径

Parameters
pAssetPathstring
Returns
void

◆ SetSceneType()

function XEWorld SetSceneType ( eSceneType  )

设置场景(工程)类型,(default/facetracker/mobile_ar/arads)

Parameters
eSceneTypenumber
Returns
void

◆ SetSceneVersion()

function XEWorld SetSceneVersion ( strVersion  )

设置工程版本号(XString)

Parameters
strVersionstring
Returns
void

◆ SetSubviewBgTexture()

function XEWorld SetSubviewBgTexture ( pSubview  ,
pTex  ,
fLeftTexcoord  ,
fTopTexcoord  ,
fWidthTexcoord  ,
fHeightTexcoord   
)

设置子视图的渲染背景,开启自定义背景时,引擎默认背景将不再渲染到此子视图中

Parameters
pSubviewXESubview 子视图对象
pTexIXTexture2D
fLeftTexcoordnumber 纹理空间内左坐标[0,1]
fTopTexcoordnumber 纹理空间内顶坐标[0,1]
fWidthTexcoordnumber 纹理空间内宽[0,1]
fHeightTexcoordnumber 纹理空间内高[0,1]
Returns
boolean

◆ SetTickable()

function XEWorld SetTickable ( bEnable  )

设置是否可以Tick

Parameters
bEnableboolean
Returns
void

◆ SetTickPhysicsable()

function XEWorld SetTickPhysicsable ( bEnable  )

设置物理是否Tick

Parameters
bEnableboolean
Returns
void

◆ SetWorldMode()

function XEWorld SetWorldMode ( mode  )

设置当前世界模式

Parameters
modenumber
Returns
void

◆ SetWorldName()

function XEWorld SetWorldName ( szName  )

设置当前世界名称

Parameters
szNamestring
Returns
void

◆ SetWorldPropertyModified()

function XEWorld SetWorldPropertyModified ( bIsModified  )

设置世界属性是否有改变

Parameters
bIsModifiedboolean
Returns
void

◆ SortActorInRenderOrder()

function XELevel SortActorInRenderOrder ( )

XELevel_SortActorInRenderOrder00

Returns
void

◆ Tick()

function XEWorld Tick ( fDelSecond  )

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

Parameters
fDelSecondnumber
Returns
void

◆ UnPresent()

function XELevel UnPresent ( )

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

Returns
void

◆ UpdateNameOfActor()

function XEWorld UpdateNameOfActor ( strActorOldName  ,
strActorNewName   
)

把名为strActorOldName的Actor改名为strActorNewName

Parameters
strActorOldNamestring
strActorNewNamestring
Returns
XEActor

Variable Documentation

◆ WM_EDITTING

WM_EDITTING = 0

◆ WM_RUNTIME

WM_RUNTIME = 0

◆ XELevel

XELevel = {}