Contains user-friendly information about instructions and expressions (usually for a behavior or an object). More...

#include <InstructionOrExpressionContainerMetadata.h>

Inherited by gd::BehaviorMetadata, and gd::ObjectMetadata.

Public Member Functions
virtual gd::InstructionMetadata &	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_)=0

virtual gd::InstructionMetadata &	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_)=0

virtual gd::InstructionMetadata &	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_)=0

virtual gd::InstructionMetadata &	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_)=0

virtual gd::ExpressionMetadata &	AddExpression (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &group_, const gd::String &smallicon_)=0

virtual gd::ExpressionMetadata &	AddStrExpression (const gd::String &name_, const gd::String &fullname_, const gd::String &description_, const gd::String &group_, const gd::String &smallicon_)=0

virtual gd::MultipleInstructionMetadata	AddExpressionAndCondition (const gd::String &type, const gd::String &name, const gd::String &fullname, const gd::String &description, const gd::String &sentenceName, const gd::String &group, const gd::String &icon)=0
	Declare a new expression and condition as being part of the behavior. More...

virtual gd::MultipleInstructionMetadata	AddExpressionAndConditionAndAction (const gd::String &type, const gd::String &name, const gd::String &fullname, const gd::String &description, const gd::String &sentenceName, const gd::String &group, const gd::String &icon)=0
	Declare a new expression, condition and action as being part of the behavior. More...

virtual gd::InstructionMetadata &	AddDuplicatedAction (const gd::String &newActionName, const gd::String &copiedActionName)=0
	Create a new action which is the duplicate of the specified one. More...

virtual gd::InstructionMetadata &	AddDuplicatedCondition (const gd::String &newConditionName, const gd::String &copiedConditionName)=0
	Create a new condition which is the duplicate of the specified one. More...

virtual InstructionOrExpressionContainerMetadata &	SetFullName (const gd::String &fullname_)=0

virtual InstructionOrExpressionContainerMetadata &	SetDescription (const gd::String &description_)=0

virtual InstructionOrExpressionContainerMetadata &	SetIncludeFile (const gd::String &includeFile)=0
	Erase any existing include file and add the specified include. More...

virtual InstructionOrExpressionContainerMetadata &	AddIncludeFile (const gd::String &includeFile)=0
	Add a file to the already existing include files.

virtual const gd::String &	GetHelpPath () const =0

virtual InstructionOrExpressionContainerMetadata &	SetHelpPath (const gd::String &path)=0

virtual const gd::String &	GetName () const =0

virtual const gd::String &	GetFullName () const =0

virtual const gd::String &	GetDescription () const =0

virtual const gd::String &	GetIconFilename () const =0

virtual std::map< gd::String, gd::InstructionMetadata > &	GetAllActions ()=0
	Return a reference to a map containing the names of the actions (as keys) and the metadata associated with (as values).

virtual std::map< gd::String, gd::InstructionMetadata > &	GetAllConditions ()=0

virtual std::map< gd::String, gd::ExpressionMetadata > &	GetAllExpressions ()=0

virtual std::map< gd::String, gd::ExpressionMetadata > &	GetAllStrExpressions ()=0

Detailed Description

Contains user-friendly information about instructions and expressions (usually for a behavior or an object).

Member Function Documentation

◆ AddAction()

virtual gd::InstructionMetadata& gd::InstructionOrExpressionContainerMetadata::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_
	)

pure virtual

Declare a new action as being part of the behavior or object.

Deprecated:: Prefer using AddScopedAction, to properly namespace the action.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddCondition()

virtual gd::InstructionMetadata& gd::InstructionOrExpressionContainerMetadata::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_
	)

pure virtual

Declare a new condition as being part of the behavior or object.

Deprecated:: Prefer using AddScopedCondition, to properly namespace the condition.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddDuplicatedAction()

virtual gd::InstructionMetadata& gd::InstructionOrExpressionContainerMetadata::AddDuplicatedAction	(	const gd::String &	newActionName,
		const gd::String &	copiedActionName
	)

pure virtual

Create a new action which is the duplicate of the specified one.

Useful for handling a deprecated action that is just a "copy" of the new one.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddDuplicatedCondition()

virtual gd::InstructionMetadata& gd::InstructionOrExpressionContainerMetadata::AddDuplicatedCondition	(	const gd::String &	newConditionName,
		const gd::String &	copiedConditionName
	)

pure virtual

Create a new condition which is the duplicate of the specified one.

Useful for handling a deprecated condition that is just a "copy" of the new one.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddExpression()

virtual gd::ExpressionMetadata& gd::InstructionOrExpressionContainerMetadata::AddExpression	(	const gd::String &	name_,
		const gd::String &	fullname_,
		const gd::String &	description_,
		const gd::String &	group_,
		const gd::String &	smallicon_
	)

pure virtual

Declare a new action as being part of the extension.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddExpressionAndCondition()

virtual gd::MultipleInstructionMetadata gd::InstructionOrExpressionContainerMetadata::AddExpressionAndCondition	(	const gd::String &	type,
		const gd::String &	name,
		const gd::String &	fullname,
		const gd::String &	description,
		const gd::String &	sentenceName,
		const gd::String &	group,
		const gd::String &	icon
	)

pure virtual

Declare a new expression and condition as being part of the behavior.

Note: It's recommended to use this function to avoid declaring twice a similar expression/condition.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddExpressionAndConditionAndAction()

virtual gd::MultipleInstructionMetadata gd::InstructionOrExpressionContainerMetadata::AddExpressionAndConditionAndAction	(	const gd::String &	type,
		const gd::String &	name,
		const gd::String &	fullname,
		const gd::String &	description,
		const gd::String &	sentenceName,
		const gd::String &	group,
		const gd::String &	icon
	)

pure virtual

Declare a new expression, condition and action as being part of the behavior.

Note: The action name is prefixed by "Set" (and the namespace, as the condition).; It's recommended to use this function to avoid declaring 3 times a similar expression/condition/action.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddScopedAction()

virtual gd::InstructionMetadata& gd::InstructionOrExpressionContainerMetadata::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_
	)

pure virtual

Declare a new action as being part of the behavior or object.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddScopedCondition()

virtual gd::InstructionMetadata& gd::InstructionOrExpressionContainerMetadata::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_
	)

pure virtual

Declare a new condition as being part of the behavior or object.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ AddStrExpression()

virtual gd::ExpressionMetadata& gd::InstructionOrExpressionContainerMetadata::AddStrExpression	(	const gd::String &	name_,
		const gd::String &	fullname_,
		const gd::String &	description_,
		const gd::String &	group_,
		const gd::String &	smallicon_
	)

pure virtual

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

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ GetAllConditions()

virtual std::map<gd::String, gd::InstructionMetadata>& gd::InstructionOrExpressionContainerMetadata::GetAllConditions ( )

pure virtual

See also: gd::PlatformExtension::GetAllActions

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ GetAllExpressions()

virtual std::map<gd::String, gd::ExpressionMetadata>& gd::InstructionOrExpressionContainerMetadata::GetAllExpressions ( )

pure virtual

See also: gd::PlatformExtension::GetAllActions

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ GetAllStrExpressions()

virtual std::map<gd::String, gd::ExpressionMetadata>& gd::InstructionOrExpressionContainerMetadata::GetAllStrExpressions ( )

pure virtual

See also: gd::PlatformExtension::GetAllActions

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ GetHelpPath()

virtual const gd::String& gd::InstructionOrExpressionContainerMetadata::GetHelpPath ( ) const

pure virtual

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

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ SetHelpPath()

virtual InstructionOrExpressionContainerMetadata& gd::InstructionOrExpressionContainerMetadata::SetHelpPath ( const gd::String & path )

pure virtual

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

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

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

◆ SetIncludeFile()

virtual InstructionOrExpressionContainerMetadata& gd::InstructionOrExpressionContainerMetadata::SetIncludeFile ( const gd::String & includeFile )

pure virtual

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.

Deprecated:: Use AddIncludeFile instead as clearing the list is more error prone.

Implemented in gd::ObjectMetadata, and gd::BehaviorMetadata.

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

InstructionOrExpressionContainerMetadata.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddAction()

◆ AddCondition()

◆ AddDuplicatedAction()

◆ AddDuplicatedCondition()

◆ AddExpression()

◆ AddExpressionAndCondition()

◆ AddExpressionAndConditionAndAction()

◆ AddScopedAction()

◆ AddScopedCondition()

◆ AddStrExpression()

◆ GetAllConditions()

◆ GetAllExpressions()

◆ GetAllStrExpressions()

◆ GetHelpPath()

◆ SetHelpPath()

◆ SetIncludeFile()