class MethodReg
Defined in:
The C4Methods.h
MethodReg
class represents a custom script method type.
Definition
template <class classType> class MethodReg : public MethodRegistration
Template Parameters
classType |
The custom method class. |
Constructor
MethodReg(MethodType type, const char *name, uint32 flags = 0, MethodGroup group = 0);
Parameters
type |
The method type. |
name |
The method name. |
flags |
The method flags. See below for possible values. |
group |
The group to which the method belongs. This should be 0 for all custom methods. |
Description
The MethodReg
template class is used to advertise the existence of a custom script method type. The World Manager uses a method registration to construct a custom method, and the Script Editor displays a list of registered methods. The act of instantiating a MethodReg
object automatically registers the corresponding method type. The method type is unregistered when the MethodReg
object is destroyed.The
flags
parameter specifies special properties of the method type and can be a combination (through logical OR) of the following constants.
kMethodNoTarget |
The method does not operate on a target node. This flag prevents a target node from being assigned in the Script Editor. |
kMethodNoSelfTarget |
The method cannot operate on the node to which its script controller is attached. This flag prevents the controller target from being selected as the target node in the Script Editor. |
kMethodNoMessage |
The method does not generate any controller messages. This flag prevents a generic controller from being assigned to the target node in the Script Editor. |
kMethodOutputValue |
The method generates an output value that can be stored in a script variable. This flag allows an output variable to be assigned in the Script Editor. |
Base Classes
MethodRegistration |
All specific method registration classes share the common base class MethodRegistration .
|
See Also