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

Functions

function XUIGuidePageGroup new () end
 
function XUIGuidePageGroup Create (vGuidePage) end
 
function XUIGuidePageGroup Create () end
 
function XUIGuidePageGroup Init () end
 
function XUIGuidePageGroup SetAutoTouchEventEnabled () end
 
function XUIGuidePageGroup SetRemoveSelfWhenEnd (bRemove) end
 
function XUIGuidePageGroup GetRemoveSelfWhenEnd () end
 
function XUIGuidePageGroup PrevPage () end
 
function XUIGuidePageGroup NextPage () end
 
function XUIGuidePageGroup AppendGuidePage (pPage) end
 
function XUIGuidePageGroup InsertGuidePage (pPage, nIndex) end
 
function XUIGuidePageGroup RemoveGuidePage (nIndex) end
 
function XUIGuidePage Create (v2ScreenSize) end
 
function XUIGuidePage SetMaskSceneSize (v2ScreenSize) end
 
function XUIGuidePage GetMaskSceneSize () end
 
function XUIGuidePage SetTargetWidget (pWidget) end
 
function XUIGuidePage SetTargetWidget (pWidget, bTouchAllow) end
 
function XUIGuidePage GetHighLightWidget () end
 
function XUIGuidePage GetAlpha () end
 
function XUIGuidePage SetAlpha (fAlpha) end
 
function XUIGuidePage GetTouchMaskWidget () end
 
function XUIGuidePage GetVisibleMaskWidget () end
 

Variables

 XUIGuidePageGroup = {}
 

Function Documentation

◆ AppendGuidePage()

function XUIGuidePageGroup AppendGuidePage ( pPage  )

添加一页向导页。

Parameters
pPageXUIGuidePage 要添加的向导页。
Returns
void

◆ Create() [1/3]

function XUIGuidePageGroup Create ( vGuidePage  )

创建一个向导页组，向导页一般是以组为单位使用的。

Parameters
vGuidePageXUIGuidePage[] 为一个向导页数组。
Returns
XUIGuidePageGroup

◆ Create() [2/3]

function XUIGuidePageGroup Create ( )

创建一个空的向导页组。

Returns
XUIGuidePageGroup

创建一个空的向导页组。

Returns
XUIGuidePage

◆ Create() [3/3]

function XUIGuidePage Create ( v2ScreenSize  )

创建一个向导页组，向导页一般是以组为单位使用的。

Parameters
v2ScreenSizeXVECTOR2
Returns
XUIGuidePage

◆ GetAlpha()

function XUIGuidePage GetAlpha ( )

获取向导页将整个场景遮盖住的效果

Returns
number 返回遮盖效果值(0~1)0是不遮盖，1是遮盖成纯黑色。

◆ GetHighLightWidget()

function XUIGuidePage GetHighLightWidget ( )

XUIGuidePage_GetHighLightWidget00

Returns
XUIWidget

◆ GetMaskSceneSize()

function XUIGuidePage GetMaskSceneSize ( )

获取遮盖范围大小

Returns
XVECTOR2 返回遮盖范围大小

◆ GetRemoveSelfWhenEnd()

function XUIGuidePageGroup GetRemoveSelfWhenEnd ( )

获取是否自动移除自己。

Returns
boolean 是否自动移除自己。

◆ GetTouchMaskWidget()

function XUIGuidePage GetTouchMaskWidget ( )

XUIGuidePage_GetTouchMaskWidget00

Returns
XUIWidget

◆ GetVisibleMaskWidget()

function XUIGuidePage GetVisibleMaskWidget ( )

XUIGuidePage_GetVisibleMaskWidget00

Returns
XUIWidget

◆ Init()

function XUIGuidePageGroup Init ( )

初始化控件

Returns
boolean

◆ InsertGuidePage()

function XUIGuidePageGroup InsertGuidePage ( pPage  ,
nIndex   
)

插入一页向导页。

Parameters
pPageXUIGuidePage 要添加的向导页。
nIndexnumber 要插入的索引位置。
Returns
void

◆ new()

function XUIGuidePageGroup new ( )

XUIGuidePageGroup_new00

Returns
XUIGuidePageGroup

XUIGuidePage_new00

Returns
XUIGuidePage

◆ NextPage()

function XUIGuidePageGroup NextPage ( )

手动跳转到下一向导页

Returns
void

◆ PrevPage()

function XUIGuidePageGroup PrevPage ( )

手动跳转到上一向导页

Returns
void

◆ RemoveGuidePage()

function XUIGuidePageGroup RemoveGuidePage ( nIndex  )

移除一页向导页。

Parameters
nIndexnumber 要移除的向导页索引。
Returns
void

◆ SetAlpha()

function XUIGuidePage SetAlpha ( fAlpha  )

XUIGuidePage_SetAlpha00

Parameters
fAlphanumber
Returns
void

◆ SetAutoTouchEventEnabled()

function XUIGuidePageGroup SetAutoTouchEventEnabled ( )

设置为自动响应触摸事件，即调用后，触摸屏幕任意位置，则会切换到下一页向导页。

Returns
void

◆ SetMaskSceneSize()

function XUIGuidePage SetMaskSceneSize ( v2ScreenSize  )

XUIGuidePage_SetMaskSceneSize00

Parameters
v2ScreenSizeXVECTOR2
Returns
void

◆ SetRemoveSelfWhenEnd()

function XUIGuidePageGroup SetRemoveSelfWhenEnd ( bRemove  )

设置为当所有向导页播放完毕后，将自己从父节点中移除。

Parameters
bRemoveboolean
Returns
void

◆ SetTargetWidget() [1/2]

function XUIGuidePage SetTargetWidget ( pWidget  )

XUIGuidePage_SetTargetWidget00

Parameters
pWidgetXUIWidget
Returns
void

◆ SetTargetWidget() [2/2]

function XUIGuidePage SetTargetWidget ( pWidget  ,
bTouchAllow   
)

XUIGuidePage_SetTargetWidget01

Parameters
pWidgetXUIWidget
bTouchAllowboolean
Returns
void

Variable Documentation

◆ XUIGuidePageGroup

XUIGuidePageGroup = {}
Generated by   doxygen 1.8.15