Location

Location

Represents an actual location instance created from a LocationTemplate. Contains the runtime state and hierarchical relationships between locations.

Constructor

new Location(template, parentopt)

Description:

  • Creates a new Location instance from a template.

Source:
Parameters:
Name Type Attributes Description
template LocationTemplate

The template to create this location from
parent Location <optional>

The parent location in the hierarchy

Extends

Classes

Location

Members

guid

Description:

  • A unique identifier for this model instance.

Source:
Overrides:
Properties:
Name Type Description
guid String

A unique identifier for this model instance.

tags

Description:

  • An array of string tags that characterize this item.

Source:
Overrides:
Properties:
Name Type Description
tags Set

An array of string tags that characterize this item.

Methods

addChild(child)

Description:

  • Adds a child location to this location's hierarchy.

Source:
Parameters:
Name Type Description
child Location

The child location to add
Throws:

If the child is not a Location instance

Type
Error

asJSON() → {String}

Description:

  • Converts the model to JSON, converting sets to arrays.

Source:
Overrides:
Returns:

JSON

Type
String

has(tag) → {Boolean}

Description:

  • Does this model have the given tag?

Source:
Overrides:
Parameters:
Name Type Description
tag String
Returns:

true if it does, false otherwise

Type
Boolean

is(tag) → {Boolean}

Description:

  • Does this model have the given tag?

Source:
Overrides:
Deprecated:
  • Use has() instead
Parameters:
Name Type Description
tag String
Returns:

true if it does, false otherwise

Type
Boolean

matches(model) → {Boolean}

Description:

  • Compares this model to another for value equality, ignoring their guids. Two independently-created models with the same properties (e.g. two identical items generated separately) will match even though they have different guids.

Source:
Overrides:
Parameters:
Name Type Description
model Model
Returns:

true if the models are equal in every respect except guid

Type
Boolean

merge()

Description:

  • Merges a fresher copy of this location (e.g. fetched via getLocation(guid) or returned from expandShim) into this instance in place. Not sure it needs it, but the location isn't replaced, it's updated in place using most fields, but not parent or revision. This is used in UI code with complex initialization requirements-elsewhere it can be ignored.

Source:

not(tag) → {Boolean}

Description:

  • Does this model not have the given tag?

Source:
Overrides:
Parameters:
Name Type Description
tag String
Returns:

true if it does not have the tag, false otherwise

Type
Boolean

typeOf(prefix) → {String}

Description:

  • Given a prefix like ammo or media, will return the specific tag for this item, such as ammo:22 or media:35mm.

Source:
Overrides:
Parameters:
Name Type Description
prefix String

the prefix to match
Returns:

the first tag found that matches this prefix

Type
String