Open Game Engine 2D API
 全部 函数 变量
函数
Group

函数

int OGE_FindGroupSpr (int iGroupId, string sSprName)
 根据名称在群组中找出指定的精灵
int OGE_GetFreeSprWithType (int iSprGroupId, int iSprType)
 从群组中取得一个指定类型的自由精灵
int OGE_GetFreeSprWithClassTag (int iSprGroupId, int iSprClassTag)
 从群组中取得一个带有指定类标签的自由精灵
int OGE_GetFreeSprWithTag (int iSprGroupId, int iSprTag)
 从群组中取得一个带有指定标签的自由精灵
int OGE_GetGroupSprCount (int iSprGroupId)
 取得群组所有精灵的总数
int OGE_GetGroupSprByIndex (int iGroupId, int iIndex)
 根据序号取得群组中的某一精灵
int OGE_GetGroupSpr (int iGroupId, int idx)
 根据代号从群组中取得一个精灵
int OGE_GetGroupCount ()
 取得游戏中所有群组的总数
int OGE_GetGroupByIndex (int iIndex)
 根据序号取得一个群组
int OGE_GetSprForGroup (int iGroupId, string sSprName, string sClassName)
 用指定的模板来创建一个精灵,并加入到群组中
int OGE_RemoveSprFromGroup (int iGroupId, int iSprId)
 从群组中移除一个精灵
void OGE_RemoveGroup (string sName)
 移除一个群组
int OGE_GetGroup (string sGroupName)
 根据名称取得群组
int OGE_GetGroupByCode (int iCode)
 根据代号取得群组
string OGE_GetGroupName (int iSprGroupId)
 取得群组的名称
void OGE_OpenGroup (int iSprGroupId)
 把群组中的所有精灵加入到当前的场景中
void OGE_CloseGroup (int iSprGroupId)
 把群组中所有的精灵从当前的场景中移走
int OGE_GroupGenSpr (int iSprGroupId, string sTempletSprName, int iCount)
 根据某一精灵模板在群组中生成若干精灵
int OGE_GetRootSprFromGroup (int iSprGroupId)
 取得群组中的首精灵
int OGE_GetFreeSprFromGroup (int iSprGroupId)
 从群组中取得一个自由的(不处于忙碌状态下的)精灵

函数文档

void OGE_CloseGroup ( int  iSprGroupId)

把群组中所有的精灵从当前的场景中移走

参数:
[in]iSprGroupId群组的ID
int OGE_FindGroupSpr ( int  iGroupId,
string  sSprName 
)

根据名称在群组中找出指定的精灵

参数:
[in]iGroupId群组的ID
[in]sSprName精灵的名称
返回:
精灵的ID
int OGE_GetFreeSprFromGroup ( int  iSprGroupId)

从群组中取得一个自由的(不处于忙碌状态下的)精灵

参数:
[in]iSprGroupId群组的ID
返回:
自由精灵的ID
int OGE_GetFreeSprWithClassTag ( int  iSprGroupId,
int  iSprClassTag 
)

从群组中取得一个带有指定类标签的自由精灵

参数:
[in]iSprGroupId群组的ID
[in]iSprClassTag类标签
返回:
自由精灵的ID
int OGE_GetFreeSprWithTag ( int  iSprGroupId,
int  iSprTag 
)

从群组中取得一个带有指定标签的自由精灵

参数:
[in]iSprGroupId群组的ID
[in]iSprTag标签(对象标签)
返回:
自由精灵的ID
int OGE_GetFreeSprWithType ( int  iSprGroupId,
int  iSprType 
)

从群组中取得一个指定类型的自由精灵

参数:
[in]iSprGroupId群组的ID
[in]iSprType精灵的类型
返回:
自由精灵的ID
int OGE_GetGroup ( string  sGroupName)

根据名称取得群组

参数:
[in]sGroupName群组的名称
返回:
群组的ID
int OGE_GetGroupByCode ( int  iCode)

根据代号取得群组

参数:
[in]iCode群组的代号
返回:
群组的ID
int OGE_GetGroupByIndex ( int  iIndex)

根据序号取得一个群组

参数:
[in]iIndex群组的序号
返回:
群组的ID

取得游戏中所有群组的总数

返回:
全部群组的总数
string OGE_GetGroupName ( int  iSprGroupId)

取得群组的名称

参数:
[in]iSprGroupId群组的ID
返回:
群组的名称
int OGE_GetGroupSpr ( int  iGroupId,
int  idx 
)

根据代号从群组中取得一个精灵

参数:
[in]iGroupId群组的ID
[in]idx精灵在群组中的代号
返回:
精灵的ID
int OGE_GetGroupSprByIndex ( int  iGroupId,
int  iIndex 
)

根据序号取得群组中的某一精灵

参数:
[in]iGroupId群组的ID
[in]iIndex精灵在群组中的序号
返回:
精灵的ID
int OGE_GetGroupSprCount ( int  iSprGroupId)

取得群组所有精灵的总数

参数:
[in]iSprGroupId群组的ID
返回:
群组中精灵的总数
int OGE_GetRootSprFromGroup ( int  iSprGroupId)

取得群组中的首精灵

参数:
[in]iSprGroupId群组的精灵
返回:
首精灵的ID
int OGE_GetSprForGroup ( int  iGroupId,
string  sSprName,
string  sClassName 
)

用指定的模板来创建一个精灵,并加入到群组中

参数:
[in]iGroupId群组的ID
[in]sSprName精灵的名称
[in]sClassName模板的名称
返回:
精灵的ID
int OGE_GroupGenSpr ( int  iSprGroupId,
string  sTempletSprName,
int  iCount 
)

根据某一精灵模板在群组中生成若干精灵

参数:
[in]iSprGroupId群组的ID
[in]sTempletSprName模板精灵的名称
[in]iCount生成多少个精灵
返回:
群组中所有精灵的总数
void OGE_OpenGroup ( int  iSprGroupId)

把群组中的所有精灵加入到当前的场景中

参数:
[in]iSprGroupId群组的ID
void OGE_RemoveGroup ( string  sName)

移除一个群组

参数:
[in]sName群组的名称
int OGE_RemoveSprFromGroup ( int  iGroupId,
int  iSprId 
)

从群组中移除一个精灵

参数:
[in]iGroupId群组的ID
[in]iSprId精灵的ID
返回:
如果成功则返回一个非负数