Annwvyn::ChaiScriptAPIDoc Namespace Reference

Classes

class  AnnCollisionEvent
 Collision between 2 game objects. More...
 
class  AnnColor
 A color. More...
 
class  AnnGameObject
 A game object. More...
 
class  AnnKeyEvent
 Keyboard event from scripts. More...
 
class  AnnMouseAxis
 Axis of a mouse. More...
 
class  AnnMouseEvent
 Mouse event from script. More...
 
class  AnnPlayerCollisionEvent
 Collision between the player and a game object. More...
 
class  AnnStickEvent
 Joystick event. More...
 
class  AnnStickPov
 state of a PoV from a controller More...
 
class  AnnTimeEvent
 Wait for a timer to go to 0. More...
 

Functions

void AnnDebugLog (const std::string &s)
 
void AnnDebugLog (const Ogre::Vector2 &v)
 
void AnnDebugLog (const Ogre::Vector3 &v)
 
void AnnDebugLog (const Ogre::Quaternion &q)
 
void AnnDebugLog (const Ogre::Radian &a)
 
void AnnDebugLog (const Ogre::Degree &a)
 
void AnnDebugLog (const AnnColor &c)
 
void AnnDebugLog (KeyCode::code c)
 
void AnnDebugLog (MouseAxisId a)
 
void AnnDebugLog (bool b)
 
void AnnDebugLog (int i)
 
void AnnDebugLog (float f)
 
void AnnSetWorldBackgroundColor (const AnnColor &c)
 
void AnnSetAmbientLight (const AnnColor &c)
 
void AnnCreateGameObject (const std::string &mesh, const std::string &objectName)
 
void AnnRemoveGameObject (const std::string &objectName)
 
AnnGameObjectAnnGetGameObject (std::string id)
 
void AnnChangeGravity (const Ogre::Vector3 &gravity)
 
void AnnRestoreGravity ()
 ScriptFunction: restore the gravity vector. More...
 
void AnnJumpLevel (level_id id)
 
void AnnSetProcessPriorityNormal ()
 Call the Win32 API to change the game process priority to "normal". Reduce the impact of the game on background task but also can create performance problems. More...
 
void AnnSetProcessPriorityHigh ()
 Call the Win32 API to change the game process priority to "high" for avoiding some performance problems with CPU time scheduling. More...
 

Variables

float PI
 Value of Pi. More...
 
float HALF_PI
 Value of Pi/2. More...
 

Detailed Description

List prototypes of C++ non-existing functions that match the interface of the Script functions you can use!

Function Documentation

◆ AnnChangeGravity()

void Annwvyn::ChaiScriptAPIDoc::AnnChangeGravity ( const Ogre::Vector3 &  gravity)

ScriptFunction: set the gravity vector

Parameters
gravityThe vector to use as g

◆ AnnCreateGameObject()

void Annwvyn::ChaiScriptAPIDoc::AnnCreateGameObject ( const std::string mesh,
const std::string objectName 
)

ScriptFunction: Create a game object. Will be added to the current level if a level is running

Parameters
meshMesh to use
objectNameName that the object will bear

◆ AnnDebugLog() [1/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( const std::string s)

ScriptFunction: Log a string

Parameters
sString to log

◆ AnnDebugLog() [2/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( const Ogre::Vector2 &  v)

ScriptFunction: Log a 2D vector

Parameters
vVector to log

◆ AnnDebugLog() [3/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( const Ogre::Vector3 &  v)

ScriptFunction: Log a 3D vector

Parameters
vVector to log

◆ AnnDebugLog() [4/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( const Ogre::Quaternion &  q)

ScriptFunction: Log a Quaternion

Parameters
qQuaternion to log

◆ AnnDebugLog() [5/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( const Ogre::Radian &  a)

ScriptFunction: Log an angle in Radian

Parameters
aAngle to log

◆ AnnDebugLog() [6/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( const Ogre::Degree &  a)

ScriptFunction: Log an angle in Degree

Parameters
aAngle to log

◆ AnnDebugLog() [7/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( const AnnColor c)

ScriptFunction: Log a color

Parameters
cColor to log

◆ AnnDebugLog() [8/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( KeyCode::code  c)

ScriptFunction: Log a keycode

Parameters
cKeyCode number

◆ AnnDebugLog() [9/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( MouseAxisId  a)

ScriptFunction: Log a mouse axis

Parameters
aAxis

◆ AnnDebugLog() [10/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( bool  b)

ScriptFunction: log a boolean

Parameters
bbool to log

◆ AnnDebugLog() [11/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( int  i)

ScriptFunction: log an integer

Parameters
iint

◆ AnnDebugLog() [12/12]

void Annwvyn::ChaiScriptAPIDoc::AnnDebugLog ( float  f)

ScriptFunction: log a simple precision floating point number

Parameters
ffloat

◆ AnnGetGameObject()

AnnGameObject* Annwvyn::ChaiScriptAPIDoc::AnnGetGameObject ( std::string  id)

ScriptFunction: get a GameObject from it's ID

Parameters
idThe string ID of the object you want

◆ AnnJumpLevel()

void Annwvyn::ChaiScriptAPIDoc::AnnJumpLevel ( level_id  id)

ScriptFunction: Jump the level manager to another level

Parameters
idThe ID number of the level

◆ AnnRemoveGameObject()

void Annwvyn::ChaiScriptAPIDoc::AnnRemoveGameObject ( const std::string objectName)

ScriptFunction: Remove a game object. Will be removed from the current level if a level is running

Parameters
objectNameName of the object

◆ AnnRestoreGravity()

void Annwvyn::ChaiScriptAPIDoc::AnnRestoreGravity ( )

ScriptFunction: restore the gravity vector.

◆ AnnSetAmbientLight()

void Annwvyn::ChaiScriptAPIDoc::AnnSetAmbientLight ( const AnnColor c)

ScriptFunction: Set the value of the ambient lighting

Parameters
cColor

◆ AnnSetProcessPriorityHigh()

void Annwvyn::ChaiScriptAPIDoc::AnnSetProcessPriorityHigh ( )

Call the Win32 API to change the game process priority to "high" for avoiding some performance problems with CPU time scheduling.

◆ AnnSetProcessPriorityNormal()

void Annwvyn::ChaiScriptAPIDoc::AnnSetProcessPriorityNormal ( )

Call the Win32 API to change the game process priority to "normal". Reduce the impact of the game on background task but also can create performance problems.

◆ AnnSetWorldBackgroundColor()

void Annwvyn::ChaiScriptAPIDoc::AnnSetWorldBackgroundColor ( const AnnColor c)

ScritpFunciton: Set the world's background color

Parameters
cColor

Variable Documentation

◆ HALF_PI

float Annwvyn::ChaiScriptAPIDoc::HALF_PI

Value of Pi/2.

Definition at line 307 of file doxygen_scriptapi.hpp.

◆ PI

float Annwvyn::ChaiScriptAPIDoc::PI

Value of Pi.

Definition at line 304 of file doxygen_scriptapi.hpp.