GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
gd::ForEachChildVariableEvent Class Reference

Event repeated for each every child of a structure variable. More...

#include <ForEachChildVariableEvent.h>

Inherits gd::BaseEvent.

Public Member Functions

virtual
gd::ForEachChildVariableEvent
Clone () const
 
virtual bool IsExecutable () const
 
virtual bool CanHaveSubEvents () const
 
virtual const gd::EventsListGetSubEvents () const
 
virtual gd::EventsListGetSubEvents ()
 
const gd::InstructionsListGetConditions () const
 
gd::InstructionsListGetConditions ()
 
const gd::InstructionsListGetActions () const
 
gd::InstructionsListGetActions ()
 
const gd::StringGetIterableVariableName () const
 Get the iterable variable name attached to the event. More...
 
void SetIterableVariableName (gd::String newName)
 Set the iterable variable name attached to the event. More...
 
const gd::StringGetValueIteratorVariableName () const
 Get the value iterator variable attached to the event. More...
 
void SetValueIteratorVariableName (gd::String newName)
 Set the value iterator variable attached to the event. More...
 
const gd::StringGetKeyIteratorVariableName () const
 Get the key iterator variable attached to the event. More...
 
void SetKeyIteratorVariableName (gd::String newName)
 Set the key iterator variable attached to the event. More...
 
virtual std::vector< const
gd::InstructionsList * > 
GetAllConditionsVectors () const
 
virtual std::vector< const
gd::InstructionsList * > 
GetAllActionsVectors () const
 
virtual std::vector
< gd::InstructionsList * > 
GetAllConditionsVectors ()
 Return a list of all conditions of the event. More...
 
virtual std::vector
< gd::InstructionsList * > 
GetAllActionsVectors ()
 Return a list of all actions of the event. More...
 
virtual void SerializeTo (SerializerElement &element) const
 Serialize event.
 
virtual void UnserializeFrom (gd::Project &project, const SerializerElement &element)
 Unserialize the event.
 
- Public Member Functions inherited from gd::BaseEvent
bool HasSubEvents () const
 Return true if the events has sub events. More...
 
virtual std::vector< gd::StringGetAllSearchableStrings () const
 Return a list of all strings of the event. More...
 
virtual std::vector< std::pair
< gd::Expression
*, gd::ParameterMetadata > > 
GetAllExpressionsWithMetadata ()
 Return a list of all expressions of the event, each with their associated metadata. More...
 
virtual std::vector< std::pair
< const gd::Expression
*, const gd::ParameterMetadata > > 
GetAllExpressionsWithMetadata () const
 
virtual const std::vector
< gd::String > & 
GetSourceFileDependencies () const
 Returns the dependencies on source files of the project. More...
 
virtual const gd::StringGetAssociatedGDManagedSourceFile (gd::Project &project) const
 Returns the name of the source file associated with the event. More...
 
virtual gd::String GenerateEventCode (gd::EventsCodeGenerator &codeGenerator, gd::EventsCodeGenerationContext &context)
 Generate the code event: the platform provided by codeGenerator is asked for the EventMetadata associated to the event, which is then used to generate the code event. More...
 
virtual void Preprocess (gd::EventsCodeGenerator &codeGenerator, gd::EventsList &eventList, std::size_t indexOfTheEventInThisList)
 
virtual bool MustBePreprocessed ()
 If MustBePreprocessed is redefined to return true, the gd::EventMetadata::preprocessing associated to the event will be called to preprocess the event. More...
 
const gd::StringGetType () const
 Return the event type.
 
void SetType (gd::String type_)
 Change the event type.
 
void SetDisabled (bool disable=true)
 Set if the event if disabled or not.
 
bool IsDisabled () const
 True if event is disabled.
 
void SetFolded (bool fold=true)
 Set if the event must be folded (i.e: sub events must be hidden in the events editor).
 
bool IsFolded () const
 True if the event should be folded in the events editor.
 

Additional Inherited Members

- Public Attributes inherited from gd::BaseEvent
std::weak_ptr< gd::BaseEventoriginalEvent
 
signed long long totalTimeDuringLastSession
 
float percentDuringLastSession
 

Detailed Description

Event repeated for each every child of a structure variable.

Member Function Documentation

virtual bool gd::ForEachChildVariableEvent::CanHaveSubEvents ( ) const
inlinevirtual

Derived class have to redefine this function, so as to return true, if they have sub events.

Reimplemented from gd::BaseEvent.

virtual gd::ForEachChildVariableEvent* gd::ForEachChildVariableEvent::Clone ( ) const
inlinevirtual

Must return a pointer to a copy of the event. A such method is needed as the IDE may want to store copies of some events and so need a way to do polymorphic copies.

Typical implementation example:

return new MyEventClass(*this);

Reimplemented from gd::BaseEvent.

vector< gd::InstructionsList * > gd::ForEachChildVariableEvent::GetAllActionsVectors ( )
virtual

Return a list of all actions of the event.

Note
Used to preprocess or search in the actions.

Reimplemented from gd::BaseEvent.

vector< gd::InstructionsList * > gd::ForEachChildVariableEvent::GetAllConditionsVectors ( )
virtual

Return a list of all conditions of the event.

Note
Used to preprocess or search in the conditions.

Reimplemented from gd::BaseEvent.

const gd::String& gd::ForEachChildVariableEvent::GetIterableVariableName ( ) const
inline

Get the iterable variable name attached to the event.

It is the structure variable that will be iterated on.

const gd::String& gd::ForEachChildVariableEvent::GetKeyIteratorVariableName ( ) const
inline

Get the key iterator variable attached to the event.

It is the variable that will contain the name of the iterable's child being iterated on.

virtual const gd::EventsList& gd::ForEachChildVariableEvent::GetSubEvents ( ) const
inlinevirtual

Return the sub events, if applicable.

Reimplemented from gd::BaseEvent.

virtual gd::EventsList& gd::ForEachChildVariableEvent::GetSubEvents ( )
inlinevirtual

Return the sub events, if applicable.

Reimplemented from gd::BaseEvent.

const gd::String& gd::ForEachChildVariableEvent::GetValueIteratorVariableName ( ) const
inline

Get the value iterator variable attached to the event.

It is the variable that will contain the value of the iterable's child being iterated on.

virtual bool gd::ForEachChildVariableEvent::IsExecutable ( ) const
inlinevirtual

Derived class have to redefine this function, so as to return true, if they are executable.

Reimplemented from gd::BaseEvent.

void gd::ForEachChildVariableEvent::SetIterableVariableName ( gd::String  newName)
inline

Set the iterable variable name attached to the event.

It is the structure variable that will be iterated on.

void gd::ForEachChildVariableEvent::SetKeyIteratorVariableName ( gd::String  newName)
inline

Set the key iterator variable attached to the event.

It is the variable that will contain the name of the iterable's child being iterated on.

void gd::ForEachChildVariableEvent::SetValueIteratorVariableName ( gd::String  newName)
inline

Set the value iterator variable attached to the event.

It is the variable that will contain the value of the iterable's child being iterated on.


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