Game Framework  2019.11.26
UIComponent类 参考

界面组件。 更多...

类 UIComponent 继承关系图:
GameFrameworkComponent GameFrameworkComponent

Public 成员函数

bool HasUIGroup (string uiGroupName)
 是否存在界面组。 更多...
 
IUIGroup GetUIGroup (string uiGroupName)
 获取界面组。 更多...
 
IUIGroup[] GetAllUIGroups ()
 获取所有界面组。 更多...
 
void GetAllUIGroups (List< IUIGroup > results)
 获取所有界面组。 更多...
 
bool AddUIGroup (string uiGroupName)
 增加界面组。 更多...
 
bool AddUIGroup (string uiGroupName, int depth)
 增加界面组。 更多...
 
bool HasUIForm (int serialId)
 是否存在界面。 更多...
 
bool HasUIForm (string uiFormAssetName)
 是否存在界面。 更多...
 
UIForm GetUIForm (int serialId)
 获取界面。 更多...
 
UIForm GetUIForm (string uiFormAssetName)
 获取界面。 更多...
 
UIForm[] GetUIForms (string uiFormAssetName)
 获取界面。 更多...
 
void GetUIForms (string uiFormAssetName, List< UIForm > results)
 获取界面。 更多...
 
UIForm[] GetAllLoadedUIForms ()
 获取所有已加载的界面。 更多...
 
void GetAllLoadedUIForms (List< UIForm > results)
 获取所有已加载的界面。 更多...
 
int[] GetAllLoadingUIFormSerialIds ()
 获取所有正在加载界面的序列编号。 更多...
 
void GetAllLoadingUIFormSerialIds (List< int > results)
 获取所有正在加载界面的序列编号。 更多...
 
bool IsLoadingUIForm (int serialId)
 是否正在加载界面。 更多...
 
bool IsLoadingUIForm (string uiFormAssetName)
 是否正在加载界面。 更多...
 
bool IsValidUIForm (UIForm uiForm)
 是否是合法的界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName)
 打开界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName, int priority)
 打开界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName, bool pauseCoveredUIForm)
 打开界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName, object userData)
 打开界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName, int priority, bool pauseCoveredUIForm)
 打开界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName, int priority, object userData)
 打开界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName, bool pauseCoveredUIForm, object userData)
 打开界面。 更多...
 
int OpenUIForm (string uiFormAssetName, string uiGroupName, int priority, bool pauseCoveredUIForm, object userData)
 打开界面。 更多...
 
void CloseUIForm (int serialId)
 关闭界面。 更多...
 
void CloseUIForm (int serialId, object userData)
 关闭界面。 更多...
 
void CloseUIForm (UIForm uiForm)
 关闭界面。 更多...
 
void CloseUIForm (UIForm uiForm, object userData)
 关闭界面。 更多...
 
void CloseAllLoadedUIForms ()
 关闭所有已加载的界面。 更多...
 
void CloseAllLoadedUIForms (object userData)
 关闭所有已加载的界面。 更多...
 
void CloseAllLoadingUIForms ()
 关闭所有正在加载的界面。 更多...
 
void RefocusUIForm (UIForm uiForm)
 激活界面。 更多...
 
void RefocusUIForm (UIForm uiForm, object userData)
 激活界面。 更多...
 
void SetUIFormInstanceLocked (UIForm uiForm, bool locked)
 设置界面是否被加锁。 更多...
 
void SetUIFormInstancePriority (UIForm uiForm, int priority)
 设置界面的优先级。 更多...
 

Protected 成员函数

override void Awake ()
 游戏框架组件初始化。 更多...
 

属性

int UIGroupCount [get]
 获取界面组数量。 更多...
 
float InstanceAutoReleaseInterval [get, set]
 获取或设置界面实例对象池自动释放可释放对象的间隔秒数。 更多...
 
int InstanceCapacity [get, set]
 获取或设置界面实例对象池的容量。 更多...
 
float InstanceExpireTime [get, set]
 获取或设置界面实例对象池对象过期秒数。 更多...
 
int InstancePriority [get, set]
 获取或设置界面实例对象池的优先级。 更多...
 

详细描述

界面组件。

成员函数说明

◆ AddUIGroup() [1/2]

bool AddUIGroup ( string  uiGroupName)

增加界面组。

参数
uiGroupName界面组名称。
返回
是否增加界面组成功。

◆ AddUIGroup() [2/2]

bool AddUIGroup ( string  uiGroupName,
int  depth 
)

增加界面组。

参数
uiGroupName界面组名称。
depth界面组深度。
返回
是否增加界面组成功。

◆ Awake()

override void Awake ( )
protectedvirtual

游戏框架组件初始化。

重载 GameFrameworkComponent .

◆ CloseAllLoadedUIForms() [1/2]

void CloseAllLoadedUIForms ( )

关闭所有已加载的界面。

◆ CloseAllLoadedUIForms() [2/2]

void CloseAllLoadedUIForms ( object  userData)

关闭所有已加载的界面。

参数
userData用户自定义数据。

◆ CloseAllLoadingUIForms()

void CloseAllLoadingUIForms ( )

关闭所有正在加载的界面。

◆ CloseUIForm() [1/4]

void CloseUIForm ( int  serialId)

关闭界面。

参数
serialId要关闭界面的序列编号。

◆ CloseUIForm() [2/4]

void CloseUIForm ( int  serialId,
object  userData 
)

关闭界面。

参数
serialId要关闭界面的序列编号。
userData用户自定义数据。

◆ CloseUIForm() [3/4]

void CloseUIForm ( UIForm  uiForm)

关闭界面。

参数
uiForm要关闭的界面。

◆ CloseUIForm() [4/4]

void CloseUIForm ( UIForm  uiForm,
object  userData 
)

关闭界面。

参数
uiForm要关闭的界面。
userData用户自定义数据。

◆ GetAllLoadedUIForms() [1/2]

UIForm [] GetAllLoadedUIForms ( )

获取所有已加载的界面。

返回
所有已加载的界面。

◆ GetAllLoadedUIForms() [2/2]

void GetAllLoadedUIForms ( List< UIForm results)

获取所有已加载的界面。

参数
results所有已加载的界面。

◆ GetAllLoadingUIFormSerialIds() [1/2]

int [] GetAllLoadingUIFormSerialIds ( )

获取所有正在加载界面的序列编号。

返回
所有正在加载界面的序列编号。

◆ GetAllLoadingUIFormSerialIds() [2/2]

void GetAllLoadingUIFormSerialIds ( List< int >  results)

获取所有正在加载界面的序列编号。

参数
results所有正在加载界面的序列编号。

◆ GetAllUIGroups() [1/2]

IUIGroup [] GetAllUIGroups ( )

获取所有界面组。

返回
所有界面组。

◆ GetAllUIGroups() [2/2]

void GetAllUIGroups ( List< IUIGroup results)

获取所有界面组。

参数
results所有界面组。

◆ GetUIForm() [1/2]

UIForm GetUIForm ( int  serialId)

获取界面。

参数
serialId界面序列编号。
返回
要获取的界面。

◆ GetUIForm() [2/2]

UIForm GetUIForm ( string  uiFormAssetName)

获取界面。

参数
uiFormAssetName界面资源名称。
返回
要获取的界面。

◆ GetUIForms() [1/2]

UIForm [] GetUIForms ( string  uiFormAssetName)

获取界面。

参数
uiFormAssetName界面资源名称。
返回
要获取的界面。

◆ GetUIForms() [2/2]

void GetUIForms ( string  uiFormAssetName,
List< UIForm results 
)

获取界面。

参数
uiFormAssetName界面资源名称。
results要获取的界面。

◆ GetUIGroup()

IUIGroup GetUIGroup ( string  uiGroupName)

获取界面组。

参数
uiGroupName界面组名称。
返回
要获取的界面组。

◆ HasUIForm() [1/2]

bool HasUIForm ( int  serialId)

是否存在界面。

参数
serialId界面序列编号。
返回
是否存在界面。

◆ HasUIForm() [2/2]

bool HasUIForm ( string  uiFormAssetName)

是否存在界面。

参数
uiFormAssetName界面资源名称。
返回
是否存在界面。

◆ HasUIGroup()

bool HasUIGroup ( string  uiGroupName)

是否存在界面组。

参数
uiGroupName界面组名称。
返回
是否存在界面组。

◆ IsLoadingUIForm() [1/2]

bool IsLoadingUIForm ( int  serialId)

是否正在加载界面。

参数
serialId界面序列编号。
返回
是否正在加载界面。

◆ IsLoadingUIForm() [2/2]

bool IsLoadingUIForm ( string  uiFormAssetName)

是否正在加载界面。

参数
uiFormAssetName界面资源名称。
返回
是否正在加载界面。

◆ IsValidUIForm()

bool IsValidUIForm ( UIForm  uiForm)

是否是合法的界面。

参数
uiForm界面。
返回
界面是否合法。

◆ OpenUIForm() [1/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
返回
界面的序列编号。

◆ OpenUIForm() [2/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName,
bool  pauseCoveredUIForm 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
pauseCoveredUIForm是否暂停被覆盖的界面。
返回
界面的序列编号。

◆ OpenUIForm() [3/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName,
bool  pauseCoveredUIForm,
object  userData 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
pauseCoveredUIForm是否暂停被覆盖的界面。
userData用户自定义数据。
返回
界面的序列编号。

◆ OpenUIForm() [4/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName,
int  priority 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
priority加载界面资源的优先级。
返回
界面的序列编号。

◆ OpenUIForm() [5/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName,
int  priority,
bool  pauseCoveredUIForm 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
priority加载界面资源的优先级。
pauseCoveredUIForm是否暂停被覆盖的界面。
返回
界面的序列编号。

◆ OpenUIForm() [6/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName,
int  priority,
bool  pauseCoveredUIForm,
object  userData 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
priority加载界面资源的优先级。
pauseCoveredUIForm是否暂停被覆盖的界面。
userData用户自定义数据。
返回
界面的序列编号。

◆ OpenUIForm() [7/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName,
int  priority,
object  userData 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
priority加载界面资源的优先级。
userData用户自定义数据。
返回
界面的序列编号。

◆ OpenUIForm() [8/8]

int OpenUIForm ( string  uiFormAssetName,
string  uiGroupName,
object  userData 
)

打开界面。

参数
uiFormAssetName界面资源名称。
uiGroupName界面组名称。
userData用户自定义数据。
返回
界面的序列编号。

◆ RefocusUIForm() [1/2]

void RefocusUIForm ( UIForm  uiForm)

激活界面。

参数
uiForm要激活的界面。

◆ RefocusUIForm() [2/2]

void RefocusUIForm ( UIForm  uiForm,
object  userData 
)

激活界面。

参数
uiForm要激活的界面。
userData用户自定义数据。

◆ SetUIFormInstanceLocked()

void SetUIFormInstanceLocked ( UIForm  uiForm,
bool  locked 
)

设置界面是否被加锁。

参数
uiForm要设置是否被加锁的界面。
locked界面是否被加锁。

◆ SetUIFormInstancePriority()

void SetUIFormInstancePriority ( UIForm  uiForm,
int  priority 
)

设置界面的优先级。

参数
uiForm要设置优先级的界面。
priority界面优先级。

属性说明

◆ InstanceAutoReleaseInterval

float InstanceAutoReleaseInterval
getset

获取或设置界面实例对象池自动释放可释放对象的间隔秒数。

◆ InstanceCapacity

int InstanceCapacity
getset

获取或设置界面实例对象池的容量。

◆ InstanceExpireTime

float InstanceExpireTime
getset

获取或设置界面实例对象池对象过期秒数。

◆ InstancePriority

int InstancePriority
getset

获取或设置界面实例对象池的优先级。

◆ UIGroupCount

int UIGroupCount
get

获取界面组数量。