Class: NounMustBe

Defined in: adventure/dictionary/NounMustBe.js, line 6

Framework class

NounMustBe is a special class used while parsing Input to specify general conditions that a noun must meet for a Verb to act on it. This is a broad set of exclusions used to narrow items by class or by certain properties, or availability to the player character. Exclusion is handled by Parser.qualifyParsedNoun. Each verb has more specific logic to handle more specific conditions. This is an internal class that authors should not need to construct, though there are methods to allow authors to customize these settings per Verb. See How to Modify Verbs for more info.

Private Constructor:

var foo = new adventurejs.NounMustBe()

Inherited Overrides

IndexMethodsProperties

Index

Methods:

Properties:

character
child_of_noun2
direction
exit
extant
global
global_substance
in_hands
in_inventory
in_inventory_if_takeable
intangible
known
matter
not_direction
not_exit
not_global
not_in_hands
not_in_inventory
not_noun2_if_all
not_player_parent
not_scenery
not_substance
not_worn
player_parent
present
present_if_tangible
reachable
reachable_if_tangible
scenery
singular
singular
string
takeable
tangible
visible
worn

Methods Collapse all | Expand all

Properties Collapse all | Expand all

character :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 78

Default value: false

If true, Verb will only act on Characters.

child_of_noun2 :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 235

Default value: false

If true, Verb will only act on noun1 if it is a child of noun2. For verbs such as 'take a from b', where b must be in a for verb to be relevant.

direction :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 42

Default value: false

If true, Verb will only act on directions, such as "go north".

exit :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 295

Default value: false

If true, Verb will only act on Exits

extant :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 33

Default value: true

Extant means the asset is available in the game world. If extant is false the asset can be referred to but not used.

global :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 261

Default value: false

If true, Verb will only act on global Assets

global_substance :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 328

Default value: false

If true, Verb will only act on global_substance. This is method for referring to a substance in the abstract rather than to a specific portion of substance.

in_hands :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 184

Default value: false

If true, Verb will only act on Assets in the player character's hands, such as held objects like ropes.

in_inventory :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 143

Default value: false

If true, Verb will only act on Assets in player's inventory.

in_inventory_if_takeable :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 151

Default value: false

If true, if Asset is takeable, it must be in player character's inventory for verb to act on it.

intangible :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 71

Default value: false

If true, Verb will only act on Intangibles.

known :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 135

Default value: false

If true, Verb will only act on Assets that are known by player character.

matter :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 56

Default value: false

If true, Verb will only act on Matter, which includes Tangibles and Substances.

not_direction :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 49

Default value: false

If true, Verb will not act on directions.

not_exit :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 303

Default value: false

If true, Verb will not act on Exits

not_global :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 270

Default value: false

If true, Verb will not act on global Assets

not_in_hands :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 193

Default value: false

If true, Verb will not act on Assets in the player character's hands, such as held objects like ropes.

not_in_inventory :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 160

Default value: false

If true, Verb will not act on Assets in player's inventory.

not_noun2_if_all :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 244

Default value: false

If true, qualified object of noun2 will be excluded from noun1. Chiefly intended for cases like 'put all in thing' where 'thing' should not be included in 'all'.

not_player_parent :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 228

Default value: false

If true, Verb will not act on the parent object of the player character.

not_scenery :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 287

Default value: false

If true, Verb will not act on Scenery

not_substance :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 311

Default value: true

If true, Verb will not act on Substances

not_worn :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 176

Default value: false

If true, Verb will only act on Assets not worn by player.

player_parent :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 220

Default value: false

If true, Verb will only act on the parent object of the player character.

present :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 85

Default value: false

If true, Verb will only act on Tangibles that are in the current Room

present_if_tangible :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 93

Default value: false

If true, Verb will only act on Tangibles that are in the current Room

reachable :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 118

Default value: false

If true, Verb will only act on Tangibles that are reachable to player character. Reachability may be determined by a number of factors.

reachable_if_tangible :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 101

Default value: false

If true, Verb will only act on Tangibles that are in reachable to player.

scenery :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 279

Default value: false

If true, Verb will only act on Scenery

singular :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 202

Default value: false

If true, Verb will not act on items that are not singular, such as collections. For example, author might make a collection to represent three drawers in a desk. Though the collection itself is a single asset, it represents multiple other assets.

singular :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 211

Default value: true

If true, Verb will not act on a group of items. This is distinct from singular. For example, if player has three keys and tries to "unlock door with all keys", "all keys" being plural will be rejected.

string :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 253

Default value: false

If true, Verb will only act on strings, for example: say "foo" to npc

takeable :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 127

Default value: false

If true, Verb will only act on Tangibles that can be taken by player character.

tangible :Boolean

Defined in: adventure/dictionary/NounMustBe.js, line 64

Default value: false

If true, Verb will only act on Tangibles.