Core

Errors, versioning and the shared types. More...

Data Structures
struct	ShVec3
	Metres. More...

Macros
#define	SH_API_VERSION   1
#define	SH_API

Typedefs
typedef int(*)	ShGetHealthPlayer_t(uint32_t *, uint32_t *)
typedef int(*)	ShSetHealthPlayer_t(uint32_t)
typedef int(*)	ShSetGodModePlayer_t(int)
typedef int(*)	ShPhysicsReady_t(void)
typedef int(*)	ShGroundHeight_t(float, float, float *)
typedef int(*)	ShTeleportPlayerToGround_t(float, float, float)

Enumerations
enum	ShError {   SH_OK = 0 , SH_ERR_BAD_ARG , SH_ERR_NO_GLOBAL , SH_ERR_NO_POSITION ,   SH_ERR_NO_CANDIDATE , SH_ERR_NO_ROOT , SH_ERR_UNWRITABLE , SH_ERR_NOT_ENTITY ,   SH_ERR_HOOK_FAILED , SH_ERR_NO_PHYSICS , SH_ERR_NO_GROUND , SH_ERR_NOT_IN_GAME ,   SH_ERR_NOT_STREAMED , SH_ERR_CONTROLLER , SH_ERR_UI_NOT_READY , SH_ERR_UI_PROP ,   SH_ERR_UI_ASSET }
	Every int function returns 1 on success, 0 on failure, and on failure ShLastError carries one of these. More...

Functions
SH_API int	ShLastError (void)
	The last error for the calling context.
SH_API const char *	ShErrorString (int err)
	The readable name of an error code.
SH_API int	ShGetVersion (void)
	SH_API_VERSION, for compatibility checks.

Detailed Description

Errors, versioning and the shared types.

Macro Definition Documentation

SH_API_VERSION

#define SH_API_VERSION   1

SH_API

#define SH_API

Typedef Documentation

ShGetHealthPlayer_t

typedef int(*) ShGetHealthPlayer_t(uint32_t *, uint32_t *)

ShSetHealthPlayer_t

typedef int(*) ShSetHealthPlayer_t(uint32_t)

ShSetGodModePlayer_t

typedef int(*) ShSetGodModePlayer_t(int)

ShPhysicsReady_t

typedef int(*) ShPhysicsReady_t(void)

ShGroundHeight_t

typedef int(*) ShGroundHeight_t(float, float, float *)

ShTeleportPlayerToGround_t

typedef int(*) ShTeleportPlayerToGround_t(float, float, float)

Enumeration Type Documentation

ShError

enum ShError

Every int function returns 1 on success, 0 on failure, and on failure ShLastError carries one of these.

Enumerator
SH_OK
SH_ERR_BAD_ARG
SH_ERR_NO_GLOBAL
SH_ERR_NO_POSITION
SH_ERR_NO_CANDIDATE
SH_ERR_NO_ROOT
SH_ERR_UNWRITABLE
SH_ERR_NOT_ENTITY
SH_ERR_HOOK_FAILED
SH_ERR_NO_PHYSICS
SH_ERR_NO_GROUND
SH_ERR_NOT_IN_GAME
SH_ERR_NOT_STREAMED
SH_ERR_CONTROLLER
SH_ERR_UI_NOT_READY	in game, scene not up yet
SH_ERR_UI_PROP	no such property on the class
SH_ERR_UI_ASSET	font or texture not loaded

Function Documentation

ShLastError()

SH_API int ShLastError

(

void

)

The last error for the calling context.

ShErrorString()

SH_API const char * ShErrorString

(

int

err

)

The readable name of an error code.

ShGetVersion()

SH_API int ShGetVersion

(

void

)

SH_API_VERSION, for compatibility checks.