API reference (Collection Resource) | Defold 1.14.0 (Alpha)

Collection resource

API for accessing loaded game object collection resources.


Namespace:	`dmGameObject`
Include:	`#include <dmsdk/gameobject/res_collection.h>`

STRUCTS
struct CollectionResource	collection resource

FUNCTIONS
dmGameObject::HCollection ResCollectionGetCollection (dmGameObject::CollectionResource* resource)	get a collection handle from a collection resource

Functions

ResCollectionGetCollection

dmGameObject::HCollection ResCollectionGetCollection(dmGameObject::CollectionResource* resource)

Converts a live collection resource returned by dmResource::Get into the numeric collection handle used by the game-object API. The caller retains ownership of the resource reference and must release the original resource pointer with dmResource::Release. The returned handle may change when the resource is reloaded; call this function again after a reload.

PARAMETERS

dmGameObject::CollectionResource* resource Live collection resource returned by dmResource::Get.

RETURNS

dmGameObject::HCollection Collection handle, or 0 if resource is null.

EXAMPLES

dmGameObject::CollectionResource* resource = 0;
dmResource::Result result = dmResource::Get(factory, "/main.collectionc", (void**)&resource);
if (result == dmResource::RESULT_OK)
{
    dmGameObject::HCollection collection = dmGameObject::ResCollectionGetCollection(resource);
    // Use collection with the game-object API.
    dmResource::Release(factory, resource);
}

Structs

CollectionResource

TYPE

struct CollectionResource

Opaque pointer returned by dmResource::Get for a compiled collection resource. The pointer remains valid while the caller holds a resource reference, including across resource reloads. Do not load a collection resource directly into an HCollection. An HCollection is a numeric collection handle and is not resource storage.