Pre-release
AdventureJS Docs Downloads
Score: 0 Moves: 0

Class:ParsedNoun

Defined in: adventure/ParsedNoun.js, line 5

Framework class

ParsedNoun is a special class constructed by Parser.parseNoun(), and used to store metadata about an asset and lists of all possible matches for that asset. This is an internal class that authors should not need to construct.

Private Constructor:

var foo = new adventurejs.ParsedNoun(asset)

Parameters:

Inherited Overrides

Methods Collapse all  |  Expand all

Properties  | 

exclude :Boolean

Defined in: adventure/ParsedNoun.js, line 37

Default value: false

input :String

Defined in: adventure/ParsedNoun.js, line 79

Default value: ""

The asset name found in user input, though that may already have been replaced with an asset ID by the time this noun gets parsed.
is_assumed :Boolean

Defined in: adventure/ParsedNoun.js, line 144

Default value: false

isGroup :Boolean

Defined in: adventure/ParsedNoun.js, line 58

Default value: false

isPlural :Boolean

Defined in: adventure/ParsedNoun.js, line 51

Default value: false

matches :Object

Defined in: adventure/ParsedNoun.js, line 109

Default value: { all:[], direction:false, qualified:[], qualifiedIndex:0, unambiguous:""}

Save a variety of information about assets that matched the input.
object_id :Getter

Defined in: adventure/ParsedNoun.js, line 154

Getter function looks for a qualified object id, and if it doesn't find one, it returns the first qualified match.
original_input :String

Defined in: adventure/ParsedNoun.js, line 94

Default value: ""

During parsing we may replace the original input string with the ID of a found asset. Ensure that we keep the original.
plural :String

Defined in: adventure/ParsedNoun.js, line 44

Default value: ""

preposition :String

Defined in: adventure/ParsedNoun.js, line 137

Default value: ""

qualified_object_id :String

Defined in: adventure/ParsedNoun.js, line 102

If a singular asset was found that matched the input, store its ID here.
serialized_input :String

Defined in: adventure/ParsedNoun.js, line 87

Default value: ""

Serializing input changes to lowercase, replaces spaces with underscores.
singular :String

Defined in: adventure/ParsedNoun.js, line 65

Default value: ""

type :String

Defined in: adventure/ParsedNoun.js, line 72

Default value: ""