HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cScript

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type	Function and Description
bool	cScript_GetGlobalArgBool(int alIdx)
cColor	cScript_GetGlobalArgColor(int alIdx)
float	cScript_GetGlobalArgFloat(int alIdx)
tID	cScript_GetGlobalArgID(int alIdx)
int	cScript_GetGlobalArgInt(int alIdx)
cMatrixf	cScript_GetGlobalArgMatrix(int alIdx)
tString	cScript_GetGlobalArgString(int alIdx)
cVector2f	cScript_GetGlobalArgVector2f(int alIdx)
cVector3f	cScript_GetGlobalArgVector3f(int alIdx)
cVector4f	cScript_GetGlobalArgVector4f(int alIdx)
bool	cScript_GetGlobalReturnBool()
cColor	cScript_GetGlobalReturnColor()
float	cScript_GetGlobalReturnFloat()
tID	cScript_GetGlobalReturnID()
int	cScript_GetGlobalReturnInt()
cMatrixf	cScript_GetGlobalReturnMatrix()
tString	cScript_GetGlobalReturnString()
cVector2f	cScript_GetGlobalReturnVector2f()
cVector3f	cScript_GetGlobalReturnVector3f()
cVector4f	cScript_GetGlobalReturnVector4f()
bool	cScript_GetGlobalVarBool(const tString &in asName)
cColor	cScript_GetGlobalVarColor(const tString &in asName)
float	cScript_GetGlobalVarFloat(const tString &in asName)
tID	cScript_GetGlobalVarID(const tString &in asName)
int	cScript_GetGlobalVarInt(const tString &in asName)
cMatrixf	cScript_GetGlobalVarMatrix(const tString &in asName)
tString	cScript_GetGlobalVarString(const tString &in asName)
cVector2f	cScript_GetGlobalVarVector2f(const tString &in asName)
cVector3f	cScript_GetGlobalVarVector3f(const tString &in asName)
cVector4f	cScript_GetGlobalVarVector4f(const tString &in asName)
bool	cScript_RunGlobalFunc(const tString &in asObjName, const tString &in asClassName, const tString &in asFuncName)
void	cScript_SetGlobalArgBool(int alIdx, bool abX)
void	cScript_SetGlobalArgColor(int alIdx, const cColor &in aX)
void	cScript_SetGlobalArgFloat(int alIdx, float afX)
void	cScript_SetGlobalArgID(int alIdx, tID alX)
void	cScript_SetGlobalArgInt(int alIdx, int alX)
void	cScript_SetGlobalArgMatrix(int alIdx, const cMatrixf &in a_mtxX)
void	cScript_SetGlobalArgString(int alIdx, const tString &in asVar)
void	cScript_SetGlobalArgVector2f(int alIdx, const cVector2f &in avX)
void	cScript_SetGlobalArgVector3f(int alIdx, const cVector3f &in avX)
void	cScript_SetGlobalArgVector4f(int alIdx, const cVector4f &in avX)
void	cScript_SetGlobalReturnBool(bool abX)
void	cScript_SetGlobalReturnColor(const cColor &in aX)
void	cScript_SetGlobalReturnFloat(float afX)
void	cScript_SetGlobalReturnID(tID alX)
void	cScript_SetGlobalReturnInt(int alX)
void	cScript_SetGlobalReturnMatrix(const cMatrixf &in a_mtxX)
void	cScript_SetGlobalReturnString(const tString &in asVar)
void	cScript_SetGlobalReturnVector2f(const cVector2f &in avX)
void	cScript_SetGlobalReturnVector3f(const cVector3f &in avX)
void	cScript_SetGlobalReturnVector4f(const cVector4f &in avX)
void	cScript_SetGlobalVarBool(const tString &in asName, bool abX)
void	cScript_SetGlobalVarColor(const tString &in asName, const cColor &in aX)
void	cScript_SetGlobalVarFloat(const tString &in asName, float afX)
void	cScript_SetGlobalVarID(const tString &in asName, tID alX)
void	cScript_SetGlobalVarInt(const tString &in asName, int alX)
void	cScript_SetGlobalVarMatrix(const tString &in asName, const cMatrixf &in a_mtxX)
void	cScript_SetGlobalVarString(const tString &in asName, const tString &in asVar)
void	cScript_SetGlobalVarVector2f(const tString &in asName, const cVector2f &in avX)
void	cScript_SetGlobalVarVector3f(const tString &in asName, const cVector3f &in avX)
void	cScript_SetGlobalVarVector4f(const tString &in asName, const cVector4f &in avX)

Function Detail

cScript_GetGlobalArgBool

bool cScript_GetGlobalArgBool(int alIdx)

Parameters

• alIdx (int) —

Returns:

• bool—

cScript_GetGlobalArgColor

cColor cScript_GetGlobalArgColor(int alIdx)

Parameters

• alIdx (int) —

Returns:

• cColor—

cScript_GetGlobalArgFloat

float cScript_GetGlobalArgFloat(int alIdx)

Parameters

• alIdx (int) —

Returns:

• float—

cScript_GetGlobalArgID

tID cScript_GetGlobalArgID(int alIdx)

Parameters

• alIdx (int) —

Returns:

• tID—

cScript_GetGlobalArgInt

int cScript_GetGlobalArgInt(int alIdx)

Parameters

• alIdx (int) —

Returns:

• int—

cScript_GetGlobalArgMatrix

cMatrixf cScript_GetGlobalArgMatrix(int alIdx)

Parameters

• alIdx (int) —

Returns:

• cMatrixf—

cScript_GetGlobalArgString

tString cScript_GetGlobalArgString(int alIdx)

Parameters

• alIdx (int) —

Returns:

• tString—

cScript_GetGlobalArgVector2f

cVector2f cScript_GetGlobalArgVector2f(int alIdx)

Parameters

• alIdx (int) —

Returns:

• cVector2f—

cScript_GetGlobalArgVector3f

cVector3f cScript_GetGlobalArgVector3f(int alIdx)

Parameters

• alIdx (int) —

Returns:

• cVector3f—

cScript_GetGlobalArgVector4f

cVector4f cScript_GetGlobalArgVector4f(int alIdx)

Parameters

• alIdx (int) —

Returns:

• cVector4f—

cScript_GetGlobalReturnBool

bool cScript_GetGlobalReturnBool()

Returns:

• bool—

cScript_GetGlobalReturnColor

cColor cScript_GetGlobalReturnColor()

Returns:

• cColor—

cScript_GetGlobalReturnFloat

float cScript_GetGlobalReturnFloat()

Returns:

• float—

cScript_GetGlobalReturnID

tID cScript_GetGlobalReturnID()

Returns:

• tID—

cScript_GetGlobalReturnInt

int cScript_GetGlobalReturnInt()

Returns:

• int—

cScript_GetGlobalReturnMatrix

cMatrixf cScript_GetGlobalReturnMatrix()

Returns:

• cMatrixf—

cScript_GetGlobalReturnString

const tString& cScript_GetGlobalReturnString()

Returns:

• const tString&—

cScript_GetGlobalReturnVector2f

cVector2f cScript_GetGlobalReturnVector2f()

Returns:

• cVector2f—

cScript_GetGlobalReturnVector3f

cVector3f cScript_GetGlobalReturnVector3f()

Returns:

• cVector3f—

cScript_GetGlobalReturnVector4f

cVector4f cScript_GetGlobalReturnVector4f()

Returns:

• cVector4f—

cScript_GetGlobalVarBool

bool cScript_GetGlobalVarBool(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• bool—

cScript_GetGlobalVarColor

cColor cScript_GetGlobalVarColor(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• cColor—

cScript_GetGlobalVarFloat

float cScript_GetGlobalVarFloat(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• float—

cScript_GetGlobalVarID

tID cScript_GetGlobalVarID(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• tID—

cScript_GetGlobalVarInt

int cScript_GetGlobalVarInt(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• int—

cScript_GetGlobalVarMatrix

cMatrixf cScript_GetGlobalVarMatrix(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• cMatrixf—

cScript_GetGlobalVarString

tString cScript_GetGlobalVarString(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• tString—

cScript_GetGlobalVarVector2f

cVector2f cScript_GetGlobalVarVector2f(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• cVector2f—

cScript_GetGlobalVarVector3f

cVector3f cScript_GetGlobalVarVector3f(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• cVector3f—

cScript_GetGlobalVarVector4f

cVector4f cScript_GetGlobalVarVector4f(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• cVector4f—

cScript_RunGlobalFunc

bool cScript_RunGlobalFunc(const tString &in asObjName,
                           const tString &in asClassName,
                           const tString &in asFuncName)

Parameters

• asObjName (tString) —
• asClassName (tString) —
• asFuncName (tString) —

Returns:

• bool—

cScript_SetGlobalArgBool

void cScript_SetGlobalArgBool(int alIdx,
                              bool abX)

Parameters

• alIdx (int) —
• abX (bool) —

Returns:

• void

cScript_SetGlobalArgColor

void cScript_SetGlobalArgColor(int alIdx,
                               const cColor &in aX)

Parameters

• alIdx (int) —
• aX (cColor) —

Returns:

• void

cScript_SetGlobalArgFloat

void cScript_SetGlobalArgFloat(int alIdx,
                               float afX)

Parameters

• alIdx (int) —
• afX (float) —

Returns:

• void

cScript_SetGlobalArgID

void cScript_SetGlobalArgID(int alIdx,
                            tID alX)

Parameters

• alIdx (int) —
• alX (tID) —

Returns:

• void

cScript_SetGlobalArgInt

void cScript_SetGlobalArgInt(int alIdx,
                             int alX)

Parameters

• alIdx (int) —
• alX (int) —

Returns:

• void

cScript_SetGlobalArgMatrix

void cScript_SetGlobalArgMatrix(int alIdx,
                                const cMatrixf &in a_mtxX)

Parameters

• alIdx (int) —
• a_mtxX (cMatrixf) —

Returns:

• void

cScript_SetGlobalArgString

void cScript_SetGlobalArgString(int alIdx,
                                const tString &in asVar)

Parameters

• alIdx (int) —
• asVar (tString) —

Returns:

• void

cScript_SetGlobalArgVector2f

void cScript_SetGlobalArgVector2f(int alIdx,
                                  const cVector2f &in avX)

Parameters

• alIdx (int) —
• avX (cVector2f) —

Returns:

• void

cScript_SetGlobalArgVector3f

void cScript_SetGlobalArgVector3f(int alIdx,
                                  const cVector3f &in avX)

Parameters

• alIdx (int) —
• avX (cVector3f) —

Returns:

• void

cScript_SetGlobalArgVector4f

void cScript_SetGlobalArgVector4f(int alIdx,
                                  const cVector4f &in avX)

Parameters

• alIdx (int) —
• avX (cVector4f) —

Returns:

• void

cScript_SetGlobalReturnBool

void cScript_SetGlobalReturnBool(bool abX)

Parameters

• abX (bool) —

Returns:

• void

cScript_SetGlobalReturnColor

void cScript_SetGlobalReturnColor(const cColor &in aX)

Parameters

• aX (cColor) —

Returns:

• void

cScript_SetGlobalReturnFloat

void cScript_SetGlobalReturnFloat(float afX)

Parameters

• afX (float) —

Returns:

• void

cScript_SetGlobalReturnID

void cScript_SetGlobalReturnID(tID alX)

Parameters

• alX (tID) —

Returns:

• void

cScript_SetGlobalReturnInt

void cScript_SetGlobalReturnInt(int alX)

Parameters

• alX (int) —

Returns:

• void

cScript_SetGlobalReturnMatrix

void cScript_SetGlobalReturnMatrix(const cMatrixf &in a_mtxX)

Parameters

• a_mtxX (cMatrixf) —

Returns:

• void

cScript_SetGlobalReturnString

void cScript_SetGlobalReturnString(const tString &in asVar)

Parameters

• asVar (tString) —

Returns:

• void

cScript_SetGlobalReturnVector2f

void cScript_SetGlobalReturnVector2f(const cVector2f &in avX)

Parameters

• avX (cVector2f) —

Returns:

• void

cScript_SetGlobalReturnVector3f

void cScript_SetGlobalReturnVector3f(const cVector3f &in avX)

Parameters

• avX (cVector3f) —

Returns:

• void

cScript_SetGlobalReturnVector4f

void cScript_SetGlobalReturnVector4f(const cVector4f &in avX)

Parameters

• avX (cVector4f) —

Returns:

• void

cScript_SetGlobalVarBool

void cScript_SetGlobalVarBool(const tString &in asName,
                              bool abX)

Parameters

• asName (tString) —
• abX (bool) —

Returns:

• void

cScript_SetGlobalVarColor

void cScript_SetGlobalVarColor(const tString &in asName,
                               const cColor &in aX)

Parameters

• asName (tString) —
• aX (cColor) —

Returns:

• void

cScript_SetGlobalVarFloat

void cScript_SetGlobalVarFloat(const tString &in asName,
                               float afX)

Parameters

• asName (tString) —
• afX (float) —

Returns:

• void

cScript_SetGlobalVarID

void cScript_SetGlobalVarID(const tString &in asName,
                            tID alX)

Parameters

• asName (tString) —
• alX (tID) —

Returns:

• void

cScript_SetGlobalVarInt

void cScript_SetGlobalVarInt(const tString &in asName,
                             int alX)

Parameters

• asName (tString) —
• alX (int) —

Returns:

• void

cScript_SetGlobalVarMatrix

void cScript_SetGlobalVarMatrix(const tString &in asName,
                                const cMatrixf &in a_mtxX)

Parameters

• asName (tString) —
• a_mtxX (cMatrixf) —

Returns:

• void

cScript_SetGlobalVarString

void cScript_SetGlobalVarString(const tString &in asName,
                                const tString &in asVar)

Parameters

• asName (tString) —
• asVar (tString) —

Returns:

• void

cScript_SetGlobalVarVector2f

void cScript_SetGlobalVarVector2f(const tString &in asName,
                                  const cVector2f &in avX)

Parameters

• asName (tString) —
• avX (cVector2f) —

Returns:

• void

cScript_SetGlobalVarVector3f

void cScript_SetGlobalVarVector3f(const tString &in asName,
                                  const cVector3f &in avX)

Parameters

• asName (tString) —
• avX (cVector3f) —

Returns:

• void

cScript_SetGlobalVarVector4f

void cScript_SetGlobalVarVector4f(const tString &in asName,
                                  const cVector4f &in avX)

Parameters

• asName (tString) —
• avX (cVector4f) —

Returns:

• void