The instance container of a custom object, containing instances of objects rendered on screen.

See

gdjs.CustomRuntimeObject

Hierarchy (view full)

Constructors

Properties

pathfindingObstaclesManager: PathfindingObstaclesManager
tileMapCollisionMaskManager: TileMapRuntimeManager

Methods

  • Create objects from initial instances data (for example, the initial instances of the scene or the instances of an external layout).

    Parameters

    • data: InstanceData[]

      The instances data

    • xPos: number

      The offset on X axis

    • yPos: number

      The offset on Y axis

    • zPos: number

      The offset on Z axis

    • trackByPersistentUuid: boolean

      If true, objects are tracked by setting their persistentUuid to the same as the associated instance. Useful for hot-reloading when instances are changed.

    Returns void

  • Load the container from the given initial configuration.

    Parameters

    • customObjectData: ObjectData & ObjectConfiguration & {
          animatable?: SpriteAnimationData[];
          childrenContent: {
              [objectName: string]: ObjectConfiguration & any;
          };
          variant: string;
      }

      An object containing the container data.

    • eventsBasedObjectVariantData: EventsBasedObjectVariantData

    Returns void

    See

    gdjs.RuntimeGame#getSceneAndExtensionsData