Data Structures | Functions

Scripting Reference

Data Structures

class  Timer
 Provides a millisecond resolution timer. More...

Functions

void Print (std::string &s)
 [AS - void Print(string@)]
void Println (std::string &s)
 [AS - void Println(string@)]
void ANIM_Play (bool loop)
 [AS - void PlayAnimation(string@,bool)]
void ANIM_SetFrame (int frame)
 [AS - void SetFrame(int)]
void ANIM_StepFrame ()
 [AS - void StepFrame()]
void ANIM_SetLooped (bool val)
 [AS - void SetLooped(bool)]
void CHAR_SetAnimation (std::string &animation)
 [AS - void SetAnimation(string@)]
void CHAR_SetState (std::string &state)
 [AS - void SetState(string@)]
int CHAR_ReadUserInt (std::string &key)
 [AS - int ReadUserInt(string@)]
float CHAR_ReadUserFloat (std::string &key)
 [AS - float ReadUserFloat(string@)]
CScriptString * CHAR_ReadUserString (std::string &key)
 [AS - string@ ReadUserString(string@)]
bool CHAR_WriteUserInt (std::string &key, int value)
 [AS - bool WriteUserInt(string@,int)]
bool CHAR_WriteUserFloat (std::string &key, float value)
 [AS - bool WriteUserFloat(string@,float)]
bool CHAR_WriteUserString (std::string &key, std::string &value)
 [AS - bool WriteUserString(string@,string@)]
int CHAR_GetX ()
 [AS - int GetX()]
int CHAR_GetY ()
 [AS - int GetY()]
void CHAR_SetX (int val)
 [AS - void SetX(int)]
void CHAR_SetY (int val)
 [AS - void SetY(int)]
int CHAR_GetXSpeed ()
 [AS - int GetXSpeed()]
int CHAR_GetYSpeed ()
 [AS - int GetYSpeed()]
void CHAR_SetXSpeed (int val)
 [AS - void SetXSpeed(int)]
void CHAR_SpawnSecondaryChar (std::string &character, std::string &handle)
 [AS - void SpawnSecondaryChar(string@,string@)]
void CHAR_SetYSpeed (int val)
 [AS - void SetYSpeed(int)]
void STATE_PushTask (asIScriptObject *task)
 [AS - void PushTask(Task@)]
void STATE_PopTask ()
 [AS - void PopTask()]
CScriptString * STATE_CurrentTaskType ()
 [AS - string@ CurrentTask()]

Detailed Description

This group contains all of the functions that are exposed to Angelscript and thus are the things you as a character creator should focus on.


Function Documentation

void ANIM_Play ( bool  loop)

[AS - void PlayAnimation(string@,bool)]

Plays the current animation all the way through, looping if specified.

void ANIM_SetFrame ( int  frame)

[AS - void SetFrame(int)]

Sets the frame of the currently active animation.

void ANIM_SetLooped ( bool  val)

[AS - void SetLooped(bool)]

Sets the currently active animation to be looped (or not).

void ANIM_StepFrame ( )

[AS - void StepFrame()]

Steps the frame of the currently active animation.

int CHAR_GetX ( )

[AS - int GetX()]

Returns the character's X position on the desktop.

int CHAR_GetXSpeed ( )

[AS - int GetXSpeed()]

Gets the Character's X speed.

int CHAR_GetY ( )

[AS - int GetY()]

Returns the character's Y position on the desktop.

int CHAR_GetYSpeed ( )

[AS - int GetYSpeed()]

Gets the character's Y speed.

float CHAR_ReadUserFloat ( std::string &  key)

[AS - float ReadUserFloat(string@)]

Reads a user-defined float from either shared memory space or from the global Json file.

int CHAR_ReadUserInt ( std::string &  key)

[AS - int ReadUserInt(string@)]

Reads a user-defined int from either shared memory space or from the global Json file.

CScriptString* CHAR_ReadUserString ( std::string &  key)

[AS - string@ ReadUserString(string@)]

Reads a user-defined string from either shared memory space or from the global Json file.

void CHAR_SetAnimation ( std::string &  animation)

[AS - void SetAnimation(string@)]

Sets the currently active animation.

void CHAR_SetState ( std::string &  state)

[AS - void SetState(string@)]

Sets the character's current state.

void CHAR_SetX ( int  val)

[AS - void SetX(int)]

Returns the character's X position on the desktop.

void CHAR_SetXSpeed ( int  val)

[AS - void SetXSpeed(int)]

Sets the X Speed of the character.

void CHAR_SetY ( int  val)

[AS - void SetY(int)]

Returns the character's Y position on the desktop.

void CHAR_SetYSpeed ( int  val)

[AS - void SetYSpeed(int)]

Sets the Y speed of the character.

void CHAR_SpawnSecondaryChar ( std::string &  character,
std::string &  handle 
)

[AS - void SpawnSecondaryChar(string@,string@)]

Spawns a secondary character.

bool CHAR_WriteUserFloat ( std::string &  key,
float  value 
)

[AS - bool WriteUserFloat(string@,float)]

Writes a user-defined float to either shared memory space or to the global Json file.

bool CHAR_WriteUserInt ( std::string &  key,
int  value 
)

[AS - bool WriteUserInt(string@,int)]

Writes a user-defined int to either shared memory space or to the global Json file.

bool CHAR_WriteUserString ( std::string &  key,
std::string &  value 
)

[AS - bool WriteUserString(string@,string@)]

Writes a user-defined string to either shared memory space or to the global Json file.

void Print ( std::string &  s)

[AS - void Print(string@)]

Prints to the console.

void Println ( std::string &  s)

[AS - void Println(string@)]

Prints a line to the console.

CScriptString* STATE_CurrentTaskType ( )

[AS - string@ CurrentTask()]

Gets the class-name of the currently active task on the stack.

void STATE_PopTask ( )

[AS - void PopTask()]

Pops off the currently active task on the task stack.

void STATE_PushTask ( asIScriptObject *  task)

[AS - void PushTask(Task@)]

Pushe's a task onto the active state's task stack.

 All Data Structures Functions