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 a behavior type. More...

#include <BehaviorMetadata.h>

Public Member Functions

 BehaviorMetadata (const gd::String &extensionNamespace, const gd::String &name_, const gd::String &fullname_, const gd::String &defaultName_, const gd::String &description_, const gd::String &group_, const gd::String &icon24x24_, const gd::String &className_, std::shared_ptr< gd::Behavior > instance, std::shared_ptr< gd::BehaviorsSharedData > sharedDatasInstance)
 
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_)
 
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_)
 
gd::InstructionMetadataAddScopedCondition (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_)
 
gd::InstructionMetadataAddScopedAction (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_)
 
gd::ExpressionMetadataAddExpression (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &group_, const gd::String &smallicon_)
 
gd::ExpressionMetadataAddStrExpression (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &group_, const gd::String &smallicon_)
 
BehaviorMetadataSetFullName (const gd::String &fullname_)
 
BehaviorMetadataSetDefaultName (const gd::String &defaultName_)
 
BehaviorMetadataSetDescription (const gd::String &description_)
 
BehaviorMetadataSetGroup (const gd::String &group_)
 
BehaviorMetadataSetIncludeFile (const gd::String &includeFile)
 Erase any existing include file and add the specified include. More...
 
BehaviorMetadataAddIncludeFile (const gd::String &includeFile)
 Add a file to the already existing include files.
 
const gd::StringGetHelpPath () const
 
BehaviorMetadataSetHelpPath (const gd::String &path)
 
const gd::StringGetName () const
 
const gd::StringGetFullName () const
 
const gd::StringGetDefaultName () const
 
const gd::StringGetDescription () const
 
const gd::StringGetGroup () const
 
const gd::StringGetIconFilename () const
 
BehaviorMetadataSetObjectType (const gd::String &objectType_)
 Set the type of the object that this behavior can be used on.
 
const gd::StringGetObjectType () const
 Get the type of the object that this behavior can be used on. More...
 
gd::BehaviorGet () const
 Return the associated gd::Behavior, handling behavior contents.
 
gd::BehaviorsSharedDataGetSharedDataInstance () const
 Return the associated gd::BehaviorsSharedData, handling behavior shared data, if any (nullptr if none).
 

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
 

Detailed Description

Contains user-friendly information about a behavior type.

Member Function Documentation

gd::InstructionMetadata & gd::BehaviorMetadata::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 behavior.

Deprecated:
Prefer using AddScopedAction.
gd::InstructionMetadata & gd::BehaviorMetadata::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 behavior.

Deprecated:
Prefer using AddScopedCondition.
gd::ExpressionMetadata & gd::BehaviorMetadata::AddExpression ( const gd::String name_,
const gd::String fullname_,
const gd::String description_,
const gd::String group_,
const gd::String smallicon_ 
)

Declare a new action as being part of the extension.

gd::InstructionMetadata & gd::BehaviorMetadata::AddScopedAction ( 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 behavior.

gd::InstructionMetadata & gd::BehaviorMetadata::AddScopedCondition ( 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 behavior.

gd::ExpressionMetadata & gd::BehaviorMetadata::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.

const gd::String& gd::BehaviorMetadata::GetHelpPath ( ) const
inline

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

const gd::String& gd::BehaviorMetadata::GetObjectType ( ) const
inline

Get the type of the object that this behavior can be used on.

Note
An empty string means the base object, so any object.
BehaviorMetadata& gd::BehaviorMetadata::SetHelpPath ( const gd::String path)
inline

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

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

BehaviorMetadata & gd::BehaviorMetadata::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 behavior.

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