 |
GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
|
|
GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
|
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. | |
| EffectMetadata & | SetFullName (const gd::String &fullname_) |
| Set the name shown to the user. | |
| EffectMetadata & | SetDescription (const gd::String &description_) |
| Set the description shown to the user. | |
| EffectMetadata & | SetHelpPath (const gd::String &path) |
| EffectMetadata & | SetIncludeFile (const gd::String &includeFile) |
| Clear any existing include file and add the specified include file. More... | |
| EffectMetadata & | AddIncludeFile (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::String & | GetHelpPath () const |
| Get the help path of the effect, relative to the GDevelop documentation root. | |
| const gd::String & | GetType () const |
| Get the type of the effect (its internal name, like "BlackAndWhite"). | |
| const gd::String & | GetFullName () const |
| Get the user facing name of the effect (like "Black and White"). | |
| const gd::String & | GetDescription () const |
| Get the user friendly description of the effect. | |
| const std::vector< gd::String > & | GetIncludeFiles () const |
| Get the required include files for this effect. | |
| EffectMetadata & | MarkAsNotWorkingForObjects () |
| Mark the effect as not working as an object effect. | |
| EffectMetadata & | MarkAsOnlyWorkingFor2D () |
| Mark the effect as only working for the 2D renderer. | |
| EffectMetadata & | MarkAsOnlyWorkingFor3D () |
| Mark the effect as only working for the 3D renderer. | |
| EffectMetadata & | MarkAsUnique () |
| Mark the effect as only addable once. | |
| bool | IsMarkedAsNotWorkingForObjects () const |
| Check if the effect is marked as not working as an object effect. | |
| bool | IsMarkedAsOnlyWorkingFor2D () const |
| Check if the effect is marked as only working for the 2D renderer. | |
| bool | IsMarkedAsOnlyWorkingFor3D () const |
| Check if the effect is marked as only working for the 3D renderer. | |
| bool | IsMarkedAsUnique () const |
| Check if the effect can only be added once. | |
Contains user-friendly information about an effect.
|
inline |
Set the help path of the effect, relative to the GDevelop documentation root.
| EffectMetadata & gd::EffectMetadata::SetIncludeFile | ( | const gd::String & | includeFile | ) |
Clear any existing include file and add the specified include file.
AddIncludeFile instead as clearing the list is more error prone. 
1.9.1