sf::ScriptGlobalObject Class Reference

Base class for a script to implementing. More...

#include <ScriptGlobalObject.h>

Inheritance diagram for sf::ScriptGlobalObject:

Collaboration diagram for sf::ScriptGlobalObject:

Public Member Functions
	ScriptGlobalObject (const Parameters &)
const IdInfo *	getInfo (const std::string &name) const override
	Must be overloaded for member namespace.
bool	getSetValue (const IdInfo *info, Value *value, Value::vector_type *params, bool flag_set) override
	Gets or sets the passed data member. Must be overloaded in derived 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.
virtual std::string	getStatusText ()
	Gets the status text of this object for debugging purposes.
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.

Protected Member Functions
void	destroyObject (bool &should_delete) override
	Asks if the object should be deleted after having made this call.
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.

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.

Detailed Description

Base class for a script to implementing.

Constructor & Destructor Documentation

ScriptGlobalObject()

sf::ScriptGlobalObject::ScriptGlobalObject ( const Parameters &  )

explicit

Member Function Documentation

destroyObject()

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

overrideprotectedvirtual

Asks if the object should be deleted after having made this call.

Implements sf::ScriptObject.

getInfo()

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

overridevirtual

Must be overloaded for member namespace.

Implements sf::ScriptObject.

getSetValue()

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

overridevirtual

Gets or sets the passed data member. Must be overloaded in derived class.

Implements sf::ScriptObject.

---

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

• ScriptGlobalObject.h