scripting Namespace Reference

Namespaces
namespace	events
	All script events are raised through functions here.

Classes
class	PhasorScript
struct	ScriptInfo
class	Scripts
class	CheckedScriptReference
	Inherit this class if you plan on storing any script states, it can be used to determine if they're still valid. More...
class	PhasorCaller

Typedefs
typedef Manager::Result	Result
typedef std::array < Common::obj_type, 5 >	results_t

Enumerations
enum	e_ident_bool_empty { kIdentSet = 0, kBoolSet, kEmptySet }

Functions
void	AddPlayerArg (const halo::s_player *player, PhasorCaller &caller)
void	AddArgIdent (const halo::ident id, PhasorCaller &caller)
template<>
bool	HandleResult< bool > (Result &result, const bool &default_value)
e_ident_bool_empty	HandleResultIdentOrBool (Result &result, halo::ident &id, bool &b)
template<class T >
T	HandleResult (Result &result, const T &default_value)
bool	CheckCompatibility (const DWORD *table, size_t n, DWORD version)

Variables
const std::wstring	log_prefix = L" "

Typedef Documentation

typedef Manager::Result scripting::Result

typedef std::array<Common::obj_type, 5> scripting::results_t

Enumeration Type Documentation

enum scripting::e_ident_bool_empty

Enumerator
kIdentSet
kBoolSet
kEmptySet

Function Documentation

void scripting::AddArgIdent	(	const halo::ident	id,
		PhasorCaller &	caller
	)

void scripting::AddPlayerArg	(	const halo::s_player *	player,
		PhasorCaller &	caller
	)

Todo:

make something so that scripts can return different types of data

  will be useful for OnServerChat where they can return the new string.
  either that or make a new function for OnServerChat which sets
  its return value. Also need be think about how this should interact with
  other scripts.

bool scripting::CheckCompatibility	(	const DWORD *	table,
		size_t	n,
		DWORD	version
	)

template<class T >

T scripting::HandleResult	(	Result &	result,
		const T &	default_value
	)

template<>

bool scripting::HandleResult< bool >	(	Result &	result,
		const bool &	default_value
	)

e_ident_bool_empty scripting::HandleResultIdentOrBool	(	Result &	result,
		halo::ident &	id,
		bool &	b
	)

Variable Documentation

const std::wstring scripting::log_prefix = L" "