C4 Engine
C4 Engine API Documentation

class Method

Defined in:  C4Methods.h
The Method class represents an action that can be placed in a script.

class Method : public GraphElement<Method, Fiber>, public Completable<Method>, public Registrable<Method, MethodRegistration>,

public Packable, public Configurable, public Memory<ScriptState>

Member Functions
Method::GetMethodType Returns the method type.
Method::GetTargetNode Returns the target node for a method.
Method::SetMethodResult Sets the boolean result for a method.
Method::SetOutputValue Sets the output value for a method.
Method::ExecuteMethod Executes a script method.
Method::ResumeMethod Resumes a script method after a saved game is loaded.

Method(MethodType type = kMethodNull);

type The method type.
The Method class is the base class for all classes representing an action that can be placed in a script.
Base Classes
GraphElement<Method, Fiber> Methods are stored in a directed graph to make up a script.
Completable<Method> A method calls its completion callback when it finishes executing.
Registrable<Method, MethodRegistration> Custom method types can be registered with the engine.
Packable Methods can be packed for storage in resources.
Configurable Methods can define configurable parameters that are exposed as user interface widgets in the Script Editor.
Memory<ScriptState> Script methods are stored in a dedicated heap.
See Also


Wiki Articles