GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
Public Member Functions | List of all members
gd::EventsFunctionsExtension Class Reference

Hold a list of Events Functions (gd::EventsFunction) and Events Based Behaviors. More...

#include <EventsFunctionsExtension.h>

Inherits gd::EventsFunctionsContainer.

Public Member Functions

 EventsFunctionsExtension (const EventsFunctionsExtension &)
 
EventsFunctionsExtensionoperator= (const EventsFunctionsExtension &rhs)
 
EventsFunctionsExtensionClone () const
 Return a pointer to a new EventsFunctionsExtension constructed from this one.
 
const gd::StringGetVersion () const
 
EventsFunctionsExtensionSetVersion (const gd::String &version_)
 
const gd::StringGetNamespace () const
 
EventsFunctionsExtensionSetNamespace (const gd::String &namespace_)
 
const gd::StringGetShortDescription () const
 
EventsFunctionsExtensionSetShortDescription (const gd::String &shortDescription_)
 
const gd::StringGetDescription () const
 
EventsFunctionsExtensionSetDescription (const gd::String &description_)
 
const gd::StringGetName () const
 
EventsFunctionsExtensionSetName (const gd::String &name_)
 
const gd::StringGetFullName () const
 
EventsFunctionsExtensionSetFullName (const gd::String &fullName_)
 
const gd::StringGetCategory () const
 
EventsFunctionsExtensionSetCategory (const gd::String &category_)
 
const std::vector< gd::String > & GetTags () const
 
std::vector< gd::String > & GetTags ()
 
const std::vector< gd::String > & GetAuthorIds () const
 
std::vector< gd::String > & GetAuthorIds ()
 
const gd::StringGetAuthor () const
 
EventsFunctionsExtensionSetAuthor (const gd::String &author_)
 
const gd::StringGetPreviewIconUrl () const
 
EventsFunctionsExtensionSetPreviewIconUrl (const gd::String &previewIconUrl_)
 
const gd::StringGetIconUrl () const
 
EventsFunctionsExtensionSetIconUrl (const gd::String &iconUrl_)
 
const gd::StringGetHelpPath () const
 Get the help path of this extension, relative to the GDevelop documentation root.
 
EventsFunctionsExtensionSetHelpPath (const gd::String &helpPath_)
 Set the help path of this extension, relative to the GDevelop documentation root.
 
gd::SerializableWithNameList< EventsBasedBehavior > & GetEventsBasedBehaviors ()
 Return a reference to the list of the events based behaviors.
 
const gd::SerializableWithNameList< EventsBasedBehavior > & GetEventsBasedBehaviors () const
 Return a const reference to the list of the events based behaviors.
 
gd::SerializableWithNameList< EventsBasedObject > & GetEventsBasedObjects ()
 Return a reference to the list of the events based objects.
 
const gd::SerializableWithNameList< EventsBasedObject > & GetEventsBasedObjects () const
 Return a const reference to the list of the events based objects.
 
virtual void SetOrigin (const gd::String &originName_, const gd::String &originIdentifier_)
 Sets an extension origin. This method is not present since the beginning so the projects created before that will have extensions installed from the store without an origin. Keep that in mind when creating features that rely on an extension's origin.
 
virtual const gd::StringGetOriginName () const
 
virtual const gd::StringGetOriginIdentifier () const
 
Dependencies
gd::DependencyMetadataAddDependency ()
 Adds a new dependency.
 
void RemoveDependencyAt (size_t index)
 Adds a new dependency.
 
std::vector< gd::DependencyMetadata > & GetAllDependencies ()
 Returns the list of dependencies.
 
const std::vector< gd::DependencyMetadata > & GetAllDependencies () const
 Returns the list of dependencies.
 
Variable management

Members functions related to layout variables management.

const gd::VariablesContainerGetGlobalVariables () const
 
gd::VariablesContainerGetGlobalVariables ()
 
const gd::VariablesContainerGetSceneVariables () const
 
gd::VariablesContainerGetSceneVariables ()
 
Serialization
void SerializeTo (gd::SerializerElement &element) const
 Serialize the EventsFunctionsExtension to the specified element.
 
void UnserializeFrom (gd::Project &project, const gd::SerializerElement &element)
 Load the EventsFunctionsExtension from the specified element.
 
void UnserializeExtensionDeclarationFrom (gd::Project &project, const gd::SerializerElement &element)
 Load the extension without free functions, behaviors and objects implementation.
 
void UnserializeExtensionImplementationFrom (gd::Project &project, const gd::SerializerElement &element)
 Load free functions, behaviors and objects implementation (in opposition to load just their "declaration" by reading their name).
 
- Public Member Functions inherited from gd::EventsFunctionsContainer
 EventsFunctionsContainer (FunctionOwner source_)
 
FunctionOwner GetOwner () const
 Get the source of the function container. More...
 
bool HasEventsFunctionNamed (const gd::String &name) const
 Check if the function with the specified name exists.
 
gd::EventsFunctionGetEventsFunction (const gd::String &name)
 Get the function with the specified name. More...
 
const gd::EventsFunctionGetEventsFunction (const gd::String &name) const
 Get the function with the specified name. More...
 
gd::EventsFunctionGetEventsFunction (std::size_t index)
 Get the function at the specified index in the list. More...
 
const gd::EventsFunctionGetEventsFunction (std::size_t index) const
 Get the function at the specified index in the list. More...
 
std::size_t GetEventsFunctionsCount () const
 Return the number of functions.
 
gd::EventsFunctionInsertNewEventsFunction (const gd::String &name, std::size_t position)
 
gd::EventsFunctionInsertEventsFunction (const gd::EventsFunction &object, std::size_t position)
 
void RemoveEventsFunction (const gd::String &name)
 
void ClearEventsFunctions ()
 
void MoveEventsFunction (std::size_t oldIndex, std::size_t newIndex)
 
std::size_t GetEventsFunctionPosition (const gd::EventsFunction &eventsFunction)
 
const std::vector< std::unique_ptr< gd::EventsFunction > > & GetInternalVector () const
 Provide a raw access to the vector containing the functions.
 
std::vector< std::unique_ptr< gd::EventsFunction > > & GetInternalVector ()
 Provide a raw access to the vector containing the functions.
 
void SerializeEventsFunctionsTo (SerializerElement &element) const
 Serialize events functions.
 
void UnserializeEventsFunctionsFrom (gd::Project &project, const SerializerElement &element)
 Unserialize the events functions.
 

Static Public Member Functions

Lifecycle event functions
static bool IsExtensionLifecycleEventsFunction (const gd::String &eventsFunctionName)
 

Additional Inherited Members

- Public Types inherited from gd::EventsFunctionsContainer
enum  FunctionOwner { Extension , Object , Behavior }
 
- Protected Member Functions inherited from gd::EventsFunctionsContainer
void Init (const gd::EventsFunctionsContainer &other)
 

Detailed Description

Hold a list of Events Functions (gd::EventsFunction) and Events Based Behaviors.

Events functions can be generated as stand-alone functions, and converted to actions/conditions/expressions. Events behaviors can be generated to a runtime behavior, with functions converted to behavior actions/conditions/expressions. Similarly, a gd::EventsFunctionsExtension can be converted to an extension.

Member Function Documentation

◆ GetGlobalVariables() [1/2]

gd::VariablesContainer& gd::EventsFunctionsExtension::GetGlobalVariables ( )
inline

Return the global variables of the extension (variables scoped to the entire game lifetime).

◆ GetGlobalVariables() [2/2]

const gd::VariablesContainer& gd::EventsFunctionsExtension::GetGlobalVariables ( ) const
inline

Return the global variables of the extension (variables scoped to the entire game lifetime).

◆ GetSceneVariables() [1/2]

gd::VariablesContainer& gd::EventsFunctionsExtension::GetSceneVariables ( )
inline

Return the global variables of the extension (variables scoped to the lifetime of a scene).

◆ GetSceneVariables() [2/2]

const gd::VariablesContainer& gd::EventsFunctionsExtension::GetSceneVariables ( ) const
inline

Return the global variables of the extension (variables scoped to the lifetime of a scene).


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