Plasma Engine  2.0
Loading...
Searching...
No Matches
plScriptFunctionProperty Class Reference
Inheritance diagram for plScriptFunctionProperty:

Public Member Functions

 plScriptFunctionProperty (plStringView sName)
 
- 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 plFunctionType::Enum GetFunctionType () const =0
 Returns the type of function, see plFunctionPropertyType::Enum.
 
virtual const plRTTI * GetReturnType () const =0
 Returns the type of the return value.
 
virtual plBitflags< plPropertyFlags > GetReturnFlags () const =0
 Returns property flags of the return value.
 
virtual plUInt32 GetArgumentCount () const =0
 Returns the number of arguments.
 
virtual const plRTTI * GetArgumentType (plUInt32 uiParamIndex) const =0
 Returns the type of the given argument.
 
virtual plBitflags< plPropertyFlags > GetArgumentFlags (plUInt32 uiParamIndex) const =0
 Returns the property flags of the given argument.
 
virtual void Execute (void *pInstance, plArrayPtr< plVariant > arguments, plVariant &out_returnValue) const =0
 Calls the function. Provide the instance on which the function is supposed to be called.
 
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
 

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