Game scripting

Return to table of content.

List

Details

Variables

Return to top.

Name	Type	Description
ScriptManagerInstance	ScriptManager	Instance of the script manager.
GameInstance	Game	Instance of the game.
SceneManagerInstance	SceneManager	Instance of the scene manager.

Enumerations

RenderPosition

Return to top.

Description:
Render position of a GUI.

Values:

RP_BEFORE_BACKGROUND	Render before background.
RP_AFTER_BACKGROUND	Render after background.
RP_BEFORE_FOREGROUND	Render before foreground.
RP_AFTER_FOREGROUND	Render after foreground.

Classes

ScriptManager

Return to top.

Description:
Manager responsible of all the scripts.

constructor

Description:
ScriptManager cannot be instanciated by a script.

load

Description:
Load a script.

Parameters:

Name	Type	Description
file_name	string	Name of the script file.

Return:

Boolean: true in case of success; false otherwise.

unload

Description:
Unload a script.

Parameters:

Name	Type	Description
file_name	string	Name of the script file.

Return:

Boolean: true in case of success; false otherwise.

execute

Description:
Execute a script.

Parameters:

Name	Type	Description
file_name	string	Name of the script file.

Return:

Boolean: true in case of success; false otherwise.

Game

Return to top.

Description:
Game manager.

constructor

Description:
Game cannot be instanciated by a script.

getTimeSinceLastFrame

Description:
Get the elapsed time since the last update (in ms) of the game.

Parameters: none.
Return:

Integer: Current value of the elapsed time since the last update (in ms) of the game.

registerUpdateScript

Description:
Register the name of a script function to be called to update the game state.

Parameters:

Name	Type	Description
file_name	string	Name of the update function.

Return:

Boolean: true in case of success; false otherwise.

unregisterUpdateScript

Description:
Unregister the name of a previously registered script function.

Parameters:

Name	Type	Description
file_name	string	Name of the update function.

Return:

Boolean: true in case of success; false otherwise.

SceneManager

Return to top.

Description:
Manager responsible of all the scenes.

constructor

Description:
SceneManager cannot be instanciated by a script.

createScene

Description:
Create a scene.

Parameters:

Name	Type	Description
scene_name	string	Name of the scene.

Return:

Boolean: true in case of success; false otherwise.

removeScene

Description:
Remove a scene and unload its data.

Parameters:

Name	Type	Description
scene_name	string	Name of the scene.

Return:

Boolean: true in case of success; false otherwise.

activateScene

Description:
Activate a scene.

Parameters:

Name	Type	Description
scene_name	string	Name of the scene.

Return:

Boolean: true in case of success; false otherwise.

disableScene

Description:
Disable a scene.

Parameters:

Name	Type	Description
scene_name	string	Name of the scene.

Return:

Boolean: true in case of success; false otherwise.

getScene

Description:
Get an existing scene.

Parameters:

Name	Type	Description
scene_name	string	Name of the scene.

Return:

Scene (by reference): Requested scene.

Scene

Return to top.

Description:
A scene.

constructor

Description:
Scene cannot be instanciated by a script.

getName

Description:
Get the name of the scene.

Parameters: none.
Return:

String: Current value of the name of the scene.

load

Description:
Load the scene from a file.

Parameters:

Name	Type	Description
file_name	string	Path of the file to load.

Return:

Boolean: true in case of success; false otherwise.

createGUI

Description:
Create a graphical user interface (GUI).

Parameters:

Name	Type	Description
name	string	Name of the GUI.
file_name	string	Path of the file to load.
render_position	RenderPosition	Position where the GUI will be rendered.

Return:

Boolean: true in case of success; false otherwise.

removeGUI

Description:
Remove a graphical user interface (GUI).

Parameters:

Name	Type	Description
name	string	Name of the GUI.

Return:

Boolean: true in case of success; false otherwise.

showGUI

Description:
Show a graphical user interface (GUI).

Parameters:

Name	Type	Description
name	string	Name of the GUI.

Return:

Boolean: true in case of success; false otherwise.

hideGUI

Description:
Hide a graphical user interface (GUI).

Parameters:

Name	Type	Description
name	string	Name of the GUI.

Return:

Boolean: true in case of success; false otherwise.

createSceneNode

Description:
Create a scene node.

Parameters:

Name	Type	Description
node_name	string	Name of the node.

Return:

Boolean: true in case of success; false otherwise.

removeSceneNode

Description:
Remove a scene node.

Parameters:

Name	Type	Description
node_name	string	Name of the node.

Return:

Boolean: true in case of success; false otherwise.

getSceneNode

Description:
Get an existing scene node.

Parameters:

Name	Type	Description
node_name	string	Name of the scene node.

Return:

SceneNode (by reference): Requested scene node.

createActor

Description:
Create an actor.

Parameters:

Name	Type	Description
name	string	Name of the actor.
model_name	string	Name of the model to use for the actor; empty if none.

Return:

Boolean: true in case of success; false otherwise.

removeActor

Description:
Remove an actor.

Parameters:

Name	Type	Description
actor_name	string	Name of the actor.

Return:

Boolean: true in case of success; false otherwise.

getActor

Description:
Get an existing actor.

Parameters:

Name	Type	Description
actor_name	string	Name of the actor.

Return:

Actor (by reference): Requested actor.

createViewport

Description:
Create a viewport.

Parameters:

Name	Type	Description
name	string	Name of the viewport.
z_order	integer	Z order of the viewport.
camera_name	string	Name of the camera to be used initially to render the viewport.

Return:

Boolean: true in case of success; false otherwise.

removeViewport

Description:
Remove a viewport.

Parameters:

Name	Type	Description
name	string	Name of the viewport.

Return:

Boolean: true in case of success; false otherwise.

getViewport

Description:
Get an existing viewport.

Parameters:

Name	Type	Description
viewport_name	string	Name of the viewport.

Return:

Viewport (by reference): Requested viewport.

createCamera

Description:
Create a camera.

Parameters:

Name	Type	Description
name	string	Name of the camera.

Return:

Boolean: true in case of success; false otherwise.

removeCamera

Description:
Remove a camera.

Parameters:

Name	Type	Description
name	string	Name of the camera.

Return:

Boolean: true in case of success; false otherwise.

getCamera

Description:
Get an existing camera.

Parameters:

Name	Type	Description
camera_name	string	Name of the camera.

Return:

Camera (by reference): Requested camera.

SceneNode

Return to top.

Description:
A scene node.

constructor

Description:
SceneNode cannot be instanciated by a script.

attachActor

Description:
Attach an actor

Parameters:

Name	Type	Description
actor_name	string	Name of the actor.

Return:

Boolean: true in case of success; false otherwise.

detachActor

Description:
Detach an actor

Parameters:

Name	Type	Description
actor_name	string	Name of the actor.

Return:

Boolean: true in case of success; false otherwise.

attachCamera

Description:
Attach a camera

Parameters:

Name	Type	Description
camera_name	string	Name of the camera.

Return:

Boolean: true in case of success; false otherwise.

detachCamera

Description:
Detach a camera

Parameters:

Name	Type	Description
camera_name	string	Name of the camera.

Return:

Boolean: true in case of success; false otherwise.

createSceneNode

Description:
Create a scene node.

Parameters:

Name	Type	Description
node_name	string	Name of the node.

Return:

Boolean: true in case of success; false otherwise.

removeSceneNode

Description:
Remove a scene node.

Parameters:

Name	Type	Description
node_name	string	Name of the node.

Return:

Boolean: true in case of success; false otherwise.

getSceneNode

Description:
Get an existing scene node.

Parameters:

Name	Type	Description
node_name	string	Name of the scene node.

Return:

SceneNode (by reference): Requested scene node.

getPosition

Description:
Get the position of the scene node.

Parameters: none.
Return:

Vector3 (by value): Current value of the position.

setPosition

Description:
Set the position of the scene node.

Parameters:

Name	Type	Description
position	Vector3	New falue for the position of the scene node.

Return:

None

move

Description:
Move.

Parameters:

Name	Type	Description
offset	Vector3	Movement offset.

Return:

None

getOrientation

Description:
Get the orientation of the scene node.

Parameters: none.
Return:

Quaternion (by value): Current value of the orientation.

setOrientation

Description:
Set the orientation of the scene node.

Parameters:

Name	Type	Description
orientation	Quaternion	New falue for the orientation of the scene node.

Return:

None

roll

Description:
Rotate around the z-axis.

Parameters:

Name	Type	Description
angle	float	Rotation angle in degrees.

Return:

None

yaw

Description:
Rotate around the x-axis.

Parameters:

Name	Type	Description
angle	float	Rotation angle in degrees.

Return:

None

pitch

Description:
Rotate around the y-axis.

Parameters:

Name	Type	Description
angle	float	Rotation angle in degrees.

Return:

None

Actor

Return to top.

Description:
An actor.

constructor

Description:
Actor cannot be instanciated by a script.

getName

Description:
Get the name of the actor.

Parameters: none.
Return:

String: Current value of the name of the actor.

getScale

Description:
Get the scale of the actor.

Parameters: none.
Return:

Vector3 (by value): Current value of the scale.

setScale

Description:
Set the scale of the actor.

Parameters:

Name	Type	Description
scale	Vector3	New falue for the scale of the actor.

Return:

None

setModel

Description:
Set the model.

Parameters:

Name	Type	Description
model	string	Name of the model to use.

Return:

Boolean: true in case of success; false otherwise.

getPhysicsState

Description:
Get the physics state of the actor.

Parameters: none.
Return:

Boolean: Current value of the physics state of the actor.

getPhysicsMass

Description:
Get the physics mass of the actor.

Parameters: none.
Return:

Float: Current value of the physics mass of the actor.

setPhysicsProperties

Description:
Set the physics properties.

Parameters:

Name	Type	Description
state	bool	Physics state (true to enable physics on actor, false otherwise).
mass	float	Physics mass of the actor.

Return:

None

Viewport

Return to top.

Description:
A viewport.

constructor

Description:
Viewport cannot be instanciated by a script.

getName

Description:
Get the name of the viewport.

Parameters: none.
Return:

String: Current value of the name of the viewport.

getLeft

Description:
Get the left position of the viewport.

Parameters: none.
Return:

Float: Current value of the left position of the viewport.

getTop

Description:
Get the top position of the viewport.

Parameters: none.
Return:

Float: Current value of the top position of the viewport.

setPosition

Description:
Set the position.

Parameters:

Name	Type	Description
top	float	Top position of the viewport on the rendering window (between 0.0 and 1.0).
left	float	Left position of the viewport on the rendering window (between 0.0 and 1.0).

Return:

None

getWidth

Description:
Get the width of the viewport.

Parameters: none.
Return:

Float: Current value of the width of the viewport.

getHeight

Description:
Get the height of the viewport.

Parameters: none.
Return:

Float: Current value of the height of the viewport.

setSize

Description:
Set the size.

Parameters:

Name	Type	Description
width	float	Width of the viewport on the rendering window (between 0.0 and 1.0).
height	float	Height of the viewport on the rendering window (between 0.0 and 1.0).

Return:

None

setBackgroundColor

Description:
Set the background color.

Parameters:

Name	Type	Description
red	float	Red component of the background color (between 0.0 and 1.0).
green	float	Green component of the background color (between 0.0 and 1.0).
blue	float	Blue component of the background color (between 0.0 and 1.0).

Return:

None

setCamera

Description:
Set the camera.

Parameters:

Name	Type	Description
camera_name	string	Name of the camera.

Return:

None

Camera

Return to top.

Description:
A camera.

constructor

Description:
Camera cannot be instanciated by a script.

getName

Description:
Get the name of the camera.

Parameters: none.
Return:

String: Current value of the name of the camera.

getNearClipDistance

Description:
Get the near clip distance of the camera.

Parameters: none.
Return:

Float: Current value of the near clip distance of the camera.

setNearClipDistance

Description:
Set the near clip distance of the camera.

Parameters:

Name	Type	Description
distance	float	New falue for the near clip distance of the camera.

Return:

None

getFarClipDistance

Description:
Get the far clip distance of the camera.

Parameters: none.
Return:

Float: Current value of the far clip distance of the camera.

setFarClipDistance

Description:
Set the far clip distance of the camera.

Parameters:

Name	Type	Description
distance	float	New falue for the far clip distance of the camera.

Return:

None

getAspectRatio

Description:
Get the aspect ratio of the camera.

Parameters: none.
Return:

Float: Current value of the aspect ratio of the camera.

setAspectRatio

Description:
Set the aspect ratio of the camera.

Parameters:

Name	Type	Description
aspect_ratio	float	New falue for the aspect ratio of the camera.

Return:

None

getVerticalFOV

Description:
Get the vertical field-of-view (in degrees) of the camera.

Parameters: none.
Return:

Float: Current value of the vertical field-of-view (in degrees) of the camera.

setVerticalFOV

Description:
Set the vertical field-of-view (in degrees) of the camera.

Parameters:

Name	Type	Description
fov	float	New falue for the vertical field-of-view (in degrees) of the camera.

Return:

None

getPhysicsState

Description:
Get the physics state of the camera.

Parameters: none.
Return:

Boolean: Current value of the physics state of the camera.

getPhysicsMass

Description:
Get the physics mass of the camera.

Parameters: none.
Return:

Float: Current value of the physics mass of the camera.

getPhysicsRadius

Description:
Get the physics radius (in meters) of the camera.

Parameters: none.
Return:

Float: Current value of the physics radius (in meters) of the camera.

setPhysicsProperties

Description:
Set the physics properties.

Parameters:

Name	Type	Description
state	bool	Physics state (true to enable physics on actor, false otherwise).
mass	float	Physics mass of the camera.
radius	float	Physics radius of the camera (in meters).

Return:

None