Special Key

Description

When carrying the appropriate special key, a locked door can be opened. The key will disappear.

This object-type can also be used for "passport"-like items: When walking onto an inventory checker, a gate for example might get opened. The "passport" will stay in the player's inventory.

Type defined by:

• object::type = 21

Attributes

Attribute	Field	Description
block view	FLAG_BLOCKSVIEW	If an item is set to block view, players (and monsters) cannot see beyond it unless they cross it or manage to stand on top.
description	obj::msg	This will add a description to the object. The player can read this text by clicking on the item in his inventory. Use this message to describe what the key/passport is good for. A player might have 50 different keys on his key-ring. Don't expect players to recall their purpose just by their names.
elevation	obj::elevation	The elevation (height above sea level) of this tile. It is used for weather calculations and should be in the range -32000..32000. The elevation of a tile must be set in the bottom-most game object; elevation values for non-bottom-most game objects are ignored by the Crossfire server.
glow radius	obj::glow_radius	If <glow radius> is set to a value greater zero, the object appears lit up on dark maps. <glow radius> can be a value between 0 and 4, the higher, the more light does the object emit.
godgiven item	FLAG_STARTEQUIP	A godgiven item vanishes as soon as the player drops it to the ground.
identified	FLAG_IDENTIFIED	If an item is identified, the player has full knowledge about it.
image	obj::face	The image-name defines what image is displayed for this object in-game.
invisible	obj::invisible	Generally makes the object invisible. Depending on the object-type, some can be made visible by the show_invisible spell. If in doubt, test it. Putting an invisible object under the floor always prevents it from being shown.
key string	obj::slaying	This string must be identical with the <key string> in the locked door, then it can be unlocked. It can also be used to trigger inventory checkers.
material	obj::material	For Special Keys, material should always be unset or set to Adamantite. This prevents the key from getting burned or otherwise destroyed.
name	obj::name	This is the name of the object, displayed to the player.
non-pickable	FLAG_NO_PICK	If set, the object cannot be picked up (Neither by players nor monsters).
number	obj::nrof	This value determines the number of objects in one stack (for example: 100 gold coins => "number = 100"). You should set this at least to one, for any pickable object - otherwise it won't be mergeable into a stack.
plural name	obj::name_pl	This is the plural name of the object. A plural name must be set for all items that can be picked up and collected by the player.
smooth level	obj::smoothlevel	If <smooth level> is set to a value greater zero, the object will be drawn partially over adjacent squares having a lower <smooth level> value. The value must be between 0 and 255 (inclusive); 0 means "never overlap adjacent squares".
title	obj::title	This is the object's title. Once an object is identified the title is attached to the name. Typical titles are "of Mostrai", "of xray vision" etc.
unique item	FLAG_UNIQUE	Unique items exist only one time on a server. If the item is taken, lost or destroyed - it's gone for good. This can be used if you want to sell apartments on your map: Simply sell a unique passport/key, and place an inventory checker at the entrance of your apartment.
unpaid	FLAG_UNPAID	An <unpaid> item cannot be used unless a player carried it over a shop mat, paying the demanded price. Setting this flag makes sense only for pickable items inside shops.
value	obj::value	Adds a certain value to the object: It will be worth that many times the default value from it's archetype (E.g. "value = 3" means three times worth the default value). Value for buying/selling will be further modified by various factors. Hence, testing values in-game is usually inevitable.
weight	obj::weight	This value defines the object's weight in grams (1000g is 1kg). Objects with zero weight are not pickable for players. Still, set the "non-pickable"-flag for explicitly non-pickable objects (hey, this is opensource.. you never know ;) ).