search:

General



Rooms & Areas



Presence



Systems



Wiki Help



pmwiki.org



edit menu
Edit Page Upload Security

Expressions

$object variable construct

$object is a reference to the currently selected object.
$object:armorvalue
The combat rewrite armor value of the current object cross-referenced with player referenced by $target.
$object:article
The article ("a", "an", "some", "the") of the current object, auto-encapsulated in quotes for evaluation commands.
$object:closeable
Checks the open / closeable status of the current object. Same as ($object:data1:3 & 1), but easier for humans to read.
0 = false
1 = true, $object can be opened and closed
$object:closedstatus
The opened / closed status of the current object. Same as (1 XOR ($object:data1:3 & 4)), but easier for humans to read.
0 = open
1 = closed
$object:contains, $object:containingquantity
The quantity of items contained in the current object.
$object:containingweight
The combined weight of all of the items contained in the current object.
$object:data1:1
Altered status of the current object.
0 = no status
1 = altered by staff
$object:data1:2, $object:charges
Charges remaining on the current object.
$object:data1:3
Bitfield for container flag data on the current object.
1 = can be opened and closed
4 = currently closed
16 = contents are protected from theft
$object:data1:4
Bitfield for general flag data on the current object.
1 = container
2 = no-sell
4 = no-enchant
8 = invisible
32 = cursed
64 = blessed
128 = manipulate while invisible
256 = no-janitor
512 = temporarily no-janitor
1024 = janitorize
131072 = staff only
$object:data1:5
Object type for the current object.
0 = source of light
1 = weapon
2 = ammunition
3 = armor
4 = money / gold
5 = treasure (gems)
6 = potion
7 = miscellaneous worn object
8 = thought device
9 = fluid container
10 = key
11 = food
12 = drink
13 = personal boat
14 = other / miscellaneous
15 = shield
$object:data1:6, $object:value
Value of the current object, in gold pieces.
$object:data1:7
Bitfield for wear slot data on the current object.
1 = pick-up / take
2 = head
4 = eyes
8 = neck
16 = back
32 = chest
64 = arms
128 = hands
256 = finger
512 = around the waist
1024 = hanging from the belt
2048 = legs
4096 = feet
8192 = anywhere
16384 = ear
32768 = shoulder
65536 = wrist
131072 = thigh
262144 = ankle
524288 = horns
1048576 = eyebrow
2097152 = wings
4194304 = tail
8388608 = underwear, top
16777216 = underwear, bottom
33554432 = toes
$object:data1:8, $object:weight
Weight of the current object, in U.S. pounds. A value of 0 is interpretted to mean 0.1, since this is a whole integer field only.
$object:data2:1 - $object:data2:8
Extra data values for the current object. Used by weapons, armor, containers, and for custom purposes.
$object:data3:1 - $object:data3:8
Extra data values for the current object. Used by many special items, armor, animal companions, store items, and for custom purposes.
$object:data4:1 - $object:data4:10
Extra data values for the current object. Used by combat rewrite equipment and for custom purposes.
$object:data5:1 - $object:data5:10
Extra data values for the current object. Used for custom purposes.
$object:descriptor
The adjective / descriptor ("red", "steel", "giant") of the current object, auto-encapsulated in quotes for evaluation commands.
$object:empty
Shortcut identification for whether or not the current object contains any other objects. Same as ($object:containingquantity == 0) but easier for humans to read.
0 = false
1 = true, $object is empty
$object:id
Object ID # of the current object.
$object:initem
Object ID # of the container object that the current object is in. If the current object is not inside of a container, then this value will be 0.
$object:magical, $object:hasanymagic
Object effect status of the current object, including effects that are and are not magical in nature.
0 = true, object is affected by at least one object effect code
1 = false
$object:meleeweapon
Shortcut identification for whether or not the current object is considered a weapon that can be used at melee combat range. Same as (($object:data1:5 == 1) && ($object:data2:5 < 3)) but easier for humans to read.
0 = false
1 = true, $object is a melee weapon
$object:name
The short description (TAP description) of the current object, auto-encapsulated in quotes for evaluation commands.
$object:longdesc, $object:look, $object:lookdesc, $object:fulldesc
The full description (LOOK description) of the current object, auto-encapsulated in quotes for evaluation commands.
$object:owner, $object:ownerid
Player ID # of the player currently holding or wearing this object (or if the object is in a container that the player is holding or wearing).
$object:read, $object:readdesc
The READ description of the current object, auto-encapsulated in quotes for evaluation commands.
$object:room:number
The room # that the current object is located in or 0 if it is not in a room.
$object:script
The script ID assigned to the current object.
$object:sellable
Checks the no-sell flag of the current object. Same as ($object:data1:4 & 2), but easier for humans to read.
0 = true, $object is sellable
1 = false
$object:truename
The noun of the current object, auto-encapsulated in quotes for evaluation commands.
$object:wornstatus
Determines the worn relationship status of the object to a player.
0 = not being held or worn by a player
1 = worn in a player's inventory
13 = held in a player's left hand
14 = held in a player's right hand
Recent Changes - Page History - Printable View
Page last modified on January 14, 2006, at 10:15 PM EST
PmWiki 2.20-beta16 - www.PmWiki.org