![]() |
GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
|
Represents an object that is implemented with events. More...
#include <EventsBasedObject.h>
Inherits gd::AbstractEventsBasedEntity.
Public Member Functions | |
| EventsBasedObject * | Clone () const |
| Return a pointer to a new EventsBasedObject constructed from this one. | |
| const gd::String & | GetDefaultName () const |
| Get the default name for created objects. | |
| EventsBasedObject & | SetDefaultName (const gd::String &defaultName_) |
| Set the default name for created objects. | |
| EventsBasedObject & | SetDescription (const gd::String &description_) override |
| Set the description of the behavior or object, to be displayed in the editor. | |
| EventsBasedObject & | SetName (const gd::String &name_) |
| Set the internal name of the object. | |
| EventsBasedObject & | SetFullName (const gd::String &fullName_) |
| Set the name of the object, to be displayed in the editor. | |
| EventsBasedObject & | SetPrivate (bool isPrivate) |
| Set that the object is private - it can't be used outside of its extension. | |
| EventsBasedObject & | MarkAsRenderedIn3D (bool isRenderedIn3D_) |
| Declare a usage of the 3D renderer. | |
| bool | IsRenderedIn3D () const |
| Return true if the object uses the 3D renderer. | |
| EventsBasedObject & | MarkAsAnimatable (bool isAnimatable_) |
| Declare an Animatable capability. | |
| bool | IsAnimatable () const |
| Return true if the object needs an Animatable capability. | |
| EventsBasedObject & | MarkAsTextContainer (bool isTextContainer_) |
| Declare a TextContainer capability. | |
| EventsBasedObject & | MarkAsInnerAreaFollowingParentSize (bool isInnerAreaExpandingWithParent_) |
| Declare that the parent scale will always be 1 and children will adapt there size. This is removing the ScalableCapability. | |
| bool | IsInnerAreaFollowingParentSize () const |
| Return true if objects handle size changes on their own and don't have the ScalableCapability. More... | |
| EventsBasedObject & | MakAsUsingLegacyInstancesRenderer (bool isUsingLegacyInstancesRenderer_) |
| Declare that custom object are rendered using their child-objects instead of their child-instances. | |
| bool | IsUsingLegacyInstancesRenderer () const |
| Return true if custom object are rendered using their child-objects instead of their child-instances. | |
| bool | IsTextContainer () const |
| Return true if the object needs a TextContainer capability. | |
| const gd::EventsBasedObjectVariant & | GetDefaultVariant () const |
| Get the default variant of the custom object. | |
| gd::EventsBasedObjectVariant & | GetDefaultVariant () |
| Get the default variant of the custom object. | |
| const gd::EventsBasedObjectVariantsContainer & | GetVariants () const |
| Get the variants of the custom object. | |
| gd::EventsBasedObjectVariantsContainer & | GetVariants () |
| Get the variants of the custom object. | |
| void | SerializeToExternal (SerializerElement &element) const |
| Serialize the events-based object for an extension in an external file. Variants are not serialized. | |
| void | SerializeTo (SerializerElement &element) const override |
| Serialize the AbstractEventsBasedEntity to the specified element. | |
| void | UnserializeFrom (gd::Project &project, const SerializerElement &element) override |
| Load the AbstractEventsBasedEntity from the specified element. | |
Layers | |
| const gd::LayersContainer & | GetLayers () const |
| Get the layers of the custom object. | |
| gd::LayersContainer & | GetLayers () |
| Get the layers of the custom object. | |
Child objects | |
| gd::ObjectsContainer & | GetObjects () |
| Get the objects of the custom object. | |
| const gd::ObjectsContainer & | GetObjects () const |
| Get the objects of the custom object. | |
Instances | |
| gd::InitialInstancesContainer & | GetInitialInstances () |
| Get the instances of the custom object. | |
| const gd::InitialInstancesContainer & | GetInitialInstances () const |
| Get the instances of the custom object. | |
| int | GetAreaMinX () const |
| Get the left bound of the custom object. More... | |
| void | SetAreaMinX (int areaMinX) |
| Set the left bound of the custom object. | |
| int | GetAreaMinY () const |
| Get the top bound of the custom object. More... | |
| void | SetAreaMinY (int areaMinY) |
| Set the top bound of the custom object. | |
| int | GetAreaMinZ () const |
| Get the min Z bound of the custom object. More... | |
| void | SetAreaMinZ (int areaMinZ) |
| Set the min Z bound of the custom object. | |
| int | GetAreaMaxX () const |
| Get the right bound of the custom object. More... | |
| void | SetAreaMaxX (int areaMaxX) |
| Set the right bound of the custom object. | |
| int | GetAreaMaxY () const |
| Get the bottom bound of the custom object. More... | |
| void | SetAreaMaxY (int areaMaxY) |
| Set the bottom bound of the custom object. | |
| int | GetAreaMaxZ () const |
| Get the max Z bound of the custom object. More... | |
| void | SetAreaMaxZ (int areaMaxZ) |
| Set the bottom bound of the custom object. | |
Public Member Functions inherited from gd::AbstractEventsBasedEntity | |
| AbstractEventsBasedEntity (const gd::String &_name, gd::EventsFunctionsContainer::FunctionOwner functionContainerSource) | |
| AbstractEventsBasedEntity * | Clone () const |
| Return a pointer to a new AbstractEventsBasedEntity constructed from this one. | |
| bool | IsPrivate () const |
| Check if the behavior or object is private - it can't be used outside of its extension. | |
| AbstractEventsBasedEntity & | SetPrivate (bool isPrivate_) |
| Set that the behavior or object is private - it can't be used outside of its extension. | |
| const gd::String & | GetDescription () const |
| Get the description of the behavior or object, that is displayed in the editor. | |
| const gd::String & | GetName () const |
| Get the internal name of the behavior or object. | |
| AbstractEventsBasedEntity & | SetName (const gd::String &name_) |
| Set the internal name of the behavior or object. | |
| const gd::String & | GetFullName () const |
| Get the name of the behavior or object, that is displayed in the editor. | |
| AbstractEventsBasedEntity & | SetFullName (const gd::String &fullName_) |
| Set the name of the behavior or object, to be displayed in the editor. | |
| EventsFunctionsContainer & | GetEventsFunctions () |
| Return a reference to the functions of the events based behavior or object. | |
| const EventsFunctionsContainer & | GetEventsFunctions () const |
| Return a const reference to the functions of the events based behavior or object. | |
| gd::PropertiesContainer & | GetPropertyDescriptors () |
| Return a reference to the list of the properties. | |
| const gd::PropertiesContainer & | GetPropertyDescriptors () const |
| Return a const reference to the list of the properties. | |
Additional Inherited Members | |
Static Public Member Functions inherited from gd::AbstractEventsBasedEntity | |
| static gd::String | GetPropertyActionName (const gd::String &propertyName) |
| Get the name of the action to change a property. | |
| static gd::String | GetPropertyConditionName (const gd::String &propertyName) |
| Get the name of the condition to compare a property. | |
| static gd::String | GetPropertyExpressionName (const gd::String &propertyName) |
| Get the name of the expression to get a property. | |
| static gd::String | GetPropertyToggleActionName (const gd::String &propertyName) |
| Get the name of the action to toggle a boolean property. | |
Represents an object that is implemented with events.
It's the responsibility of the IDE to run the logic to transform this into a real object, by declaring an extension and running code generation. See EventsFunctionsExtensionsLoader.
|
inline |
Get the right bound of the custom object.
This is used only if there is any initial instances.
|
inline |
Get the bottom bound of the custom object.
This is used only if there is any initial instances.
|
inline |
Get the max Z bound of the custom object.
This is used only if there is any initial instances.
|
inline |
Get the left bound of the custom object.
This is used only if there is any initial instances.
|
inline |
Get the top bound of the custom object.
This is used only if there is any initial instances.
|
inline |
Get the min Z bound of the custom object.
This is used only if there is any initial instances.
|
inline |
Return true if objects handle size changes on their own and don't have the ScalableCapability.
When the parent dimensions change:
false, the object is stretch proportionally while children local positions stay the same.true, the children local positions need to be adapted by events to follow their parent size.