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

函数

void OGE_FreezeSprites (bool bValue)
 冻结或重新激活当前场景中的NPC精灵和玩家精灵
int OGE_SetSceneMap (int iSceneId, string sNewMap, int iNewLeft, int iNewTop)
 设置场景地图
int OGE_FindSceneSpr (int iSceneId, string sSprName)
 通过名称在场景中找出指定的精灵
int OGE_GetFocusSpr ()
 取得当前场景中的获得焦点的精灵
int OGE_GetModalSpr ()
 取得当前场景中的模态精灵
void OGE_SetFocusSpr (int iSprId)
 设置当前场景中获得焦点的精灵
void OGE_SetModalSpr (int iSprId)
 设置当前场景中的模态精灵
int OGE_GetMouseSpr ()
 取得当前场景中的鼠标精灵
void OGE_SetMouseSpr (int iSprId)
 设置当前场景的鼠标精灵
int OGE_GetFirstSpr ()
 取得当前场景中的首精灵
void OGE_SetFirstSpr (int iSprId)
 设置当前场景中的首精灵
int OGE_GetLastSpr ()
 取得当前场景中的末精灵
void OGE_SetLastSpr (int iSprId)
 设置当前场景中的末精灵
int OGE_GetProxySpr ()
 取得当前场景中的代理精灵
void OGE_SetProxySpr (int iSprId)
 设置当前场景的代理精灵
int OGE_GetTopZ ()
 取得当前场景中最大的Z轴坐标值
int OGE_BringSprToTop (int iSprId)
 把精灵提到当前场景的最顶层
int OGE_GetSceneSpr (int idx)
 根据序号取得当前场景中的指定精灵
int OGE_GetDefaultPlayerSpr ()
 取得当前场景中的默认玩家精灵
void OGE_SetDefaultPlayerSpr (int iSprId)
 设置当前场景的默认玩家精灵
int OGE_GetSceneLightMap (int iSceneId)
 取得场景的光图
int OGE_SetSceneLightMap (int iSceneId, int iImageId, int iLightMode)
 设置场景的光图
bool OGE_OpenSceneTimer (int iInterval)
 启动当前场景自带的计时器
void OGE_CloseSceneTimer ()
 关闭当前场景自带的计时器
int OGE_GetSceneTimerInterval ()
 取得当前场景自带的计时器的计时间隔
bool OGE_IsSceneTimerWaiting ()
 检查当前场景自带的计时器是否正在计时
int OGE_GetScenePlot ()
 取得当前场景的剧情精灵的ID
int OGE_GetSceneCustomData (int iSceneId)
 取得场景的自定义数据
void OGE_SetSceneCustomData (int iSceneId, int iGameDataId, bool bOwnIt)
 设置场景的自定义数据
int OGE_SetSceneBgMusic (int iSceneId, string sMusicName)
 设置当前场景的背景音乐
int OGE_PlayBgMusic (int iLoopTimes)
 播放背景音乐
int OGE_GetSceneSprCount (int iSceneId, int iState)
 取得场景中所有在指定状态下的精灵的总数
int OGE_GetSceneSprByIndex (int iSceneId, int iIndex, int iState)
 根据序号取得场景中在指定状态下的某一精灵
int OGE_GetSceneCount ()
 取得所有场景的总数
int OGE_GetSceneByIndex (int iIndex)
 根据序号取得场景
int OGE_GetSprForScene (int iSceneId, string sSprName, string sClassName)
 用指定的模板来创建一个精灵,并加入到场景中
int OGE_RemoveSprFromScene (int iSceneId, int iSprId)
 从场景中移除一个精灵
void OGE_RemoveScene (string sName)
 移除一个场景
int OGE_GetScene ()
 取得当前场景
int OGE_GetActiveScene ()
 取得当前活动的场景
int OGE_GetLastActiveScene ()
 取得上一个活动的场景
int OGE_GetNextActiveScene ()
 取得下一个活动的场景
int OGE_GetSceneByName (string sSceneName)
 根据名称取得场景
int OGE_FindScene (string sSceneName)
 根据名称找出场景
string OGE_GetSceneName (int iSceneId)
 取得场景的名称
string OGE_GetSceneChapter (int iSceneId)
 取得场景所属的章节的名称
void OGE_SetSceneChapter (int iSceneId, string sChapterName)
 给场景设置章节名称
string OGE_GetSceneTag (int iSceneId)
 取得场景的标签名称
void OGE_SetSceneTag (int iSceneId, string sTagName)
 给场景设置标签名称
int OGE_GetSceneGameData (int iSceneId)
 取得场景自带的数据对象
string OGE_GetSceneBgMusic (int iSceneId)
 取得场景的背景音乐名称
int OGE_GetSceneTime ()
 取得场景从运行到现在所经过的时间
int OGE_CallScene (string sSceneName)
 跳转到指定名称的场景
int OGE_SetSceneFadeIn (int iSceneId, int iType, int iSpeed)
 设置场景淡入动作
int OGE_SetSceneFadeOut (int iSceneId, int iType, int iSpeed)
 设置场景淡出的动作
int OGE_SetSceneFadeMask (int iSceneId, int iImageId)
 设置场景过渡效果图

函数文档

int OGE_BringSprToTop ( int  iSprId)

把精灵提到当前场景的最顶层

参数:
[in]iSprId精灵的ID
返回:
精灵的Z轴坐标值
int OGE_CallScene ( string  sSceneName)

跳转到指定名称的场景

参数:
[in]sSceneName要跳转到的场景的名称
返回:
如果成功则返回一个非负数
int OGE_FindScene ( string  sSceneName)

根据名称找出场景

参数:
[in]sSceneName场景的名称
返回:
场景的ID
int OGE_FindSceneSpr ( int  iSceneId,
string  sSprName 
)

通过名称在场景中找出指定的精灵

参数:
[in]iSceneId场景的ID
[in]sSprName精灵的名称
返回:
精灵的ID
void OGE_FreezeSprites ( bool  bValue)

冻结或重新激活当前场景中的NPC精灵和玩家精灵

参数:
[in]bValue为真则冻结精灵,否则就重新激活他们

取得当前活动的场景

返回:
当前活动的场景的ID

取得当前场景中的默认玩家精灵

返回:
精灵的ID
int OGE_GetFirstSpr ( )

取得当前场景中的首精灵

返回:
首精灵的ID
int OGE_GetFocusSpr ( )

取得当前场景中的获得焦点的精灵

返回:
精灵的ID

取得上一个活动的场景

返回:
上一个活动的场景的ID
int OGE_GetLastSpr ( )

取得当前场景中的末精灵

返回:
末精灵的ID
int OGE_GetModalSpr ( )

取得当前场景中的模态精灵

返回:
精灵的ID
int OGE_GetMouseSpr ( )

取得当前场景中的鼠标精灵

返回:
鼠标精灵的ID

取得下一个活动的场景

返回:
下一个活动的场景的ID
int OGE_GetProxySpr ( )

取得当前场景中的代理精灵

返回:
代理精灵的ID
int OGE_GetScene ( )

取得当前场景

返回:
当前场景的ID
string OGE_GetSceneBgMusic ( int  iSceneId)

取得场景的背景音乐名称

参数:
[in]iSceneId场景的ID
返回:
背景音乐的名称
int OGE_GetSceneByIndex ( int  iIndex)

根据序号取得场景

参数:
[in]iIndex场景的序号
返回:
场景的ID
int OGE_GetSceneByName ( string  sSceneName)

根据名称取得场景

参数:
[in]sSceneName场景的名称
返回:
场景的ID
string OGE_GetSceneChapter ( int  iSceneId)

取得场景所属的章节的名称

参数:
[in]iSceneId场景的ID
返回:
场景所属的章节的名称

取得所有场景的总数

返回:
全部场景的总数
int OGE_GetSceneCustomData ( int  iSceneId)

取得场景的自定义数据

参数:
[in]iSceneId场景的ID
返回:
数据的ID
int OGE_GetSceneGameData ( int  iSceneId)

取得场景自带的数据对象

参数:
[in]iSceneId场景的ID
返回:
数据的ID
int OGE_GetSceneLightMap ( int  iSceneId)

取得场景的光图

参数:
[in]iSceneId场景的ID
返回:
光图的图像ID
string OGE_GetSceneName ( int  iSceneId)

取得场景的名称

参数:
[in]iSceneId场景的ID
返回:
场景的名称

取得当前场景的剧情精灵的ID

返回:
当前场景的剧情精灵的ID
int OGE_GetSceneSpr ( int  idx)

根据序号取得当前场景中的指定精灵

参数:
[in]idx精灵在当前场景中的序号
返回:
精灵的ID
int OGE_GetSceneSprByIndex ( int  iSceneId,
int  iIndex,
int  iState 
)

根据序号取得场景中在指定状态下的某一精灵

参数:
[in]iSceneId场景的ID
[in]iIndex在某一状态下的精灵在场景中的序号
[in]iState某一状态
返回:
精灵的ID
int OGE_GetSceneSprCount ( int  iSceneId,
int  iState 
)

取得场景中所有在指定状态下的精灵的总数

参数:
[in]iSceneId场景的ID
[in]iState精灵的状态
返回:
精灵的总数
string OGE_GetSceneTag ( int  iSceneId)

取得场景的标签名称

参数:
[in]iSceneId场景的ID
返回:
场景的标签名称

取得场景从运行到现在所经过的时间

返回:
场景运行到现在所经过的时间(毫秒数)

取得当前场景自带的计时器的计时间隔

返回:
计时器的计时间隔
int OGE_GetSprForScene ( int  iSceneId,
string  sSprName,
string  sClassName 
)

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

参数:
[in]iSceneId场景的ID
[in]sSprName精灵的名称
[in]sClassName模板的名称
返回:
精灵的ID
int OGE_GetTopZ ( )

取得当前场景中最大的Z轴坐标值

返回:
最大的Z轴坐标值

检查当前场景自带的计时器是否正在计时

返回:
如果计时器正在计时则返回真,否则返回假
bool OGE_OpenSceneTimer ( int  iInterval)

启动当前场景自带的计时器

参数:
[in]iInterval计时器的计时间隔
返回:
如果成功则返回真
int OGE_PlayBgMusic ( int  iLoopTimes)

播放背景音乐

参数:
[in]iLoopTimes播放的次数
返回:
如果成功则返回一个非负数
void OGE_RemoveScene ( string  sName)

移除一个场景

参数:
[in]sName场景的名称
int OGE_RemoveSprFromScene ( int  iSceneId,
int  iSprId 
)

从场景中移除一个精灵

参数:
[in]iSceneId场景的ID
[in]iSprId精灵的ID
返回:
如果成功则返回一个非负数
void OGE_SetDefaultPlayerSpr ( int  iSprId)

设置当前场景的默认玩家精灵

参数:
[in]iSprId精灵的ID
void OGE_SetFirstSpr ( int  iSprId)

设置当前场景中的首精灵

参数:
[in]iSprId首精灵的ID
void OGE_SetFocusSpr ( int  iSprId)

设置当前场景中获得焦点的精灵

参数:
[in]iSprId获得焦点的精灵的ID
void OGE_SetLastSpr ( int  iSprId)

设置当前场景中的末精灵

参数:
[in]iSprId末精灵的ID
void OGE_SetModalSpr ( int  iSprId)

设置当前场景中的模态精灵

参数:
[in]iSprId模态精灵的ID
void OGE_SetMouseSpr ( int  iSprId)

设置当前场景的鼠标精灵

参数:
[in]iSprId鼠标精灵的ID
void OGE_SetProxySpr ( int  iSprId)

设置当前场景的代理精灵

参数:
[in]iSprId代理精灵的ID
int OGE_SetSceneBgMusic ( int  iSceneId,
string  sMusicName 
)

设置当前场景的背景音乐

参数:
[in]iSceneId场景的ID
[in]sMusicName音乐的名称
返回:
如果成功则返回一个非负数
void OGE_SetSceneChapter ( int  iSceneId,
string  sChapterName 
)

给场景设置章节名称

参数:
[in]iSceneId场景的ID
[in]sChapterName章节的名称
void OGE_SetSceneCustomData ( int  iSceneId,
int  iGameDataId,
bool  bOwnIt 
)

设置场景的自定义数据

参数:
[in]iSceneId场景的ID
[in]iGameDataId数据的ID
[in]bOwnIt是否让场景拥有该数据
int OGE_SetSceneFadeIn ( int  iSceneId,
int  iType,
int  iSpeed 
)

设置场景淡入动作

参数:
[in]iSceneId场景的ID
[in]iType淡入效果的类型
[in]iSpeed淡入的速度
返回:
如果成功则返回一个非负数
int OGE_SetSceneFadeMask ( int  iSceneId,
int  iImageId 
)

设置场景过渡效果图

参数:
[in]iSceneId场景的ID
[in]iImageId过渡效果图的ID
返回:
如果成功则返回一个非负数
int OGE_SetSceneFadeOut ( int  iSceneId,
int  iType,
int  iSpeed 
)

设置场景淡出的动作

参数:
[in]iSceneId场景的ID
[in]iType淡出效果的类型
[in]iSpeed淡出的速度
返回:
如果成功则返回一个非负数
int OGE_SetSceneLightMap ( int  iSceneId,
int  iImageId,
int  iLightMode 
)

设置场景的光图

参数:
[in]iSceneId场景的ID
[in]iImageId光图的图像ID
[in]iLightMode光照模式
返回:
光图的图像ID
int OGE_SetSceneMap ( int  iSceneId,
string  sNewMap,
int  iNewLeft,
int  iNewTop 
)

设置场景地图

参数:
[in]iSceneId场景ID
[in]sNewMap地图名称
[in]iNewLeft新的视口位置横坐标
[in]iNewTop新的视口位置纵坐标
返回:
地图的ID
void OGE_SetSceneTag ( int  iSceneId,
string  sTagName 
)

给场景设置标签名称

参数:
[in]iSceneId场景的ID
[in]sTagName标签名称