^AngelScript^ Documents game functions which scripts can invoke to control it. More...

Collaboration diagram for Script-to-game:

Namespaces
	Script2Game
	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.

	ScriptValueTypes
	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.

	AngelOgre
	OGRE-AngelScript bindings; Actually named `Ogre` in the scripts, just changed for docs to separate things.

Data Structures
struct	ScriptValueTypes::color
	Binding of Ogre::ColourValue. More...

struct	ScriptValueTypes::degree
	Binding of Ogre::Degree. More...

struct	ScriptValueTypes::quaternion
	Binding of Ogre::Quaternion. More...

struct	ScriptValueTypes::radian
	Binding of Ogre::Radian. More...

struct	ScriptValueTypes::vector2
	Binding of Ogre::Vector2. More...

struct	ScriptValueTypes::vector3
	Binding of Ogre::Vector3. More...

class	AngelOgre::AnimationState
	Represents a single named skeletal animation track present in the mesh. More...

class	AngelOgre::AnimationStateSet
	A manager for skeletal animation tracks in the entity. More...

class	AngelOgre::Entity
	Defines an instance of a discrete, movable object based on a Mesh. More...

class	AngelOgre::MovableObject
	Abstract class defining a movable object in a scene. More...

class	AngelOgre::Node

class	AngelOgre::SceneNode
	Class representing a node in the scene graph. More...

class	AngelOgre::Root
	a singleton - use `Ogre::Root::getSingleton()` to retrieve instance. More...

class	AngelOgre::SceneManager
	Encapsulates everything renderable by OGRE - use `game.getSceneManager()` to get it. More...

class	AngelOgre::TextureManager
	a singleton - use `Ogre::TextureManager::getSingleton()` to retrieve instance. More...

class	AngelOgre::TexturePtr

class	Script2Game::BeamClass
	Binding of RoR::Actor; a softbody-physics gameplay object, can be anything from soda can to space shuttle. More...

class	Script2Game::ConsoleClass
	Binding of RoR::Console; provides console variables (cvars), usually defined in RoR.cfg file. More...

class	Script2Game::CVarClass
	Binding of RoR::CVar; A console variable, usually defined in RoR.cfg but also created by users or scripts. More...

class	Script2Game::GameScriptClass
	Binding of RoR::GameScript; A general class that will provide you with general functions. More...

class	Script2Game::GenericDocContextClass
	Binding of RoR::GenericDocContext; Traverses document tokens; See 'demo_script.as' for an example. More...

class	Script2Game::GenericDocumentClass
	Binding of RoR::GenericDocument; Parses TRUCK/TOBJ/ODEF/CHARACTER file formats. More...

class	Script2Game::InputEngineClass
	Binding of RoR::InputEngine; Manages input devices, their configuration (input.map ...) and state. More...

class	Script2Game::LocalStorageClass
	Binding of RoR::LocalStorage; A class that allows your script to store data persistently. More...

class	Script2Game::ProceduralManagerClass
	Binding of RoR::ProceduralManager; generates dynamic roads for terrain. More...

class	Script2Game::ProceduralObjectClass
	Binding of RoR::ProceduralObject; a spline for generating dynamic roads. More...

class	Script2Game::ProceduralPointClass
	Binding of RoR::ProceduralPoint;. More...

class	Script2Game::ProceduralRoadClass
	Binding of RoR::ProceduralRoad; a dynamically generated road mesh. More...

class	Script2Game::SoundClass
	Binding of RoR::Sound; a single sound sample positioned in 3D space (spatial audio). More...

class	Script2Game::SoundScriptInstanceClass
	Binding of RoR::SoundScriptInstance; instance of SoundScriptTemplateClass. More...

class	Script2Game::SoundScriptTemplateClass
	Binding of RoR::SoundScriptTemplate; a customizable sound effect. More...

class	Script2Game::TerrainClass
	Binding of RoR::Terrain; represents a loaded terrain. More...

class	Script2Game::VehicleAIClass
	Binding of RoR::VehicleAI; Vehicle driving AI using waypoints. More...

Enumerations
enum	Script2Game::CVarFlags { Script2Game::CVAR_TYPE_BOOL = BITMASK(1), Script2Game::CVAR_TYPE_INT = BITMASK(2), Script2Game::CVAR_TYPE_FLOAT = BITMASK(3), Script2Game::CVAR_ARCHIVE = BITMASK(4), Script2Game::CVAR_NO_LOG = BITMASK(5) }
	Types and special attributes of cvars. More...

enum	Script2Game::TokenType { Script2Game::TOKEN_TYPE_NONE, Script2Game::TOKEN_TYPE_LINEBREAK, Script2Game::TOKEN_TYPE_COMMENT, Script2Game::TOKEN_TYPE_STRING, Script2Game::TOKEN_TYPE_NUMBER, Script2Game::TOKEN_TYPE_BOOL, Script2Game::TOKEN_TYPE_KEYWORD }

enum	Script2Game::GenericDocumentOptions { Script2Game::GENERIC_DOCUMENT_OPTION_ALLOW_NAKED_STRINGS, Script2Game::GENERIC_DOCUMENT_OPTION_ALLOW_SLASH_COMMENTS, Script2Game::GENERIC_DOCUMENT_OPTION_FIRST_LINE_IS_TITLE, Script2Game::GENERIC_DOCUMENT_OPTION_ALLOW_SEPARATOR_COLON, Script2Game::GENERIC_DOCUMENT_OPTION_PARENTHESES_CAPTURE_SPACES, Script2Game::GENERIC_DOCUMENT_OPTION_ALLOW_BRACED_KEYWORDS, Script2Game::GENERIC_DOCUMENT_OPTION_ALLOW_SEPARATOR_EQUALS, Script2Game::GENERIC_DOCUMENT_OPTION_ALLOW_HASH_COMMENTS }

enum	Script2Game::RoadType { Script2Game::ROAD_AUTOMATIC, Script2Game::ROAD_FLAT, Script2Game::ROAD_LEFT, Script2Game::ROAD_RIGHT, Script2Game::ROAD_BOTH, Script2Game::ROAD_BRIDGE, Script2Game::ROAD_MONORAIL }

enum	Script2Game::TextureFit { Script2Game::TEXFIT_NONE, Script2Game::TEXFIT_BRICKWALL, Script2Game::TEXFIT_ROADS1, Script2Game::TEXFIT_ROADS2, Script2Game::TEXFIT_ROAD, Script2Game::TEXFIT_ROADS3, Script2Game::TEXFIT_ROADS4, Script2Game::TEXFIT_CONCRETEWALL, Script2Game::TEXFIT_CONCRETEWALLI, Script2Game::TEXFIT_CONCRETETOP, Script2Game::TEXFIT_CONCRETEUNDER }

enum	Script2Game::Ai_events { Script2Game::AI_HORN, Script2Game::AI_LIGHTSTOGGLE, Script2Game::AI_WAIT_SECONDS, Script2Game::AI_BEACONSTOGGLE }
	Enum with AI events. More...

enum	Script2Game::Ai_values { Script2Game::AI_SPEED, Script2Game::AI_POWER }
	Enum with AI values that can be set. More...

Functions
struct ScriptValueTypes::quaternion	ScriptValueTypes::Slerp (float, const quaternion &in, const quaternion &in, bool &in)

quaternion	ScriptValueTypes::SlerpExtraSpins (float, const quaternion &in, const quaternion &in, int &in)

void	ScriptValueTypes::Intermediate (const quaternion &in, const quaternion &in, const quaternion &in, const quaternion &in, const quaternion &in)

quaternion	ScriptValueTypes::Squad (float, const quaternion &in, const quaternion &in, const quaternion &in, const quaternion &in, bool &in)

quaternion	ScriptValueTypes::nlerp (float, const quaternion &in, const quaternion &in, bool &in)

Variables
class AngelOgre::AnimationState	AngelOgre::Slerp

Detailed Description

^AngelScript^ Documents game functions which scripts can invoke to control it.

Enumeration Type Documentation

◆ Ai_events

enum Script2Game::Ai_events

Enum with AI events.

Enumerator
AI_HORN
AI_LIGHTSTOGGLE
AI_WAIT_SECONDS
AI_BEACONSTOGGLE

Definition at line 43 of file VehicleAIClass.h.

◆ Ai_values

enum Script2Game::Ai_values

Enum with AI values that can be set.

Enumerator
AI_SPEED
AI_POWER

Definition at line 54 of file VehicleAIClass.h.

◆ CVarFlags

enum Script2Game::CVarFlags

Types and special attributes of cvars.

Note: Default cvar type is string - To create a string cvar, enter '0' as flags.

Enumerator
CVAR_TYPE_BOOL
CVAR_TYPE_INT
CVAR_TYPE_FLOAT
CVAR_ARCHIVE	Will be written to RoR.cfg.
CVAR_NO_LOG	Will not be written to RoR.log.

Definition at line 16 of file CVarClass.h.

◆ GenericDocumentOptions

enum Script2Game::GenericDocumentOptions

Enumerator
GENERIC_DOCUMENT_OPTION_ALLOW_NAKED_STRINGS	Allow strings without quotes, for backwards compatibility.
GENERIC_DOCUMENT_OPTION_ALLOW_SLASH_COMMENTS	Allow comments starting with `//`.
GENERIC_DOCUMENT_OPTION_FIRST_LINE_IS_TITLE	First non-empty & non-comment line is a naked string with spaces.
GENERIC_DOCUMENT_OPTION_ALLOW_SEPARATOR_COLON	Allow ':' as separator between tokens.
GENERIC_DOCUMENT_OPTION_PARENTHESES_CAPTURE_SPACES	If non-empty NAKED string encounters '(', following spaces will be captured until matching ')' is found.
GENERIC_DOCUMENT_OPTION_ALLOW_BRACED_KEYWORDS	Allow INI-like '[keyword]' tokens.
GENERIC_DOCUMENT_OPTION_ALLOW_SEPARATOR_EQUALS	Allow '=' as separator between tokens.
GENERIC_DOCUMENT_OPTION_ALLOW_HASH_COMMENTS	Allow comments starting with `#`.

Definition at line 11 of file GenericDocumentClass.h.

◆ RoadType

enum Script2Game::RoadType

Enumerator
ROAD_AUTOMATIC
ROAD_FLAT
ROAD_LEFT
ROAD_RIGHT
ROAD_BOTH
ROAD_BRIDGE
ROAD_MONORAIL

Definition at line 12 of file ProceduralRoadClass.h.

◆ TextureFit

enum Script2Game::TextureFit

Enumerator
TEXFIT_NONE
TEXFIT_BRICKWALL
TEXFIT_ROADS1
TEXFIT_ROADS2
TEXFIT_ROAD
TEXFIT_ROADS3
TEXFIT_ROADS4
TEXFIT_CONCRETEWALL
TEXFIT_CONCRETEWALLI
TEXFIT_CONCRETETOP
TEXFIT_CONCRETEUNDER

Definition at line 23 of file ProceduralRoadClass.h.

◆ TokenType

enum Script2Game::TokenType

Enumerator
TOKEN_TYPE_NONE
TOKEN_TYPE_LINEBREAK
TOKEN_TYPE_COMMENT
TOKEN_TYPE_STRING
TOKEN_TYPE_NUMBER
TOKEN_TYPE_BOOL
TOKEN_TYPE_KEYWORD

Definition at line 11 of file GenericDocContextClass.h.

Function Documentation

◆ Intermediate()

void ScriptValueTypes::Intermediate	(	const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in
	)

Here is the caller graph for this function:

◆ nlerp()

quaternion ScriptValueTypes::nlerp	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		bool &	in
	)

Here is the caller graph for this function:

◆ Slerp()

struct ScriptValueTypes::quaternion ScriptValueTypes::Slerp	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		bool &	in
	)

◆ SlerpExtraSpins()

quaternion ScriptValueTypes::SlerpExtraSpins	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		int &	in
	)

Here is the caller graph for this function:

◆ Squad()

quaternion ScriptValueTypes::Squad	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		bool &	in
	)

Here is the caller graph for this function:

Variable Documentation

◆ Slerp

class AngelOgre::AnimationState AngelOgre::Slerp

Namespaces

Data Structures

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ Ai_events

◆ Ai_values

◆ CVarFlags

◆ GenericDocumentOptions

◆ RoadType

◆ TextureFit

◆ TokenType

Function Documentation

◆ Intermediate()

◆ nlerp()

◆ Slerp()

◆ SlerpExtraSpins()

◆ Squad()

Variable Documentation

◆ Slerp