This page has been translated automatically.
Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Bounds-Related Classes
Containers
Controls-Related Classes
Core Library
Engine-Related Classes
GUI-Related Classes
Node-Related Classes
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

FunctionBase Class

Function base class.

To use this class, include the UnigineFunction.h file.

Unigine::FunctionBase Class

Members


FunctionBase ()

Default constructor.

virtual ~FunctionBase ()

Virtual destructor.

void setName (const Variable & n)

Sets the function name.

Arguments

  • const Variable & n - Function name.

const Variable & getName () const

Returns the function name.

Return value

Function name.

Variable runSystem () const

Runs the system script function.

Return value

System script function return value.

Variable runWorld () const

Runs the world script function.

Return value

World script function return value.

Variable runEditor () const

Runs the editor script function.

Return value

Editor script function return value.

virtual int getNumArgs () const =0

Returns the number of arguments.

Return value

Number of arguments.

void setArg (int num, const Variable & a)

Sets an argument value.

Arguments

  • int num - Argument number.
  • const Variable & a - Argument value.

const Variable & getArg (int num)

Gets the argument value.

Arguments

  • int num - Argument number.

Return value

Argument value.
Last update: 2017-07-03
Build: ()