sf::VariableScriptObject Class Reference

Script object for exporting GII parameters to a script object. More...

#include <VariableScriptObject.h>

Inheritance diagram for sf::VariableScriptObject:

Collaboration diagram for sf::VariableScriptObject:

Public Member Functions
	VariableScriptObject (const Parameters &params)
	Interface constructor for setting up variable as server or client.
	VariableScriptObject (ScriptObject *parent, Variable *var)
	Constructor for not using the interface to create it. Does not do any of the event handling but only for accessing the information.
	~VariableScriptObject () override
	Overridden from base class.
std::string	getStatusText () override
	Overridden from base class.
const IdInfo *	getInfo (const std::string &name) const override
	Overridden from base class.
void	destroyObject (bool &should_delete) override
	Overridden from base class.
bool	getSetValue (const IdInfo *info, Value *value, Value::vector_type *params, bool flag_set) override
	Overridden from base class.
Public Member Functions inherited from sf::ScriptObject
	ScriptObject (const char *type_name, ScriptObject *parent=nullptr)
virtual	~ScriptObject ()=default
	Virtual destructor which can be overloaded to clean up objects.
int	getRefCount () const
	Gets the reference count.
	operator Value () const
	Cast operator to be able to return this instance as a Value.
std::string	getTypeName () const
	Returns the type name Set at the constructor.
ScriptObject *	getParent ()
	Gets the script object owner.
const ScriptObject *	getParent () const
	Gets the script object owner.
ScriptObject *	castToObject (const Value &value)
	Casts a sf::Value::vitCustom typed sf::Value to a ScriptObject typed pointer.

Additional Inherited Members
Public Types inherited from sf::ScriptObject
enum	EIdentifier {   idUnknown = 0 , idConstant , idVariable , idFunction ,   idTypedef , idKeyword }
	Keyword identifiers. More...
typedef std::string::size_type	pos_type
	Source position type.
typedef ssize_t	ip_type
	Instruction pointer type.
Static Public Member Functions inherited from sf::ScriptObject
static const IdInfo *	getInfoUnknown ()
	Returns the static Info structure for unknowns.
Protected Member Functions inherited from sf::ScriptObject
void	makeParent (ScriptObject *so)
	Makes this object the owner of the other object.
void	setParent (ScriptObject *parent)
	Sets the owner to the pass script object.

Detailed Description

Script object for exporting GII parameters to a script object.

Constructor & Destructor Documentation

VariableScriptObject() [1/2]

sf::VariableScriptObject::VariableScriptObject ( const Parameters &  params )

explicit

Interface constructor for setting up variable as server or client.

VariableScriptObject() [2/2]

sf::VariableScriptObject::VariableScriptObject ( ScriptObject *  parent, Variable *  var  )

explicit

Constructor for not using the interface to create it. Does not do any of the event handling but only for accessing the information.

Parameters

parent	Parent of the object.
var	Non-owned variable to service.

~VariableScriptObject()

sf::VariableScriptObject::~VariableScriptObject ( )

override

Overridden from base class.

Member Function Documentation

destroyObject()

void sf::VariableScriptObject::destroyObject ( bool &  should_delete )

overridevirtual

Overridden from base class.

Implements sf::ScriptObject.

getInfo()

const IdInfo * sf::VariableScriptObject::getInfo ( const std::string &  name ) const

overridevirtual

Overridden from base class.

Implements sf::ScriptObject.

getSetValue()

bool sf::VariableScriptObject::getSetValue ( const IdInfo *  info, Value *  value, Value::vector_type *  params, bool  flag_set  )

overridevirtual

Overridden from base class.

Implements sf::ScriptObject.

getStatusText()

std::string sf::VariableScriptObject::getStatusText ( )

overridevirtual

Overridden from base class.

Reimplemented from sf::ScriptObject.

---

The documentation for this class was generated from the following file:

• VariableScriptObject.h