GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | List of all members

Contains user-friendly information about an effect. More...

#include <EffectMetadata.h>

Public Member Functions

 EffectMetadata (const gd::String &type_)
 Construct an effect metadata, with the given type.
 
 EffectMetadata ()
 Default constructor, only used for initializing badEffectMetadata.
 
EffectMetadataSetFullName (const gd::String &fullname_)
 Set the name shown to the user.
 
EffectMetadataSetDescription (const gd::String &description_)
 Set the description shown to the user.
 
EffectMetadataSetHelpPath (const gd::String &path)
 
EffectMetadataSetIncludeFile (const gd::String &includeFile)
 Clear any existing include file and add the specified include file.
 
EffectMetadataAddIncludeFile (const gd::String &includeFile)
 Add a file to the already existing include files.
 
std::map< gd::String,
gd::PropertyDescriptor > & 
GetProperties ()
 Return a reference to the properties of this effect.
 
const std::map< gd::String,
gd::PropertyDescriptor > & 
GetProperties () const
 Return a (const) reference to the properties of this effect.
 
const gd::StringGetHelpPath () const
 Get the help path of the effect, relative to the documentation root.
 
const gd::StringGetType () const
 Get the type of the effect (its internal name, like "BlackAndWhite").
 
const gd::StringGetFullName () const
 Get the user facing name of the effect (like "Black and White").
 
const gd::StringGetDescription () const
 Get the user friendly description of the effect.
 
const std::vector< gd::String > & GetIncludeFiles () const
 Get the required include files for this effect.
 

Detailed Description

Contains user-friendly information about an effect.

Member Function Documentation

EffectMetadata& gd::EffectMetadata::SetHelpPath ( const gd::String path)
inline

Set the help path of the effect, relative to the documentation root.


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