API Docs for:
Show:

LS.Pack Class

Defined in: ../src/resources/pack.js:4
Module: LS

Pack is an object that contain several resources, helpful when you want to carry a whole scene in one single file

Constructor

LS.Pack

()

Defined in ../src/resources/pack.js:4

Methods

addResource

(
  • filename
)

Defined in ../src/resources/pack.js:162

Adds a resource to the prefab

Parameters:

  • filename String

    filename of the resource

configure

(
  • data
)

Defined in ../src/resources/pack.js:23

configure the pack from an unpacked WBin

Parameters:

  • data Object

    an unpacked WBIN (object with every chunk)

Pack.createWBin

(
  • fullpath
  • resource_names
  • metadata
  • mark_them
)

Defined in ../src/resources/pack.js:188

to create a WBin containing all the resource and metadata

Parameters:

  • fullpath String

    for the pack

  • resource_names Array

    array with the names of all the resources to store

  • metadata Object

    [optional] extra data to store

  • mark_them Boolean

    [optional] marks all the resources as if they come from a pack

Returns:

object containing the pack data ready to be converted to WBin

removeResource

(
  • filename
)

Defined in ../src/resources/pack.js:175

Remove a resource to the prefab

Parameters:

  • filename String

    filename of the resource