Constructor
new Store(template, parentopt)
- Description:
Creates a new Store instance from a template.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
template |
LocationTemplate | The template to create this store from |
|
parent |
Location |
<optional> |
The parent location in the hierarchy |
Extends
Classes
Members
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:
- Overrides:
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:
Parameters:
| Name | Type | Description |
|---|---|---|
tag |
String |
Returns:
true if it does, false otherwise
- Type
- Boolean
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
ammoormedia, will return the specific tag for this item, such asammo:22ormedia:35mm.
- Source:
- Overrides:
Parameters:
| Name | Type | Description |
|---|---|---|
prefix |
String | the prefix to match |
Returns:
the first tag found that matches this prefix
- Type
- String