ezEngine  Milestone 9
ezAbstractFunctionProperty Class Referenceabstract

The base class for a property that represents a function. More...

#include <AbstractProperty.h>

Inheritance diagram for ezAbstractFunctionProperty:

Public Member Functions

 ezAbstractFunctionProperty (const char *szPropertyName)
 Passes the property name through to ezAbstractProperty.
 
virtual ezPropertyCategory::Enum GetCategory () const override
 Returns the category of this property. Cast this property to the next higher type for more information.
 
virtual ezFunctionType::Enum GetFunctionType () const =0
 Returns the type of function, see ezFunctionPropertyType::Enum.
 
virtual const ezRTTIGetReturnType () const =0
 Returns the type of the return value.
 
virtual ezBitflags< ezPropertyFlagsGetReturnFlags () const =0
 Returns property flags of the return value.
 
virtual ezUInt32 GetArgumentCount () const =0
 Returns the number of arguments.
 
virtual const ezRTTIGetArgumentType (ezUInt32 uiParamIndex) const =0
 Returns the type of the given argument.
 
virtual ezBitflags< ezPropertyFlagsGetArgumentFlags (ezUInt32 uiParamIndex) const =0
 Returns the property flags of the given argument.
 
virtual void Execute (void *pInstance, ezArrayPtr< ezVariant > arguments, ezVariant &returnValue) const =0
 Calls the function. Provide the instance on which the function is supposed to be called. More...
 
virtual const ezRTTIGetSpecificType () const override
 Returns the type information of the constant property. Use this to cast this property to a specific version of ezTypedConstantProperty.
 
- Public Member Functions inherited from ezAbstractProperty
 ezAbstractProperty (const char *szPropertyName)
 The constructor must get the name of the property. The string must be a compile-time constant.
 
const char * GetPropertyName () const
 Returns the name of the property.
 
const ezBitflags< ezPropertyFlags > & GetFlags () const
 Returns the flags of the property.
 
ezAbstractPropertyAddFlags (ezBitflags< ezPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
ezAbstractPropertyAddAttributes (ezPropertyAttribute *pAttrib1, ezPropertyAttribute *pAttrib2=nullptr, ezPropertyAttribute *pAttrib3=nullptr, ezPropertyAttribute *pAttrib4=nullptr, ezPropertyAttribute *pAttrib5=nullptr, ezPropertyAttribute *pAttrib6=nullptr)
 Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
 
const ezArrayPtr< ezPropertyAttribute *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 ezAbstractProperty
ezBitflags< ezPropertyFlagsm_Flags
 
const char * m_szPropertyName
 
ezHybridArray< ezPropertyAttribute *, 2, ezStaticAllocatorWrapperm_Attributes
 

Detailed Description

The base class for a property that represents a function.

Member Function Documentation

◆ Execute()

virtual void ezAbstractFunctionProperty::Execute ( void *  pInstance,
ezArrayPtr< ezVariant arguments,
ezVariant returnValue 
) const
pure virtual

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 ezEnum / ezBitflags is used, value must be provided as ezInt64. 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 ezVariant, in which case it is impossible to pass along a nullptr.

Implemented in ezConstructorFunctionProperty< CLASS, Args >, ezFunctionProperty< R(*)(Args...)>, ezFunctionProperty< R(CLASS::*)(Args...)>, and ezPhantomFunctionProperty.


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