Class: Input
Defined in: adventure/Input.js, line 6
Input is a special class constructed by Parser.parseInput(), and used to store each turn's input and all of the metadata that is generated for it, including the verb and noun(s) that were parsed, whether a disambiguation was called for, whether a soft prompt was made, whether a noun was assumed based upon context, and other data. This is an internal class that authors should not need to construct.
Private Constructor:
var foo = new adventurejs.Input()
Index
Methods:
- appendToOutput
- deletePhrase
- getAsset
- getAssumed
- getExclude
- getInPhrase
- getNoun
- getNounCount
- getParsedNoun
- getPhrase
- getPhraseCount
- getPreposition
- getVerb
- hasInput
- hasPhrase
- hasVerb
- overrideOutput
- prependToOutput
- setAsset
- setAssumed
- setDisambiguate
- setExclude
- setInPhrase
- setNewPhrase
- setNoun
- setOneWord
- setParsedNoun
- setPhrase
- setPreposition
- setSoftPrompt
- setVerb
- setVessel
- setVessel
- swapNouns
- swapPhrases
- swapPrepositions
Properties:
- allow_circular_verb
- append_to_next_print
- disambiguate
- found_one_word
- game
- input
- input_verb
- joint
- output_class
- override_next_print
- parsed_input
- parsed_one_word
- parsed_sentence_array
- parsed_sentence_structure
- parsedNoun1
- parsedNoun1_is_assumed
- parsedNoun2
- parsedNoun2_is_assumed
- parsedNoun3
- parsedNoun3_is_assumed
- prepend_to_next_print
- preposition1
- preposition2
- preposition3
- replacements
- soft_prompt
- strings
- unknown_word
- unparsed_input
- verb_chain
- verb_params
- verified_input
- was_appended_to_print
- was_overridden_to_print
- was_prepended_to_print
Methods Collapse all |
Defined in: adventure/Input.js, line 301
Parameters:
-
msg
String
Arbitrary string to append to next print.
Returns:
boolean
Defined in: adventure/Input.js, line 418
Parameters:
-
index
int
Defined in: adventure/Input.js, line 538
Parameters:
-
index
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 720
Parameters:
-
index
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 511
Parameters:
-
index
int
Returns:
String
|
Boolean
Defined in: adventure/Input.js, line 803
Parameters:
-
position
String -
property
String
Returns:
*
Defined in: adventure/Input.js, line 480
Parameters:
-
index
int
Returns:
String
|
Boolean
Defined in: adventure/Input.js, line 692
Parameters:
-
index
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 430
Parameters:
-
index
int
Returns:
Object
Defined in: adventure/Input.js, line 666
Parameters:
-
index
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 365
Parameters:
-
index
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 840
Returns:
Boolean
Defined in: adventure/Input.js, line 466
Parameters:
-
index
int
Returns:
Boolean
Defined in: adventure/Input.js, line 346
Parameters:
-
index
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 316
Parameters:
-
msg
String
Arbitrary string to override next print.
Returns:
boolean
Defined in: adventure/Input.js, line 331
Parameters:
-
msg
String
Arbitrary string to prepend to next print.
Returns:
boolean
Defined in: adventure/Input.js, line 565
Parameters:
-
index
Int -
parsedNoun
Object
Defined in: adventure/Input.js, line 733
Parameters:
-
index
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 887
Parameters:
-
params
Object
Defined in: adventure/Input.js, line 524
Parameters:
-
index
int -
value
String
Returns:
String
|
Boolean
Defined in: adventure/Input.js, line 822
Parameters:
-
position
String -
property
String
Returns:
*
Defined in: adventure/Input.js, line 620
Parameters:
-
params
Object
Returns:
Int
Defined in: adventure/Input.js, line 493
Parameters:
-
index
int -
value
String
Returns:
String
|
Boolean
Defined in: adventure/Input.js, line 869
Parameters:
-
params
Object
Defined in: adventure/Input.js, line 706
Parameters:
-
index
int -
parsedNoun
Object
Defined in: adventure/Input.js, line 403
Parameters:
-
index
int -
type
string -
value
string
Defined in: adventure/Input.js, line 679
Parameters:
-
index
int -
value
string
Defined in: adventure/Input.js, line 853
Parameters:
-
params
Object
Defined in: adventure/Input.js, line 384
Parameters:
-
value
String
Defined in: adventure/Input.js, line 586
Parameters:
-
index
Int -
asset
Object
Defined in: adventure/Input.js, line 605
Parameters:
-
index
Int -
asset
Object
Defined in: adventure/Input.js, line 764
Parameters:
-
index1
int -
index2
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 747
Parameters:
-
index1
int -
index2
int
Returns:
Object
|
Boolean
Defined in: adventure/Input.js, line 785
Parameters:
-
index1
int -
index2
int
Returns:
Object
|
Boolean
Properties Collapse all |
Defined in: adventure/Input.js, line 205
Default value: false
Todos: Should this also be an Array and sync indexes with verb_chain?
Defined in: adventure/Input.js, line 70
Default value: []
Defined in: adventure/Input.js, line 180
Default value: { 'index':null, 'noun1':false, 'noun2':false, 'noun3':false }
Defined in: adventure/Input.js, line 137
Default value: ""
Defined in: adventure/Input.js, line 289
this.game
.
Defined in: adventure/Input.js, line 28
Default value: ""
Defined in: adventure/Input.js, line 145
Default value: ""
Defined in: adventure/Input.js, line 239
Default value: []
Defined in: adventure/Input.js, line 129
Default value: ""
Defined in: adventure/Input.js, line 77
Default value: []
Defined in: adventure/Input.js, line 122
Defined in: adventure/Input.js, line 43
Default value: { 'enabled':false }
Defined in: adventure/Input.js, line 51
Default value: []
Defined in: adventure/Input.js, line 59
Default value: ""
Defined in: adventure/Input.js, line 932
Defined in: adventure/Input.js, line 960
Defined in: adventure/Input.js, line 942
Defined in: adventure/Input.js, line 970
Defined in: adventure/Input.js, line 951
Defined in: adventure/Input.js, line 980
Defined in: adventure/Input.js, line 84
Default value: []
Defined in: adventure/Input.js, line 905
Defined in: adventure/Input.js, line 914
Defined in: adventure/Input.js, line 923
Defined in: adventure/Input.js, line 223
Default value: {}
Defined in: adventure/Input.js, line 159
Default value: { 'verb':null, 'noun1':false, 'noun2':false, 'noun3':false, 'enabled':false, 'satisfied':false }
Defined in: adventure/Input.js, line 231
Default value: []
Defined in: adventure/Input.js, line 152
Default value: undefined
Defined in: adventure/Input.js, line 115
Default value: ""
Defined in: adventure/Input.js, line 196
Default value: []
Defined in: adventure/Input.js, line 214
Default value: {}
Defined in: adventure/Input.js, line 35
Default value: {}
Defined in: adventure/Input.js, line 91
Default value: []
Defined in: adventure/Input.js, line 99
Default value: []
Defined in: adventure/Input.js, line 107
Default value: []