GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
EventsBasedBehavior.h
1 /*
2  * GDevelop Core
3  * Copyright 2008-2016 Florian Rival ([email protected]). All rights
4  * reserved. This project is released under the MIT License.
5  */
6 #ifndef GDCORE_EVENTSBASEDBEHAVIOR_H
7 #define GDCORE_EVENTSBASEDBEHAVIOR_H
8 
9 #include <vector>
10 #include "GDCore/Project/AbstractEventsBasedEntity.h"
11 #include "GDCore/Project/NamedPropertyDescriptor.h"
12 #include "GDCore/Project/PropertiesContainer.h"
13 #include "GDCore/Project/EventsFunctionsContainer.h"
14 #include "GDCore/String.h"
15 namespace gd {
16 class SerializerElement;
17 class Project;
18 } // namespace gd
19 
20 namespace gd {
21 
32  public:
34  virtual ~EventsBasedBehavior(){};
35 
40  EventsBasedBehavior* Clone() const { return new EventsBasedBehavior(*this); };
41 
42  EventsBasedBehavior& SetDescription(const gd::String& description_) override {
44  return *this;
45  }
46 
52  return *this;
53  }
54 
60  return *this;
61  }
62 
66  const gd::String& GetObjectType() const { return objectType; };
67 
72  objectType = objectType_;
73  return *this;
74  }
75 
80  bool IsPrivate() const { return isPrivate; }
81 
86  EventsBasedBehavior& SetPrivate(bool _isPrivate) {
87  isPrivate = _isPrivate;
88  return *this;
89  }
90 
95  return sharedPropertyDescriptors;
96  }
97 
102  const {
103  return sharedPropertyDescriptors;
104  }
105 
109  static gd::String GetSharedPropertyActionName(const gd::String &propertyName) {
110  return "SetSharedProperty" + propertyName;
111  };
112 
117  return "SharedProperty" + propertyName;
118  };
119 
123  static gd::String
125  return "SharedProperty" + propertyName;
126  };
127 
132  return "ToggleSharedProperty" + propertyName;
133  };
134 
135  void SerializeTo(SerializerElement& element) const override;
136 
137  void UnserializeFrom(gd::Project& project,
138  const SerializerElement& element) override;
139 
140  private:
141  gd::String objectType;
142  bool isPrivate = false;
143  gd::PropertiesContainer sharedPropertyDescriptors;
144 };
145 
146 } // namespace gd
147 
148 #endif // GDCORE_EVENTSBASEDBEHAVIOR_H
Represents a behavior or an object that is implemented with events.
Definition: AbstractEventsBasedEntity.h:30
virtual AbstractEventsBasedEntity & SetDescription(const gd::String &description_)
Set the description of the behavior or object, to be displayed in the editor.
Definition: AbstractEventsBasedEntity.h:52
AbstractEventsBasedEntity & SetName(const gd::String &name_)
Set the internal name of the behavior or object.
Definition: AbstractEventsBasedEntity.h:65
AbstractEventsBasedEntity & SetFullName(const gd::String &fullName_)
Set the name of the behavior or object, to be displayed in the editor.
Definition: AbstractEventsBasedEntity.h:78
Represents a behavior that is implemented with events.
Definition: EventsBasedBehavior.h:31
EventsBasedBehavior * Clone() const
Return a pointer to a new EventsBasedBehavior constructed from this one.
Definition: EventsBasedBehavior.h:40
static gd::String GetSharedPropertyConditionName(const gd::String &propertyName)
Get the name of the condition to compare a shared property.
Definition: EventsBasedBehavior.h:116
const gd::String & GetObjectType() const
Get the object type the behavior should be used with.
Definition: EventsBasedBehavior.h:66
static gd::String GetSharedPropertyExpressionName(const gd::String &propertyName)
Get the name of the expression to get a shared property.
Definition: EventsBasedBehavior.h:124
static gd::String GetSharedPropertyActionName(const gd::String &propertyName)
Get the name of the action to change a shared property.
Definition: EventsBasedBehavior.h:109
EventsBasedBehavior & SetName(const gd::String &name_)
Set the internal name of the behavior.
Definition: EventsBasedBehavior.h:50
const gd::PropertiesContainer & GetSharedPropertyDescriptors() const
Return a const reference to the list of shared properties.
Definition: EventsBasedBehavior.h:101
EventsBasedBehavior & SetFullName(const gd::String &fullName_)
Set the name of the behavior, to be displayed in the editor.
Definition: EventsBasedBehavior.h:58
EventsBasedBehavior & SetDescription(const gd::String &description_) override
Set the description of the behavior or object, to be displayed in the editor.
Definition: EventsBasedBehavior.h:42
EventsBasedBehavior & SetObjectType(const gd::String &objectType_)
Set the object type the behavior should be used with.
Definition: EventsBasedBehavior.h:71
bool IsPrivate() const
Check if the behavior is private - it can't be used outside of its extension.
Definition: EventsBasedBehavior.h:80
static gd::String GetSharedPropertyToggleActionName(const gd::String &propertyName)
Get the name of the action to toggle a boolean shared property.
Definition: EventsBasedBehavior.h:131
gd::PropertiesContainer & GetSharedPropertyDescriptors()
Return a reference to the list of shared properties.
Definition: EventsBasedBehavior.h:94
EventsBasedBehavior & SetPrivate(bool _isPrivate)
Set that the behavior is private - it can't be used outside of its extension.
Definition: EventsBasedBehavior.h:86
Base class representing a project (game), including all resources, scenes, objects,...
Definition: Project.h:50
A container of properties, used for custom behaviors, custom objects, extensions.....
Definition: PropertiesContainer.h:17
A generic container that can represent a value ( containing a string, double, bool or int),...
Definition: SerializerElement.h:37
String represents an UTF8 encoded string.
Definition: String.h:31
Definition: CommonTools.h:24