Methods

addScriptListener(entityRef, event, listener)

EntityFactory.js, line 49

Add an event listener from a script to a specific item

Parameters:

Name	Type	Description
entityRef	string
event	string
listener	function

See:

• BehaviorManager::addListener

clone(entity) → {Item|Npc|Room|Area}

EntityFactory.js, line 86

Clone an existing entity.

Parameters:

Name	Type	Description
entity	Item | Npc | Room | Area

Returns:

Item | Npc | Room | Area

createByType(area, entityRef, Type) → {type}

EntityFactory.js, line 63

Create a new instance of a given npc definition. Resulting npc will not be held or equipped and will not have its default contents. If you want it to also populate its default contents you must manually call npc.hydrate(state)

Parameters:

Name	Type	Description
area	Area
entityRef	string
Type	Class	Type of entity to instantiate

Returns:

type

createEntityRef(areaName, id) → {string}

EntityFactory.js, line 21

Create the key used by the entities and scripts maps

Parameters:

Name	Type	Description
areaName	string
id	number

Returns:

string

getDefinition(entityRef) → {Object}

EntityFactory.js, line 29

Parameters:

Name	Type	Description
entityRef	string

Returns:

Object

setDefinition(entityRef, def)

EntityFactory.js, line 37

Parameters:

Name	Type	Description
entityRef	string
def	Object