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

函数

int OGE_GetMap ()
 取得当前场景中的地图
int OGE_GetMapByName (string sMapName)
 根据名称取得地图
string OGE_GetMapName (int iMapId)
 取得地图名称
int OGE_GetMapWidth (int iMapId)
 取得地图的宽度
int OGE_GetMapHeight (int iMapId)
 取得地图的高度
int OGE_GetMapImage (int iMapId)
 取得地图的图像ID
bool OGE_GetEightDirectionMode (int iMapId)
 检查地图是否在使用八方向模式
void OGE_SetEightDirectionMode (int iMapId, bool value)
 让地图使用八方向模式或者四方向模式
int OGE_GetColumnCount (int iMapId)
 取得瓦片地图中瓦片的列数
int OGE_GetRowCount (int iMapId)
 取得瓦片地图的瓦片行数
int OGE_GetTileValue (int iMapId, int iTileX, int iTileY)
 取得瓦片地图中指定位置的瓦格的值
int OGE_SetTileValue (int iMapId, int iTileX, int iTileY, int iValue)
 设置瓦片地图中指定位置的瓦格的值
void OGE_ReloadTileValues (int iMapId)
 从原地图配置文件中重新加载所有瓦格的值
void OGE_ResetGameMap (int iMapId)
 重新加载原地图配置文件中的所有瓦格值,并把瓦格所关联的所有数据清零
int OGE_GetTileData (int iMapId, int iTileX, int iTileY)
 取得地图中指定位置的瓦格所关联的数据的值
int OGE_SetTileData (int iMapId, int iTileX, int iTileY, int iValue)
 设置地图中指定位置的瓦格所关联的数据的值
void OGE_InitTileData (int iMapId, int iInitValue)
 把所有瓦格所关联的数据设置为一个相同的值
void OGE_InitTileValues (int iMapId, int iInitValue)
 设置所有瓦格的值为一个相同的数值
bool OGE_PixelToTile (int iMapId, int iPixelX, int iPixelY, int &iTileX, int &iTileY)
 把像素坐标转换成瓦格在地图中的坐标
bool OGE_TileToPixel (int iMapId, int iTileX, int iTileY, int &iPixelX, int &iPixelY)
 把瓦格在地图中的坐标(瓦格所在的行和列)转换成像素坐标
bool OGE_AlignPixel (int iMapId, int iInPixelX, int iInPixelY, int &iOutPixelX, int &iOutPixelY)
 把像素按瓦格对齐
int OGE_FindWay (int iMapId, int iStartX, int iStartY, int iEndX, int iEndY, int iTileListId)
 瓦片地图寻径
int OGE_FindRange (int iMapId, int iPosX, int iPosY, int iMovementPoints, int iTileListId)
 在瓦片地图中找出可移动的范围
int OGE_GetTileListSize (int iTileListId)
 取得瓦格列表的大小
int OGE_GetTileXFromList (int iTileListId, int iIndex)
 取得瓦格列表中某一瓦格的列号
int OGE_GetTileYFromList (int iTileListId, int iIndex)
 取得瓦格列表中某一瓦格的行号
int OGE_GetTileIndexInList (int iTileListId, int iTileX, int iTileY)
 取得瓦格在列表中的序号
int OGE_AddTileToList (int iTileListId, int iTileX, int iTileY)
 把瓦格加到列表中
int OGE_RemoveTileFromList (int iTileListId, int iIndex)
 从瓦格列表中删除一个瓦格
void OGE_ClearTileList (int iTileListId)
 把瓦格列表清空
void OGE_RemoveGameMap (string sName)
 移除一张游戏地图

函数文档

int OGE_AddTileToList ( int  iTileListId,
int  iTileX,
int  iTileY 
)

把瓦格加到列表中

参数:
[in]iTileListId瓦格列表的ID
[in]iTileX瓦格的列号
[in]iTileY瓦格的行号
返回:
瓦格在列表中的序号
bool OGE_AlignPixel ( int  iMapId,
int  iInPixelX,
int  iInPixelY,
int &  iOutPixelX,
int &  iOutPixelY 
)

把像素按瓦格对齐

参数:
[in]iMapId地图的ID
[in]iInPixelX像素原坐标X
[in]iInPixelY像素原坐标Y
[out]iOutPixelX对齐后的像素坐标X
[out]iOutPixelY对齐后的像素坐标Y
返回:
如果成功则返回真,否则返回假
void OGE_ClearTileList ( int  iTileListId)

把瓦格列表清空

参数:
[in]iTileListId瓦格列表的ID
int OGE_FindRange ( int  iMapId,
int  iPosX,
int  iPosY,
int  iMovementPoints,
int  iTileListId 
)

在瓦片地图中找出可移动的范围

参数:
[in]iMapId瓦片地图的ID
[in]iPosX当前瓦格的列号
[in]iPosY当前瓦格的行号
[in]iMovementPoints能使用的移动点数
[in]iTileListId组成可移动范围的瓦格的列表
返回:
如果成功则返回组成可移动范围的瓦片数量
int OGE_FindWay ( int  iMapId,
int  iStartX,
int  iStartY,
int  iEndX,
int  iEndY,
int  iTileListId 
)

瓦片地图寻径

参数:
[in]iMapId地图的ID
[in]iStartX起点瓦格的列号
[in]iStartY起点瓦格的行号
[in]iEndX终点瓦格的列号
[in]iEndY终点瓦格的行号
[in]iTileListId用于存放组成路径的瓦格的列表的ID
返回:
如果成功则返回路径的步数
int OGE_GetColumnCount ( int  iMapId)

取得瓦片地图中瓦片的列数

参数:
[in]iMapId地图的ID
返回:
瓦片的列数
bool OGE_GetEightDirectionMode ( int  iMapId)

检查地图是否在使用八方向模式

参数:
[in]iMapId地图的ID
返回:
若地图是在使用八方向模式,则返回真,否则返回假
int OGE_GetMap ( )

取得当前场景中的地图

返回:
地图的ID
int OGE_GetMapByName ( string  sMapName)

根据名称取得地图

参数:
[in]sMapName地图名称
返回:
地图的ID
int OGE_GetMapHeight ( int  iMapId)

取得地图的高度

参数:
[in]iMapId地图的ID
返回:
地图的高度
int OGE_GetMapImage ( int  iMapId)

取得地图的图像ID

参数:
[in]iMapId地图的ID
返回:
地图图像的ID
string OGE_GetMapName ( int  iMapId)

取得地图名称

参数:
[in]iMapId地图的ID
返回:
地图的名称
int OGE_GetMapWidth ( int  iMapId)

取得地图的宽度

参数:
[in]iMapId地图的ID
返回:
地图的宽度
int OGE_GetRowCount ( int  iMapId)

取得瓦片地图的瓦片行数

参数:
[in]iMapId地图的ID
返回:
瓦片行数
int OGE_GetTileData ( int  iMapId,
int  iTileX,
int  iTileY 
)

取得地图中指定位置的瓦格所关联的数据的值

参数:
[in]iMapId地图的ID
[in]iTileX瓦格的列号
[in]iTileY瓦格的行号
返回:
瓦格所关联的数据的值
int OGE_GetTileIndexInList ( int  iTileListId,
int  iTileX,
int  iTileY 
)

取得瓦格在列表中的序号

参数:
[in]iTileListId瓦格列表的ID
[in]iTileX瓦格的列号
[in]iTileY瓦格的行号
返回:
瓦格在列表中的序号
int OGE_GetTileListSize ( int  iTileListId)

取得瓦格列表的大小

参数:
[in]iTileListId瓦格列表的ID
返回:
瓦格列表的大小
int OGE_GetTileValue ( int  iMapId,
int  iTileX,
int  iTileY 
)

取得瓦片地图中指定位置的瓦格的值

参数:
[in]iMapId地图的ID
[in]iTileX瓦格的列号
[in]iTileY瓦格的行号
返回:
瓦格的值
int OGE_GetTileXFromList ( int  iTileListId,
int  iIndex 
)

取得瓦格列表中某一瓦格的列号

参数:
[in]iTileListId瓦格列表的ID
[in]iIndex瓦格在列表中的序号
返回:
瓦格的列号
int OGE_GetTileYFromList ( int  iTileListId,
int  iIndex 
)

取得瓦格列表中某一瓦格的行号

参数:
[in]iTileListId瓦格列表的ID
[in]iIndex瓦格在列表中的序号
返回:
瓦格的行号
void OGE_InitTileData ( int  iMapId,
int  iInitValue 
)

把所有瓦格所关联的数据设置为一个相同的值

参数:
[in]iMapId地图的ID
[in]iInitValue数据值
void OGE_InitTileValues ( int  iMapId,
int  iInitValue 
)

设置所有瓦格的值为一个相同的数值

参数:
[in]iMapId地图的ID
[in]iInitValue用于设置所有瓦格的值的数值
bool OGE_PixelToTile ( int  iMapId,
int  iPixelX,
int  iPixelY,
int &  iTileX,
int &  iTileY 
)

把像素坐标转换成瓦格在地图中的坐标

参数:
[in]iMapId瓦片地图的ID
[in]iPixelX像素的X坐标
[in]iPixelY像素的Y坐标
[out]iTileX瓦格在地图中的X坐标(所在列数)
[out]iTileY瓦格在地图中的Y坐标(所在行数)
返回:
如果转换成功则返回真,否则返回假
void OGE_ReloadTileValues ( int  iMapId)

从原地图配置文件中重新加载所有瓦格的值

参数:
[in]iMapId瓦片地图的ID
void OGE_RemoveGameMap ( string  sName)

移除一张游戏地图

参数:
[in]sName游戏地图的名称
int OGE_RemoveTileFromList ( int  iTileListId,
int  iIndex 
)

从瓦格列表中删除一个瓦格

参数:
[in]iTileListId瓦格列表的ID
[in]iIndex瓦格在列表中的序号
返回:
删除指定序号的瓦格后,瓦格列表的大小
void OGE_ResetGameMap ( int  iMapId)

重新加载原地图配置文件中的所有瓦格值,并把瓦格所关联的所有数据清零

参数:
[in]iMapId瓦片地图的ID
void OGE_SetEightDirectionMode ( int  iMapId,
bool  value 
)

让地图使用八方向模式或者四方向模式

参数:
[in]iMapId地图的ID
[in]value为真则地图使用八方向模式,否则就使用四方向模式
int OGE_SetTileData ( int  iMapId,
int  iTileX,
int  iTileY,
int  iValue 
)

设置地图中指定位置的瓦格所关联的数据的值

参数:
[in]iMapId瓦片地图的ID
[in]iTileX瓦格的列号
[in]iTileY瓦格的行号
[in]iValue瓦格所关联的数据的值
返回:
返回瓦格所关联的数据的值
int OGE_SetTileValue ( int  iMapId,
int  iTileX,
int  iTileY,
int  iValue 
)

设置瓦片地图中指定位置的瓦格的值

参数:
[in]iMapId地图的ID
[in]iTileX瓦格的列号
[in]iTileY瓦格的行号
[in]iValue瓦格的值
返回:
如果执行成功则返回瓦格的值
bool OGE_TileToPixel ( int  iMapId,
int  iTileX,
int  iTileY,
int &  iPixelX,
int &  iPixelY 
)

把瓦格在地图中的坐标(瓦格所在的行和列)转换成像素坐标

参数:
[in]iMapId瓦片地图的ID
[in]iTileX瓦格的列号
[in]iTileY瓦格的行号
[out]iPixelX像素的X坐标
[out]iPixelY像素的Y坐标
返回:
如果转换成功则返回真,否则返回假