Class: Tangible
Extends: adventurejs.Matter
Defined in: adventure/assets/Tangible.js, line 5
How to: UseTangibles
Public Constructor:
MyGame.createAsset({ "class":"Tangible", "name":"foo", [...] })
Tangible is the base class for all Assets with physical properties in the game world, with the exception of Substances. All of the properties of Tangible are inherited by all of its subclasses, and most subclasses don't define new properties. Most subclasses are essentially convenience methods that set a group of properties particular to a type of object. In theory, an instance of almost any subclass could be made to behave like an instance of almost any other subclass, simply by setting the right properties. This provides the flexibility to mix and match properties to construct game assets with customized behaviors.
For example, Chair defines something you can sit on, and Bed defines something you can lie on, but perhaps you want to make something like a divan, that you can sit on and lie on. You could create a Chair and set asset.can_put.on.player_can_lie property to true.
MyGame.createAsset({
class: "Chair",
name: "divan",
descriptions: {look:"A comfortable looking fainting couch. ",),
can_put:
{
on: { player_can_lie: true }
}
});
This is a simple example of customizing an object, but hopefully
it gives you an idea of how flexible the Tangible class is.
Alternatively if you wanted to extensively customize your divan,
you could define your own Divan class to extend
Furniture.
Private Constructor:
var foo = new adventurejs.Tangible(game_name, name)
Though all in-game glasses use a standard constructor method under the hood, it's unlikely that you'd need to call it directly. To create an instance of the Tangible class, it must be defined in a game file as a generic object. That object will be used at runtime to construct a new game class instance, which will be validated and initialized before adding it to the Game. See above for the public constructor, or see Game#createAsset to learn more.
Parameters:
-
game_name
String
The name of the top level game object. -
name
String
A name for the object, to be serialized and used as ID.
Index
Methods:
- Overrides from Matter $is
- $moveTo
- addAssetAt
- Inherited from Asset addWordsToLookup
- Inherited from Asset aliases
- areAnscestorsClosed
- areAnscestorsKnown
- areAnscestorsOpen
- areAnscestorsUnknown
- canBePlacedInAspectOfAsset
- canContainAnySubstance
- canContainAssetAt
- canPlayerNest
- canPlayerReachThatFromThis
- Inherited from Asset canSetVerbState
- Overrides from Matter destroy
- Inherited from Asset didDoVerbs
- Inherited from Asset didIoVerbs
- doesContainAnyAsset
- doesContainAnyAssetAt
- doesContainAnySubstance
- doesContainAnySubstanceAt
- doesContainAsset
- doesContainAssetAt
- doesContainSubstance
- doesContainSubstanceAt
- Inherited from Asset DOVallowOnce
- Inherited from Asset DOVallowWithAnything
- Inherited from Asset DOVallowWithAsset
- Inherited from Asset DOVallowWithNothing
- Inherited from Asset DOVdidDo
- Inherited from Asset DOVdidDoCount
- Inherited from Asset DOVdidTry
- Inherited from Asset DOVdidTryCount
- Inherited from Asset DOVgetConnectionCount
- Inherited from Asset DOVgetConnections
- Inherited from Asset DOVgetMaxConnections
- Inherited from Asset DOVhasIndirectObjects
- Inherited from Asset DOVhasMaxConnections
- Inherited from Asset DOVincrementDoCount
- Inherited from Asset DOVincrementTryCount
- Inherited from Asset DOVisConnectedToAnything
- Inherited from Asset DOVisConnectedToAsset
- Inherited from Asset DOVisConnectedToNothing
- Inherited from Asset DOVsetConnection
- Inherited from Asset DOVsetWithAsset
- Inherited from Asset DOVsetWithClass
- Inherited from Asset DOVunsetConnection
- Overrides from Matter event_hooks
- get
- getAllContents
- getAllNestedContents
- getAncestorId
- getAnySubstanceThisContains
- getAspectAt
- getAspectWithVessel
- getClosedAnscestors
- getContentsAt
- getCountOfListableContentsAt
- Inherited from Asset getDescription
- Inherited from Asset getIndirectDescription
- Inherited from Atom getInheritance
- getListableContents
- getNestedInstancesOfClass
- getOpenOrClosed
- getPlaceAspect
- getPlaceAspectId
- getPlaceAsset
- getPlaceAssetId
- getPrintableListOfContents
- Inherited from Atom getProperty
- getRoomAsset
- getRoomId
- getRopesThatBlockTravel
- getSubstanceAt
- getThingThisIsTiedToPlayerBy
- getTiedThingsThatDragOnTravel
- getVesselAt
- getYBottom
- getYRange
- getYTop
- Inherited from Asset has
- hasAspectAt
- Inherited from Atom hasClass
- hasContentsAtAspect
- Inherited from Asset hasDescription
- Inherited from Asset hasEventHook
- Inherited from Asset hasIndirectDescription
- hasListableContents
- hasPlace
- Inherited from Atom hasProperty
- hasPropertyOnAspectAt
- hasRopesThatBlockTravel
- hasTiedThingsThatDragOnTravel
- hasVessel
- hasVesselAtAspect
- Inherited from Asset incrementDoVerbCount
- Inherited from Asset incrementTryVerbCount
- Overrides from Matter initialize
- Inherited from Asset IOVallowOnce
- Inherited from Asset IOVallowWithAnything
- Inherited from Asset IOVallowWithAsset
- Inherited from Asset IOVallowWithNothing
- Inherited from Asset IOVdidDo
- Inherited from Asset IOVdidDoCount
- Inherited from Asset IOVdidTry
- Inherited from Asset IOVdidTryCount
- Inherited from Asset IOVgetConnectionCount
- Inherited from Asset IOVgetConnections
- Inherited from Asset IOVgetMaxConnections
- Inherited from Asset IOVhasDirectObjects
- Inherited from Asset IOVhasMaxConnections
- Inherited from Asset IOVincrementDoCount
- Inherited from Asset IOVincrementTryCount
- Inherited from Asset IOVisConnectedToAnything
- Inherited from Asset IOVisConnectedToAsset
- Inherited from Asset IOVisConnectedToNothing
- Inherited from Asset IOVsetConnection
- Inherited from Asset IOVsetWithAsset
- Inherited from Asset IOVsetWithClass
- Inherited from Asset IOVunsetConnection
- Inherited from Asset isDOV
- isIn
- Inherited from Asset isIOV
- isPlacedAtAspect
- isPlacedAtAspectAndAsset
- Inherited from Asset isVerbState
- isWithinYRange
- linkRegisteredParts
- moveFrom
- moveFrom
- moveTo
- onAddSubstanceToThis
- onChangeGravity
- onChangeMoisture
- onChangeTemperature
- onMoveThatToThis
- onNestThatToThis
- onRemoveThatFromThis
- onSubtractSubstanceFromThis
- onTieThisToThat
- onTurnThatWithThis
- onTurnThis
- onTurnThisWithThat
- onUnnestThatFromThis
- onUntieThisFromThat
- put
- Inherited from Asset redirectVerb
- registerParts
- removeAssetAt
- removeThatFromThis
- Inherited from Atom set
- setAspectAt
- setAttachmentsKnown
- setContentsKnown
- Inherited from Asset setDOV
- Inherited from Asset setDOVs
- Inherited from Asset setIOV
- Inherited from Asset setIOVs
- Inherited from Asset setObjectOfVerbs
- setPlace
- Inherited from Asset setVerbSubscription
- Inherited from Asset setVerbSubscriptionsWithAssets
- Inherited from Asset setVerbSubscriptionsWithConnection
- setVesselAt
- Inherited from Asset toggleVerbState
- Inherited from Asset tryEventHook
- trySetContentsKnown
- Inherited from Asset undestroy
- Inherited from Asset unredirectVerb
- Inherited from Asset unsetDOV
- Inherited from Asset unsetDOVs
- Inherited from Asset unsetIOV
- Inherited from Asset unsetIOVs
- Inherited from Asset unsetVerbSubscription
- Overrides from Matter validate
Properties:
- absorption_quantity
- Inherited from Asset adjectives
- aperture
- append_written_strings_to_description
- Inherited from Asset article_name
- Inherited from Asset articlename
- Inherited from Asset Articlename
- buoyancy
- can_auto_open
- can_auto_unlock
- can_auto_unseal
- can_be_filled_from
- can_be_filled_from_without_turning_on
- can_be_given_to
- can_be_in_multiple_rooms
- can_be_looked_through
- can_be_moved_from_room
- can_be_opened_without_taking
- can_be_poured_into
- can_be_pushed_from_room
- can_be_swung
- can_be_swung_at
- can_be_thrown_at
- can_be_thrown_to
- can_be_typed_on
- can_deep_nest
- can_drink_from
- can_go_out
- can_hang_things_on_this
- can_hang_this_on_things
- can_jump_across
- can_jump_from
- can_jump_in
- can_jump_over
- can_jump_through
- can_jump_to
- can_kick_while_in_hands
- can_peddle
- can_put
- can_run
- can_skate
- can_step
- can_support_swinging
- can_swing_across
- can_swing_from
- can_swing_on
- can_swing_on_if_holding
- can_swing_on_if_holding_and_supported
- can_swing_on_if_nested
- can_swing_over
- can_swing_to
- can_take_from
- can_tie_this_to_things_without_holding
- can_walk
- cant_get_off
- Inherited from Atom class
- Inherited from Asset collection
- control_positions
- control_target_id
- current_position
- default_aspect
- default_aspect_for_climb
- default_aspect_for_swing_to
- default_posture_for_swing_to
- Inherited from Asset definite_article
- Inherited from Asset definite_name
- Inherited from Asset description
- Inherited from Asset descriptions
- Inherited from Asset did_do_verb
- Inherited from Asset did_do_verb_count
- Inherited from Asset did_try_verb
- Inherited from Asset did_try_verb_count
- direction
- Inherited from Asset dont_use_articles
- emits
- Inherited from Asset exclude_from_lookup
- exit
- Inherited from Atom game
- Inherited from Atom game_name
- Inherited from Atom id
- Inherited from Asset image
- Inherited from Asset indefinite_article
- Inherited from Asset indefinite_name
- Inherited from Asset is
- Inherited from Asset is.abstract
- is.body
- is.closed
- Inherited from Asset is.collection
- Inherited from Asset is.destroyed
- Inherited from Asset is.direct_object_of_verb
- is.direct_object_of_verb!hit
- is.distant
- Inherited from Asset is.extant
- is.fixed
- Inherited from Asset is.global
- is.hidden
- is.hollow
- Inherited from Asset is.initialized
- Inherited from Asset is.known
- is.listed_in_parent
- is.listed_in_room
- is.locked
- Inherited from Asset is.nameless
- is.open
- Overrides from Matter is.plugged
- Inherited from Asset is.pluggedIn
- is.rideable
- is.screwed
- is.sealed
- Inherited from Asset is.seen
- Inherited from Asset is.singleton
- is.supported
- is.typing_target
- is.unlisted_but_list_children
- Inherited from Asset is.used
- Inherited from Asset is.validated
- is.watertight
- is.worn
- is.zipped
- list_group
- location_required
- location_unneccessary
- measurements
- min_light_required_to_see
- must_be_in_hands_to_look_through
- must_be_in_hands_to_look_with
- must_be_in_hands_to_read
- must_be_worn_to_look_with
- must_let_go_after_swing
- Inherited from Atom name
- Inherited from Asset name_is_proper
- Inherited from Asset noun
- Inherited from Asset object_of_verb
- on_drink_destroy
- on_drink_empty
- on_eat_destroy
- on_tie_to_drag_behind_rope
- on_tie_to_this_take_this
- opacity
- parts
- place
- place
- player_can_climb_this
- player_can_exit
- player_can_hang_on_this
- player_knows_its_hidden
- Inherited from Asset plural
- position
- posture_position
- Inherited from Asset print_bold
- Inherited from Asset print_italic
- print_open_or_closed
- Inherited from Asset pronoun
- Inherited from Asset propername
- Inherited from Asset quirks
- quirks.climb_means_go_on
- quirks.climb_means_stand_on
- quirks.crawl_means_go
- quirks.get_up_means_get_off
- quirks.go_on_means_climb
- quirks.in_means_on
- quirks.jump_means_jump_off
- quirks.jump_means_jump_on
- quirks.let_go_of_means_go_down
- quirks.let_go_of_means_go_off
- quirks.look_with_means_look_through
- quirks.pick_means_unlock
- quirks.point_means_aim
- quirks.put_means_pour
- quirks.stand_means_get_off
- quirks.step_on_means_stamp_on
- quirks.step_on_means_stand_on
- quirks.take_means_hold
- quirks.write_on_means_write_in
- redirected_verbs
- registerableClasses
- registered_parts
- show_things_this_is_tied_to_in_description
- Inherited from Asset singlePluralPairs
- Inherited from Asset split_name_for_world_lookup
- things_player_can_climb_to_from_this
- things_player_can_do_all_verbs_to_from_this
- things_player_can_jump_to_from_this
- things_player_can_reach_from_this
- things_player_can_reach_from_top_of_this
- things_player_can_reach_from_top_of_this
- things_player_can_swing_to_across_this
- things_player_can_swing_to_from_this
- turn_positions
- turn_rotation
- turn_target_id
- typing_target_id
- Inherited from Atom UID
- Inherited from Asset use_definite_article_in_lists
- use_once_message
- Inherited from Asset verb_hooks
- written_strings
Methods Collapse all |
Defined in: adventure/assets/tangible/$is.js, line 6
Overrides from: adventurejs.Matter#$is
Todos: Leaving open the possibility for other params.
Parameters:
-
property
String -
asset
Object
- assetA.$is("in", assetB)
- accepts any preposition, asking, is this asset in that aspect of that asset?
- assetA.$is("nested in", assetB)
- nested in, specific to character classes, asking, is this asset nested in that asset?
- assetA.$is("closed")
- asking, is this asset closed?
- assetA.$is("locked")
- asking, is this asset locked?
- assetA.$is("plugged")
- asking, is this asset plugged?
- assetA.$is("sealed")
- asking, is this asset sealed?
- assetA.$is("held", assetB)
- asking, is this asset held by that asset, as in a bannister held by player?
- assetA.$is("holding", assetB)
- asking, is this asset holding that asset, as in player holding a rope?
- assetA.$is("worn")
- asking, is this asset being worn?
- assetA.$is("zipped")
- asking, is this asset zipped?
- assetA.$is("open")
- asking, is this asset open?
- assetA.$is("unlocked")
- asking, is this asset unlocked?
- assetA.$is("unplugged")
- asking, is this asset unplugged?
- assetA.$is("unsealed")
- asking, is this asset unsealed?
Defined in: adventure/assets/tangible/$moveTo.js, line 6
Parameters:
-
aspect
String -
asset
Object
Defined in: adventure/assets/tangible/addAssetAt.js, line 6
Returns:
Array
Defined in: adventure/asset/addWordsToLookup.js, line 6
Inherited from: adventurejs.Asset#addWordsToLookup
Parameters:
-
allTheWords
Array -
typeOfWord
String
Defined in: adventure/Asset.js, line 951
Inherited from: adventurejs.Asset#aliases
Defined in: adventure/assets/tangible/areAnscestorsClosed.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/areAnscestorsKnown.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/areAnscestorsOpen.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/areAnscestorsUnknown.js, line 6
Parameters:
-
nestlevel
int
Returns:
Boolean
Defined in: adventure/assets/tangible/canBePlacedInAspectOfAsset.js, line 6
Parameters:
-
aspect
String -
asset
Object
with_assets
and
with_classes
properties.
Returns:
Boolean
Defined in: adventure/assets/tangible/canContainAnySubstance.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/canContainAssetAt.js, line 6
Parameters:
-
object
Object
Returns:
Boolean
Defined in: adventure/assets/tangible/canPlayerNest.js, line 9
Parameters:
-
aspect
String
A Tangible Aspect ID.
Returns:
Boolean
Defined in: adventure/assets/tangible/canPlayerReachThatFromThis.js, line 6
Parameters:
-
object
Object
Returns:
Boolean
Defined in: adventure/asset/canSetVerbState.js, line 6
Inherited from: adventurejs.Asset#canSetVerbState
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/assets/Tangible.js, line 2151
Overrides from: adventurejs.Matter#destroy
Todos: What else needs to happen on destroy?
Defined in: adventure/asset/didDoVerbs.js, line 6
Inherited from: adventurejs.Asset#didDoVerbs
Parameters:
-
verbs
Array
Returns:
Boolean
Defined in: adventure/asset/didIoVerbs.js, line 6
Inherited from: adventurejs.Asset#didIoVerbs
Parameters:
-
verbs
Array
Returns:
Boolean
Defined in: adventure/assets/tangible/doesContainAnyAsset.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/doesContainAnyAssetAt.js, line 6
Parameters:
-
aspect
String
Returns:
Boolean
Defined in: adventure/assets/tangible/doesContainAnySubstance.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/doesContainAnySubstanceAt.js, line 6
Parameters:
-
aspect
String
Returns:
Boolean
Defined in: adventure/assets/tangible/doesContainAsset.js, line 6
Parameters:
-
id
String
Returns:
String
Defined in: adventure/assets/tangible/doesContainAssetAt.js, line 6
Parameters:
-
id
String -
aspect
String
Returns:
Boolean
Defined in: adventure/assets/tangible/doesContainSubstance.js, line 6
Parameters:
-
id
String
Returns:
String
Defined in: adventure/assets/tangible/doesContainSubstanceAt.js, line 6
Parameters:
-
id
String -
aspect
String
Returns:
Boolean
Defined in: adventure/asset/DOVallowOnce.js, line 6
Inherited from: adventurejs.Asset#DOVallowOnce
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/DOVallowWithAnything.js, line 6
Inherited from: adventurejs.Asset#DOVallowWithAnything
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/DOVallowWithAsset.js, line 6
Inherited from: adventurejs.Asset#DOVallowWithAsset
Parameters:
-
verb
String -
asset
Object
Returns:
Boolean
Defined in: adventure/asset/DOVallowWithNothing.js, line 6
Inherited from: adventurejs.Asset#DOVallowWithNothing
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/DOVdidDo.js, line 6
Inherited from: adventurejs.Asset#DOVdidDo
Parameters:
-
verb
String
_didDo is an alias meant for authors.
Returns:
Boolean
Defined in: adventure/asset/DOVdidDoCount.js, line 6
Inherited from: adventurejs.Asset#DOVdidDoCount
Parameters:
-
verb
String
_doCount is an alias meant for authors.
Returns:
Int
Defined in: adventure/asset/DOVdidTry.js, line 6
Inherited from: adventurejs.Asset#DOVdidTry
Parameters:
-
verb
String
_didTry is an alias meant for authors.
Returns:
Boolean
Defined in: adventure/asset/DOVdidTryCount.js, line 6
Inherited from: adventurejs.Asset#DOVdidTryCount
Parameters:
-
verb
String
_tryCount is an alias meant for authors.
Returns:
Boolean
Defined in: adventure/asset/DOVgetConnectionCount.js, line 6
Inherited from: adventurejs.Asset#DOVgetConnectionCount
Parameters:
-
verb
String
The name of a verb.
Returns:
Int
Defined in: adventure/asset/DOVgetConnections.js, line 6
Inherited from: adventurejs.Asset#DOVgetConnections
Parameters:
-
verb
String
The name of a verb.
Returns:
Array
Defined in: adventure/asset/DOVgetMaxConnections.js, line 6
Inherited from: adventurejs.Asset#DOVgetMaxConnections
Parameters:
-
verb
String
The name of a verb.
Returns:
Int
Defined in: adventure/asset/DOVhasIndirectObjects.js, line 6
Inherited from: adventurejs.Asset#DOVhasIndirectObjects
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/DOVhasMaxConnections.js, line 6
Inherited from: adventurejs.Asset#DOVhasMaxConnections
Parameters:
-
verb
String
The name of a verb.
Returns:
Boolean
Defined in: adventure/asset/DOVincrementDoCount.js, line 6
Inherited from: adventurejs.Asset#DOVincrementDoCount
Parameters:
-
verb
String
Defined in: adventure/asset/DOVincrementTryCount.js, line 6
Inherited from: adventurejs.Asset#DOVincrementTryCount
Parameters:
-
verb
String
Defined in: adventure/asset/DOVisConnectedToAnything.js, line 6
Inherited from: adventurejs.Asset#DOVisConnectedToAnything
Parameters:
-
verb
String
The name of a verb.
plugIn
or tie
. For example, if this asset
is a computer plugged into an outlet, this method would return true.
Returns:
Boolean
Defined in: adventure/asset/DOVisConnectedToAsset.js, line 6
Inherited from: adventurejs.Asset#DOVisConnectedToAsset
Parameters:
-
verb
String
The name of the verb to test. -
asset
Object | String
A game asset or asset id to test.
Returns:
Boolean
Defined in: adventure/asset/DOVisConnectedToNothing.js, line 6
Inherited from: adventurejs.Asset#DOVisConnectedToNothing
Parameters:
-
verb
String
The name of a verb.
asset.is.direct_object_of_verb.plugIn.with_params.connections
to represent the computer's plugged in state.
Returns:
Boolean
Defined in: adventure/asset/DOVsetConnection.js, line 6
Inherited from: adventurejs.Asset#DOVsetConnection
Parameters:
-
verb
String -
asset
Object
Defined in: adventure/asset/DOVsetWithAsset.js, line 6
Inherited from: adventurejs.Asset#DOVsetWithAsset
Parameters:
-
verb
String -
asset
Object
Returns:
Boolean
Defined in: adventure/asset/DOVsetWithClass.js, line 6
Inherited from: adventurejs.Asset#DOVsetWithClass
Parameters:
-
verb
String -
clas
String
Returns:
Boolean
Defined in: adventure/asset/DOVunsetConnection.js, line 6
Inherited from: adventurejs.Asset#DOVunsetConnection
Parameters:
-
verb
String -
asset
Object
Defined in: adventure/assets/Tangible.js, line 1498
Overrides from: adventurejs.Matter#event_hooks
Todos: move all this!
MyGame.createAsset({
class: "Bicycle",// THIS asset to be nested to
name: "bicycle",
event_hooks: {
onNestThatToThis: {
"Mighty Hero": function(params){ // THAT asset to be nested
MyGame.prependToNextPrint("You wobble a bit getting on the bike. ");
MyGame.appendToNextPrint("Success! ");
}
},
},
});
This example only adds some text to the output for the turn,
but overrides can be used to add any kind of logic. Here's are
some of the reactions that can be overriden:
Defined in: adventure/assets/tangible/$get.js, line 6
Parameters:
-
property
String -
qualifier
String
- all - list things anywhere in this
- behind - list things behind this
- in - list things in this
- on - list things on this
- under - list things under this
- attached - list things attached to this
Defined in: adventure/assets/tangible/getAllContents.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getAllNestedContents.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getAncestorId.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getAnySubstanceThisContains.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getAspectAt.js, line 6
Parameters:
-
aspect
string
The aspect to get.
Returns:
Object
|
Null
Defined in: adventure/assets/tangible/getAspectWithVessel.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getClosedAnscestors.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getContentsAt.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getCountOfListableContentsAt.js, line 6
Parameters:
-
where
String
Returns:
int
Defined in: adventure/asset/getDescription.js, line 6
Inherited from: adventurejs.Asset#getDescription
Parameters:
-
description
String
Returns:
String
Defined in: adventure/asset/getIndirectDescription.js, line 6
Inherited from: adventurejs.Asset#getIndirectDescription
Parameters:
-
indirect_aspect
String -
indirect_asset
Object -
direct_aspect
String
Returns:
String
Defined in: adventure/Atom.js, line 238
Inherited from: adventurejs.Atom#getInheritance
Returns:
Array
Defined in: adventure/assets/tangible/getListableContents.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getNestedInstancesOfClass.js, line 6
Parameters:
-
instanceClass
String
Returns:
Array
Defined in: adventure/assets/tangible/getOpenOrClosed.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getPlaceAspect.js, line 6
Returns:
Object
|
null
Defined in: adventure/assets/tangible/getPlacePreposition.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getPlaceAsset.js, line 6
Returns:
Object
|
Boolean
Defined in: adventure/assets/tangible/getPlaceAssetId.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getPrintableListOfContents.js, line 6
Parameters:
-
params
Object
Returns:
String
Defined in: adventure/Atom.js, line 184
Inherited from: adventurejs.Atom#getProperty
Parameters:
-
prop
String
Name of the property to test for. Can include dot notation.
if(false === foo.bar.baz)
comparisons.
Returns:
Boolean
Defined in: adventure/assets/tangible/getRoomAsset.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getRoomId.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getRopesThatBlockTravel.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getSubstanceAt.js, line 6
Returns:
String
Defined in: adventure/assets/tangible/getThingThisIsTiedToPlayerBy.js, line 6
Returns:
Object
Defined in: adventure/assets/tangible/getTiedThingsThatDragOnTravel.js, line 6
Returns:
Array
Defined in: adventure/assets/tangible/getVesselAt.js, line 6
Parameters:
-
aspect
string
The aspect to check.
Returns:
Object
|
Null
Defined in: adventure/assets/tangible/getYBottom.js, line 6
Returns:
Float
Defined in: adventure/assets/tangible/getYRange.js, line 6
Returns:
Object
Defined in: adventure/assets/tangible/getYTop.js, line 6
Returns:
Float
Defined in: adventure/asset/_has.js, line 7
Inherited from: adventurejs.Asset#has
if( MyGame.$('crown').$has('jewel') ){ // do stuff }
Defined in: adventure/assets/tangible/hasAspectAt.js, line 6
Parameters:
-
aspect
String
Returns:
Boolean
Defined in: adventure/Atom.js, line 216
Inherited from: adventurejs.Atom#hasClass
Parameters:
-
prop
String
Name of the classe to test for.
Returns:
Boolean
Defined in: adventure/assets/tangible/hasContentsAtAspect.js, line 6
Parameters:
-
aspect
String
Returns:
Boolean
Defined in: adventure/asset/hasDescription.js, line 6
Inherited from: adventurejs.Asset#hasDescription
Parameters:
-
description
String
Returns:
String
|
Boolean
Defined in: adventure/asset/hasEventHook.js, line 6
Inherited from: adventurejs.Asset#hasEventHook
Parameters:
-
hook
string -
asset_name
string
We use asset.name here instead of asset.id to make life slightly easier for authors. Asset IDs are formed from asset names, but generally we don't expect authors to be aware of IDs. Hooks will only be defined by authors, so let them use asset.name as their identifier. We do however make an effort to see if an id has been passed instead of a name.
Returns:
Boolean
Defined in: adventure/asset/hasIndirectDescription.js, line 6
Inherited from: adventurejs.Asset#hasIndirectDescription
Parameters:
-
indirect_aspect
String -
indirect_asset
Object -
direct_aspect
String
Returns:
String
|
Boolean
Defined in: adventure/assets/tangible/hasListableContents.js, line 6
Todos: transparent containers
Returns:
Boolean
Defined in: adventure/assets/tangible/hasPlace.js, line 6
Returns:
Boolean
Defined in: adventure/Atom.js, line 148
Inherited from: adventurejs.Atom#hasProperty
Parameters:
-
prop
String
Name of the property to test for. Can include dot notation.
Returns:
Boolean
Defined in: adventure/assets/tangible/hasPropertyOnAspectAt.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/hasRopesThatBlockTravel.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/hasTiedThingsThatDragOnTravel.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/hasVessel.js, line 6
Returns:
Boolean
Defined in: adventure/assets/tangible/hasVesselAtAspect.js, line 6
Parameters:
-
aspect
String
Returns:
Boolean
Defined in: adventure/asset/incrementDoVerbCount.js, line 6
Inherited from: adventurejs.Asset#incrementDoVerbCount
Parameters:
-
verb
String -
index
Int
Defined in: adventure/asset/incrementTryVerbCount.js, line 6
Inherited from: adventurejs.Asset#incrementTryVerbCount
Parameters:
-
verb
String -
index
Int
Defined in: adventure/assets/Tangible.js, line 2122
Overrides from: adventurejs.Matter#initialize
Parameters:
-
game
Object
- link related objects
- register parts
Returns:
Boolean
Defined in: adventure/asset/IOVallowOnce.js, line 6
Inherited from: adventurejs.Asset#IOVallowOnce
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/IOVallowWithAnything.js, line 6
Inherited from: adventurejs.Asset#IOVallowWithAnything
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/IOVallowWithAsset.js, line 6
Inherited from: adventurejs.Asset#IOVallowWithAsset
Parameters:
-
verb
String -
asset
Object
Returns:
Boolean
Defined in: adventure/asset/IOVallowWithNothing.js, line 6
Inherited from: adventurejs.Asset#IOVallowWithNothing
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/IOVdidDo.js, line 6
Inherited from: adventurejs.Asset#IOVdidDo
Parameters:
-
verb
String
_iDidDo is an alias meant for authors.
Returns:
Boolean
Defined in: adventure/asset/IOVdidDoCount.js, line 6
Inherited from: adventurejs.Asset#IOVdidDoCount
Parameters:
-
verb
String
_iDoCount is an alias meant for authors.
Returns:
Int
Defined in: adventure/asset/IOVdidTry.js, line 6
Inherited from: adventurejs.Asset#IOVdidTry
Parameters:
-
verb
String
_iDidTry is an alias meant for authors.
Returns:
Boolean
Defined in: adventure/asset/IOVdidTryCount.js, line 6
Inherited from: adventurejs.Asset#IOVdidTryCount
Parameters:
-
verb
String
_iTryCount is an alias meant for authors.
Returns:
Boolean
Defined in: adventure/asset/IOVgetConnectionCount.js, line 6
Inherited from: adventurejs.Asset#IOVgetConnectionCount
Parameters:
-
verb
String
The name of a verb.
Returns:
Int
Defined in: adventure/asset/IOVgetConnections.js, line 6
Inherited from: adventurejs.Asset#IOVgetConnections
Parameters:
-
verb
String
The name of a verb.
Returns:
Array
Defined in: adventure/asset/IOVgetMaxConnections.js, line 6
Inherited from: adventurejs.Asset#IOVgetMaxConnections
Parameters:
-
verb
String
The name of a verb.
Returns:
Int
Defined in: adventure/asset/IOVhasDirectObjects.js, line 6
Inherited from: adventurejs.Asset#IOVhasDirectObjects
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/asset/IOVhasMaxConnections.js, line 6
Inherited from: adventurejs.Asset#IOVhasMaxConnections
Parameters:
-
verb
String
The name of a verb.
Returns:
Boolean
Defined in: adventure/asset/IOVincrementDoCount.js, line 6
Inherited from: adventurejs.Asset#IOVincrementDoCount
Parameters:
-
verb
String
Defined in: adventure/asset/IOVincrementTryCount.js, line 6
Inherited from: adventurejs.Asset#IOVincrementTryCount
Parameters:
-
verb
String
Defined in: adventure/asset/IOVisConnectedToAnything.js, line 6
Inherited from: adventurejs.Asset#IOVisConnectedToAnything
Parameters:
-
verb
String
The name of a verb.
plugIn
or tie
. For example, if this asset
is an outlet with a computer plugged into it, this method would return true.
Returns:
Boolean
Defined in: adventure/asset/IOVisConnectedToAsset.js, line 6
Inherited from: adventurejs.Asset#IOVisConnectedToAsset
Parameters:
-
verb
String
The name of the verb to test. -
asset
Object | String
A game asset or asset id to test.
Returns:
Boolean
Defined in: adventure/asset/IOVisConnectedToNothing.js, line 6
Inherited from: adventurejs.Asset#IOVisConnectedToNothing
Parameters:
-
verb
String
The name of a verb.
Returns:
Boolean
Defined in: adventure/asset/IOVsetConnection.js, line 6
Inherited from: adventurejs.Asset#IOVsetConnection
Parameters:
-
verb
String -
asset
Object
Defined in: adventure/asset/IOVsetWithAsset.js, line 6
Inherited from: adventurejs.Asset#IOVsetWithAsset
Parameters:
-
verb
String -
asset
Object
Returns:
Boolean
Defined in: adventure/asset/IOVsetWithClass.js, line 6
Inherited from: adventurejs.Asset#IOVsetWithClass
Parameters:
-
verb
String -
clas
String
Returns:
Boolean
Defined in: adventure/asset/IOVunsetConnection.js, line 6
Inherited from: adventurejs.Asset#IOVunsetConnection
Parameters:
-
verb
String -
asset
Object
Defined in: adventure/asset/isDOV.js, line 6
Inherited from: adventurejs.Asset#isDOV
Parameters:
-
verb
String
Returns:
Boolean
Defined in: adventure/assets/tangible/$isIn.js, line 7
Parameters:
-
asset
Object | String
Can be string or object.
if( MyGame.$('jewel').$isIn('crown') ){ // do stuff }
Defined in: adventure/asset/isIOV.js, line 6
Inherited from: adventurejs.Asset#isIOV
Parameters:
-
verb
String
Returns:
Boolean