GDevelop/Core/GDCore/IDE/EventsFunctionTools.h

/*
 * GDevelop Core
 * Copyright 2008-present Florian Rival (Florian.Rival@gmail.com). All rights
 * reserved. This project is released under the MIT License.
 */
#pragma once 

#include <vector>
#include "GDCore/String.h"

namespace gd {
class Project;
class EventsFunctionsContainer;
class ObjectsContainer;
class ParameterMetadataContainer;
class PropertiesContainer;
class VariablesContainer;
class ParameterMetadata;
class EventsFunction;
class EventsBasedBehavior;
class EventsBasedObject;
class Expression;
}  // namespace gd

namespace gd {
/**
 * Contains tools to use events functions.
 */
class GD_CORE_API EventsFunctionTools {
 public:
  /**
   * \brief Given a free events function, initialize the given objects container
   * with objects described in the events function parameters and in
   * the events function groups.
   *
   * This is useful to create the "context" of a function, before code
   * generation for example.
   */
  static void FreeEventsFunctionToObjectsContainer(
      const gd::Project& project,
      const gd::EventsFunctionsContainer& functionContainer,
      const gd::EventsFunction& eventsFunction,
      gd::ObjectsContainer& outputObjectsContainer);

  /**
   * \brief Given a behavior events function, initialize the given objects container
   * with objects described in the events function parameters, in
   * the events function groups and in the behavior properties (for additional
   * required behaviors on the object).
   *
   * This is useful to create the "context" of a function, before code
   * generation for example.
   */
  static void BehaviorEventsFunctionToObjectsContainer(
      const gd::Project& project,
      const gd::EventsBasedBehavior& eventsBasedBehavior,
      const gd::EventsFunction& eventsFunction,
      gd::ObjectsContainer& outputObjectsContainer);

  /**
   * \brief Given a parent-object events function, initialize the given objects container
   * with objects described in the events function parameters, in
   * the events function groups and in the parent-object properties for
   * child-objects.
   *
   * This is useful to create the "context" of a function, before code
   * generation for example.
   */
  static void ObjectEventsFunctionToObjectsContainer(
      const gd::Project& project,
      const gd::EventsBasedObject& eventsBasedObject,
      const gd::EventsFunction& eventsFunction,
      gd::ObjectsContainer& outputObjectsContainer);

  static void ParametersToVariablesContainer(
      const ParameterMetadataContainer &parameters,
      gd::VariablesContainer &outputVariablesContainer);

  static void PropertiesToVariablesContainer(
      const PropertiesContainer &properties,
      gd::VariablesContainer &outputVariablesContainer);
};
}  // namespace gd