Plasma Engine  2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
plConstructorFunctionProperty< CLASS, Args > Class Template Reference
Inheritance diagram for plConstructorFunctionProperty< CLASS, Args >:
Inheritance graph
[legend]

Public Member Functions

virtual plFunctionType::Enum GetFunctionType () const override
 Returns the type of function, see plFunctionPropertyType::Enum.
 
template<std::size_t... I>
void ExecuteImpl (plTraitInt< 1 >, plVariant &out_returnValue, plArrayPtr< plVariant > arguments, std::index_sequence< I... >) const
 
template<std::size_t... I>
void ExecuteImpl (plTraitInt< 0 >, plVariant &out_returnValue, plArrayPtr< plVariant > arguments, std::index_sequence< I... >) const
 
virtual void Execute (void *pInstance, plArrayPtr< plVariant > arguments, plVariant &out_returnValue) const override
 Calls the function. Provide the instance on which the function is supposed to be called.
 
- Public Member Functions inherited from plTypedFunctionProperty< CLASS *, Args... >
 plTypedFunctionProperty (const char *szPropertyName)
 
virtual const plRTTI * GetReturnType () const override
 Returns the type of the return value.
 
virtual plBitflags< plPropertyFlags > GetReturnFlags () const override
 Returns property flags of the return value.
 
virtual plUInt32 GetArgumentCount () const override
 Returns the number of arguments.
 
const plRTTI * GetParameterTypeImpl (plUInt32 uiParamIndex, std::index_sequence< I... >) const
 
virtual const plRTTI * GetArgumentType (plUInt32 uiParamIndex) const override
 Returns the type of the given argument.
 
plBitflags< plPropertyFlags > GetParameterFlagsImpl (plUInt32 uiParamIndex, std::index_sequence< I... >) const
 
virtual plBitflags< plPropertyFlags > GetArgumentFlags (plUInt32 uiParamIndex) const override
 Returns the property flags of the given argument.
 
- Public Member Functions inherited from plAbstractFunctionProperty
 plAbstractFunctionProperty (const char *szPropertyName)
 Passes the property name through to plAbstractProperty.
 
virtual plPropertyCategory::Enum GetCategory () const override
 Returns the category of this property. Cast this property to the next higher type for more information.
 
virtual const plRTTI * GetSpecificType () const override
 Returns the type information of the constant property. Use this to cast this property to a specific version of plTypedConstantProperty.
 
plAbstractFunctionProperty * AddFlags (plBitflags< plPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
plAbstractFunctionProperty * AddAttributes (plPropertyAttribute *pAttrib1, plPropertyAttribute *pAttrib2=nullptr, plPropertyAttribute *pAttrib3=nullptr, plPropertyAttribute *pAttrib4=nullptr, plPropertyAttribute *pAttrib5=nullptr, plPropertyAttribute *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 plAbstractProperty
 plAbstractProperty (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 plBitflags< plPropertyFlags > & GetFlags () const
 Returns the flags of the property.
 
plAbstractProperty * AddFlags (plBitflags< plPropertyFlags > flags)
 Adds flags to the property. Returns itself to allow to be called during initialization.
 
plAbstractProperty * AddAttributes (plPropertyAttribute *pAttrib1, plPropertyAttribute *pAttrib2=nullptr, plPropertyAttribute *pAttrib3=nullptr, plPropertyAttribute *pAttrib4=nullptr, plPropertyAttribute *pAttrib5=nullptr, plPropertyAttribute *pAttrib6=nullptr)
 Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
 
plArrayPtr< const plPropertyAttribute *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 plAbstractProperty
plBitflags< plPropertyFlags > m_Flags
 
const char * m_szPropertyName
 
plHybridArray< const plPropertyAttribute *, 2, plStaticsAllocatorWrapper > m_Attributes
 

Member Function Documentation

◆ Execute()

template<class CLASS , class... Args>
virtual void plConstructorFunctionProperty< CLASS, Args >::Execute ( void * pInstance,
plArrayPtr< plVariant > arguments,
plVariant & out_returnValue ) const
inlineoverridevirtual

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 plEnum / plBitflags is used, value must be provided as plInt64. 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 plVariant, in which case it is impossible to pass along a nullptr.

Implements plAbstractFunctionProperty.

◆ GetFunctionType()

template<class CLASS , class... Args>
virtual plFunctionType::Enum plConstructorFunctionProperty< CLASS, Args >::GetFunctionType ( ) const
inlineoverridevirtual

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

Implements plAbstractFunctionProperty.

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