Functions
int	OGE_ResetPath (int iSprId, int iStepLength, bool bAutoStepping)
	Reset the path.
int	OGE_GetPathNodeIndex (int iSprId)
	Get the index of current node of current path.
int	OGE_GetPathStepLength (int iSprId)
	Get the length of the step of current path.
void	OGE_SetPathStepLength (int iSprId, int iStepLength)
	Set the length of the step of the path.
int	OGE_GetPathStepInterval (int iSprId)
	Get the step interval of current path.
void	OGE_SetPathStepInterval (int iSprId, int iStepInterval)
	Set the step interval of the path.
int	OGE_GetPathDirection (int iSprId)
	Get the direction of current path.
int	OGE_GetPath (string sPathName)
	Get the path by its name.
int	OGE_GetPathByCode (int iCode)
	Get the path by code.
void	OGE_PathGenLine (int iPathId, int x1, int y1, int x2, int y2)
	Generate a single beeline to fill the nodes of path.
void	OGE_PathGenExtLine (int iPathId, int iSrcX, int iSrcY, int iDstX, int iDstY, int iExtraWidth, int iExtraHeight)
	Generate a single beeline path going over the edge of the screen.
int	OGE_GetPathNodeCount (int iPathId)
	Get the count of all the nodes of the path.

Function Documentation

int OGE_GetPath ( string sPathName )

Get the path by its name.

Parameters:

[in] sPathName The name of the path

Returns:: The ID of the path

int OGE_GetPathByCode ( int iCode )

Get the path by code.

Parameters:

[in] iCode The code of the path

Returns:: The ID of the path

int OGE_GetPathDirection ( int iSprId )

Get the direction of current path.

Parameters:

[in] iSprId The ID of the sprite

Returns:: The direction

int OGE_GetPathNodeCount ( int iPathId )

Get the count of all the nodes of the path.

Parameters:

[in] iPathId The ID of the path

Returns:: The count of all the nodes

int OGE_GetPathNodeIndex ( int iSprId )

Get the index of current node of current path.

Parameters:

[in] iSprId The ID of the sprite

Returns:: The index of current node

int OGE_GetPathStepInterval ( int iSprId )

Get the step interval of current path.

Parameters:

[in] iSprId The ID of the sprite

Returns:: The step interval

int OGE_GetPathStepLength ( int iSprId )

Get the length of the step of current path.

Parameters:

[in] iSprId The ID of the sprite

Returns:: The length of the step of the path

void OGE_PathGenExtLine	(	int	iPathId,
		int	iSrcX,
		int	iSrcY,
		int	iDstX,
		int	iDstY,
		int	iExtraWidth,
		int	iExtraHeight
	)

Generate a single beeline path going over the edge of the screen.

Parameters:

[in]	iPathId	The ID of the path
[in]	iSrcX	The x coordinate of the start point
[in]	iSrcY	The y coordinate of the start point
[in]	iDstX	The x coordinate of the end point
[in]	iDstY	The y coordinate of the end point
[in]	iExtraWidth	The width of the area beyond the screen
[in]	iExtraHeight	The height of the area beyond the screen

void OGE_PathGenLine	(	int	iPathId,
		int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Generate a single beeline to fill the nodes of path.

Parameters:

[in]	iPathId	The ID of the path
[in]	x1	The x coordinate of the start point
[in]	y1	The y coordinate of the start point
[in]	x2	The x coordinate of the end point
[in]	y2	The y coordinate of the end point

int OGE_ResetPath	(	int	iSprId,
		int	iStepLength,
		bool	bAutoStepping
	)

Reset the path.

Parameters:

[in]	iSprId	The ID of the sprite
[in]	iStepLength	The length of the step
[in]	bAutoStepping	Allow auto stepping or not

Returns:: Return zero if it succeeds

void OGE_SetPathStepInterval	(	int	iSprId,
		int	iStepInterval
	)

Set the step interval of the path.

Parameters:

[in]	iSprId	The ID of the sprite
[in]	iStepInterval	The step interval

void OGE_SetPathStepLength	(	int	iSprId,
		int	iStepLength
	)

Set the length of the step of the path.

Parameters:

[in]	iSprId	The ID of the sprite
[in]	iStepLength	The length of the step of the path

Functions

Function Documentation