Class:NounMustBe

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

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 Modify Verbs for more info.

Private Constructor:

var foo = new adventurejs.NounMustBe()

Inherited Overrides

Index
Methods
Properties

Index

Methods:

Properties:

character
child_of_noun2
direction
dov
exit
extant
global
global_substance
in_hands
in_inventory
in_inventory_if_takeable
intangible
iov
known
matter
not_direction
not_exit
not_global
not_in_hands
not_in_inventory
not_in_prior_plural
not_player
not_player_parent
not_scenery
not_self
not_self_parent
not_substance
not_worn
player
player_parent
prefer_carried_if_ambiguous
prefer_uncarried_if_ambiguous
present
present_if_ambiguous
present_if_tangible
reachable
reachable_if_tangible
reservoir_if_substance
reservoir_if_substance
scenery
self
self_parent
singular
singular
string
substance
takeable
tangible
visible
visible
worn

Methods Collapse all | Expand all

Properties |

character :Boolean

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

Default value: false

If true, Verb will only act on Characters.

child_of_noun2 :Boolean

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

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 48

Default value: false

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

dov :Boolean

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

Default value: false

If true, parser will exclude assets that Verb can't act on.

exit :Boolean

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

Default value: false

If true, Verb will only act on Exits

extant :Boolean

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

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 79

Default value: false

If true, Verb will only act on global Assets

global_substance :Boolean

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

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 98

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 107

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 115

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 124

Default value: false

If true, Verb will only act on Intangibles.

iov :Boolean

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

Default value: false

If true, parser will exclude assets that Verb can't act on.

known :Boolean

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

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 146

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 194

Default value: false

If true, Verb will not act on directions.

not_exit :Boolean

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

Default value: false

If true, Verb will not act on Exits

not_global :Boolean

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

Default value: false

If true, Verb will not act on global Assets

not_in_hands :Boolean

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

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 227

Default value: false

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

not_in_prior_plural :Boolean

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

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 :Boolean

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

Default value: false

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

not_player_parent :Boolean

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

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 244

Default value: false

If true, Verb will not act on Scenery

not_self :Boolean

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

Default value: false

If true, Verb will not act on the character specified by current input. By default that is the player but may also be an NPC in cases such as "Floyd, go east".

not_self_parent :Boolean

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

Default value: false

If true, Verb will not act on the parent object of the character specified by current input. By default that is the player but may also be an NPC in cases such as "Floyd, go east".

not_substance :Boolean

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

Default value: true

If true, Verb will not act on Substances

not_worn :Boolean

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

Default value: false

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

player :Boolean

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

Default value: false

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

player_parent :Boolean

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

Default value: false

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

prefer_carried_if_ambiguous :Boolean

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

Default value: false

If true, on finding ambiguous assets, Verb will prefer assets that are carried by player.

prefer_uncarried_if_ambiguous :Boolean

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

Default value: false

If true, on finding ambiguous assets, Verb will prefer assets that are not carried by player.

present :Boolean

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

Default value: false

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

present_if_ambiguous :Boolean

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

Default value: false

If true, on finding ambiguous assets, Verb will prefer present assets that are in the current Room

present_if_tangible :Boolean

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

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 344

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 353

Default value: false

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

reservoir_if_substance :Boolean

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

Default value: false

If true, Verb will only act on Substances reservoirs. Looks for Substances in a present Vessel.

reservoir_if_substance :Boolean

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

Default value: false

If true, Verb will only act on Substances that are in reservoirs or carried vessels. Looks for Substances in a present Vessel.

scenery :Boolean

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

Default value: false

If true, Verb will only act on Scenery

self :Boolean

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

Default value: false

If true, Verb will only act on the character specified by current input. By default that is the player but may also be an NPC in cases such as "Floyd, go east". This is distinct from this.player, which will only act on the player character.

self_parent :Boolean

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

Default value: false

If true, Verb will only act on the parent object of the character specified by current input. By default that is the player but may also be an NPC in cases such as "Floyd, go east".

singular :Boolean

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

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.

singular :Boolean

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

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.

string :Boolean

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

Default value: false

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

substance :Boolean

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

Default value: false

If true, Verb will only act on Substances. Looks for Substances in a present Vessel.

takeable :Boolean

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

Default value: false

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