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 | Public Attributes | List of all members

Contains user-friendly information about an object type, and a function to create a new gd::Object of this type. More...

#include <ObjectMetadata.h>

Public Member Functions

 ObjectMetadata (const gd::String &extensionNamespace_, const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &icon24x24_, std::shared_ptr< gd::Object > blueprintObject_)
 Construct an object metadata, using a "blueprint" object that will be copied when a new object is asked.
 
 ObjectMetadata (const gd::String &extensionNamespace_, const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &icon24x24_, CreateFunPtr createFunPtrP)
 Construct an object metadata, with a function that will be called to instanciate a new object.
 
gd::InstructionMetadataAddCondition (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &sentence_, const gd::String &group_, const gd::String &icon_, const gd::String &smallicon_)
 Declare a new condition as being part of the extension. More...
 
gd::InstructionMetadataAddAction (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &sentence_, const gd::String &group_, const gd::String &icon_, const gd::String &smallicon_)
 Declare a new action as being part of the extension. More...
 
gd::ExpressionMetadataAddExpression (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &group_, const gd::String &smallicon_)
 Declare a new expression as being part of the extension. More...
 
gd::ExpressionMetadataAddStrExpression (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &group_, const gd::String &smallicon_)
 Declare a new string expression as being part of the extension. More...
 
ObjectMetadataSetFullName (const gd::String &fullname_)
 Set the name shown to the user. More...
 
ObjectMetadataSetDescription (const gd::String &description_)
 Set the description shown to the user. More...
 
const gd::StringGetHelpPath () const
 
ObjectMetadataSetHelpPath (const gd::String &path)
 
const gd::StringGetName () const
 
const gd::StringGetFullName () const
 
const gd::StringGetHelpUrl () const
 
const gd::StringGetDescription () const
 
const gd::StringGetIconFilename () const
 
ObjectMetadataSetHelpUrl (const gd::String &url)
 Set the URL pointing to the help page about this object. More...
 
ObjectMetadataSetIncludeFile (const gd::String &includeFile)
 Erase any existing include file and add the specified include. More...
 
ObjectMetadataAddIncludeFile (const gd::String &includeFile)
 Add a file to the already existing include files.
 

Public Attributes

std::map< gd::String,
gd::InstructionMetadata
conditionsInfos
 
std::map< gd::String,
gd::InstructionMetadata
actionsInfos
 
std::map< gd::String,
gd::ExpressionMetadata
expressionsInfos
 
std::map< gd::String,
gd::ExpressionMetadata
strExpressionsInfos
 
std::vector< gd::StringincludeFiles
 
gd::String className
 
CreateFunPtr createFunPtr
 

Detailed Description

Contains user-friendly information about an object type, and a function to create a new gd::Object of this type.

Member Function Documentation

gd::InstructionMetadata & gd::ObjectMetadata::AddAction ( const gd::String name_,
const gd::String fullname_,
const gd::String description_,
const gd::String sentence_,
const gd::String group_,
const gd::String icon_,
const gd::String smallicon_ 
)

Declare a new action as being part of the extension.

Note
This method does nothing when used for GD C++ runtime.
gd::InstructionMetadata & gd::ObjectMetadata::AddCondition ( const gd::String name_,
const gd::String fullname_,
const gd::String description_,
const gd::String sentence_,
const gd::String group_,
const gd::String icon_,
const gd::String smallicon_ 
)

Declare a new condition as being part of the extension.

Note
This method does nothing when used for GD C++ runtime.
gd::ExpressionMetadata & gd::ObjectMetadata::AddExpression ( const gd::String name_,
const gd::String fullname_,
const gd::String description_,
const gd::String group_,
const gd::String smallicon_ 
)

Declare a new expression as being part of the extension.

Note
This method does nothing when used for GD C++ runtime.
gd::ExpressionMetadata & gd::ObjectMetadata::AddStrExpression ( const gd::String name_,
const gd::String fullname_,
const gd::String description_,
const gd::String group_,
const gd::String smallicon_ 
)

Declare a new string expression as being part of the extension.

Note
This method does nothing when used for GD C++ runtime.
const gd::String& gd::ObjectMetadata::GetHelpPath ( ) const
inline

Get the help path of the object, relative to the documentation root.

ObjectMetadata & gd::ObjectMetadata::SetDescription ( const gd::String description_)

Set the description shown to the user.

Note
This method does nothing when used for GD C++ runtime.
ObjectMetadata & gd::ObjectMetadata::SetFullName ( const gd::String fullname_)

Set the name shown to the user.

Note
This method does nothing when used for GD C++ runtime.
ObjectMetadata& gd::ObjectMetadata::SetHelpPath ( const gd::String path)
inline

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

The object instructions will have this help path set by default, unless you call SetHelpPath on them.

ObjectMetadata & gd::ObjectMetadata::SetHelpUrl ( const gd::String url)

Set the URL pointing to the help page about this object.

Note
The path to the page must be relative to the wiki url.
Deprecated:
Use SetHelpPath instead
ObjectMetadata & gd::ObjectMetadata::SetIncludeFile ( const gd::String includeFile)

Erase any existing include file and add the specified include.

Note
The requirement may vary depending on the platform: Most of the time, the include file contains the declaration of the object.

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