sf::StaticScriptGlobalEntry Class Reference

sf::ScriptGlobalEntry derived class to link static functions or methods. More...

#include <ScriptGlobalEntry.h>

Inheritance diagram for sf::StaticScriptGlobalEntry:

Collaboration diagram for sf::StaticScriptGlobalEntry:

Public Types
typedef Value(*	FunctionType) (const Value::vector_type &arguments)

Public Member Functions
	StaticScriptGlobalEntry (FunctionType func, const std::string &name, const std::string &description, int arg_count)
	StaticScriptGlobalEntry (const StaticScriptGlobalEntry &)=delete
StaticScriptGlobalEntry &	operator= (const StaticScriptGlobalEntry &)=delete
Public Member Functions inherited from sf::ScriptGlobalEntry
	ScriptGlobalEntry (const std::string &name, const std::string &description, int argumentCount)
	Default Constructor adding itself to the global mapped entries.
virtual	~ScriptGlobalEntry ()
	Destructor. Removes itself from the mapped entries.
	ScriptGlobalEntry (const ScriptGlobalEntry &)=delete
	Not allowed to copy.
ScriptGlobalEntry &	operator= (const ScriptGlobalEntry &)=delete
	Not allowed to copy.
std::string	getName () const
	Gets the name of the entry.
void	setDescription (const std::string &description)
	Sets the description of the entry.
std::string	getDescription () const
	Gets the description of the entry.
int	getArgumentCount () const
	Gets the amount of parameters that is needed for this function.

Additional Inherited Members
Static Public Member Functions inherited from sf::ScriptGlobalEntry
static bool	call (const std::string &name, const Value::vector_type &arguments, Value &result)
	Finds the function with name 'name' and returns true when the function was found passing the correct amount of parameters. When found the function is also executed.
static ScriptGlobalEntry *	getEntry (const std::string &name)
	Gets the entry pointer by name.
static string_list	getEntryStringList (bool descriptive)
	Gets a string list containing all available global script functions.
Static Public Attributes inherited from sf::ScriptGlobalEntry
static constexpr size_t	unlimitedArgs = std::numeric_limits<int>::max()
	Unsigned size value indicating not found or no index.
Protected Attributes inherited from sf::ScriptGlobalEntry
std::string	_name
	Holds the name of the entry.
std::string	_description
	Holds description of the entry.
int	_argumentCount {0}
	Holds the number of parameters to pass to the entry.

Detailed Description

sf::ScriptGlobalEntry derived class to link static functions or methods.

Member Typedef Documentation

FunctionType

typedef Value(* sf::StaticScriptGlobalEntry::FunctionType) (const Value::vector_type &arguments)

Constructor & Destructor Documentation

StaticScriptGlobalEntry() [1/2]

sf::StaticScriptGlobalEntry::StaticScriptGlobalEntry	(	FunctionType	func,
		const std::string &	name,
		const std::string &	description,
		int	arg_count )

StaticScriptGlobalEntry() [2/2]

sf::StaticScriptGlobalEntry::StaticScriptGlobalEntry ( const StaticScriptGlobalEntry & )

delete

Member Function Documentation

operator=()

StaticScriptGlobalEntry & sf::StaticScriptGlobalEntry::operator= ( const StaticScriptGlobalEntry & )

delete

---

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

• ScriptGlobalEntry.h