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
gd::CommentEvent Class Reference

Allows to add a text in the events editor. More...

#include <CommentEvent.h>

Inherits gd::BaseEvent.

Public Member Functions

virtual gd::CommentEventClone () const
 
int GetBackgroundColorRed () const
 
int GetBackgroundColorGreen () const
 
int GetBackgroundColorBlue () const
 
void SetBackgroundColor (int r_, int g_, int b_)
 
int GetTextColorRed () const
 
int GetTextColorGreen () const
 
int GetTextColorBlue () const
 
void SetTextColor (int r_, int g_, int b_)
 
const gd::StringGetComment () const
 
void SetComment (const gd::String &comment)
 
virtual std::vector< gd::StringGetAllSearchableStrings () const
 Return a list of all strings 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
virtual bool IsExecutable () const
 
virtual bool CanHaveSubEvents () const
 
virtual const gd::EventsListGetSubEvents () const
 
virtual gd::EventsListGetSubEvents ()
 
bool HasSubEvents () const
 Return true if the events has sub events. More...
 
virtual std::vector
< gd::InstructionsList * > 
GetAllConditionsVectors ()
 Return a list of all conditions of the event. More...
 
virtual std::vector< const
gd::InstructionsList * > 
GetAllConditionsVectors () const
 
virtual std::vector
< gd::InstructionsList * > 
GetAllActionsVectors ()
 Return a list of all actions of the event. More...
 
virtual std::vector< const
gd::InstructionsList * > 
GetAllActionsVectors () const
 
virtual std::vector
< gd::Expression * > 
GetAllExpressions ()
 Return a list of all expressions of the event. More...
 
virtual std::vector< const
gd::Expression * > 
GetAllExpressions () 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.
 

Public Attributes

int r
 Background color Red component.
 
int v
 Background color Green component.
 
int b
 Background color Blue component.
 
int textR
 Text color Red component.
 
int textG
 Text color Green component.
 
int textB
 Text color Blue component.
 
gd::String com1
 Comment.
 
gd::String com2
 Optional second column comment, deprecated.
 
- Public Attributes inherited from gd::BaseEvent
std::weak_ptr< gd::BaseEventoriginalEvent
 
signed long long totalTimeDuringLastSession
 
float percentDuringLastSession
 

Detailed Description

Allows to add a text in the events editor.

Member Function Documentation

virtual gd::CommentEvent* gd::CommentEvent::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::String > gd::CommentEvent::GetAllSearchableStrings ( ) const
virtual

Return a list of all strings of the event.

Note
Used to preprocess or search in the event strings.

< Com2 is deprecated

Reimplemented from gd::BaseEvent.


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