XII Release 0.1.0
Loading...
Searching...
No Matches
xiiVisualScriptFunctionProperty Class Reference
Inheritance diagram for xiiVisualScriptFunctionProperty:
[legend]

Public Member Functions

 xiiVisualScriptFunctionProperty (xiiStringView sName, const xiiSharedPtr< const xiiVisualScriptGraphDescription > &pDesc)
 
virtual xiiFunctionType::Enum GetFunctionType () const override
 Returns the type of function, see xiiFunctionPropertyType::Enum.
 
virtual const xiiRTTIGetReturnType () const override
 Returns the type of the return value.
 
virtual xiiBitflags< xiiPropertyFlagsGetReturnFlags () const override
 Returns property flags of the return value.
 
virtual xiiUInt32 GetArgumentCount () const override
 Returns the number of arguments.
 
virtual const xiiRTTIGetArgumentType (xiiUInt32 uiParamIndex) const override
 Returns the type of the given argument.
 
virtual xiiBitflags< xiiPropertyFlagsGetArgumentFlags (xiiUInt32 uiParamIndex) const override
 Returns the property flags of the given argument.
 
virtual void Execute (void *pInstance, xiiArrayPtr< xiiVariant > arguments, xiiVariant &out_returnValue) const override
 Calls the function. Provide the instance on which the function is supposed to be called.
 
- Public Member Functions inherited from xiiScriptFunctionProperty
 xiiScriptFunctionProperty (xiiStringView sName)
 
- Public Member Functions inherited from xiiAbstractFunctionProperty
 xiiAbstractFunctionProperty (xiiStringView sPropertyName)
 Passes the property name through to xiiAbstractProperty.
 
virtual xiiPropertyCategory::Enum GetCategory () const override
 Returns the category of this property. Cast this property to the next higher type for more information.
 
virtual const xiiRTTIGetSpecificType () const override
 Returns the type information of the constant property. Use this to cast this property to a specific version of xiiTypedConstantProperty.
 
xiiAbstractFunctionPropertyAddFlags (xiiBitflags< xiiPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
xiiAbstractFunctionPropertyAddAttributes (xiiPropertyAttribute *pAttrib1, xiiPropertyAttribute *pAttrib2=nullptr, xiiPropertyAttribute *pAttrib3=nullptr, xiiPropertyAttribute *pAttrib4=nullptr, xiiPropertyAttribute *pAttrib5=nullptr, xiiPropertyAttribute *pAttrib6=nullptr)
 Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
 
- Public Member Functions inherited from xiiAbstractProperty
 xiiAbstractProperty (xiiStringView sPropertyName)
 The constructor must get the name of the property. The string must be a compile-time constant.
 
xiiStringView GetPropertyName () const
 Returns the name of the property.
 
const xiiBitflags< xiiPropertyFlags > & GetFlags () const
 Returns the flags of the property.
 
xiiAbstractPropertyAddFlags (xiiBitflags< xiiPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
xiiAbstractPropertyAddAttributes (xiiPropertyAttribute *pAttrib1, xiiPropertyAttribute *pAttrib2=nullptr, xiiPropertyAttribute *pAttrib3=nullptr, xiiPropertyAttribute *pAttrib4=nullptr, xiiPropertyAttribute *pAttrib5=nullptr, xiiPropertyAttribute *pAttrib6=nullptr)
 Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
 
xiiArrayPtr< const xiiPropertyAttribute *const > GetAttributes () const
 Returns the array of property attributes.
 
template<typename Type>
const Type * GetAttributeByType () const
 Returns the first attribute that derives from the given type, or nullptr if nothing is found.
 

Additional Inherited Members

- Protected Attributes inherited from xiiAbstractProperty
xiiBitflags< xiiPropertyFlagsm_Flags
 
xiiStringView m_sPropertyName
 
xiiHybridArray< const xiiPropertyAttribute *, 2U, xiiStaticAllocatorWrapperm_Attributes
 

Member Function Documentation

◆ Execute()

void xiiVisualScriptFunctionProperty::Execute ( void * pInstance,
xiiArrayPtr< xiiVariant > arguments,
xiiVariant & out_returnValue ) const
overridevirtual

Calls the function. Provide the instance on which the function is supposed to be called.

arguments must be the size of GetArgumentCount, the following rules apply for both arguments and return value: Any standard type must be provided by value, even if it is a pointer to one. Types must match exactly, no ConvertTo is called. enum and bitflags are supported if xiiEnum / xiiBitflags is used, value must be provided as xiiInt64. Out values (&, *) are written back to the variant they were read from. Any class is provided by pointer, regardless of whether it is a pointer or not. The returnValue must only be valid if the return value is a ref or by value class. In that case returnValue must be a ptr to a valid class instance of the returned type. An invalid variant is equal to a nullptr, except for if the argument is of type xiiVariant, in which case it is impossible to pass along a nullptr.

Implements xiiAbstractFunctionProperty.

◆ GetArgumentCount()

virtual xiiUInt32 xiiVisualScriptFunctionProperty::GetArgumentCount ( ) const
inlineoverridevirtual

Returns the number of arguments.

Implements xiiAbstractFunctionProperty.

◆ GetArgumentFlags()

virtual xiiBitflags< xiiPropertyFlags > xiiVisualScriptFunctionProperty::GetArgumentFlags ( xiiUInt32 uiParamIndex) const
inlineoverridevirtual

Returns the property flags of the given argument.

Implements xiiAbstractFunctionProperty.

◆ GetArgumentType()

virtual const xiiRTTI * xiiVisualScriptFunctionProperty::GetArgumentType ( xiiUInt32 uiParamIndex) const
inlineoverridevirtual

Returns the type of the given argument.

Implements xiiAbstractFunctionProperty.

◆ GetFunctionType()

virtual xiiFunctionType::Enum xiiVisualScriptFunctionProperty::GetFunctionType ( ) const
inlineoverridevirtual

Returns the type of function, see xiiFunctionPropertyType::Enum.

Implements xiiAbstractFunctionProperty.

◆ GetReturnFlags()

virtual xiiBitflags< xiiPropertyFlags > xiiVisualScriptFunctionProperty::GetReturnFlags ( ) const
inlineoverridevirtual

Returns property flags of the return value.

Implements xiiAbstractFunctionProperty.

◆ GetReturnType()

virtual const xiiRTTI * xiiVisualScriptFunctionProperty::GetReturnType ( ) const
inlineoverridevirtual

Returns the type of the return value.

Implements xiiAbstractFunctionProperty.


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