collectionfactory

This returns status of the collection factory. Calling this function when the factory is not marked as dynamic loading always returns COMP_COLLECTION_FACTORY_STATUS_LOADED.

Parameters

• url?: string | Hash | Url — the collection factory component to get status from

Returns

• status: Opaque<"constant"> — status of the collection factory component

• collectionfactory.STATUS_UNLOADED

• collectionfactory.STATUS_LOADING

• collectionfactory.STATUS_LOADED

This decreases the reference count for each resource loaded with collectionfactory.load. If reference is zero, the resource is destroyed. Calling this function when the factory is not marked as dynamic loading does nothing.

// How to unload resources of a collection factory prototype loaded with collectionfactory.load:
collectionfactory.unload("#factory");

Parameters

• url?: string | Hash | Url — the collection factory component to unload

Resources loaded are referenced by the collection factory component until the existing (parent) collection is destroyed or collectionfactory.unload is called. Calling this function when the factory is not marked as dynamic loading does nothing.

// How to load resources of a collection factory prototype.
collectionfactory.load("#factory", (self, url, result) => {});

Parameters

• url?: string | Hash | Url — the collection factory component to load
• complete_function?: function(self, url, result) — function to call when resources are loaded.

self object The current object. url url url of the collection factory component result boolean True if resource were loaded successfully

The URL identifies the collectionfactory component that should do the spawning. Spawning is instant, but spawned game objects get their first update calls the following frame. The supplied parameters for position, rotation and scale will be applied to the whole collection when spawned. Script properties in the created game objects can be overridden through a properties-parameter table. The table should contain game object ids (hash) as keys and property tables as values to be used when initiating each spawned game object. See go.property for more information on script properties. The function returns a table that contains a key for each game object id (hash), as addressed if the collection file was top level, and the corresponding spawned instance id (hash) as value with a unique path prefix added to each instance. Calling collectionfactory.create create on a collection factory that is marked as dynamic without having loaded resources using collectionfactory.load will synchronously load and create resources which may affect application performance.

// How to spawn a collection of game objects:
export default defineScript({
  init(self) {
    // Spawn a small group of enemies.
    const pos = vmath.vector3(100, 12.5, 0);
    const rot = vmath.quat_rotation_z(Math.PI / 2);
    const scale = 0.5;
    const props = {
      [hash("/enemy_leader")]: { health: 1000.0 },
      [hash("/enemy_1")]: { health: 200.0 },
      [hash("/enemy_2")]: { health: 400.0, color: hash("green") },
    };

    self.enemy_ids = collectionfactory.create("#enemyfactory", pos, rot, props, scale);
    // enemy_ids now map to the spawned instance ids:
    //
    // pprint(self.enemy_ids)
    //
    // DEBUG:SCRIPT:
    // {
    //   hash: [/enemy_leader] = hash: [/collection0/enemy_leader],
    //   hash: [/enemy_1] = hash: [/collection0/enemy_1],
    //   hash: [/enemy_2] = hash: [/collection0/enemy_2]
    // }

    // Send "attack" message to the leader. First look up its instance id.
    const leader_id = self.enemy_ids[hash("/enemy_leader")];
    msg.post(leader_id, "attack");
  },
});

// How to delete a spawned collection:
go.delete(self.enemy_ids);

Parameters

• url: string | Hash | Url — the collection factory component to be used
• position?: Vector3 — position to assign to the newly spawned collection
• rotation?: Quaternion — rotation to assign to the newly spawned collection
• properties?: Record<string | number, unknown> — table of script properties to propagate to any new game object instances
• scale?: number | Vector3 — uniform scaling to apply to the newly spawned collection (must be greater than 0).

Returns

• ids: Record<string | number, unknown> — a table mapping the id:s from the collection to the new instance id:s

Changes the prototype for the collection factory. Setting the prototype to "nil" will revert back to the original prototype.

// How to unload the previous prototype's resources, and then spawn a new collection:
collectionfactory.unload("#factory"); // unload the previous resources
collectionfactory.set_prototype("#factory", "/main/levels/level1.collectionc");
const ids = collectionfactory.create("#factory", go.get_world_position(), vmath.quat());

Parameters

• url?: string | Hash | Url — the collection factory component
• prototype?: string | nil — the path to the new prototype, or nil

unloaded

loading

loaded