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

Used as a base class for classes that will own events-backed variants. More...

#include <EventsBasedObjectVariantsContainer.h>

Inherits gd::SerializableWithNameList< gd::EventsBasedObjectVariant >.

Public Member Functions

 EventsBasedObjectVariantsContainer (const EventsBasedObjectVariantsContainer &other)
 
EventsBasedObjectVariantsContaineroperator= (const EventsBasedObjectVariantsContainer &other)
 
Events Functions management
bool HasVariantNamed (const gd::String &name) const
 Check if the variant with the specified name exists.
 
gd::EventsBasedObjectVariantGetVariant (const gd::String &name)
 Get the variant with the specified name. More...
 
const gd::EventsBasedObjectVariantGetVariant (const gd::String &name) const
 Get the variant with the specified name. More...
 
gd::EventsBasedObjectVariantGetVariant (std::size_t index)
 Get the variant at the specified index in the list. More...
 
const gd::EventsBasedObjectVariantGetVariant (std::size_t index) const
 Get the variant at the specified index in the list. More...
 
std::size_t GetVariantsCount () const
 Return the number of variants.
 
gd::EventsBasedObjectVariantInsertNewVariant (const gd::String &name, std::size_t position)
 
gd::EventsBasedObjectVariantInsertVariant (const gd::EventsBasedObjectVariant &object, std::size_t position)
 
void RemoveVariant (const gd::String &name)
 
void ClearVariants ()
 
void MoveVariant (std::size_t oldIndex, std::size_t newIndex)
 
std::size_t GetVariantPosition (const gd::EventsBasedObjectVariant &eventsFunction)
 
const std::vector< std::unique_ptr< gd::EventsBasedObjectVariant > > & GetInternalVector () const
 Provide a raw access to the vector containing the variants.
 
std::vector< std::unique_ptr< gd::EventsBasedObjectVariant > > & GetInternalVector ()
 Provide a raw access to the vector containing the variants.
 
Serialization
void SerializeVariantsTo (SerializerElement &element) const
 Serialize events variants.
 
void UnserializeVariantsFrom (gd::Project &project, const SerializerElement &element)
 Unserialize the events variants.
 

Protected Member Functions

void Init (const gd::EventsBasedObjectVariantsContainer &other)
 

Detailed Description

Used as a base class for classes that will own events-backed variants.

See also
gd::EventsBasedObjectVariantContainer

Member Function Documentation

◆ GetVariant() [1/4]

gd::EventsBasedObjectVariant& gd::EventsBasedObjectVariantsContainer::GetVariant ( const gd::String name)
inline

Get the variant with the specified name.

Warning
Trying to access to a not existing variant will result in undefined behavior.

◆ GetVariant() [2/4]

const gd::EventsBasedObjectVariant& gd::EventsBasedObjectVariantsContainer::GetVariant ( const gd::String name) const
inline

Get the variant with the specified name.

Warning
Trying to access to a not existing variant will result in undefined behavior.

◆ GetVariant() [3/4]

gd::EventsBasedObjectVariant& gd::EventsBasedObjectVariantsContainer::GetVariant ( std::size_t  index)
inline

Get the variant at the specified index in the list.

Warning
Trying to access to a not existing variant will result in undefined behavior.

◆ GetVariant() [4/4]

const gd::EventsBasedObjectVariant& gd::EventsBasedObjectVariantsContainer::GetVariant ( std::size_t  index) const
inline

Get the variant at the specified index in the list.

Warning
Trying to access to a not existing variant will result in undefined behavior.

◆ Init()

void gd::EventsBasedObjectVariantsContainer::Init ( const gd::EventsBasedObjectVariantsContainer other)
inlineprotected

Initialize object using another object. Used by copy-ctor and assign-op. Don't forget to update me if members were changed!


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