SphereWiki - User contributions [en]

@PersonalSpace

2025-10-02T16:26:54Z

Jhobean: Add ARGN3

==Description==
This trigger fires when a character is stepped on by another character.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] being stepped on.
|-
| [[SRC]] || The [[Characters|character]] doing the stepping.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of stamina needed to step on to the character.
|-
| ARGN2 || O || Setting it to 1 allow NPCs to pass over another NPCs, 0 reject the movement.
|-
| ARGN3 || IO || Maximum stamina requirement (default 1 = require maximum stamina)(X-Only)
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from being stepped on.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

TYPEDEF

2025-05-20T10:45:33Z

Jhobean:

{{Languages|TYPEDEF}}

__FORCETOC__
Type definitions are the equivalent of [[EVENTS]] that can be attached to [[Items|items]]. There are different properties that can be used to attach a type block to an item or set of items:
* [[ITEMDEF|item definitions]] via their [[TYPE]] and/or [[TEVENTS]] property.
* [[Items|items]] via their [[TYPE]] and/or [[EVENTS (Property)|EVENTS]] property.

In addition to handling triggers, type definitions can also be used to define different types of terrain. This can be used to affect the return value of the [[TYPE]] property on [[Map points|map points]], or for some hardcoded types such as t_rock it can be used to define which terrain IDs Sphere should consider to be rock when the mining skill is used.

==Built-in Types==

The built-in types are all listed in the sphere_defs.scp file. The table below only lists some of the built-in types and it is VERY weak on actual details...so use with care.

{| border="1"
! DEFNAME !! Number !! Description
|-
| t_normal || 0 || No built-in behavior.
|-
| t_container and t_container_locked || 1 and 2 || These types are used for containers. They leverage the following properties:
* MORE1 = "ID" from the key that can unlock this item (If the MORE1 of the key matches the MORE1 of the container then they are linked)
* MORE2 = The lock complexity (how hard it is to pick the lock)
* MOREX = The trap type (not used yet?)
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3/4: Defines rectangle, where you can place items (so they won't end up out of gump)
* TDATA3 = top left corner. Hexadecimal number, each position takes 4 bytes, XY (example: X = 10 (0a) and Y = 20 (014) will look like TDATA3=000a0014
* TDATA4 = bottom right corner.
* LINK = UID of a secondary key?
|-
| t_door or t_door_locked || 3 or 4 || This type is used for both unlocked and locked doors. They leverage the following properties:
* MORE1 = UID of this door's key (if it has one)
* TDATA1 = ID for the sound it makes when double clicked
|-
| t_key || 5 || This type is used for keys. It leverages the following properties:
* MORE1 = "ID" of the item(s) this key can unlock (if the MORE1 of the key matches the MORE1 of the container/door then they are linked)
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.
|-
| t_light_lit || 6 || This type is used for light sources that can be turned onIT_S or off. It leverages the following properties:
* MOREY = Number of charges before the item is consumed
* MOREZ = Type of light pattern it will cast
|-
| t_light_out || 7 || This type is used for light sources that can be turned on or off. It leverages the following properties:
* MOREY = Number of charges before the item is consumed
* MOREZ = Type of light pattern it will cast
|-
| t_food || 8 || This type is used for edible food. It leverages the following properties:
* MORE2 = The ID of the creature that this came from
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the food
'''Note:''' The following properties may also exist depending on your server version:
* MOREX = The ID of a spell effect that will be gained when eaten
* MOREY = The strength of the spell effect
|-
| t_food_raw || 9 || This type is used for ''raw'' food. It leverages the following properties:
* MORE1 = ID of the item it makes when cooked (the default is i_unused and if defined, it will override TDATA1)
* MORE2 = The ID of the creature that this came from
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the food
* TDATA1 = The item ID this cooks into
'''Note:''' The following properties may also exist depending on your server version:
* MOREX = The ID of a spell effect that will be gained when eaten
* MOREY = The strength of the spell effect
* TDATA2 = The creature ID type that the food came from
* TDATA3 = The amount of skill required to cook it (did this ever work?)
|-
| t_armor || 10 || This type is used for armor. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)
* MOREY = There are two possible effects of setting MOREY:
*# If MOREX is set, then MOREY is the power/effect of that spell
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.
|-
| t_weapon_mace_smith || 11 || This type is used for macefighting weapons that can also be used by blacksmiths to forge items. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_mace_sharp || 12 || This type is used for macefighting weapons that have sharp cutting edges. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_sword || 13 || This type is used for swordsmanship weapons. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_fence || 14 || This type is used for fencing weapons. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_bow || 15 || This type is used for archery weapons (bow or crossbow). It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
* TDATA1 = The sound effect the weapon makes when it shoots
* TDATA2 = The required strength to wield the weapon
* TDATA3 = ID of arrow item that will be fired (and must therefore be on the player's person)
* TDATA4 = ID of the arrow animation (for bows it is usually i_arrow_x, for crossbows, i_xbow_x)
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = to override the sound this weapon makes when it misses
* AMMOANIMRENDER = to override the rendermode of the ANIM this item uses (yes, no TAGs)
* AMMOTYPE = to override the type of ammo (TDATA3) this item uses (yes, no TAGs)
* AMMOANIM = to override the ammo animation (TDATA4) this item uses (yes, no TAGs)
* AMMOANIMHUE = to override the color of the ammo animation this item uses (yes, no TAGs)
|-
| t_wand || 16 || This type is used for magic wands. It leverages the following properties:
* MORE1L = the current amount of hitpoints the item has
* MORE1H = the maximum hitpoints for the item
* MORE2 = the number of remaining charges (if magical)
* MOREX = the spell type (if magical)
* MOREY = the spell strength (0-1000)
* MOREZ = the poison skill applied (0-100)
* TDATA2 = Required Strength to equip the wand
* TDATA3 = ID of the light pattern
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object).
|-
| t_telepad || 17 || This type is used for teleport pads. It leverages the following properties:
* MOREP = Coordinates of the point to which you will teleport when you step on the item
* MORE1 = If set to 1, the teleport pad will only work for players (and their pets)
* MORE2 = If set to 1, the teleport animation and sound will not be shown to anyone witnessing the teleport
|-
| t_switch || 18 || This type is used for switches. The way these things work is, when used, they trigger @DCLICK on the LINK object. It leverages the following properties:
* LINK = UID of item to trigger
* MORE1 = The item ID of the next state of the switch
* MOREX = A flag to indicate if this is activated by stepping on it
|-
| t_book || 19 || This type is used for books of static or dynamic text. It leverages the following properties:
* MORE1L = This can be set to an ID of a book (some default book text is included in the sphere_books.scp file)
* MORE1H = Some flags that determine book behavior:
** 0c00: Scripted book
** 0800: Editable book
** 08000: ? time stamp ?
* AUTHOR = The ID of the character that wrote the book
* BODY.# = The text for each page of the book (starting with page 0)
'''Note:''' we need more information on those flags...
|-
| t_rune || 20 || This type is used for recall runes. It leverages the following properties:
* MORE1 = The number of uses left before it wears out
* MOREP = The coordinates of the marked location
|-
| t_booze || 21 || This type is used for alcohol (it causes a drunk effect when double clicked.) It leverages the following properties:
* TDATA1 = A flag that indicates whether the container is empty or not.
|-
| t_potion || 22 || This type is used for potions. It leverages the following properties:
* MORE1 = The potion spell effect that will result when the potion is double clicked
* MORE2 = The strength of the potion (This has a different effect defending on the spell, usually between 0 and 1000)
* MOREX = The countdown to explosion (for purple potions)
* TDATA1 = A flag that indicates whether the container is empty or not
|-
| t_fire || 23 || This type is used for fires (and ovens?). These items can be used to cook food, and they can burn you if stepped on. It leverages the following properties:
* TIMER = time until it decays?
* MORE1 (or MORE2?) = Amount of damage it will cause when stepped on or dclicked
* MOREZ = Type of light pattern it will cast
|-
| t_clock || 24 || This type is used to tell time (game time, not real time) when double clicked. The result comes out something like "half past eleven o'clock at night". From what I can tell there are no MORE or TDATA modifiers that affect the result.
|-
| t_trap and t_trap_active || 25 and 26 || These types are used for traps that are triggered when walked on. They leverage the following properties:
* MORE1 = ID of the animation
* MORE2 = The damage the trap will cause
* MOREX = The length of time the animation will run
* MOREY = The length of time the activated trap will idle until reset
* MOREZ = A flag that indicates if the trap must idle before changing from active to inactive.
|-
| t_musical || 27 || This type is used for musical instruments. It leverages the following properties:
* TDATA1 = The sound ID to be played if successful
* TDATA2 = The sound ID to be played if not successful
|-
| t_spell || 28 || This type is used for magic spell effects. It leverages the following properties:
* MORE1L = The polymorph effect on STR
* MORE1H = The polymorph effect on DEX
* MORE2 = The number of charges left
* MOREX = The spell effect that will result when the item is stepped on
* MOREY = The strength of the spell (This has a different effect defending on the spell, usually between 0 and 1000)
* MOREZ = Type of light pattern it will cast
|-
| t_gem || 29 || This type is used for gems, and from what I can tell there is no built-in behavior for it.
|-
| t_water || 30 || This type is used for water, which means it can be fished in or used to clean used bandages.
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
|-
| t_clothing || 31 || This type is used for all cloth based equip-able items. It is essentially identical to t_armor and t_armor_leather. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)
* MOREY = There are two possible effects of setting MOREY:
*# If MOREX is set, then MOREY is the power/effect of that spell
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.
|-
| t_scroll || 32 || This type is used for scrolls. It leverages the following properties:
* MOREX = ID of the spell to cast when double-clicked
* MOREY = Power of the spell (equivalent to the EFFECT setting of the spell itself?)
|-
| t_carpentry || 33 || This type is used by carpenters to craft items, and from what I can tell there is no built-in behavior for it.
|-
| t_spawn_char || 34 || This type is used to spawn NPCs. Once it spawns its first creature, it will turn red and change its appearance to the ICON of the creature (or appear as a wisp if the spawn is set to use a template.) It leverages the following properties:
* AMOUNT = The maximum amount of NPCs the spawner should create
* MORE1/SPAWNID* = The creature ID or spawn template ID for what you want to spawn
* MORE2/COUNT* = The current number of creatures spawned from this point
* MOREX/TIMELO* = The minimum time between spawns (in minutes)
* MOREY/TIMEHI* = The maximum time between spawns (in minutes)
* MOREZ/MAXDIST* = The maximum distance away from the spawn to create the spawned NPC (this is also the maximum wander distance for the NPC)
* AT*(R/W) = Access the object in the N position and reads/writes/executes the given text, eg: at.0.remove, <at.0.str>...
* ADDOBJ*(W) = Adds to the spawn an object with the given uid (must be a valid uid)
* DELOBJ*(W) = Deletes from the spawn an object with the given uid (must be a valid uid)
* START*(W) = Forces the spawn to start spawning
* STOP*(W) = Stops the spawn and removes everything it created
* RESET*(W) = Froces an STOP and then START it again

*X branch only

'''Note:''' The spawn is considered active if the TIMER has a positive value, and when the timer reaches zero, it is automatically restarted using a random number between MOREX and MOREY.
|-
| t_game_piece || 35 || This type is used for game board pieces (checkers, chess, etc). They cannot be removed from the game, and they have no tile image outside of the game board gump. It leverages the following properties:
* TDATA1 = The starting x position for this piece
* TDATA2 = The starting y position for this piece
|-
| t_portculis || 36 || This type is used for portcullis doors that raise and lower when double clicked. It leverages the following properties:
* MORE1 = The z height at the lowest setting
* MORE2 = The z height at the highest setting
|-
| t_figurine || 37 || This type is used for shrunk NPCs (essentially magic figurines), that turn into a "pet" creature when double clicked. It leverages the following properties:
* MORE1 = The creature ID that will spawn when the item is double clicked.
* MORE2 = The UID of the off-line creature (in "stable master" inventory)
* TDATA2 = The required strength to mount the creature (presumably only if it is possible to mount it)
* TDATA3 = The base creature ID.
|-
| t_shrine || 38 || This type is used for shrines. They will resurrect a ghost when double-clicked by a ghost.
|-
| t_moongate || 39 || This type is used for moongates. When stepped on they teleport the player to another location. It leverages the following properties:
* MOREP = The coordinates that the moongate leads to
* MORE1 = If set to 1, the smoke and sound is supressed
* MORE2 = If set to 1, NPCs (and pets?) cannot use it
|-
| t_chair || 40 || This type is used for any sort of a chair item and it's only purpose is to trigger a sitting animation.
|-
| t_forge || 41 || This type is used by blacksmiths to smelt ore....
|-
| t_ore || 42 || This type is harvested by miners, and converted by blacksmiths (using a forge) into something else. It leverages the following properties:
* TDATA1 = ID of item created when the ore is smelted (usually ingots)
|-
| t_log || 43 || This type is a raw material resource usually harvested from trees.
|-
| t_tree || 44 || This type is chopped by lumberjacks to get logs. It leverages the following properties:
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
* FRUIT = ID of item gathered if double-clicked (usually logs)
|-
| t_rock || 45 || This type can be mined for ore.
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
|-
| t_carpentry_chop || 46 || A carpentry tool that can be used to craft carpentry objects as well as used to "chop" trees (like a saw?)
|-
| t_multi || 47 || Multi part object like house or ship.
* MORE1 is the UID of the player that created/owns the multi
|-
| t_reagent || 48 || Alchemy when clicked ?
|-
| t_ship || 49 || This is a ship multi.
* MORE1 is the UID of the player that created/owns the multi
* MORE2 contains the speed, anchor flag, direction of movement, and facing direction in each byte respectively
|-
| t_ship_plank || 50 || Ship plank for players to get on a boat.
* TDATA1 = is the itemID of the next open/closed state.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
* MOREX = type to become (IT_SHIP_SIDE or IT_SHIP_SIDE_LOCKED)
|-
| t_ship_side || 51 || Should extend to make a plank TDATA1 is the itemID of the next open/closed state.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_ship_side_locked || 52 || TDATA1 is the itemID of the next open/closed state.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_ship_tiller || 53 || Tiller man on the ship.
* MORE1 = the lock code. Normally this is the UID, except if uidLink is set.
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.
|-
| t_eq_trade_window || 54 || Container for the trade window.
|-
| t_fish || 55 || Fish can be cut up. Yields 4 * <Amount> when a bladed object is used on it.
|-
| t_sign_gump || 56 || This type is used for simple signs (and things like grave stones). It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
* MORE1 = the lock code. Normally this is the UID, except if uidLink is set.
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.
|-
| t_stone_guild || 57 || This type is used for guild stones. It leverages the following properties:
* MORE1 = The alignment of the guild (chaos, neutral, order)
* MORE2 = The amount of gold in the guild account
|-
| || ||
t_anim_active 58 // = active anium that will recycle when done.
t_sand 59 // = sand on the beach
t_cloth 60 // = bolt or folded cloth
t_hair 61 //
t_beard 62 // = just for grouping purposes.
|-
| t_ingot || 63 || This type is used for ingots (when a blacksmith smelts ore, it turns into ingots. It leverages the following properties:
* TDATA1 = The skill required to smelt this
* TDATA2 = The skill required to get the maximum yield when smelting
|-
| t_coin || 64 || This types is used for coins, gold or otherwise.
|-
| t_crops || 65 || This type is used to grow plants that likely bear fruit. Double clicking a t_crop item will harvest the fruit if it is ripe. It leverages the following properties:
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)
* TDATA1 = Is the ID of the first stage of the crop (the sprout), it is the ID that the crop will be reset to regrow from (0=nothing, which means this plant will not regrow once harvested)
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant (0 means the plant is not mature)
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.
|-
| t_drink || 66 || This type is used for non-alcoholic drinks. It leverages the following properties:
* TATA1 = A flag that indicates whether the container is empty or not.
'''Note:''' There is an INI flag OF_DrinkIsFood (0x10000) that, if set, will increase FOOD level when the drink is consumed (like T_FOOD does)
|-
| || ||
t_anvil 67 // = for repair.
t_port_locked 68 // = this portcullis must be triggered.
|-
| t_spawn_item || 69 || This type is used to spawn items. Once it spawns its first item, it will turn red and change its appearance to the i_worldgem_lg ID item. It leverages the following properties:
* AMOUNT = The maximum amount of items the spawner should create
* MORE1/SPAWNID* = The item ID or spawn template ID for what you want to spawn
* MORE2/PILE* = The current number of items spawned from this point
* MOREX/TIMELO* = The minimum time between spawns (in minutes)
* MOREY/TIMEHI* = The maximum time between spawns (in minutes)
* MOREZ/MAXDIST* = The maximum distance away from the spawn to create the spawned item (this is also the maximum wander distance for the NPC)
* AT*(R/W) = Access the object in the N position and reads/writes/executes the given text, eg: at.0.remove, <at.0.str>...
* ADDOBJ*(W) = Adds to the spawn an object with the given uid (must be a valid uid)
* DELOBJ*(W) = Deletes from the spawn an object with the given uid (must be a valid uid)
* START*(W) = Forces the spawn to start spawning
* STOP*(W) = Stops the spawn and removes everything it created
* RESET*(W) = Froces an STOP and then START it again

*X branch only

'''Note:''' The spawn is considered active if the TIMER has a positive value, and when the timer reaches zero, it is automatically restarted using a random number between MOREX and MOREY.
|-
| || ||
t_telescope 70 // = big telescope pic.
|-
| t_bed || 71 || This type is used to indicate the item is a bed. I am not sure how it is used exactly, but it leverages the following properties:
* TDATA1 = The direction it occupies
|-
| t_gold || 72 || This type is used to indicate the object is a gold coin and can be used to purchase stuff.
|-
| t_map || 73 || This type is used for cartography maps. It has the following properties:
* MORE1L = The top coordinate.
* MORE1H = The left coordinate.
* MORE2L = The bottom coordinate.
* MORE2H = The right coordinate.
* MOREZ = A flag that indicates whether the map has pins or not.
* MOREX and MOREY = The coordinates of the pin (I think).
* TDATA1 = The map gump width.
* TDATA2 = The map gump height.
|-
| t_eq_memory_obj || 74 || This type is used for character memories, and it really depends on the type of memory to know what each property really means, but here is a relatively good guide:
* MORE1L = The action type this is a memory for
* MORE1H = The skill involved
* MORE2 = The start time of the memory
* MOREP = The map coordinates at which the memory occurred.
|-
| || ||
t_weapon_mace_staff 75 // = staff type of mace. or just other type of mace.
|-
| t_eq_horse || 76 || This type is used for equipped horse object. Essentially it represents a riding horse to the client. It leverages the following properties:
* MORE1 = The creature ID
* MORE2 = The UID of the offline creature (in "stable master" inventory)
* TDATA2 = The required strength to mount it
* TDATA3 = The base creature ID
|-
| t_comm_crystal || 77 || This type is used for communication crystals.
|-
| t_game_board || 78 || This type is used as a container for game pieces (t_game_piece). It leverages the following properties:
* MORE1 = The type of pieces to use (0=chess, 1=checkers, 2=none... presumably this is hard-coded)
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_trash_can || 79 || This type is used as a trash can container, and it deletes any object placed into it. It leverages the following properties:
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_cannon_muzzle || 80 || This type is used for the business end of the cannon. It leverages the following properties:
* MORE2 = A mask of what is currently loaded in it. (0 = none, 1=powder, 2=shot)
|-
| t_cannon || 81 || This type is used for the cannon control.

|-
| t_cannon_ball || 82 || This is ammo for a t_cannon.
|-
| || ||
t_armor_leather 83 // = non metallic armor (t_clothing)
|-
| t_seed || 84 || This type is used for seeds. A seed can be created by using a dagger on a fruit (assuming the fruit is setup to have a seed.) A seed can be planted by double clicking it and targeting the ground (specifically t_dirt items). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that will grow the fruit that this seed comes from. 0 is Nothing.
* TDATA2 = The art asset to use as the seed art asset. A copper coin is default.
|-
| || ||
t_junk 85 // = never used
t_crystal_ball 86 // = Has no internal use.
t_swamp 87 // = swamp (smelly)
|-
| t_message || 88 || This type is used for bulletin board messages. It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_reagent_raw || 89 || Freshly grown reagents...not processed yet. A seed can be created by using a dagger on a raw reagent (assuming the raw reagent is setup to have a seed.) A seed can be planted by double clicking it and targeting the ground (specifically t_dirt items). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that will grow the fruit that this seed comes from. 0 is Nothing.
* TDATA2 = The art asset to use as the seed art asset. A copper coin is default.
|-
| t_eq_client_linger || 90 || Change player to npc for a while.
|-
| t_snow || 91 || Snow
|-
| t_it_stone || 92 || This type is an "item stone" that is used to generate items when the object is double clicked. It has the following properties:
* MORE1 = The item or template ID to generate
* MORE2 = The price (or Plotflags to set?)
* MOREX = The regen time (0 = instant)
* MOREY = The total amount to deliver (0 = infinite, 0xFFFF = none left)
|-
| t_unused_93 || 93 || This has no use.
|-
| t_explosion || 94 || This type is used for explosion animations. It leverages the following properties:
* MOREX = The damage that the explosion will cause
* MOREY = The type of damage (fire, magic, etc)
* MOREZ = The distance range for the damage
|-
| t_eq_npc_script || 95 || This type is used to script NPC actions (in the form of a book). The sphere_defs.scp file says "get rid of this in favor of waiting on m_events" but it may still exist... if so, it leverages the following properties:
* MORE1 = The same as for other books
* MORE2L = The current script page
* MORE2H = The current offset
* MOREZ = The priority for this script (as a percent, this is the chance they want to "do" this task)
|-
| t_web || 96 || Walk on this and transform into some other object. MORE1 is the amount of hits the web can take.
|-
| t_grass || 97 || Can be eaten by grazing animals
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
|-
| t_arock || 98 || A rock or boulder. can be thrown by giants.
|-
| t_tracker || 99 || Points to a linked object.
|-
| t_sound || 100 || This type is used to play sounds. It uses the following properties:
* MORE1 = The sound ID
* MORE2 = A flag to indicate repetition
|-
| t_stone_town || 101 || This type is used for town stones. It leverages the following properties:
* MORE1 = The alignment of the town (chaos, neutral, order)
* MORE2 = The amount of gold in the town bank account
|-
| || ||
t_weapon_mace_crook 102 //
t_weapon_mace_pick 103 //
t_leather 104 // = leather or skins of some sort.(not wearable)
t_ship_other 105 // = some other part of a ship.
|-
| t_bboard || 106 || This type is a bulleting board container that holds t_message items. It leverages the following properties:
* TDATA2 = The gumpID of the container
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_spellbook || 107 || This type is used for the Magery spellbook. It leverages the following properties:
* MORE1 = A bit mask of available spells in circles 0-4, so to add all those spells: set MORE1=0ffffffff
* MORE2 = A bit mask of available spells in circles 5-8, so to add all those spells: set MORE2=0ffffffff
'''Note:''' In older sphere versions, MOREX, MOREY, and MOREZ could be set to add additional spells (necro, etc), but recently these concepts may have been removed... same with these TDATA settings:
* TDATA2 = Required Strength to equip the book
* TDATA3 = Type of light pattern it will cast
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)
|-
| t_corpse || 108 || This type is a container used for all dead corpses. It leverages the following properties:
* <s>MORE1 = The time of death</s> TIMESTAMP seems to hold the time of death.
* MORE1 = Corpse is already carved? (0=not carved, 1=carved)
* MORE2 = The UID of the individual character that landed the killing blow
* MOREX & MOREY = Combined, these make up a single DWORD which specifies what type of creature this was
* MOREZ = The direction it is facing
* TDATA2 = The gumpID of the container
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
There are two special TAGs for corpses:
* TAG.BLOOD = This is the number of times you can carve the corpse and cause blood to come out (default 5)
* TAG.MAXBLOOD = Not certain about this one, but it is likely related... perhaps it is set on the CHARDEF?
|-
| || ||
t_track_item 109 // - track a id or type of item.
t_track_char 110 // = track a char or range of char id's
t_weapon_arrow 111 //
t_weapon_bolt 112 //
t_eq_vendor_box 113 // = an equipped vendor box
|-
| t_eq_bank_box || 114 || This type is a container that is used for the character bank. It leverages the following properties:
* MORE1 = The amount of gold in the account (is this still true?)
* MORE2 = The amount to restock to (for NPCs vendors who can buy stuff from players?)
* MOREP = The location in the world (x, y, and z) where the bank box was opened
* TDATA2 = The gumpID for the bank box container
* TDATA3 = The minimum gump size
* TDATA4 = the maximum gump size
|-
| t_deed || 115 || This type is used to create something else when double clicked. It is perhaps the best solution for a player to place a ''multi'' part item like a house. When double clicked, it will prompt for a target location. It leverages the following properties:
* MORE1 = The ID of the item that will be created at the target location
* MORE2 = The previous key ID (ideally this is set when a house or ship are re-deeded so that all the existing keys will still work)
|-
| t_loom || 116 || This type of device is used by weavers who turn wool or thread into bolts of cloth. It leverages the following properties:
* MORE1 = The ID of the currently loaded resource (wool or cotton/flax) that is being woven
* MORE2 = The amount of resources currently in the loom
|-
| t_bee_hive || 117 || This type is used for beehives. It leverages the following properties:
* MORE1 = The amount of honey which has accumulated in the hive
|-
| t_archery_butte || 118 || This type is used for practice archery targets. When double clicked, the target will first check if you have an archery weapon equipped and if so, it will return some ammo. It leverages the following properties:
* MORE1 = The ID for the type of ammo currently stuck in the target
* MORE2 = The amount of items stuck in the target
|-
| || ||
t_eq_murder_count 119 // = my murder count flag. MORE1 contains the amount of time before it expires.
t_eq_stuck 120 // we are stuck in a web
t_trap_inactive 121 // = a safe trap.
//t_unused_122 122
t_bandage 123 // = can be used for healing.
t_campfire 124 // = this is a fire but a small one.
t_map_blank 125
t_spy_glass 126
t_sextant 127
t_scroll_blank 128
|-
| t_fruit || 129 || This type is used for fruit. When double clicked, fruit will be eaten. Fruit can be grown from crops (t_crop). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that this fruit comes from (If not set, this fruit may not have a seed, use zero to be certain)
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the fruit
|-
| || ||
t_water_wash 130 // water that will not contain fish. (for washing or drinking) TDATA1 is a flag that indicates whether the container is empty or not
t_weapon_axe 131 // not the same as a sword. but uses swordsmanship skill
|-
| t_weapon_xbow || 132 || This type is used for crossbow weapons. It is essentially identical to t_weapon_bow.
|-
| || ||
t_spellicon 133
t_door_open 134
t_meat_raw 135 // just a meaty part of a corpse. (uncooked meat)
t_garbage 136
|-
| t_keyring || 137 || This type is a container used to store keys. It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_table || 138 || doesn't really do anything.
|-
| t_floor || 139 ||
|-
| t_roof || 140 ||
|-
| t_feather || 141 || a birds feather
|-
| t_wool || 142 || wool cut from a sheep.
|-
| t_fur || 143 ||
|-
| t_blood || 144 || blood of some creature
|-
| t_foliage || 145 || This type is very similar to t_crops, the difference being the foliage does not disappear when the fruit is harvested. It leverages the following properties:
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)
* TDATA1 = Is the ID of the first stage of the crop (the sprout)
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.
|-
| || ||
t_grain 146
t_scissors 147
t_thread 148
t_yarn 149
t_spinwheel 150
t_bandage_blood 151 // = can't be used for healing.
t_fish_pole 152
t_shaft 153 // bolt or arrow.
t_lockpick 154
t_kindling 155
t_train_dummy 156
t_train_pickpocket 157
t_bedroll 158
t_bellows 159
|-
| t_hide || 160 ||Made into leather.
* TDATA1 = Hold ID or DEFNAME of custom cut leather (or any item).
|-
| t_cloth_bolt || 161 || A bolt of cloth.
|-
| t_board || 162 || Logs are plained into decent lumber
|-
| t_pitcher || 163 || A pitcher holding a liquid of some kind.
*TDATA1 is a flag that indicates whether the container is empty or not.
|-
| t_pitcher_empty || 164 || An empty pitcher that can or did hold a liquid.
* TDATA1 is a flag that indicates whether the container is empty or not.
|-
| t_dye_vat || 165 || For dyeing items with.
|-
| t_dye || 166 || Dyes to set colors on a t_dye_vat
|-
| t_potion_empty || 167 || Empty bottle.
|-
| t_mortar || 168 || Alchemists mortar and pestle.
|-
| t_hair_dye || 169 || Hair dye.
|-
| t_sewing_kit || 170 || Tailoring sewing kit.
|-
| t_tinker_tools || 171 || Tinker's tools.
|-
| t_wall || 172 || Wall of a structure.
|-
| t_window || 173 || Window for a structure. MOREZ is the light pattern
|-
| t_cotton || 174 || Cotton from the plant
|-
| t_bone || 175 || A bone from a corpse.
|-
| t_eq_script || 176 || This type can have tags and can be equipped. Possibly used for memory objects that leverage @Equip and @UnEquip triggers.
|-
| t_ship_hold || 177 || A ships hold.
* TDATA2 is the gumpID
* TDATA3 is the minimum gump size
* TDATA4 is the maximum gump size
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_ship_hold_lock || 178 || A locked ship's hold.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_lava || 179 ||
|-
| t_shield || 180 || This type is used to indicate the object is an equipable shield. It has the following properties:
* MORE1L = The current amount of hitpoints the item has
* MORE1H = The maximum hitpoints for the item
* MORE2 = The number of remaining charges (if magical)
* MOREX = The spell type (if magical)
* MOREY = The spell strength (0-1000)
|-
| t_jewelry || 181 || This type is used for equpable jewelry. It leverages the following properties:
* MORE1L = The current amount of hitpoints the item has
* MORE1H = The maximum hitpoints for the item
* MORE2 = The number of remaining charges (if magical)
* MOREX = The spell type (if magical)
* MOREY = The spell strength (0-1000)
* TDATA2 = Required Strength to equip the item
* TDATA3 = Light pattern
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)
|-
| t_dirt || 182 || This type is used to represent a patch of dirt where something can be planted.
|-
| t_script || 183 || This type can have tags, but can NOT be equipped.
|-
| t_spellbook_necro || 184 || AOS Necromancy spellbook (should have MOREZ=100 by default)
|-
| t_spellbook_pala || 185 || AOS Paladin spellbook (should have MOREZ=200 by default)
|-
| t_spellbook_extra || 186 || some spellbook for script purposes (MOREZ=basic offset)
|-
| t_spellbook_bushido || 187 || SE Bushido spellbook (should have MOREZ=400 by default)
|-
| t_spellbook_ninjitsu || 188 || SE Ninjitsu spellbook (should have MOREZ=500 by default)
|-
| t_spellbook_arcanist || 189 || ML Spellweaver spellbook (should have MOREZ=600 by default)
|-
| t_multi_custom || 190 || Customisable multi
|-
| t_spellbook_mystic || 191 || SA Mysticism spellbook (should have MOREZ=677 by default)
|-
| t_hoverover || 192 || Hover-over item (CAN_C_HOVER can hover over blocking items)
|-
| t_spellbook_bard || 193 || SA Bard spellbook (should have MOREZ=700 by default)
|}

==Scripted TYPEDEFs==

{| border="1"
! DEFNAME !! File !! Description
|-
| t_advance_gate || ??.scp || MORE = ID of character to change into
|}

==Syntax==
The syntax for defining a type is:

<tt>
[TYPEDEF ''defname'']<br />
TERRAIN=''id''<br />
TERRAIN=''start_id'', ''end_id''<br />
<br />
ON=''trigger_name''<br />
    ''script''<br />
<br />
ON=''trigger_name''<br />
    ''script''<br />
<br /></tt>

Any number of triggers can be handled by one [[TYPEDEF]] definition, however it is not possible to handle the same trigger twice without using multiple definitions.

The trigger name can be the name of any [[Items#Triggers|item trigger]]. The return value from the script can affect Sphere's hardcoded behaviour in different ways. See the documentation for the trigger to discover what parameters are passed in to each trigger and what the return values do.

'''Note:''' If the ''defname'' matches any of Sphere's hardcoded types (see 'typedefs' block in sphere_defs.scp), then the [[TYPEDEF]] can be used to override the behaviours of items of that type.

==Examples==
<spherescript>
//
// Water definition from default script pack.
//
[TYPEDEF t_water]
TERRAIN = 0a8 0ab
TERRAIN = 0136 0137
</spherescript>

<spherescript>
//
// Makes an item speak when double clicked.
//
[TYPEDEF t_exampletype]
ON=@DClick
SAY I have been double clicked!
RETURN 2
</spherescript>

[[Category: Reference Compendium]]
[[Category: Definitions]]

TYPEDEF

2025-05-19T12:02:22Z

Jhobean: Update Tdata3 et 4 for t_container

{{Languages|TYPEDEF}}

__FORCETOC__
Type definitions are the equivalent of [[EVENTS]] that can be attached to [[Items|items]]. There are different properties that can be used to attach a type block to an item or set of items:
* [[ITEMDEF|item definitions]] via their [[TYPE]] and/or [[TEVENTS]] property.
* [[Items|items]] via their [[TYPE]] and/or [[EVENTS (Property)|EVENTS]] property.

In addition to handling triggers, type definitions can also be used to define different types of terrain. This can be used to affect the return value of the [[TYPE]] property on [[Map points|map points]], or for some hardcoded types such as t_rock it can be used to define which terrain IDs Sphere should consider to be rock when the mining skill is used.

==Built-in Types==

The built-in types are all listed in the sphere_defs.scp file. The table below only lists some of the built-in types and it is VERY weak on actual details...so use with care.

{| border="1"
! DEFNAME !! Number !! Description
|-
| t_normal || 0 || No built-in behavior.
|-
| t_container and t_container_locked || 1 and 2 || These types are used for containers. They leverage the following properties:
* MORE1 = "ID" from the key that can unlock this item (If the MORE1 of the key matches the MORE1 of the container then they are linked)
* MORE2 = The lock complexity (how hard it is to pick the lock)
* MOREX = The trap type (not used yet?)
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3/4: Defines rectangle, where you can place items (so they won't end up out of gump).
* TDATA3 = top left corner. Hexadecimal number, each position takes 4 bytes, YX (example: X = 10 (0a) and Y = 20 (014) will look like TDATA3=0014000a
* TDATA4 = bottom right corner.
* LINK = UID of a secondary key?
|-
| t_door or t_door_locked || 3 or 4 || This type is used for both unlocked and locked doors. They leverage the following properties:
* MORE1 = UID of this door's key (if it has one)
* TDATA1 = ID for the sound it makes when double clicked
|-
| t_key || 5 || This type is used for keys. It leverages the following properties:
* MORE1 = "ID" of the item(s) this key can unlock (if the MORE1 of the key matches the MORE1 of the container/door then they are linked)
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.
|-
| t_light_lit || 6 || This type is used for light sources that can be turned onIT_S or off. It leverages the following properties:
* MOREY = Number of charges before the item is consumed
* MOREZ = Type of light pattern it will cast
|-
| t_light_out || 7 || This type is used for light sources that can be turned on or off. It leverages the following properties:
* MOREY = Number of charges before the item is consumed
* MOREZ = Type of light pattern it will cast
|-
| t_food || 8 || This type is used for edible food. It leverages the following properties:
* MORE2 = The ID of the creature that this came from
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the food
'''Note:''' The following properties may also exist depending on your server version:
* MOREX = The ID of a spell effect that will be gained when eaten
* MOREY = The strength of the spell effect
|-
| t_food_raw || 9 || This type is used for ''raw'' food. It leverages the following properties:
* MORE1 = ID of the item it makes when cooked (the default is i_unused and if defined, it will override TDATA1)
* MORE2 = The ID of the creature that this came from
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the food
* TDATA1 = The item ID this cooks into
'''Note:''' The following properties may also exist depending on your server version:
* MOREX = The ID of a spell effect that will be gained when eaten
* MOREY = The strength of the spell effect
* TDATA2 = The creature ID type that the food came from
* TDATA3 = The amount of skill required to cook it (did this ever work?)
|-
| t_armor || 10 || This type is used for armor. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)
* MOREY = There are two possible effects of setting MOREY:
*# If MOREX is set, then MOREY is the power/effect of that spell
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.
|-
| t_weapon_mace_smith || 11 || This type is used for macefighting weapons that can also be used by blacksmiths to forge items. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_mace_sharp || 12 || This type is used for macefighting weapons that have sharp cutting edges. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_sword || 13 || This type is used for swordsmanship weapons. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_fence || 14 || This type is used for fencing weapons. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_bow || 15 || This type is used for archery weapons (bow or crossbow). It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
* TDATA1 = The sound effect the weapon makes when it shoots
* TDATA2 = The required strength to wield the weapon
* TDATA3 = ID of arrow item that will be fired (and must therefore be on the player's person)
* TDATA4 = ID of the arrow animation (for bows it is usually i_arrow_x, for crossbows, i_xbow_x)
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = to override the sound this weapon makes when it misses
* AMMOANIMRENDER = to override the rendermode of the ANIM this item uses (yes, no TAGs)
* AMMOTYPE = to override the type of ammo (TDATA3) this item uses (yes, no TAGs)
* AMMOANIM = to override the ammo animation (TDATA4) this item uses (yes, no TAGs)
* AMMOANIMHUE = to override the color of the ammo animation this item uses (yes, no TAGs)
|-
| t_wand || 16 || This type is used for magic wands. It leverages the following properties:
* MORE1L = the current amount of hitpoints the item has
* MORE1H = the maximum hitpoints for the item
* MORE2 = the number of remaining charges (if magical)
* MOREX = the spell type (if magical)
* MOREY = the spell strength (0-1000)
* MOREZ = the poison skill applied (0-100)
* TDATA2 = Required Strength to equip the wand
* TDATA3 = ID of the light pattern
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object).
|-
| t_telepad || 17 || This type is used for teleport pads. It leverages the following properties:
* MOREP = Coordinates of the point to which you will teleport when you step on the item
* MORE1 = If set to 1, the teleport pad will only work for players (and their pets)
* MORE2 = If set to 1, the teleport animation and sound will not be shown to anyone witnessing the teleport
|-
| t_switch || 18 || This type is used for switches. The way these things work is, when used, they trigger @DCLICK on the LINK object. It leverages the following properties:
* LINK = UID of item to trigger
* MORE1 = The item ID of the next state of the switch
* MOREX = A flag to indicate if this is activated by stepping on it
|-
| t_book || 19 || This type is used for books of static or dynamic text. It leverages the following properties:
* MORE1L = This can be set to an ID of a book (some default book text is included in the sphere_books.scp file)
* MORE1H = Some flags that determine book behavior:
** 0c00: Scripted book
** 0800: Editable book
** 08000: ? time stamp ?
* AUTHOR = The ID of the character that wrote the book
* BODY.# = The text for each page of the book (starting with page 0)
'''Note:''' we need more information on those flags...
|-
| t_rune || 20 || This type is used for recall runes. It leverages the following properties:
* MORE1 = The number of uses left before it wears out
* MOREP = The coordinates of the marked location
|-
| t_booze || 21 || This type is used for alcohol (it causes a drunk effect when double clicked.) It leverages the following properties:
* TDATA1 = A flag that indicates whether the container is empty or not.
|-
| t_potion || 22 || This type is used for potions. It leverages the following properties:
* MORE1 = The potion spell effect that will result when the potion is double clicked
* MORE2 = The strength of the potion (This has a different effect defending on the spell, usually between 0 and 1000)
* MOREX = The countdown to explosion (for purple potions)
* TDATA1 = A flag that indicates whether the container is empty or not
|-
| t_fire || 23 || This type is used for fires (and ovens?). These items can be used to cook food, and they can burn you if stepped on. It leverages the following properties:
* TIMER = time until it decays?
* MORE1 (or MORE2?) = Amount of damage it will cause when stepped on or dclicked
* MOREZ = Type of light pattern it will cast
|-
| t_clock || 24 || This type is used to tell time (game time, not real time) when double clicked. The result comes out something like "half past eleven o'clock at night". From what I can tell there are no MORE or TDATA modifiers that affect the result.
|-
| t_trap and t_trap_active || 25 and 26 || These types are used for traps that are triggered when walked on. They leverage the following properties:
* MORE1 = ID of the animation
* MORE2 = The damage the trap will cause
* MOREX = The length of time the animation will run
* MOREY = The length of time the activated trap will idle until reset
* MOREZ = A flag that indicates if the trap must idle before changing from active to inactive.
|-
| t_musical || 27 || This type is used for musical instruments. It leverages the following properties:
* TDATA1 = The sound ID to be played if successful
* TDATA2 = The sound ID to be played if not successful
|-
| t_spell || 28 || This type is used for magic spell effects. It leverages the following properties:
* MORE1L = The polymorph effect on STR
* MORE1H = The polymorph effect on DEX
* MORE2 = The number of charges left
* MOREX = The spell effect that will result when the item is stepped on
* MOREY = The strength of the spell (This has a different effect defending on the spell, usually between 0 and 1000)
* MOREZ = Type of light pattern it will cast
|-
| t_gem || 29 || This type is used for gems, and from what I can tell there is no built-in behavior for it.
|-
| t_water || 30 || This type is used for water, which means it can be fished in or used to clean used bandages.
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
|-
| t_clothing || 31 || This type is used for all cloth based equip-able items. It is essentially identical to t_armor and t_armor_leather. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)
* MOREY = There are two possible effects of setting MOREY:
*# If MOREX is set, then MOREY is the power/effect of that spell
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.
|-
| t_scroll || 32 || This type is used for scrolls. It leverages the following properties:
* MOREX = ID of the spell to cast when double-clicked
* MOREY = Power of the spell (equivalent to the EFFECT setting of the spell itself?)
|-
| t_carpentry || 33 || This type is used by carpenters to craft items, and from what I can tell there is no built-in behavior for it.
|-
| t_spawn_char || 34 || This type is used to spawn NPCs. Once it spawns its first creature, it will turn red and change its appearance to the ICON of the creature (or appear as a wisp if the spawn is set to use a template.) It leverages the following properties:
* AMOUNT = The maximum amount of NPCs the spawner should create
* MORE1/SPAWNID* = The creature ID or spawn template ID for what you want to spawn
* MORE2/COUNT* = The current number of creatures spawned from this point
* MOREX/TIMELO* = The minimum time between spawns (in minutes)
* MOREY/TIMEHI* = The maximum time between spawns (in minutes)
* MOREZ/MAXDIST* = The maximum distance away from the spawn to create the spawned NPC (this is also the maximum wander distance for the NPC)
* AT*(R/W) = Access the object in the N position and reads/writes/executes the given text, eg: at.0.remove, <at.0.str>...
* ADDOBJ*(W) = Adds to the spawn an object with the given uid (must be a valid uid)
* DELOBJ*(W) = Deletes from the spawn an object with the given uid (must be a valid uid)
* START*(W) = Forces the spawn to start spawning
* STOP*(W) = Stops the spawn and removes everything it created
* RESET*(W) = Froces an STOP and then START it again

*X branch only

'''Note:''' The spawn is considered active if the TIMER has a positive value, and when the timer reaches zero, it is automatically restarted using a random number between MOREX and MOREY.
|-
| t_game_piece || 35 || This type is used for game board pieces (checkers, chess, etc). They cannot be removed from the game, and they have no tile image outside of the game board gump. It leverages the following properties:
* TDATA1 = The starting x position for this piece
* TDATA2 = The starting y position for this piece
|-
| t_portculis || 36 || This type is used for portcullis doors that raise and lower when double clicked. It leverages the following properties:
* MORE1 = The z height at the lowest setting
* MORE2 = The z height at the highest setting
|-
| t_figurine || 37 || This type is used for shrunk NPCs (essentially magic figurines), that turn into a "pet" creature when double clicked. It leverages the following properties:
* MORE1 = The creature ID that will spawn when the item is double clicked.
* MORE2 = The UID of the off-line creature (in "stable master" inventory)
* TDATA2 = The required strength to mount the creature (presumably only if it is possible to mount it)
* TDATA3 = The base creature ID.
|-
| t_shrine || 38 || This type is used for shrines. They will resurrect a ghost when double-clicked by a ghost.
|-
| t_moongate || 39 || This type is used for moongates. When stepped on they teleport the player to another location. It leverages the following properties:
* MOREP = The coordinates that the moongate leads to
* MORE1 = If set to 1, the smoke and sound is supressed
* MORE2 = If set to 1, NPCs (and pets?) cannot use it
|-
| t_chair || 40 || This type is used for any sort of a chair item and it's only purpose is to trigger a sitting animation.
|-
| t_forge || 41 || This type is used by blacksmiths to smelt ore....
|-
| t_ore || 42 || This type is harvested by miners, and converted by blacksmiths (using a forge) into something else. It leverages the following properties:
* TDATA1 = ID of item created when the ore is smelted (usually ingots)
|-
| t_log || 43 || This type is a raw material resource usually harvested from trees.
|-
| t_tree || 44 || This type is chopped by lumberjacks to get logs. It leverages the following properties:
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
* FRUIT = ID of item gathered if double-clicked (usually logs)
|-
| t_rock || 45 || This type can be mined for ore.
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
|-
| t_carpentry_chop || 46 || A carpentry tool that can be used to craft carpentry objects as well as used to "chop" trees (like a saw?)
|-
| t_multi || 47 || Multi part object like house or ship.
* MORE1 is the UID of the player that created/owns the multi
|-
| t_reagent || 48 || Alchemy when clicked ?
|-
| t_ship || 49 || This is a ship multi.
* MORE1 is the UID of the player that created/owns the multi
* MORE2 contains the speed, anchor flag, direction of movement, and facing direction in each byte respectively
|-
| t_ship_plank || 50 || Ship plank for players to get on a boat.
* TDATA1 = is the itemID of the next open/closed state.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
* MOREX = type to become (IT_SHIP_SIDE or IT_SHIP_SIDE_LOCKED)
|-
| t_ship_side || 51 || Should extend to make a plank TDATA1 is the itemID of the next open/closed state.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_ship_side_locked || 52 || TDATA1 is the itemID of the next open/closed state.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_ship_tiller || 53 || Tiller man on the ship.
* MORE1 = the lock code. Normally this is the UID, except if uidLink is set.
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.
|-
| t_eq_trade_window || 54 || Container for the trade window.
|-
| t_fish || 55 || Fish can be cut up. Yields 4 * <Amount> when a bladed object is used on it.
|-
| t_sign_gump || 56 || This type is used for simple signs (and things like grave stones). It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
* MORE1 = the lock code. Normally this is the UID, except if uidLink is set.
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.
|-
| t_stone_guild || 57 || This type is used for guild stones. It leverages the following properties:
* MORE1 = The alignment of the guild (chaos, neutral, order)
* MORE2 = The amount of gold in the guild account
|-
| || ||
t_anim_active 58 // = active anium that will recycle when done.
t_sand 59 // = sand on the beach
t_cloth 60 // = bolt or folded cloth
t_hair 61 //
t_beard 62 // = just for grouping purposes.
|-
| t_ingot || 63 || This type is used for ingots (when a blacksmith smelts ore, it turns into ingots. It leverages the following properties:
* TDATA1 = The skill required to smelt this
* TDATA2 = The skill required to get the maximum yield when smelting
|-
| t_coin || 64 || This types is used for coins, gold or otherwise.
|-
| t_crops || 65 || This type is used to grow plants that likely bear fruit. Double clicking a t_crop item will harvest the fruit if it is ripe. It leverages the following properties:
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)
* TDATA1 = Is the ID of the first stage of the crop (the sprout), it is the ID that the crop will be reset to regrow from (0=nothing, which means this plant will not regrow once harvested)
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant (0 means the plant is not mature)
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.
|-
| t_drink || 66 || This type is used for non-alcoholic drinks. It leverages the following properties:
* TATA1 = A flag that indicates whether the container is empty or not.
'''Note:''' There is an INI flag OF_DrinkIsFood (0x10000) that, if set, will increase FOOD level when the drink is consumed (like T_FOOD does)
|-
| || ||
t_anvil 67 // = for repair.
t_port_locked 68 // = this portcullis must be triggered.
|-
| t_spawn_item || 69 || This type is used to spawn items. Once it spawns its first item, it will turn red and change its appearance to the i_worldgem_lg ID item. It leverages the following properties:
* AMOUNT = The maximum amount of items the spawner should create
* MORE1/SPAWNID* = The item ID or spawn template ID for what you want to spawn
* MORE2/PILE* = The current number of items spawned from this point
* MOREX/TIMELO* = The minimum time between spawns (in minutes)
* MOREY/TIMEHI* = The maximum time between spawns (in minutes)
* MOREZ/MAXDIST* = The maximum distance away from the spawn to create the spawned item (this is also the maximum wander distance for the NPC)
* AT*(R/W) = Access the object in the N position and reads/writes/executes the given text, eg: at.0.remove, <at.0.str>...
* ADDOBJ*(W) = Adds to the spawn an object with the given uid (must be a valid uid)
* DELOBJ*(W) = Deletes from the spawn an object with the given uid (must be a valid uid)
* START*(W) = Forces the spawn to start spawning
* STOP*(W) = Stops the spawn and removes everything it created
* RESET*(W) = Froces an STOP and then START it again

*X branch only

'''Note:''' The spawn is considered active if the TIMER has a positive value, and when the timer reaches zero, it is automatically restarted using a random number between MOREX and MOREY.
|-
| || ||
t_telescope 70 // = big telescope pic.
|-
| t_bed || 71 || This type is used to indicate the item is a bed. I am not sure how it is used exactly, but it leverages the following properties:
* TDATA1 = The direction it occupies
|-
| t_gold || 72 || This type is used to indicate the object is a gold coin and can be used to purchase stuff.
|-
| t_map || 73 || This type is used for cartography maps. It has the following properties:
* MORE1L = The top coordinate.
* MORE1H = The left coordinate.
* MORE2L = The bottom coordinate.
* MORE2H = The right coordinate.
* MOREZ = A flag that indicates whether the map has pins or not.
* MOREX and MOREY = The coordinates of the pin (I think).
* TDATA1 = The map gump width.
* TDATA2 = The map gump height.
|-
| t_eq_memory_obj || 74 || This type is used for character memories, and it really depends on the type of memory to know what each property really means, but here is a relatively good guide:
* MORE1L = The action type this is a memory for
* MORE1H = The skill involved
* MORE2 = The start time of the memory
* MOREP = The map coordinates at which the memory occurred.
|-
| || ||
t_weapon_mace_staff 75 // = staff type of mace. or just other type of mace.
|-
| t_eq_horse || 76 || This type is used for equipped horse object. Essentially it represents a riding horse to the client. It leverages the following properties:
* MORE1 = The creature ID
* MORE2 = The UID of the offline creature (in "stable master" inventory)
* TDATA2 = The required strength to mount it
* TDATA3 = The base creature ID
|-
| t_comm_crystal || 77 || This type is used for communication crystals.
|-
| t_game_board || 78 || This type is used as a container for game pieces (t_game_piece). It leverages the following properties:
* MORE1 = The type of pieces to use (0=chess, 1=checkers, 2=none... presumably this is hard-coded)
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_trash_can || 79 || This type is used as a trash can container, and it deletes any object placed into it. It leverages the following properties:
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_cannon_muzzle || 80 || This type is used for the business end of the cannon. It leverages the following properties:
* MORE2 = A mask of what is currently loaded in it. (0 = none, 1=powder, 2=shot)
|-
| t_cannon || 81 || This type is used for the cannon control.

|-
| t_cannon_ball || 82 || This is ammo for a t_cannon.
|-
| || ||
t_armor_leather 83 // = non metallic armor (t_clothing)
|-
| t_seed || 84 || This type is used for seeds. A seed can be created by using a dagger on a fruit (assuming the fruit is setup to have a seed.) A seed can be planted by double clicking it and targeting the ground (specifically t_dirt items). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that will grow the fruit that this seed comes from. 0 is Nothing.
* TDATA2 = The art asset to use as the seed art asset. A copper coin is default.
|-
| || ||
t_junk 85 // = never used
t_crystal_ball 86 // = Has no internal use.
t_swamp 87 // = swamp (smelly)
|-
| t_message || 88 || This type is used for bulletin board messages. It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_reagent_raw || 89 || Freshly grown reagents...not processed yet. A seed can be created by using a dagger on a raw reagent (assuming the raw reagent is setup to have a seed.) A seed can be planted by double clicking it and targeting the ground (specifically t_dirt items). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that will grow the fruit that this seed comes from. 0 is Nothing.
* TDATA2 = The art asset to use as the seed art asset. A copper coin is default.
|-
| t_eq_client_linger || 90 || Change player to npc for a while.
|-
| t_snow || 91 || Snow
|-
| t_it_stone || 92 || This type is an "item stone" that is used to generate items when the object is double clicked. It has the following properties:
* MORE1 = The item or template ID to generate
* MORE2 = The price (or Plotflags to set?)
* MOREX = The regen time (0 = instant)
* MOREY = The total amount to deliver (0 = infinite, 0xFFFF = none left)
|-
| t_unused_93 || 93 || This has no use.
|-
| t_explosion || 94 || This type is used for explosion animations. It leverages the following properties:
* MOREX = The damage that the explosion will cause
* MOREY = The type of damage (fire, magic, etc)
* MOREZ = The distance range for the damage
|-
| t_eq_npc_script || 95 || This type is used to script NPC actions (in the form of a book). The sphere_defs.scp file says "get rid of this in favor of waiting on m_events" but it may still exist... if so, it leverages the following properties:
* MORE1 = The same as for other books
* MORE2L = The current script page
* MORE2H = The current offset
* MOREZ = The priority for this script (as a percent, this is the chance they want to "do" this task)
|-
| t_web || 96 || Walk on this and transform into some other object. MORE1 is the amount of hits the web can take.
|-
| t_grass || 97 || Can be eaten by grazing animals
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.
|-
| t_arock || 98 || A rock or boulder. can be thrown by giants.
|-
| t_tracker || 99 || Points to a linked object.
|-
| t_sound || 100 || This type is used to play sounds. It uses the following properties:
* MORE1 = The sound ID
* MORE2 = A flag to indicate repetition
|-
| t_stone_town || 101 || This type is used for town stones. It leverages the following properties:
* MORE1 = The alignment of the town (chaos, neutral, order)
* MORE2 = The amount of gold in the town bank account
|-
| || ||
t_weapon_mace_crook 102 //
t_weapon_mace_pick 103 //
t_leather 104 // = leather or skins of some sort.(not wearable)
t_ship_other 105 // = some other part of a ship.
|-
| t_bboard || 106 || This type is a bulleting board container that holds t_message items. It leverages the following properties:
* TDATA2 = The gumpID of the container
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_spellbook || 107 || This type is used for the Magery spellbook. It leverages the following properties:
* MORE1 = A bit mask of available spells in circles 0-4, so to add all those spells: set MORE1=0ffffffff
* MORE2 = A bit mask of available spells in circles 5-8, so to add all those spells: set MORE2=0ffffffff
'''Note:''' In older sphere versions, MOREX, MOREY, and MOREZ could be set to add additional spells (necro, etc), but recently these concepts may have been removed... same with these TDATA settings:
* TDATA2 = Required Strength to equip the book
* TDATA3 = Type of light pattern it will cast
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)
|-
| t_corpse || 108 || This type is a container used for all dead corpses. It leverages the following properties:
* <s>MORE1 = The time of death</s> TIMESTAMP seems to hold the time of death.
* MORE1 = Corpse is already carved? (0=not carved, 1=carved)
* MORE2 = The UID of the individual character that landed the killing blow
* MOREX & MOREY = Combined, these make up a single DWORD which specifies what type of creature this was
* MOREZ = The direction it is facing
* TDATA2 = The gumpID of the container
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
There are two special TAGs for corpses:
* TAG.BLOOD = This is the number of times you can carve the corpse and cause blood to come out (default 5)
* TAG.MAXBLOOD = Not certain about this one, but it is likely related... perhaps it is set on the CHARDEF?
|-
| || ||
t_track_item 109 // - track a id or type of item.
t_track_char 110 // = track a char or range of char id's
t_weapon_arrow 111 //
t_weapon_bolt 112 //
t_eq_vendor_box 113 // = an equipped vendor box
|-
| t_eq_bank_box || 114 || This type is a container that is used for the character bank. It leverages the following properties:
* MORE1 = The amount of gold in the account (is this still true?)
* MORE2 = The amount to restock to (for NPCs vendors who can buy stuff from players?)
* MOREP = The location in the world (x, y, and z) where the bank box was opened
* TDATA2 = The gumpID for the bank box container
* TDATA3 = The minimum gump size
* TDATA4 = the maximum gump size
|-
| t_deed || 115 || This type is used to create something else when double clicked. It is perhaps the best solution for a player to place a ''multi'' part item like a house. When double clicked, it will prompt for a target location. It leverages the following properties:
* MORE1 = The ID of the item that will be created at the target location
* MORE2 = The previous key ID (ideally this is set when a house or ship are re-deeded so that all the existing keys will still work)
|-
| t_loom || 116 || This type of device is used by weavers who turn wool or thread into bolts of cloth. It leverages the following properties:
* MORE1 = The ID of the currently loaded resource (wool or cotton/flax) that is being woven
* MORE2 = The amount of resources currently in the loom
|-
| t_bee_hive || 117 || This type is used for beehives. It leverages the following properties:
* MORE1 = The amount of honey which has accumulated in the hive
|-
| t_archery_butte || 118 || This type is used for practice archery targets. When double clicked, the target will first check if you have an archery weapon equipped and if so, it will return some ammo. It leverages the following properties:
* MORE1 = The ID for the type of ammo currently stuck in the target
* MORE2 = The amount of items stuck in the target
|-
| || ||
t_eq_murder_count 119 // = my murder count flag. MORE1 contains the amount of time before it expires.
t_eq_stuck 120 // we are stuck in a web
t_trap_inactive 121 // = a safe trap.
//t_unused_122 122
t_bandage 123 // = can be used for healing.
t_campfire 124 // = this is a fire but a small one.
t_map_blank 125
t_spy_glass 126
t_sextant 127
t_scroll_blank 128
|-
| t_fruit || 129 || This type is used for fruit. When double clicked, fruit will be eaten. Fruit can be grown from crops (t_crop). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that this fruit comes from (If not set, this fruit may not have a seed, use zero to be certain)
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the fruit
|-
| || ||
t_water_wash 130 // water that will not contain fish. (for washing or drinking) TDATA1 is a flag that indicates whether the container is empty or not
t_weapon_axe 131 // not the same as a sword. but uses swordsmanship skill
|-
| t_weapon_xbow || 132 || This type is used for crossbow weapons. It is essentially identical to t_weapon_bow.
|-
| || ||
t_spellicon 133
t_door_open 134
t_meat_raw 135 // just a meaty part of a corpse. (uncooked meat)
t_garbage 136
|-
| t_keyring || 137 || This type is a container used to store keys. It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_table || 138 || doesn't really do anything.
|-
| t_floor || 139 ||
|-
| t_roof || 140 ||
|-
| t_feather || 141 || a birds feather
|-
| t_wool || 142 || wool cut from a sheep.
|-
| t_fur || 143 ||
|-
| t_blood || 144 || blood of some creature
|-
| t_foliage || 145 || This type is very similar to t_crops, the difference being the foliage does not disappear when the fruit is harvested. It leverages the following properties:
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)
* TDATA1 = Is the ID of the first stage of the crop (the sprout)
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.
|-
| || ||
t_grain 146
t_scissors 147
t_thread 148
t_yarn 149
t_spinwheel 150
t_bandage_blood 151 // = can't be used for healing.
t_fish_pole 152
t_shaft 153 // bolt or arrow.
t_lockpick 154
t_kindling 155
t_train_dummy 156
t_train_pickpocket 157
t_bedroll 158
t_bellows 159
|-
| t_hide || 160 ||Made into leather.
* TDATA1 = Hold ID or DEFNAME of custom cut leather (or any item).
|-
| t_cloth_bolt || 161 || A bolt of cloth.
|-
| t_board || 162 || Logs are plained into decent lumber
|-
| t_pitcher || 163 || A pitcher holding a liquid of some kind.
*TDATA1 is a flag that indicates whether the container is empty or not.
|-
| t_pitcher_empty || 164 || An empty pitcher that can or did hold a liquid.
* TDATA1 is a flag that indicates whether the container is empty or not.
|-
| t_dye_vat || 165 || For dyeing items with.
|-
| t_dye || 166 || Dyes to set colors on a t_dye_vat
|-
| t_potion_empty || 167 || Empty bottle.
|-
| t_mortar || 168 || Alchemists mortar and pestle.
|-
| t_hair_dye || 169 || Hair dye.
|-
| t_sewing_kit || 170 || Tailoring sewing kit.
|-
| t_tinker_tools || 171 || Tinker's tools.
|-
| t_wall || 172 || Wall of a structure.
|-
| t_window || 173 || Window for a structure. MOREZ is the light pattern
|-
| t_cotton || 174 || Cotton from the plant
|-
| t_bone || 175 || A bone from a corpse.
|-
| t_eq_script || 176 || This type can have tags and can be equipped. Possibly used for memory objects that leverage @Equip and @UnEquip triggers.
|-
| t_ship_hold || 177 || A ships hold.
* TDATA2 is the gumpID
* TDATA3 is the minimum gump size
* TDATA4 is the maximum gump size
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_ship_hold_lock || 178 || A locked ship's hold.
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)
|-
| t_lava || 179 ||
|-
| t_shield || 180 || This type is used to indicate the object is an equipable shield. It has the following properties:
* MORE1L = The current amount of hitpoints the item has
* MORE1H = The maximum hitpoints for the item
* MORE2 = The number of remaining charges (if magical)
* MOREX = The spell type (if magical)
* MOREY = The spell strength (0-1000)
|-
| t_jewelry || 181 || This type is used for equpable jewelry. It leverages the following properties:
* MORE1L = The current amount of hitpoints the item has
* MORE1H = The maximum hitpoints for the item
* MORE2 = The number of remaining charges (if magical)
* MOREX = The spell type (if magical)
* MOREY = The spell strength (0-1000)
* TDATA2 = Required Strength to equip the item
* TDATA3 = Light pattern
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)
|-
| t_dirt || 182 || This type is used to represent a patch of dirt where something can be planted.
|-
| t_script || 183 || This type can have tags, but can NOT be equipped.
|-
| t_spellbook_necro || 184 || AOS Necromancy spellbook (should have MOREZ=100 by default)
|-
| t_spellbook_pala || 185 || AOS Paladin spellbook (should have MOREZ=200 by default)
|-
| t_spellbook_extra || 186 || some spellbook for script purposes (MOREZ=basic offset)
|-
| t_spellbook_bushido || 187 || SE Bushido spellbook (should have MOREZ=400 by default)
|-
| t_spellbook_ninjitsu || 188 || SE Ninjitsu spellbook (should have MOREZ=500 by default)
|-
| t_spellbook_arcanist || 189 || ML Spellweaver spellbook (should have MOREZ=600 by default)
|-
| t_multi_custom || 190 || Customisable multi
|-
| t_spellbook_mystic || 191 || SA Mysticism spellbook (should have MOREZ=677 by default)
|-
| t_hoverover || 192 || Hover-over item (CAN_C_HOVER can hover over blocking items)
|-
| t_spellbook_bard || 193 || SA Bard spellbook (should have MOREZ=700 by default)
|}

==Scripted TYPEDEFs==

{| border="1"
! DEFNAME !! File !! Description
|-
| t_advance_gate || ??.scp || MORE = ID of character to change into
|}

==Syntax==
The syntax for defining a type is:

<tt>
[TYPEDEF ''defname'']<br />
TERRAIN=''id''<br />
TERRAIN=''start_id'', ''end_id''<br />
<br />
ON=''trigger_name''<br />
    ''script''<br />
<br />
ON=''trigger_name''<br />
    ''script''<br />
<br /></tt>

Any number of triggers can be handled by one [[TYPEDEF]] definition, however it is not possible to handle the same trigger twice without using multiple definitions.

The trigger name can be the name of any [[Items#Triggers|item trigger]]. The return value from the script can affect Sphere's hardcoded behaviour in different ways. See the documentation for the trigger to discover what parameters are passed in to each trigger and what the return values do.

'''Note:''' If the ''defname'' matches any of Sphere's hardcoded types (see 'typedefs' block in sphere_defs.scp), then the [[TYPEDEF]] can be used to override the behaviours of items of that type.

==Examples==
<spherescript>
//
// Water definition from default script pack.
//
[TYPEDEF t_water]
TERRAIN = 0a8 0ab
TERRAIN = 0136 0137
</spherescript>

<spherescript>
//
// Makes an item speak when double clicked.
//
[TYPEDEF t_exampletype]
ON=@DClick
SAY I have been double clicked!
RETURN 2
</spherescript>

[[Category: Reference Compendium]]
[[Category: Definitions]]

How Combat Works

2024-10-02T01:35:02Z

Jhobean:

{{Languages|How_Combat_Works}}

The following diagram shows when combat triggers are triggered. See the [[Triggers]] page for more information on each trigger.

<tt>       [[@HitTry]] (attacker)<br />
           /           \<br />
[[@Hit]] (attacker)    [[@HitMiss]] (attacker)<br />
       |<br />
[[@Damage]] (weapon)<br />
       |<br />
[[@HitParry]] (victim)<br />
       |<br />
[[@GetHit]] (victim)<br />
       |<br />
[[@Damage]] (armor)<br /></tt>

Thanks to Moe for posting this.

NOTE: HITCHECK was added too. page need to be create

[[Category:Articles]]

@SkillMenu

2024-06-03T01:53:23Z

Jhobean:

==Description==
This trigger fires when a [[SKILLMENU|skill menu]] is displayed to a player. Note that the trigger only fires when Sphere attempts to display the menu through hardcoded behaviour, using the [[SKILLMENU]] command will not cause this trigger to fire.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] who the menu is being shown to.
|-
| [[SRC]] || The [[Characters#Players|player]] who the menu is being shown to.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGS || I || The skillmenu's defname. This is expected to be one of the following:
* sm_alchemy
* sm_blacksmith
* sm_bolts
* sm_bowcraft
* sm_carpentry
* sm_cartography
* sm_inscription
* sm_polymorph
* sm_summon
* sm_tailor_cloth
* sm_tailor_leather
* sm_tinker
|-
| BIG change on X || I || https://github.com/Sphereserver/Source-X/blob/3b2c4d9c6dec393eaea725770bb86237e2a85074/Changelog.txt#L3408
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the skillmenu from being displayed.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

Main Page

2024-05-30T01:11:07Z

Jhobean:

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Starting with SphereServer'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Setup of Sphere'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Sphere 101'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Extra Tutorials'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''
* [[Bitwise Operations]] ''(How to work with FLAGS/ATTR)''
* [[Script Debugging]] ''(How to fix your scripts)''
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''IMPORTANT LINKS'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [https://github.com/Sphereserver SphereServer Official Github]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Download Nightly Builds] ''(Plus! Extra downloads, like tools and scripts!)''
* [https://github.com/Sphereserver/Source-X/blob/master/Changelog.txt SphereX Changelog] | [https://github.com/Sphereserver/Source/blob/master/changelog.txt 56d Changelog] | [https://github.com/Sphereserver/Source-X/tree/master/docst Older Changelog]
* [https://discord.gg/BZj2fEA Join us at Discord] ''(We will solve most of your doubts over there)''
</div>
</div>
</div>
.

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Reference Compendium'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Definitions|'''Definitions''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[CHARDEF|Chardef]] | [[Characters|Characters]]
* [[DIALOG|Dialogs]]
* [[EVENTS|Events]]
* [[ITEMDEF|Itemdef]] | [[Items|Items]]
* [[MENU|Menus]]
* [[REGIONRESOURCE|Region Resources]]
* [[REGIONTYPE|Region Types]]
* [[AREADEF|Regions]]
* [[ROOMDEF|Rooms]]
* [[SKILLCLASS|Skill Classes]]
* [[SKILLMENU|Skill Menus]]
* [[SKILL|Skills]]
* [[SPAWN|Spawn Groups]]
* [[SPELL|Spells]]
* [[TYPEDEF|Types]]
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Objects|'''Objects''']]
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Accounts]]
* [[Characters]]
* [[Database]]
* [[Files]]
* [[GM Pages]]
* [[Items]]
** ''[[Special Items]]''
* [[Map Points]]
* [[Parties]]
* [[Regions]]
* [[Rooms]]
* [[Sectors]]
* [[Server]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Scripts|'''Scripts''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[:Category:Functions|Functions and Triggers]]
* [[:Category:Variables|General Functions, Properties and References]]
* [[Intrinsic Functions]]
* [[:Category:Statements|Statements]]
* [[:Category:Triggers|Triggers]]
</div>
</div>
.
----

.

==Useful Links==
* Modern SphereServer Nightly Downloads (Server) https://forum.spherecommunity.net/sshare.php?srt=4
* Older/Classic SphereServer downloads (Server) https://forum.spherecommunity.net/sshare.php?srt=4&prj=7
* Sphere-X Script Pack (Scripts) https://github.com/Sphereserver/Scripts-X
* Julians Script Vault (Scripts) https://github.com/JulianUO/SphereX-ScriptsVault
* List of UO Packets (Info) https://docs.polserver.com/packets/index.php
* Scripts https://mirror.ashkantra.de/scripts/Sphere/
* GM Commands (Commands) https://wiki.spherecommunity.net/index.php?title=GM_Commands
* Axis 2 Downloads (GM Tool) https://forum.spherecommunity.net/sshare.php?srt=4&prj=1
* Leviathan (GM tool) https://github.com/cbnolok/Leviathan/releases
* Ultima Online Downloads (Clients) https://mega.nz/folder/6uYxnIpY#tahGzzz_yOkLgNM1c_DxdQ
* Client 7.0.20 https://mirror.ashkantra.de/fullclients/
* ClassicUO (Third Party Client) https://www.classicuo.eu/
* OrionUO (Third Party Client) http://orionuo.online/
* CentrED (Worldbuilding) https://uo.wzk.cz/centred/
* UO-Pixel (Graphics) http://www.uo-pixel.de/
* UO Fiddler ( MUL Viewer) http://uofiddler.polserver.com/
* UO Grafiken by Nyray (Graphics) https://nyray.wordpress.com/
* Vestimisu (Graphics) http://vestimisu.blogspot.com/
* Ultima Online Graphics By Rubra (Graphcs) http://uographicsrubra.blogspot.com/
* Isis‘ UO Grafiken (Graphics) https://isispixel.wordpress.com/
* ServUO (Graphics) https://www.servuo.com/archive/categories/assets.13/
* UOGateway (Shard Listing) https://uogateway.com/

==Sphere 3rd Party Tools==
* [http://forum.spherecommunity.net/sshare.php?srt=4&uid=603 Axis II] - GM Tool for Sphere that will allow you to place objects in-game, spawns, traveling and many other useful functions for shard admins and GMs.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=3 vSCP] - vSCP is the most complete and up-to-date syntax editor for sphere scripting. It does contain syntax highlighting, autocomplete, folding markers to specify blocks of code that can expand or collapse, bookmarks, autoindent, find/replace/gotoline, help guide for all the sphere elements added to your code, and more!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=2 vServerLauncher] - Install and run the latest build of sphereserver in a few clicks with vServerLauncher. It's pretty quick and simple!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=5 SphereService] - Relaunch SphereSvr.exe everytime it closes/crashes. Automatically runs at windows startup and works in a silent mode minimized to Tray.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=4 vCrypter] - Type the client version and the tool will calculate the correct UO login keys for classic or enhanced clients.

==Other Articles==

* [[Armor Calculation]]
* [[Client Changes]]
* [[Common Scripting Misconceptions]]
* [[Custom Object Properties]]
* [[Error Codes]]
* [[Experience System]]
* [[How Combat Works]]
* [[Occam's Razor]]
* [[Optimization|Optimization Theory]]
* [[Override TAGs]]
* [[Revisions Changelog]]
* [[Sendpacket]]
* [[Skill Gain Theory]]
* [[The Process of Scripting]]
* [[Building Component Reference]]

==Credits==

'''Special thanks to:'''

[[WhoIsWho|XuN, Nolok, Ben, and Drk]], for their hard work on the X branch taking Sphere into the next decade.

[[WhoIsWho|Ben, Cloud_Br, Ellessar, Jdog, Lord Zerofiz, Mordaunt, Nazghul-ll, RanXerox, Rattlehead, Sandman, Sharlenwar, ShiryuX, thelegbra, Maximus, WarAngel and Valios]], for helping to add content.

[[WhoIsWho|Daleth]], for writing the Sphere Reference Project, and [[WhoIsWho|Mordaunt]] for converting it to .chm format.

[[WhoIsWho|Tracker]], for writing the Sphere 56 Tracking Changes in Sphereserver.net

[[WhoIsWho|Taran]], for writing the original and now famous Sphere Scripting for Dummies tutorials, and [[WhoIsWho|MrSugarCube]] for bringing it up-to-date directly from source.

[[WhoIsWho|Ben, Khaos, Ranxerox, Shiryux, Furio, Radiant, Vjaka, Nazghul-ll, Ellessar, Torfo, Shadow Dragon, MrSugarCube and coruja747]] for continuing to develop Sphere into a powerful and very customizable Ultima Online emulator.

[[WhoIsWho|Crius]], for providing hosting for the original SphereWiki, and [[WhoIsWho|Torfo]] for providing the current hosting.

==External Links==

* [[Useful Links]] ''(An ongoing list of useful links for community members)''
* [http://www.spherecommunity.net/ Official SphereServer Website]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Nightly builds]
* [http://nightly.prerelease.sphere.torfo.org/ Nightly builds - OUTDATED, use the link above]
* [http://spherepack.codeplex.com/ Sphere Community Pack 2.0]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]

@Eat

2024-04-28T13:02:56Z

Jhobean: Add Argo trigger

==Description==
This trigger fires when someone is eating something.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|item]] being ate (X ONLY).
|-
| [[I]] / [[SRC]] || The [[Characters|character]] doing the clicking.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| Argn1 || I/O || Set to 1 to let it pass your MaxStats, ie: MaxHits=100 and local.hits + hits = 150, having it to 1 will set hits to 150 and setting it to 0 will raise hits up to MaxHits only.
|-
| local.hits || I/O || Amount of HitPoints to regenerate.
|-
| local.mana || I/O || Amount of Mana to regenerate.
|-
| local.stam || I/O || Amount of Stamina to regenerate.
|-
| local.food || I/O || Amount of Food to regenerate.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the gain of stats but not the eating.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

Main Page

2024-04-05T12:17:55Z

Jhobean:

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Starting with SphereServer'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Setup of Sphere'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Sphere 101'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Extra Tutorials'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''
* [[Bitwise Operations]] ''(How to work with FLAGS/ATTR)''
* [[Script Debugging]] ''(How to fix your scripts)''
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''IMPORTANT LINKS'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [https://github.com/Sphereserver SphereServer Official Github]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Download Nightly Builds] ''(Plus! Extra downloads, like tools and scripts!)''
* [https://github.com/Sphereserver/Source-X/blob/master/Changelog.txt SphereX Changelog] | [https://github.com/Sphereserver/Source/blob/master/changelog.txt 56d Changelog] | [https://github.com/Sphereserver/Source-X/tree/master/docst Older Changelog]
* [https://discord.gg/BZj2fEA Join us at Discord] ''(We will solve most of your doubts over there)''
</div>
</div>
</div>
.

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Reference Compendium'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Definitions|'''Definitions''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[CHARDEF|Characters]]
* [[DIALOG|Dialogs]]
* [[EVENTS|Events]]
* [[ITEMDEF|Itemdef]] | [[Items|Items]]
* [[MENU|Menus]]
* [[REGIONRESOURCE|Region Resources]]
* [[REGIONTYPE|Region Types]]
* [[AREADEF|Regions]]
* [[ROOMDEF|Rooms]]
* [[SKILLCLASS|Skill Classes]]
* [[SKILLMENU|Skill Menus]]
* [[SKILL|Skills]]
* [[SPAWN|Spawn Groups]]
* [[SPELL|Spells]]
* [[TYPEDEF|Types]]
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Objects|'''Objects''']]
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Accounts]]
* [[Characters]]
* [[Database]]
* [[Files]]
* [[GM Pages]]
* [[Items]]
** ''[[Special Items]]''
* [[Map Points]]
* [[Parties]]
* [[Regions]]
* [[Rooms]]
* [[Sectors]]
* [[Server]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Scripts|'''Scripts''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[:Category:Functions|Functions and Triggers]]
* [[:Category:Variables|General Functions, Properties and References]]
* [[Intrinsic Functions]]
* [[:Category:Statements|Statements]]
* [[:Category:Triggers|Triggers]]
</div>
</div>
.
----

.

==Useful Links==
* Modern SphereServer Nightly Downloads (Server) https://forum.spherecommunity.net/sshare.php?srt=4
* Older/Classic SphereServer downloads (Server) https://forum.spherecommunity.net/sshare.php?srt=4&prj=7
* Sphere-X Script Pack (Scripts) https://github.com/Sphereserver/Scripts-X
* Julians Script Vault (Scripts) https://github.com/JulianUO/SphereX-ScriptsVault
* List of UO Packets (Info) https://docs.polserver.com/packets/index.php
* Scripts https://mirror.ashkantra.de/scripts/Sphere/
* GM Commands (Commands) https://wiki.spherecommunity.net/index.php?title=GM_Commands
* Axis 2 Downloads (GM Tool) https://forum.spherecommunity.net/sshare.php?srt=4&prj=1
* Leviathan (GM tool) https://github.com/cbnolok/Leviathan/releases
* Ultima Online Downloads (Clients) https://mega.nz/folder/6uYxnIpY#tahGzzz_yOkLgNM1c_DxdQ
* Client 7.0.20 https://mirror.ashkantra.de/fullclients/
* ClassicUO (Third Party Client) https://www.classicuo.eu/
* OrionUO (Third Party Client) http://orionuo.online/
* CentrED (Worldbuilding) https://uo.wzk.cz/centred/
* UO-Pixel (Graphics) http://www.uo-pixel.de/
* UO Fiddler ( MUL Viewer) http://uofiddler.polserver.com/
* UO Grafiken by Nyray (Graphics) https://nyray.wordpress.com/
* Vestimisu (Graphics) http://vestimisu.blogspot.com/
* Ultima Online Graphics By Rubra (Graphcs) http://uographicsrubra.blogspot.com/
* Isis‘ UO Grafiken (Graphics) https://isispixel.wordpress.com/
* ServUO (Graphics) https://www.servuo.com/archive/categories/assets.13/
* UOGateway (Shard Listing) https://uogateway.com/

==Sphere 3rd Party Tools==
* [http://forum.spherecommunity.net/sshare.php?srt=4&uid=603 Axis II] - GM Tool for Sphere that will allow you to place objects in-game, spawns, traveling and many other useful functions for shard admins and GMs.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=3 vSCP] - vSCP is the most complete and up-to-date syntax editor for sphere scripting. It does contain syntax highlighting, autocomplete, folding markers to specify blocks of code that can expand or collapse, bookmarks, autoindent, find/replace/gotoline, help guide for all the sphere elements added to your code, and more!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=2 vServerLauncher] - Install and run the latest build of sphereserver in a few clicks with vServerLauncher. It's pretty quick and simple!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=5 SphereService] - Relaunch SphereSvr.exe everytime it closes/crashes. Automatically runs at windows startup and works in a silent mode minimized to Tray.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=4 vCrypter] - Type the client version and the tool will calculate the correct UO login keys for classic or enhanced clients.

==Other Articles==

* [[Armor Calculation]]
* [[Client Changes]]
* [[Common Scripting Misconceptions]]
* [[Custom Object Properties]]
* [[Error Codes]]
* [[Experience System]]
* [[How Combat Works]]
* [[Occam's Razor]]
* [[Optimization|Optimization Theory]]
* [[Override TAGs]]
* [[Revisions Changelog]]
* [[Sendpacket]]
* [[Skill Gain Theory]]
* [[The Process of Scripting]]
* [[Building Component Reference]]

==Credits==

'''Special thanks to:'''

[[WhoIsWho|XuN, Nolok, Ben, and Drk]], for their hard work on the X branch taking Sphere into the next decade.

[[WhoIsWho|Ben, Cloud_Br, Ellessar, Jdog, Lord Zerofiz, Mordaunt, Nazghul-ll, RanXerox, Rattlehead, Sandman, Sharlenwar, ShiryuX, thelegbra, Maximus, WarAngel and Valios]], for helping to add content.

[[WhoIsWho|Daleth]], for writing the Sphere Reference Project, and [[WhoIsWho|Mordaunt]] for converting it to .chm format.

[[WhoIsWho|Tracker]], for writing the Sphere 56 Tracking Changes in Sphereserver.net

[[WhoIsWho|Taran]], for writing the original and now famous Sphere Scripting for Dummies tutorials, and [[WhoIsWho|MrSugarCube]] for bringing it up-to-date directly from source.

[[WhoIsWho|Ben, Khaos, Ranxerox, Shiryux, Furio, Radiant, Vjaka, Nazghul-ll, Ellessar, Torfo, Shadow Dragon, MrSugarCube and coruja747]] for continuing to develop Sphere into a powerful and very customizable Ultima Online emulator.

[[WhoIsWho|Crius]], for providing hosting for the original SphereWiki, and [[WhoIsWho|Torfo]] for providing the current hosting.

==External Links==

* [[Useful Links]] ''(An ongoing list of useful links for community members)''
* [http://www.spherecommunity.net/ Official SphereServer Website]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Nightly builds]
* [http://nightly.prerelease.sphere.torfo.org/ Nightly builds - OUTDATED, use the link above]
* [http://spherepack.codeplex.com/ Sphere Community Pack 2.0]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]

Main Page

2024-04-05T12:17:00Z

Jhobean: add itemdef link

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Starting with SphereServer'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Setup of Sphere'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Sphere 101'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Extra Tutorials'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''
* [[Bitwise Operations]] ''(How to work with FLAGS/ATTR)''
* [[Script Debugging]] ''(How to fix your scripts)''
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''IMPORTANT LINKS'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [https://github.com/Sphereserver SphereServer Official Github]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Download Nightly Builds] ''(Plus! Extra downloads, like tools and scripts!)''
* [https://github.com/Sphereserver/Source-X/blob/master/Changelog.txt SphereX Changelog] | [https://github.com/Sphereserver/Source/blob/master/changelog.txt 56d Changelog] | [https://github.com/Sphereserver/Source-X/tree/master/docst Older Changelog]
* [https://discord.gg/BZj2fEA Join us at Discord] ''(We will solve most of your doubts over there)''
</div>
</div>
</div>
.

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Reference Compendium'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Definitions|'''Definitions''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[CHARDEF|Characters]]
* [[DIALOG|Dialogs]]
* [[EVENTS|Events]]
* [[ITEMDEF|Itemdef]] | [[ITEMS|Items]]
* [[MENU|Menus]]
* [[REGIONRESOURCE|Region Resources]]
* [[REGIONTYPE|Region Types]]
* [[AREADEF|Regions]]
* [[ROOMDEF|Rooms]]
* [[SKILLCLASS|Skill Classes]]
* [[SKILLMENU|Skill Menus]]
* [[SKILL|Skills]]
* [[SPAWN|Spawn Groups]]
* [[SPELL|Spells]]
* [[TYPEDEF|Types]]
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Objects|'''Objects''']]
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Accounts]]
* [[Characters]]
* [[Database]]
* [[Files]]
* [[GM Pages]]
* [[Items]]
** ''[[Special Items]]''
* [[Map Points]]
* [[Parties]]
* [[Regions]]
* [[Rooms]]
* [[Sectors]]
* [[Server]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Scripts|'''Scripts''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[:Category:Functions|Functions and Triggers]]
* [[:Category:Variables|General Functions, Properties and References]]
* [[Intrinsic Functions]]
* [[:Category:Statements|Statements]]
* [[:Category:Triggers|Triggers]]
</div>
</div>
.
----

.

==Useful Links==
* Modern SphereServer Nightly Downloads (Server) https://forum.spherecommunity.net/sshare.php?srt=4
* Older/Classic SphereServer downloads (Server) https://forum.spherecommunity.net/sshare.php?srt=4&prj=7
* Sphere-X Script Pack (Scripts) https://github.com/Sphereserver/Scripts-X
* Julians Script Vault (Scripts) https://github.com/JulianUO/SphereX-ScriptsVault
* List of UO Packets (Info) https://docs.polserver.com/packets/index.php
* Scripts https://mirror.ashkantra.de/scripts/Sphere/
* GM Commands (Commands) https://wiki.spherecommunity.net/index.php?title=GM_Commands
* Axis 2 Downloads (GM Tool) https://forum.spherecommunity.net/sshare.php?srt=4&prj=1
* Leviathan (GM tool) https://github.com/cbnolok/Leviathan/releases
* Ultima Online Downloads (Clients) https://mega.nz/folder/6uYxnIpY#tahGzzz_yOkLgNM1c_DxdQ
* Client 7.0.20 https://mirror.ashkantra.de/fullclients/
* ClassicUO (Third Party Client) https://www.classicuo.eu/
* OrionUO (Third Party Client) http://orionuo.online/
* CentrED (Worldbuilding) https://uo.wzk.cz/centred/
* UO-Pixel (Graphics) http://www.uo-pixel.de/
* UO Fiddler ( MUL Viewer) http://uofiddler.polserver.com/
* UO Grafiken by Nyray (Graphics) https://nyray.wordpress.com/
* Vestimisu (Graphics) http://vestimisu.blogspot.com/
* Ultima Online Graphics By Rubra (Graphcs) http://uographicsrubra.blogspot.com/
* Isis‘ UO Grafiken (Graphics) https://isispixel.wordpress.com/
* ServUO (Graphics) https://www.servuo.com/archive/categories/assets.13/
* UOGateway (Shard Listing) https://uogateway.com/

==Sphere 3rd Party Tools==
* [http://forum.spherecommunity.net/sshare.php?srt=4&uid=603 Axis II] - GM Tool for Sphere that will allow you to place objects in-game, spawns, traveling and many other useful functions for shard admins and GMs.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=3 vSCP] - vSCP is the most complete and up-to-date syntax editor for sphere scripting. It does contain syntax highlighting, autocomplete, folding markers to specify blocks of code that can expand or collapse, bookmarks, autoindent, find/replace/gotoline, help guide for all the sphere elements added to your code, and more!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=2 vServerLauncher] - Install and run the latest build of sphereserver in a few clicks with vServerLauncher. It's pretty quick and simple!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=5 SphereService] - Relaunch SphereSvr.exe everytime it closes/crashes. Automatically runs at windows startup and works in a silent mode minimized to Tray.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=4 vCrypter] - Type the client version and the tool will calculate the correct UO login keys for classic or enhanced clients.

==Other Articles==

* [[Armor Calculation]]
* [[Client Changes]]
* [[Common Scripting Misconceptions]]
* [[Custom Object Properties]]
* [[Error Codes]]
* [[Experience System]]
* [[How Combat Works]]
* [[Occam's Razor]]
* [[Optimization|Optimization Theory]]
* [[Override TAGs]]
* [[Revisions Changelog]]
* [[Sendpacket]]
* [[Skill Gain Theory]]
* [[The Process of Scripting]]
* [[Building Component Reference]]

==Credits==

'''Special thanks to:'''

[[WhoIsWho|XuN, Nolok, Ben, and Drk]], for their hard work on the X branch taking Sphere into the next decade.

[[WhoIsWho|Ben, Cloud_Br, Ellessar, Jdog, Lord Zerofiz, Mordaunt, Nazghul-ll, RanXerox, Rattlehead, Sandman, Sharlenwar, ShiryuX, thelegbra, Maximus, WarAngel and Valios]], for helping to add content.

[[WhoIsWho|Daleth]], for writing the Sphere Reference Project, and [[WhoIsWho|Mordaunt]] for converting it to .chm format.

[[WhoIsWho|Tracker]], for writing the Sphere 56 Tracking Changes in Sphereserver.net

[[WhoIsWho|Taran]], for writing the original and now famous Sphere Scripting for Dummies tutorials, and [[WhoIsWho|MrSugarCube]] for bringing it up-to-date directly from source.

[[WhoIsWho|Ben, Khaos, Ranxerox, Shiryux, Furio, Radiant, Vjaka, Nazghul-ll, Ellessar, Torfo, Shadow Dragon, MrSugarCube and coruja747]] for continuing to develop Sphere into a powerful and very customizable Ultima Online emulator.

[[WhoIsWho|Crius]], for providing hosting for the original SphereWiki, and [[WhoIsWho|Torfo]] for providing the current hosting.

==External Links==

* [[Useful Links]] ''(An ongoing list of useful links for community members)''
* [http://www.spherecommunity.net/ Official SphereServer Website]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Nightly builds]
* [http://nightly.prerelease.sphere.torfo.org/ Nightly builds - OUTDATED, use the link above]
* [http://spherepack.codeplex.com/ Sphere Community Pack 2.0]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]

@Eat

2024-01-14T02:52:13Z

Jhobean: Add ACT information

==Description==
This trigger fires when someone is eating something.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ACT]] || The [[Items|item]] being clicked.
|-
| [[I]] / [[SRC]] || The [[Characters|character]] doing the clicking.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| Argn1 || I/O || Set to 1 to let it pass your MaxStats, ie: MaxHits=100 and local.hits + hits = 150, having it to 1 will set hits to 150 and setting it to 0 will raise hits up to MaxHits only.
|-
| local.hits || I/O || Amount of HitPoints to regenerate.
|-
| local.mana || I/O || Amount of Mana to regenerate.
|-
| local.stam || I/O || Amount of Stamina to regenerate.
|-
| local.food || I/O || Amount of Food to regenerate.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the gain of stats but not the eating.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

TARGETF

2024-01-02T21:18:06Z

Jhobean: Add TargP

Targetf is a command you can use to directly target a character or item and using a function on it without manually creating an memory item or such. Using the targetf itself works like calling an ordinary function and you can put arguments after the function normally.

ex. targetf f_hello or targetf f_hello 1,2

In targetf:

SRC= player using the function

ARGO= target's UID

TARGP= ID of the tiles when target is a static tile

local.id stores the ID of the targeted object
[[Category:Reference Compendium]]
[[Category: Properties and Functions]]

Items

2023-12-02T22:37:36Z

Jhobean: Visual change

{{Languages|Items}}

__FORCETOC__
Generally speaking, there are two types of "things" in the game; characters and items. Compared to characters, items are very complex. Items have a number of different uses, for example a sword is an item that players can see and equip to increase the damage they can do in combat. Some items in the game can not be seen by the players, but they have as much impact on the player as their sword, for example, a memory item is equipped every time a player is under the effects of a spell. Some [[Special Items|special types of item]] also have additional properties that can be accessed via scripts. The following tables detail the various properties of items in SphereServer:

==References==
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[CONT]] || RW || Gets or sets the [[Characters|character]] or [[Special Items#Containers|container item]] that the object is inside. When an item's CONT is changed, it bypasses the typical behavior (for example, you can force an item to be "in" a container and bypass @dropon triggers, or force an item to be equipped to a player and bypass @equiptest and @equip triggers -- but be careful, because in this second scenario it may end up in an invalid layer.)
|-
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to. Note, you can make circular LINK's, but a single item cannot be linked to more than one other item.
|-
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the object is in.
|-
| [[ROOM]] || R || Gets the [[Rooms|room]] that the object is in.
|-
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the object is at.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the object is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the item.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[ITEMDEF]] that defines the item.
|}

==Properties and Functions==
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.

{| border="1" cellspacing="4" cellpadding="4"
! Name !! '''Read/Write''' !! '''Description'''
|-
| [[ADDCIRCLE]] ''spell_circle'' || W || Adds all of the spells in the given Magery circle to the spellbook.
|-
| [[ADDSPELL]] ''spell_id'' || RW || Gets whether or not a spell exists in the spellbook, or adds a spell to the spellbook.
|-
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.
|-
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.
|-
| [[AMMOSOUNDHIT]] || RW || Overrides the hit sound on weapons.
|-
| [[AMMOSOUNDMISS]] || RW || Overrides the miss sound on weapons.
|-
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.
|-
| [[AMOUNT]] || RW || Gets the amount of items this icon represents (e.g. a pile of gold or any stacked item).
|-
| [[ATTR]] || RW || Gets or sets the item's attribute flags.
|-
| [[BOUNCE]] || W || Moves the item to SRC's backpack (triggering the ''you put the item in your pack'' message.
|-
| [[CAN]] || RW || Gets or Sets the can_flags (Setting can be only done in the Itemdef itself). Only readable in X branch.
|-
| [[CANMASK]] || RW || Stores the CAN flags to be dynamically switched on or off from the base CAN property.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the item.
|-
| [[CANSEELOS]] ''point_or_uid'' || R || Returns 1 if SRC has line of sight to the item or character (uid) or point (location).
|-
| [[CANSEELOSFLAG]] ''flags,point_or_uid'' || R || Returns 1 if SRC has line of sight to the item. The ''flags'' are defined in the los_flags section of the sphere_defs.scp file and can be used to modify what tests take place. The ''point_or_uid'' is an object or position that can be used to test line of sight to something other than SRC. Note, the delimiter for FLAG values is ;
|-
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the item that start with the given prefix.
|-
| [[COLOR]] || RW || Gets or sets the object's hue.
|-
| [[CONSUME]] ''amount'' || W || Deducts an amount from the item, deleting it at 0.
|-
| [[CONTCONSUME]] ''resource_list'' || W || Deletes items from inside the container.
|-
| [[CONTGRID]] || RW || If in a container, gets or sets the grid number that the item occupies (in KR's grid view)
|-
| [[CONTP]] || RW || Gets or sets the position of the item within its container.
|-
| [[DAMAGE]] ''chance, type, source'' || W || If ''chance'' is greater than (Rand(maxhits*16)), inflicts damage of ''type'' (the damage type flags are defined in the sphere_defs.scp file) upon the item. You can optionally specify the ''source'' of the damage.
|-
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.
|-
| [[DECAY]] ''time'' || W || Sets the decay timer (in tenths of a second) for the item.
|-
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DISPID]] || RW || Gets or sets the ID that the item will appear as to players.
|-
| [[DISPIDDEC]] || RW || Same as [[DISPID]], except it returns the ID as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and SRC. If ''point_or_uid'' is used, SRC can be replaced with a map location or another object.
|-
| [[DMGCOLD]] || RW || Gets or sets the amount of cold damage the weapon will give.
|-
| [[DMGENERGY]] || RW || Gets or sets the amount of energy damage the weapon will give.
|-
| [[DMGFIRE]] || RW || Gets or sets the amount of fire damage the weapon will give.
|-
| [[DMGPOISON]] || RW || Gets or sets the amount of poison damage the weapon will give.
|-
| [[DROP]] || W || Drops the item to the ground.
|-
| [[DUPE]] || W || Clones the item.
|-
| [[EDIT]] || W || Displays an editing dialog for the item to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EQUIP]] || W || Equips the item to SRC.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[FIX]] || W || Re-aligns the item or character's Z level to ground level (if items are on the ground, the top item's ''Z+HEIGHT'' is used).
|-
| [[FLIP]] || W || Rotates the item clockwise.
|-
| [[FRUIT]] || RW || Gets or sets the fruit that will be produced by the crops.
|-
| [[HEIGHT]] || R || Gets the height of the item.
|-
| [[HITS]] || RW || Gets or sets the number of hitpoints the item has.
|-
| [[HITPOINTS]] || RW || Gets or sets the number of hitpoints the item has.
|-
| [[ID]] || RW || Gets or sets the ID of the item.
|-
| [[INFO]] || W || Displays an information dialog about the item to SRC.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE and is within ''distance''.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE and is within ''distance''.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player character.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.
|-
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[LAYER]] || RW || Gets or sets the layer that the item occupies when equipped (possible layers are defined in the sphere_defs.scp file).
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXHITS]] || RW || Gets or sets the maximum number of hitpoints the item can have.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this item to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this item to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the item's armour rating if it is clothing, armor, or a shield. This gets or sets a modifier for the item's damage if it is a weapon type.
|-
| [[MORE1]] || RW || Gets or sets the MORE1 value for the item.
|-
| [[MORE1H]] || RW || Gets or sets the upper 4 bytes of the item's MORE1 value.
|-
| [[MORE1L]] || RW || Gets or sets the lower 4 bytes of the item's MORE1 value.
|-
| [[MORE2]] || RW || Gets or sets the MORE2 value for the item.
|-
| [[MORE2H]] || RW || Gets or sets the upper 4 bytes of the item's MORE2 value.
|-
| [[MORE2L]] || RW || Gets or sets the lower 4 bytes of the item's MORE2 value.
|-
| [[MOREM]] || RW || Gets or sets the MOREM value for the item.
|-
| [[MOREX]] || RW || Gets or sets the MOREX value for the item.
|-
| [[MOREY]] || RW || Gets or sets the MOREY value for the item.
|-
| [[MOREZ]] || RW || Gets or sets the MOREZ value for the item.
|-
| [[MOREP]] || RW || Gets or sets the MOREP value for the item.
|-
| [[MOVE]] ''direction amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position. Possible ''direction'' values are N,S,W, or E. Note, you can combine directions (like: MOVE SW 1) but nonsensical directions (like: MOVE WE 2) have the nonsense removed.
|-
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the object to a random location near another object within a certain distance.
|-
| [[MOVETO]] ''location'' || W || Moves the object to a specific location (note, the AREADEF or ROOMDEF must have a P defined).
|-
| [[NAME]] || RW || Gets or sets the object's name.
|-
| [[NUDGEDOWN]] ''amount'' || W || Decreases the object's Z level.
|-
| [[NUDGEUP]] ''amount'' || W || Increases the object's Z level.
|-
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.
|-
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.
|-
| [[REMOVE]] || W || Deletes the object.
|-
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item inside a container.
|-
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.
|-
| [[SAY]] ''message'' || W || Makes the object speak a message.
|-
| [[SAYU]] ''message'' || W || Makes the object speak a UTF-8 message
|-
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || Makes the object speak a UNICODE message.
|-
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.
|-
| [[SERIAL]] || R || Gets the item's unique ID in the world.
|-
| [[SEXTANTP]] ''location'' || R || Converts the item's location or a specified location into sextant coordinates.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this object.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the item to be affected by a spell.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC. ''F'' makes the ''function'' available, and when added, the function name must be the 1st argument. ''M'' allows you to place a ''multi'' item, in which case the multi number must be passed as an argument. ''G'' forces the target to only be the ground. ''W'' checks the criminal status of the player before (or after?) the target selection is made.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Schedules a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the object.
|-
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the item. (On X version wild character * is available for defining the function name or the argument)
|-
| [[TRIGGER]] ''trig_name, trigger_argtype, argument1, argument2, ...'' || R || Fires a custom trigger (trig_name), allowing you to define the behavior of the arguments (the types are defined under trigger_argtype in the sphere_defs.scp file). The result of the trigger's RETURN value is returned. For example:
LOCAL.result=<TRIGGER @CustomTrigger,<DEF.tat_as_argn>,1,2,3>
|-
| [[TYPE]] || RW || Gets or sets the item type. You can use built-in or custom [[TYPEDEF]]s as a value.
|-
| [[UID]] || R || Gets the item's unique ID in the world.
|-
| [[UNEQUIP]] || W || Unequips the item and places it in SRC's backpack.
|-
| [[UPDATE]] || W || Updates the state of the item to nearby clients.
|-
| [[UPDATEX]] || W || Updates the state of the item to nearby clients, removing it from their view first to ensure a full refresh.
|-
| [[USESCUR]] || W || X branch only. Gets or sets the current uses of an item. Only partially supported.
|-
| [[USESMAX]] || W || X branch only. Gets or sets the maximum uses of an item. Only partially supported.
|-
| [[USE]] ''check_los'' || W || Uses the item, as if SRC had double clicked it.
|-
| [[USEITEM]] || W || Double clicks the item, with SRC as the source of the event, without checking for line of sight.
|-
| [[WEIGHT]] || R || Gets the weight of the item.
|-
| [[Z]] || R || Gets the Z position of the item.
|}

==Triggers==
Here is a list of all item triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description''' || '''Sphere X Only?'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@Buy]] || Fires when the item is being bought from a vendor.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips are about to be sent to a client.
|-
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.
|-
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.
|-
|[[@Carve]] || Fires when a corpse item is being carved. || X
|-
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.
|-
| [[@Damage]] || Fires when the item receives damage.
|-
| [[@DClick]] || Fires when the object is double-clicked.
|-
| [[@Destroy]] || Fires when the object is being deleted.
|-
| [[@DropOn_Char]] || Fires when the item has been dropped on to a character.
|-
| [[@DropOn_Ground]] || Fires when the item has been dropped on to the ground.
|-
| [[@DropOn_Item]] || Fires when the item is dropped on to another item.
|-
| [[@DropOn_Self]] || Fires when an item has been dropped on to this item.
|-
| [[@DropOn_Trade]] || Fires when an item is being dropped on a Trade Window.
|-
| [[@Dye]] || Fires when an item is having its colored changed.
|-
| [[@Equip]] || Fires when the item has been equipped.
|-
| [[@EquipTest]] || Fires when the item is about to be equipped.
|-
| [[@HouseDesignBegin]] || A trigger for t_multi_custom, called when the player enters on design mode. || X
|-
| [[@HouseDesignCommitItem]] || Fires for each commited item in house design system. || X
|-
| [[@PickUp_Ground]] || Fires when the item ihas been picked up from the ground.
|-
| [[@PickUp_Pack]] || Fires when the item is picked up from inside a container.
|-
| [[@PickUp_Self]] || Fires when an item has been picked up from inside the item.
|-
| [[@PickUp_Stack]] || Fires when the item is picked up from a stack.
|-
| [[@Redeed]] || Fires when multi item is about to redeed (t_multi, t_ship, t_multi_custom, t_addon).
|-
| [[@Sell]] || Fires when the item is sold to a vendor.
|-
| [[@Smelt]] || Fires when the item is being smelt. || X
|-
| [[@SpellEffect]] || Fires when the object is hit by the effects of a spell.
|-
| [[@Step]] || Fires when a character steps on the item.
|-
| [[@TargOn_Cancel]] || Fires when a target is cancelled from the item.
|-
| [[@TargOn_Char]] || Fires when a character is targeted from the item.
|-
| [[@TargOn_Ground]] || Fires when the ground is targeted from the item.
|-
| [[@TargOn_Item]] || Fires when an item is targeted from this item.
|-
| [[@Timer]] || Fires when the item's timer expires.
|-
| [[@ToolTip]] || Fires when old-style tooltips are requested for the item.
|-
| [[@UnEquip]] || Fires when the item is unequipped.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

CANMASK

2023-12-02T20:44:54Z

Jhobean:

=Description=

X branch only.

This property is a bitmask, like the CAN property, and stores the [[CAN]] flags to be dynamically switched on or off from the base CAN property.

When retrieving the CAN property, now it is first XORed with CANMASK (the return value will be CAN ^ CANMASK), so in other words:

If a flag set in the CANMASK is also set in CAN, the flag is ignored;
If a flag set in the CANMASK isn't set in CAN, the flag is considered as set.

CAN

2023-12-02T20:43:03Z

Jhobean:

=Description=

CAN is a Flag like variable, predefined values must be added with special characters and not with sums or sustractions ( + or - ).

These values adds some behaviour modification for items, like make sphere they are water (can_i_water), a tile where Gargoyles can hover over (can_i_hover) and much more.

On X version: CAN flags are read only. You can't edit them after the item/char creation. I you want modify the can Flags you should use [[CANMASK]]

=Usage=
<spherescript>
[itemdef i_test]
id=i_pickaxe
name=Pickaxe
can=can_i_flip|can_i_dye|can_i_repair //This is how values must be added, using the | means they are being sum.

ON=@DClick
src.say <name>'s current can_flags are: <can>
//To check any specific flag this is how its done:

if (<can>&can_i_dye)
src.say and can be dyeable.
endif

</spherescript>

<spherescript>
CANMASK EXAMPLE ON X VERSION

IF <CANMASK>&mt_nonmover // is on, turn it off
CANMASK &=~mt_nonmover
SYSMESSAGE @,,1 Can move
else// is off, turn it on
CANMASK |= mt_nonmover
SYSMESSAGE @,,1 Can't move
ENDIF
</spherescript>

=Actual Flags=
CAN_I_DOOR 000001 // Is a door UFLAG4_DOOR

CAN_I_WATER 000002 // Need to swim in it. UFLAG1_WATER

CAN_I_PLATFORM 000004 // we can walk on top of it. (even tho the item itself might block) UFLAG2_PLATFORM

CAN_I_BLOCK 000008 // need to walk thru walls or fly over. UFLAG1_BLOCK

CAN_I_CLIMB 000010 // step up on it, UFLAG2_CLIMBABLE

CAN_I_FIRE 000020 // Is a fire. Ussually blocks as well. UFLAG1_DAMAGE

CAN_I_ROOF 000040 // We are under a roof. can't rain on us. UFLAG4_ROOF

CAN_I_HOVER 000080 // We are hovering. UFLAG4_HOVEROVER

CAN_I_PILE 000100 // Can item be piled UFLAG2_STACKABLE (*.mul)

CAN_I_DYE 000200 // Can item be dyed UFLAG3_CLOTH? (sort of)

CAN_I_FLIP 000400 // will flip by default.

CAN_I_LIGHT 000800 // UFLAG3_LIGHT

CAN_I_REPAIR 001000 // Is it repairable (difficulty based on value)

CAN_I_REPLICATE 002000 // Things like arrows are pretty much all the same.

CAN_I_DCIGNORELOS 004000 // when dclicked, ignore LOS checks

CAN_I_DCIGNOREDIST 008000 // when dclicked, ignore distance checks

CAN_I_BLOCKLOS 010000 // blocks LOS, but not walking thru

CAN

2023-12-02T20:40:14Z

Jhobean: Add canmask info

=Description=

CAN is a Flag like variable, predefined values must be added with special characters and not with sums or sustractions ( + or - ).

These values adds some behaviour modification for items, like make sphere they are water (can_i_water), a tile where Gargoyles can hover over (can_i_hover) and much more.

CAN flags are read only. You can't edit them after the item/char creation. I you want modify the can Flags you should use canmask

=Usage=
<spherescript>
[itemdef i_test]
id=i_pickaxe
name=Pickaxe
can=can_i_flip|can_i_dye|can_i_repair //This is how values must be added, using the | means they are being sum.

ON=@DClick
src.say <name>'s current can_flags are: <can>
//To check any specific flag this is how its done:

if (<can>&can_i_dye)
src.say and can be dyeable.
endif

</spherescript>

<spherescript>
IF <CANMASK>&mt_nonmover // is on, turn it off
CANMASK &=~mt_nonmover
SYSMESSAGE @,,1 Can move
else// is off, turn it on
CANMASK |= mt_nonmover
SYSMESSAGE @,,1 Can't move
ENDIF
</spherescript>

=Actual Flags=
CAN_I_DOOR 000001 // Is a door UFLAG4_DOOR

CAN_I_WATER 000002 // Need to swim in it. UFLAG1_WATER

CAN_I_PLATFORM 000004 // we can walk on top of it. (even tho the item itself might block) UFLAG2_PLATFORM

CAN_I_BLOCK 000008 // need to walk thru walls or fly over. UFLAG1_BLOCK

CAN_I_CLIMB 000010 // step up on it, UFLAG2_CLIMBABLE

CAN_I_FIRE 000020 // Is a fire. Ussually blocks as well. UFLAG1_DAMAGE

CAN_I_ROOF 000040 // We are under a roof. can't rain on us. UFLAG4_ROOF

CAN_I_HOVER 000080 // We are hovering. UFLAG4_HOVEROVER

CAN_I_PILE 000100 // Can item be piled UFLAG2_STACKABLE (*.mul)

CAN_I_DYE 000200 // Can item be dyed UFLAG3_CLOTH? (sort of)

CAN_I_FLIP 000400 // will flip by default.

CAN_I_LIGHT 000800 // UFLAG3_LIGHT

CAN_I_REPAIR 001000 // Is it repairable (difficulty based on value)

CAN_I_REPLICATE 002000 // Things like arrows are pretty much all the same.

CAN_I_DCIGNORELOS 004000 // when dclicked, ignore LOS checks

CAN_I_DCIGNOREDIST 008000 // when dclicked, ignore distance checks

CAN_I_BLOCKLOS 010000 // blocks LOS, but not walking thru

@HitTry

2023-11-29T22:21:13Z

Jhobean: Add link of page "how combat work"

==Description==
This trigger fires when a character is about to swing their weapon or fist using a combat skill.

More info on [[How_Combat_Works]]

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|weapon]] being used (can be nothing, if fists are used).
|-
| [[I]] || The [[Characters|character]] doing the hitting.
|-
| [[SRC]] || The [[Characters|character]] being hit.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The time, in tenths of a second, until the swing will complete.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the combat swing.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

@Mount

2023-11-17T19:04:24Z

Jhobean: Add ARGN1 argument and note

==Description==
This trigger fires when a character attempts to mount a rideable creature.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Characters|creature]] being mounted.
|-
| [[I]] || The [[Characters|character]] attempting to mount the creature.
|-
| [[SRC]] || The [[Characters|character]] attempting to mount the creature.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The itemID of the item containing the animation use when moounting.(Anim # is in tiledata of this item) [Sphere X]
|-
|}

NOTE: When mounting a pet you'll read a non sense random value in ARGN1 but you can replace it by an ITEMID to force anim
EX: 03ea6 for Llama anim or 03e9f for gray horse anim. Yes 03ea6 is a ship part but in tiledata it link to anim 828

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from mounting the creature.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

Main Page

2023-06-12T22:16:50Z

Jhobean: add old changelog link

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Starting with SphereServer'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Setup of Sphere'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Sphere 101'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Extra Tutorials'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''
* [[Bitwise Operations]] ''(How to work with FLAGS/ATTR)''
* [[Script Debugging]] ''(How to fix your scripts)''
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''IMPORTANT LINKS'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [https://github.com/Sphereserver SphereServer Official Github]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Download Nightly Builds] ''(Plus! Extra downloads, like tools and scripts!)''
* [https://github.com/Sphereserver/Source-X/blob/master/Changelog.txt SphereX Changelog] | [https://github.com/Sphereserver/Source/blob/master/changelog.txt 56d Changelog] | [https://github.com/Sphereserver/Source-X/tree/master/docst Older Changelog]
* [https://discord.gg/BZj2fEA Join us at Discord] ''(We will solve most of your doubts over there)''
</div>
</div>
</div>
.

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Reference Compendium'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Definitions|'''Definitions''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[CHARDEF|Characters]]
* [[DIALOG|Dialogs]]
* [[EVENTS|Events]]
* [[ITEMDEF|Items]]
* [[MENU|Menus]]
* [[REGIONRESOURCE|Region Resources]]
* [[REGIONTYPE|Region Types]]
* [[AREADEF|Regions]]
* [[ROOMDEF|Rooms]]
* [[SKILLCLASS|Skill Classes]]
* [[SKILLMENU|Skill Menus]]
* [[SKILL|Skills]]
* [[SPAWN|Spawn Groups]]
* [[SPELL|Spells]]
* [[TYPEDEF|Types]]
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Objects|'''Objects''']]
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Accounts]]
* [[Characters]]
* [[Database]]
* [[Files]]
* [[GM Pages]]
* [[Items]]
** ''[[Special Items]]''
* [[Map Points]]
* [[Parties]]
* [[Regions]]
* [[Rooms]]
* [[Sectors]]
* [[Server]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Scripts|'''Scripts''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[:Category:Functions|Functions and Triggers]]
* [[:Category:Variables|General Functions, Properties and References]]
* [[Intrinsic Functions]]
* [[:Category:Statements|Statements]]
* [[:Category:Triggers|Triggers]]
</div>
</div>
.
----

.
==Sphere 3rd Party Tools==
* [http://forum.spherecommunity.net/sshare.php?srt=4&uid=603 Axis II] - GM Tool for Sphere that will allow you to place objects in-game, spawns, traveling and many other useful functions for shard admins and GMs.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=3 vSCP] - vSCP is the most complete and up-to-date syntax editor for sphere scripting. It does contain syntax highlighting, autocomplete, folding markers to specify blocks of code that can expand or collapse, bookmarks, autoindent, find/replace/gotoline, help guide for all the sphere elements added to your code, and more!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=2 vServerLauncher] - Install and run the latest build of sphereserver in a few clicks with vServerLauncher. It's pretty quick and simple!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=5 SphereService] - Relaunch SphereSvr.exe everytime it closes/crashes. Automatically runs at windows startup and works in a silent mode minimized to Tray.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=4 vCrypter] - Type the client version and the tool will calculate the correct UO login keys for classic or enhanced clients.

==Other Articles==

* [[Armor Calculation]]
* [[Client Changes]]
* [[Common Scripting Misconceptions]]
* [[Custom Object Properties]]
* [[Error Codes]]
* [[Experience System]]
* [[How Combat Works]]
* [[Occam's Razor]]
* [[Optimization|Optimization Theory]]
* [[Override TAGs]]
* [[Revisions Changelog]]
* [[Sendpacket]]
* [[Skill Gain Theory]]
* [[The Process of Scripting]]
* [[Building Component Reference]]

==Credits==

'''Special thanks to:'''

[[WhoIsWho|XuN, Nolok, Ben, and Drk]], for their hard work on the X branch taking Sphere into the next decade.

[[WhoIsWho|Ben, Cloud_Br, Ellessar, Jdog, Lord Zerofiz, Mordaunt, Nazghul-ll, RanXerox, Rattlehead, Sandman, Sharlenwar, ShiryuX, thelegbra, Maximus, WarAngel and Valios]], for helping to add content.

[[WhoIsWho|Daleth]], for writing the Sphere Reference Project, and [[WhoIsWho|Mordaunt]] for converting it to .chm format.

[[WhoIsWho|Tracker]], for writing the Sphere 56 Tracking Changes in Sphereserver.net

[[WhoIsWho|Taran]], for writing the original and now famous Sphere Scripting for Dummies tutorials, and [[WhoIsWho|MrSugarCube]] for bringing it up-to-date directly from source.

[[WhoIsWho|Ben, Khaos, Ranxerox, Shiryux, Furio, Radiant, Vjaka, Nazghul-ll, Ellessar, Torfo, Shadow Dragon, MrSugarCube and coruja747]] for continuing to develop Sphere into a powerful and very customizable Ultima Online emulator.

[[WhoIsWho|Crius]], for providing hosting for the original SphereWiki, and [[WhoIsWho|Torfo]] for providing the current hosting.

==External Links==

* [[Useful Links]] ''(An ongoing list of useful links for community members)''
* [http://www.spherecommunity.net/ Official SphereServer Website]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Nightly builds]
* [http://nightly.prerelease.sphere.torfo.org/ Nightly builds - OUTDATED, use the link above]
* [http://spherepack.codeplex.com/ Sphere Community Pack 2.0]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]

Serv.rtime.format

2023-06-12T22:13:37Z

Jhobean: Change %J value 0-366 to 1-366 Ref: https://web.archive.org/web/20080226060323/http://www.scit.wlv.ac.uk/cgi-bin/mansec?3C+strftime#

SERV.RTIME.FORMAT <args>

SERV.RTIME.FORMAT accepts arguments as a string, e.g. SERV.RTIME.FORMAT %d returns the number of the day.

Acceptable variables are:

%a= day name 3 letter

%A= day name full

%b= month name 3 letter

%B= month name full

%c= date & time numeric

%d= day of month

%H= hour 24hr clock

%I= hour 12hr clock

%j= day of year 1-366

%m= month number

%M= minutes

%p= AM/PM

%S= seconds

%U= week number 0-52 with Sunday as the first day of week 1

%w= week day numerical Sunday = 0

%W= week number in year 0-52 with Monday as the first day of week 1

%x= date numeric

%X= time numeric

%y= year 2 digit

%Y= year 4 digit

%z= Time zone

Chapter 7

2023-03-13T03:12:37Z

Jhobean: Specify forchar include only online players

{{Languages|Chapter_7}}

==Recursive Functions==
I discovered this very seldom explored extension of SPHERE scripting while reading messages on the boards. Someone was trying to create a function that counted the number of items in a container using this sort of thing, and it worked for the most part. I was very amazed, because before that, no one had even thought of using functions that looped back upon themselves.

Which is what a recursive function is. I'll say it one more time.

A recursive function is one that calls itself, or recurs. Surprise!

So how do we do this? It's as simple as calling a function:

<spherescript>[FUNCTION recursive_test]
recursive_test</spherescript>

This very small piece of code in fact IS a recursive function. As you can see, the function will call itself and start over from the beginning, which will proceed to call the function again, and again, and again, and on and on. In this case, we don't have any way to stop it. This is called an infinite loop, one that will continue forever without stopping. Your server will die a flaming death.

'''Lesson 1: How to NOT create an infinite loop'''

Let me tell you right now. You will write a script that implements an infinite loop. You will test it. Your server will die. It's guaranteed. No programmer can say that they have never accidentally written an infinite loop. (RANDOM NOTE: All windows programs are in fact infinite loops. Your SPHERE server is an infinite loop.) In a SPHERE script, however, here's what happens:

# The function is called.
# Some stuff takes place
# The function is called from within itself. Being a good scripting language, it records where it left off so it can go back later. This is called the stack.
# Go back to number 1.

This "stack" builds up very very quickly, and soon the server cannot allocate any more memory for it, and will crash when it tries. Fun stuff, I tell you.

Anyways, here is one way to avoid creating an infinite loop. Let's say we want to make a function that executes SRC.SYSMESSAGE Hello World 35 times. Here would be an example of how one could do this:

<spherescript>[FUNCTION recurse_hello]
IF (<ARGN1> < 1)
RETURN 1
ENDIF
SYSMESSAGE Hello World
RECURSE_HELLO <EVAL <ARGN1> - 1>
RETURN 1</spherescript>

Then, in another script, we would execute this command: <font color="darkred">SRC.RECURSE_HELLO 35</font>

Remember what ARGN is from the previous chapter? It's the argument to the function stored as a number. Initially, as you can see, it's 25 because we made it be that way. However, every time the function calls itself, or "recurses", it sets ARGN1 to be one less than itself. Here's the step-by-step analysis of this:

# The function is called. ARGN1 is 35 because we said so.
# It checks to see if ARGN1 is less than one. If it is, we immediately RETURN 1 and set off the chain reaction that stops the recursive function.
# The next part should be fairly obvious. We're sending a SYSMESSAGE to the default object. Because we used SRC when we initially called the function, the default object is SRC.
# This is where the recursion takes place. The function calls itself with an argument ONE LESS than the current one. This starts the whole thing over at step 1. This is a NEW FUNCTION CALL, remember. The original function call STILL EXISTS and the program will "rewind" back down the stack to that location later. That is why I have a RETURN 1 after the function call.

That's your example of a recursive function. It isn't very practical. Let's look at a more practical example. See if you can figure it out for yourself. This is courtesy of Belgar, for the most part:

<spherescript>[FUNCTION pack_to_bank]
IF (<FINDLAYER.21.FINDCONT.0.UID> == 0)
RETURN 1
ENDIF
FINDLAYER.21.FINDCONT.0.CONT = <FINDLAYER.layer_bankbox.UID>
PACK_TO_BANK
RETURN 1</spherescript>

(As you can see, we don't always need an ARGS to make a function loop. In this case, we use a backpack with an unknown number of items inside and only stop when the pack no longer contains items.)

Recursive functions are very useful. Be sure you don't overuse them, though! Remember, while a script is running, YOUR SERVER IS FROZEN. If a recursive function takes too long to complete, your server will lag. A good method is to make sure that no function should be looping more than about 500 times. (Actually other server emulators such as POL have a mechanism to catch "runaway scripts" like this and halt them in their tracks.)

==FOR==

===FOR===
FOR is a powerful way to create a recursive function, and it allows a simpler level of control over your recursions.

Usage:

<spherescript>[FUNCTION for_display]
FOR X 1 20
SYSMESSAGE <LOCAL.X> //Will sysmessage the current for count.
ENDFOR</spherescript>

The loop will loop through 20 times, starting at 1 and ending at 20. X is the variable containing the current FOR count. If no variable is declared, the count can be accessed using <LOCAL._FOR>

Changing LOCAL._FOR or whatever you declared as count, will not change the loop's behaviour. But be aware that if you "stack" FOR loops without giving them different loop variables, the innermost loop will overwrite the loop variables of its successors, usually leading towards a completely messup of the whole loop stuff.

===FORCHARLAYER===
FORCHARLAYER is another type of FOR loop. Basically it allows you to loop through each item that is stored on the specified layer of a character. This can be useful for when you want to manipulate all of the spell runes or memory items on a character as an alternative to using FINDLAYER.x in a loop.

Something to be aware of here is that whilst inside the loop, the default object will be temporarily changed to the item in the loop. As you can see in the following example, we must store a reference to the original default object (the character) so that we can still reference it from within the loop:

<spherescript>[FUNCTION get_mitems_names]
REF1 = <UID> // store the default object in REF1
FORCHARLAYER 30
REF1.SYSMESSAGE <NAME> is a memory item in layer <LAYER>
ENDFOR</spherescript>

===FORCHARMEMORYTYPE===
FORCHARMEMORYTYPE is a very useful type of FOR loop. You may want to use it for experience systems, and some player and NPC killing systems. It loops through every memory item on a character that has a specified flag.

For example, a character has 4 memory items with the following names and flags:
{|
| Ellessar || 02000
|-
| Sorea || 022bc
|-
| Introvert || 0740d
|-
| Enrath || 0c40d
|}

'''Script:'''<br />
<spherescript>[FUNCTION get_harmedby_mems]
REF1 = <UID> // As with FORCHARLAYER, the default object changes within the loop
FORCHARMEMORYTYPE memory_harmedby // Loop through memory items with flag 00010=memory_harmedby
REF1.SYSMESSAGE There is a memory item with name <NAME>, uid <UID>, flags <COLOR> and one of its flag is also 00010.
ENDFOR</spherescript>

'''Result:'''<br />
On your screen you would see:

''There is a memory item with name Ellessar, uid 04f000001, flags 02000 and one of its flag is also 02000.''<br />
''There is a memory item with name Sorea, uid 04f000002, flags 022bc and one of its flag is also 02000.''<br />
''There is a memory item with name Introvert, uid 04f000003, flags 0740d and one of its flag is also 02000.''<br /></tt>

'''Note that there are only three messages, because the memory item "Enrath" does not have the flag 02000.'''

===FORCHARS===
FORCHARS is a FOR loop that you can use to check all mobiles (online player and NPC) within a set radius of an object.

The correct syntax being ''FORCHARS x'' where ''x'' is the radius in tiles the loop will cover.

* '''FORCHARS 2''' would check any mobile within a 2 tile radius
* '''FORCHARS 18''' would check the area inside your screen
* '''FORCHARS 6144''' would check the entire world map

One example of a function using FORCHARS

<spherescript>[FUNCTION kill_vendors]
FORCHARS 6144 // checks entire map
IF (<BRAIN> == brain_vendor) //argument for what will be acted upon within this function
KILL // action
ENDIF
ENDFOR</spherescript>

As with all FOR loops you have to stipulate inside the loop what it is to act upon, if you are restricting it to certian players/npcs (or in the case of FORITEMS, items) otherwise it will perform the action upon all online players/npcs within the radius of the loop.

In this case the loop checks for any Vendor npc's and kills them.

===FORCLIENTS, FORPLAYERS===
FORCLIENTS and FORPLAYERS are FOR loops, both are used to affect a clients/players in certain radius. If you do not set the radius, radius 18 is used as default. While FORCLIENTS only acts on player characters who are logged in, FORPLAYERS acts on each and every player character, even if logged off.

'''Usage:'''<br />
<spherescript>[FUNCTION radius_players]
FORCLIENTS 25
IF (<ACCOUNT.PLEVEL> <= 1) // Affects only logged in players, not staff
SAY I am here!
ENDIF
ENDFOR</spherescript>

===FORCONT===
FORCONT is a type of FOR loop. It loops through every item in a container. The default object inside the loop will be the item currently being looped over.

'''Usage:'''<br />
<spherescript>[FUNCTION rem_spellbooks]
FORCONT <FINDLAYER.21.UID> 10 // <FINDLAYER.21.UID> - UID of a container, 10 - how many subcontainers the function goes through, if set 0, it affects only items in container with UID
IF (<BASEID> == i_spellbook)
REMOVE
ENDIF
ENDFOR</spherescript>

===FORCONTID===
FORCONTID is a FOR loop that works in a similar way to FORCONT, except that it will only cycle through items that have a specific BASEID. You can set the amount of subcontainers to loop through, like the FORCONT example.

'''Usage:'''<br />
<spherescript>[FUNCTION rem_spellbooks2]
FORCONTID i_spellbook 10
REMOVE
ENDFOR</spherescript>

===FORCONTTYPE===
This is another FOR loop that is almost identical to FORCONTYPE. The only difference is that instead of looping through items with a specific BASEID, it will loop through items with a specific TYPE. Following the spellbooks remover example:

'''Usage:'''<br />
<spherescript>[FUNCTION rem_spellbook3]
FORCONTTYPE t_spellbook
REMOVE
ENDFOR</spherescript>

===FORINSTANCES===
You may have seen scripts that do something like the following:

<spherescript>[FUNCTION removespawns]
FORITEMS 9999
IF (<BASEID> == i_worldgem_bit)
REMOVE
ENDIF
ENDFOR</spherescript>

At a glance this script looks like a fairly useful script that can be used to remove all of your i_worldgem_bit (spawn) items from the server. If you attempt to run it you will most certainly notice that your server pauses for a signicantly long time (on a well-populated server you may even end up waiting a whole minute for the script to run), even if you only have several instances of the item on the server! The reason that this happens is because ''FORITEMS 9999'' will loop through ''every'' item within the 9999 tile radius, so the code will be looping hundreds or thousands of times when you only wanted to affect a handful of items!

To resolve this issue we have FORINSTANCES. This is a special loop which will loop through all instances of a given character or item BASEID that exist on the server. This offers the following advantages over using ''FORITEMS/FORCHARS 9999'':
* Sphere will only run your script for objects with the BASEID you are interested in.
* Sphere knows how many instances of the object exist, so can abort the loop at an appropriate time.
* Items inside containers (e.g. character backpacks or player banks) will not be missed out.

So with this in mind, the above script can be rewritten to the following:

<spherescript>[FUNCTION removespawns]
FORINSTANCES i_worldgem_bit
REMOVe
ENDFOR</spherescript>

Now when you run this script you should notice a significant drop in the execution time.

'''Note:''' Since Sphere still has to internally search for references to the objects you're after you may find that on well-populate servers there is still a noticable pause. If you need to use this kind of loop then you should do so sparingly, and if you need to regularly use this then you may wish to consider finding a more optimal way of implementing your script(s).

===FORITEMS===
FORITEMS works in much the same way that FORCHARS does, except it checks for ITEMS within the set radius as opposed to characters. Default obejct is set to the item which can be affected.

A basic example of a function using FORITEMS:

<spherescript>[FUNCTION Spawn_remover]
FORITEMS 6144 //once again it checks the entire map
IF (<TYPE> == t_spawn_char) //if this arguement is met
REMOVE //remove it
ENDIF //end the IF arguement
ENDFOR //end the FOR loop </spherescript>

===FOROBJS===
FOROBJS works in the same way that FORITEMS and FORCHARS does with the exception that this loop will find both characters '''AND''' items within the specified radius.

==WHILE==
WHILE is a ''conditional loop'', a block of code that will repeat itself whilst a given condition is true. Basically you can think of this as being an IF..ENDIF block that will run indefinately until the IF statement returns false.

'''ALWAYS AND ALWAYS:'''
# End WHILE blocks with ENDWHILE.
# Perform some action within the WHILE block that will change the outcome of the conditional statement.

For example:

<spherescript>[FUNCTION remove_all_mems]
WHILE (<FINDID.i_memory.UID>) // continue to loop whilst an i_memory item is found inside the object
FINDID.i_memory.REMOVE // remove a memory item
ENDWHILE</spherescript>

Whilst inside the loop, LOCAL._WHILE can be used to access the number of times that the script has looped so far. In some situations you may want to use this to impose a 'limit' on how many times your WHILE block can loop before it is forced to exit. An example of this could be:

<spherescript>[FUNCTION random_health]
WHILE (<HITS> > 10) && (<LOCAL._WHILE> < 20) // loop whilst the character has more than 10 health, but no more than 20 times
HITS = <R1,100> // set the character's health to a random value between 1 and 100
ENDWHILE</spherescript>

Since random numbers are.. random.. it is in theory possible that the health will never be set to a value less than or equal to 10. By checking LOCAL._WHILE inside the WHILE condition we add protection against the script looping indefinately and freezing the server.

==TRY==

===TRY===
TRY can be used to execute a line of script where the left hand side (i.e. a property being set or a function being called) is based on the value of an expression.

For example, we may have the following script:

<spherescript>LOCAL.TEST = 05
SRC.TAG0.MYTAG_<LOCAL.SOME> = 1234</spherescript>

Sphere will add a TAG named "MYTAG_<LOCAL.SOME>" with a value of "1234", when really we were hoping for "MYTAG_05". We can use TRY to accomplish this:

<spherescript>LOCAL.TEST = 05
TRY SRC.TAG0.MYTAG_<LOCAL.SOME> = 1234</spherescript>

This causes Sphere to evaluate the entire line first, as "<tt>SRC.TAG0.MYTAG_05 = 1234</tt>" and then run it, giving us the "MYTAG_05" TAG as we were after.

'''Note:''' Since 27-11-2006 the TRY function has become obsolete. Sphere will now always evaluate the entire line before executing it.

===TRYP===
This is the same as the TRY function, except that a PLEVEL parameter is also supplied. If SRC's PLEVEL is less than this value then the line will not be executed, for example:

<spherescript>TRYP 4 UID.<TAG.CHARUID>.NAME Yerk</spherescript>

The above line will not be executed if SRC's PLEVEL is less than 4, so it will not run for players but it will to GM and above. This is almost the same as writing:

<spherescript>IF (<SRC.ACCOUNT.PLEVEL> >= 4)
UID.<TAG.CHARUID>.NAME Yerk
ENDIF</spherescript>

However, with TRYP the line will also run if there is no SRC (in an @Timer trigger, for example). So a more accurate scripted equivalent would be:

<spherescript>IF !(<SRC>)
TRY UID.<TAG.CHARUID>.NAME Yerk
ELSEIF (<SRC.ACCOUNT.PLEVEL> >= 4)
TRY UID.<TAG.CHARUID>.NAME Yerk
ENDIF</spherescript>

===TRYSRC===
As already mentioned in a previous chapter, the TRYSRC function can be used to override the SRC object for a given line.

The syntax for this function is <tt>TRYSRC uid command</tt>, where <tt>uid</tt> is the UID of the character who you want to become SRC, and <tt>command</tt> is the command you want to execute.

<spherescript>ON=@Timer
// place 5000 gold coins in LINK's backpack
SERV.NEWITEM i_gold
NEW.AMOUNT = 5000
TRYSRC <LINK.UID> NEW.BOUNCE // the BOUNCE function places an item into SRC's backpack
RETURN 1</spherescript>

===TRYSRV===
TRYSRV is similar to the TRYSRC command except that rather than running a command with a specific character as SRC, the command is instead executed with SRC set to the SERV object.

This can be desirable in the following situations:
* Certain properties of accounts, such as passwords, are protected against being accessed unless SRC has a PLEVEL of 7 (owner). It would be incredibly dangerous and unwise to set a player's PLEVEL to 7, even temporarily, but the SERV object is always considered to have a PLEVEL of 7.
* Certain functions/commands behave differently with a character as SRC, for example:
** SERV.NEWNPC will automatically set the new NPC's position to beside the SRC character. By using <tt>TRYSRV SERV.NEWNPC</tt> you can avoid players seeing an NPC 'flicker' on and off their screen.

==SERV==

===CHARDEF===
Let's say you wanted to retrieve the DAM property from, say, a Liche. Because DAM isn't a character property, we can only get the property from the CHARDEF. (Technically, there is a DAM property for characters, but it is not what we're looking for.)

<spherescript>[FUNCTION f_return_char_prop]
LOCAL.DAM = <SERV.CHARDEF.<ARGS>.DAM></spherescript>

With the above example, Sphere will take the argument passed (ARGS), then try to store the DAM property from the corresponding CHARDEF into LOCAL.DAM.

Pretty simple, right?

===ITEMDEF===
This works similar to SERV.CHARDEF, only it works on ITEMDEFs. Let's say you wanted to get the SKILL property from a character's equipped weapon.

Here's an example:

<spherescript>[FUNCTION f_return_wep_skill]
LOCAL.WEP_SKILL = <SERV.ITEMDEF.<ARGS>.SKILL></spherescript>

That would store the SKILL property of whatever ITEMDEF passed (ARGS) into LOCAL.WEP_SKILL. And this can get much more complex. As an example, I recently wrote a script that does the following:
* Use QVAL to find the equipped weapon.
* Store the weapon found in REF1.
* Check to see if REF1 returned a weapon UID.
* Store the DAM property for the weapon in LOCAL.WEP_DAM.

<spherescript>[FUNCTION f_weapon_dam]
REF1 = <QVAL <FINDLAYER.1.UID> ? <FINDLAYER.1.UID> : <FINDLAYER.2.UID>>
IF (<REF1>) // REF1 is true; weapon found.
LOCAL.WEP_DAM = <SERV.ITEMDEF.<REF1.BASEID>.DAM>
ENDIF
RETURN <LOCAL.WEP_DAM></spherescript>

That's not too complex, is it?

===LOG===
This functions is very good if you want to see when a player makes something or say something or when want to know the result of formulas in your scripts. This, is for writing messages onto the console (and logs). It is really simple to use:

<spherescript>SERV.LOG Hi world</spherescript>

And when you look at console it shows something like:

<spherescript color="darkgreen">21:56:(YourScript.scp,2)Hi world</spherescript>

Easy and useful.

'''Note:''' If for some reason you don't want the script name to appear in the log, prefix your log message with the '@' character (prefix the message with two '@' characters (@@) if you actually want to start the message with the @ symbol.

===MAP===
The SERV.MAP function allows you to read the properties of a specific point on a map. There are two syntaxes that can be used:
# <tt><SERV.MAP(x,y,map)>.KEY</tt>
# <tt><SERV.MAP(x,y,z,map)>.KEY</tt>

You may notice a slight 'peculiarity' in these syntaxes and you should be aware of them so that they don't catch you out: When there are 3 parameters given, the third parameter is used as the map number to access. When 4 parameters are given, the third parameter is the height (Z) and the fourth becomes the map number.

The KEY can be a number of things:

{|
|-
| ISNEARTYPE type distance checkmulti || Returns 1 if an item exists near the point within <distance> tiles. If <checkmulti> is 1 then multi components will also be checked.
|-
| REGION || Access the REGION at the map point.
|-
| ROOM || Access the ROOM at the map point.
|-
| SECTOR || Access the SECTOR at the map point.
|-
| STATICS || The number of static items at the map point.
|-
| STATICS.n.ID || The ID of the nth static item at the map point (n starts at 0)
|-
| STATICS.n.COLOR || The COLOR of the nth static item at the map point (n starts at 0)
|-
| STATICS.n.Z || The Z level of the nth static item at the map point (n starts at 0)
|-
| STATICS.n.* || If the STATICS.n.KEY does not match any of the above properties, the value will be taken from the static's ITEMDEF in the scripts
|-
| TERRAIN || The ID of the terrain at the map point.
|-
| TYPE || The type of terrain at the map point.
|-
| X, Y, Z, M, MAP || Access the X/Y/Z/MAP values at the map point.
|-
| COMPONENTS || The number of components items at the map point.
|-
| COMPONENTS.n.ID || The ID of the nth component item at the map point (n starts at 0)
|-
| COMPONENTS.n.Z || The Z level of the nth component item at the map point (n starts at 0)
|}

===NEWDUPE===
When you use the <font color="darkred">.DUPE</font> command you can create a 'clone' of a targeted item. The NEWDUPE function allows this functionality to be reproduced within scripts.

The syntax of the function is <tt>NEWDUPE uid</tt>, where uid is the UID of the object you want to clone. After running this function, the SERV.NEW reference will be set to the newly cloned item. You should know that it creates the 'duped' item exactly on the same spot where the targeted item exists. So you may have to move it anywhere else or it will maybe crush your stack.

Here is an example, the script below will clone the character's weapon and place it in their backpack:

<spherescript>[FUNCTION f_dupeweapon]
IF (<WEAPON.UID>)
SERV.NEWDUPE <WEAPON>
BOUNCE <NEW.UID>
ENDIF</spherescript>

===NEWITEM===
This is an easy function, used to create items. Many of you learned in 55i tutorials the format of NEWITEM, well, this changed on 56b and this is mainly to explain that change.

Now, you can't use this function on some player, you have to create it on SERV. Also, the reference to the new item isn't SRC.ACT anymore. It changed to NEW, so, if i want to create an item with the color 9, it will look like this:

<spherescript>SERV.NEWITEM i_example
NEW.COLOR 9</spherescript>

As you can see, it is really easy to use. There are also additional parameters that can be optionally passed into NEWITEM:

<tt>NEWITEM id, amount, cont, triggerEquip</tt>

So if I want to create 3 i_test in SRC's backpack I should do:

<spherescript>SERV.NEWITEM i_test, 3, <SRC.FINDLAYER.21.UID>,1</spherescript>

Easy, uh?

===NEWNPC===
This function can be used to create NPCs in the world. The syntax is <tt>NEWNPC id</tt>, where <tt>id</tt> is the BASEID of the character you wish to create. The newly created character can be accessed via the NEW reference.

The following function creates a headless and moves it to within 10 tiles of the default object.

<spherescript>[FUNCTION f_createnpc]
SERV.NEWNPC c_headless
NEW.MOVENEAR <UID> 10</spherescript>

'''Note''' It is also possible to create player characters this way, by setting the ACCOUNT property after creating the new character.

===NEWSUMMON===
This function similar to NEWNPC but is specific to summons. This will allow you to create a new summoned creature for a specific time.

<spherescript>
[FUNCTION f_createsummon]
SERV.NEWSUMMON=c_ogre,15
NEW.P=<p>
</spherescript>

This example will summon and Ogre for 15 seconds at your current location.

===SKILL===
Well, this is an easy function, like the others. This one refers to the SKILL section.

You can see the skill properties in sphere_skills.scp. I'll explain how it works:

<spherescript>LOCAL.SKILL = <SERV.SKILL.<ACTION>.KEY></spherescript>

With that line you get the Skill Key (Alchemy, ex.).

There are 3 ways to use SERV.SKILL: Key, Defname, Number.

Any of them are accepted, and if you see, in most of the cases people use Action to get the Key and get the player skill amount.

You can find many uses for it, all you need is some imagination.

[[Category:Tutorials]]

ITEMDEF

2023-01-16T13:56:48Z

Jhobean:

{{Languages|ITEMDEF}}

__FORCETOC__

An ITEMDEF block defines the basic properties of an [[Items|item]].

==Properties==
Here is a list of all item definition properties.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.
|-
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.
|-
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.
|-
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.
|-
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.
|-
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.
|-
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.
|-
| [[BONUSSTR]] | [[BONUSDEX]] | [[BONUSINT]] | [[BONUSHITS]] | [[BONUSSTAM]] | [[BONUSMANA]] | [[BONUSSKILLx]] | [[BONUSSKILLxAMT]] (X branch only) || RW || Increases (or decreases) the applicable Stat. Positive or negative integer.
For BonusSkill, x is a sequential number(1-4) and must assign a skill. Ex:bonusskill1=bowcraft and BonusSkillxAMT is the amount
|-
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.
|-
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.
|-
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.
|-
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.
|-
| [[DEFNAME]] || RW || Gets or sets defname of the item
|-
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.
|-
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).
|-
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.
|-
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).
|-
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.
|-
| [[HEIGHT]] || RW || Gets or sets the height of the item.
|-
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.
|-
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.
|-
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.
|-
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.
|-
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).
|-
| [[NAME]] || RW || Gets or sets the name of the item.
|-
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.
|-
| [[RANGEH]] || R || Gets the maximum range of the weapon.
|-
| [[RANGEL]] || R || Gets the minimum range of the weapon.
|-
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).
|-
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.
|-
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.
|-
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.
|-
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.
|-
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.
|-
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.
|-
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.
|-
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)
|-
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)
|-
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.
|-
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.
|-
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.
|-
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.
|-
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.
|-
| [[SPEED]] || RW || Gets or sets the speed of the weapon.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.
|-
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.
|-
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.
|-
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.
|-
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.
|-
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.
|-
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)
|-
| [[TYPE]] || RW || Gets or sets the item's type.
|-
| [[VALUE]] || RW || Gets or sets the base value of the item.
|-
| [[WEIGHT]] || RW || Gets or sets the weight of the item.
|-
| [[WEIGHTREDUCTION]] || RW || Gets or sets the percent of weight reduction of the item.
|}

==Multi Definitions==
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.

===Properties===
Here is a list of all multi definition properties.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''
|-
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.
|-
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)
|-
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.
|-
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)
|-
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)
|-
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).
|-
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.
|-
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)
|-
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)
|-
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)
|-
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.
|}

'''&dagger;''' Some ITEMDEF properties can be overridden by using [[Override_TAGs]]. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.

==Examples==
<spherescript>//
// Blue Gold
//
[ITEMDEF i_gold_blue]
ID=i_gold // inherits from i_gold
NAME=Blue Gold // named Blue Gold
TYPE=t_gold // is type t_gold
VALUE=10 // valued at gold

ON=@Create
COLOR = colors_blue

//
// Small Stone and Plaster House (from default script pack)
//
[ITEMDEF 04064] // item ID 0x4064 (in mul files)
DEFNAME=i_multi_house_stone_plaster_small
NAME=Small Stone and Plaster House
TYPE=t_multi
VALUE=43800 // valued at 43800 gold
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript>

[[Category: Reference Compendium]]
[[Category: Definitions]]

ITEMDEF

2023-01-16T13:53:13Z

Jhobean:

{{Languages|ITEMDEF}}

__FORCETOC__

An ITEMDEF block defines the basic properties of an [[Items|item]].

==Properties==
Here is a list of all item definition properties.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.
|-
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.
|-
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.
|-
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.
|-
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.
|-
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.
|-
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.
|-
| [[BONUSSTR]] | [[BONUSDEX]] | [[BONUSINT]] | [[BONUSHITS]] | [[BONUSSTAM]] | [[BONUSMANA]] | [[BONUSSKILLx]] | [[BONUSSKILLxAMT]] (X branch only) || RW || Increases (or decreases) the applicable Stat. Positive or negative integer.
For BonusSkill, x is a sequential number(1-4) and must assign a skill. Ex:bonusskill1=bowcraft and BonusSkillxAMT is the amount
|-
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.
|-
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.
|-
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.
|-
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.
|-
| [[DEFNAME]] || RW || Gets or sets defname of the item
|-
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.
|-
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).
|-
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.
|-
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).
|-
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.
|-
| [[HEIGHT]] || RW || Gets or sets the height of the item.
|-
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.
|-
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.
|-
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.
|-
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.
|-
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).
|-
| [[NAME]] || RW || Gets or sets the name of the item.
|-
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.
|-
| [[RANGEH]] || R || Gets the maximum range of the weapon.
|-
| [[RANGEL]] || R || Gets the minimum range of the weapon.
|-
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).
|-
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.
|-
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.
|-
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.
|-
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.
|-
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.
|-
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.
|-
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.
|-
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)
|-
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)
|-
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.
|-
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.
|-
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.
|-
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.
|-
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.
|-
| [[SPEED]] || RW || Gets or sets the speed of the weapon.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.
|-
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.
|-
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.
|-
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.
|-
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.
|-
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.
|-
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)
|-
| [[TYPE]] || RW || Gets or sets the item's type.
|-
| [[VALUE]] || RW || Gets or sets the base value of the item.
|-
| [[WEIGHT]] || RW || Gets or sets the weight of the item.
|-
| [[WEIGHTREDUCTION]] || RW || Gets or sets the percent of weight reduction of the item.
|}

==Multi Definitions==
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.

===Properties===
Here is a list of all multi definition properties.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''
|-
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.
|-
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)
|-
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.
|-
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)
|-
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)
|-
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).
|-
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.
|-
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)
|-
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)
|-
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)
|-
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.
|}

'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.

==Examples==
<spherescript>//
// Blue Gold
//
[ITEMDEF i_gold_blue]
ID=i_gold // inherits from i_gold
NAME=Blue Gold // named Blue Gold
TYPE=t_gold // is type t_gold
VALUE=10 // valued at gold

ON=@Create
COLOR = colors_blue

//
// Small Stone and Plaster House (from default script pack)
//
[ITEMDEF 04064] // item ID 0x4064 (in mul files)
DEFNAME=i_multi_house_stone_plaster_small
NAME=Small Stone and Plaster House
TYPE=t_multi
VALUE=43800 // valued at 43800 gold
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript>

[[Category: Reference Compendium]]
[[Category: Definitions]]

ITEMDEF

2023-01-16T13:52:03Z

Jhobean:

{{Languages|ITEMDEF}}

__FORCETOC__

An ITEMDEF block defines the basic properties of an [[Items|item]].

==Properties==
Here is a list of all item definition properties.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.
|-
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.
|-
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.
|-
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.
|-
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.
|-
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.
|-
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.
|-
| [[BONUSSTR]] | [[BONUSDEX]] | [[BONUSINT]] | [[BONUSHITS]] | [[BONUSSTAM]] | [[BONUSMANA]] | [[BONUSSKILLx]] | [[BONUSSKILLxAMT]] (X branch only) || RW || Increases (or decreases) the applicable Stat. Positive or negative integer.
For BonusSkill, x is a sequential numbert(1-4) and assignt a skill. Ex:bonusskill1=bowcraft and BonusSkillxAMT is the amount
|-
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.
|-
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.
|-
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.
|-
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.
|-
| [[DEFNAME]] || RW || Gets or sets defname of the item
|-
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.
|-
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).
|-
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.
|-
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).
|-
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.
|-
| [[HEIGHT]] || RW || Gets or sets the height of the item.
|-
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.
|-
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.
|-
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.
|-
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.
|-
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).
|-
| [[NAME]] || RW || Gets or sets the name of the item.
|-
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.
|-
| [[RANGEH]] || R || Gets the maximum range of the weapon.
|-
| [[RANGEL]] || R || Gets the minimum range of the weapon.
|-
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).
|-
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.
|-
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.
|-
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.
|-
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.
|-
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.
|-
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.
|-
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.
|-
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)
|-
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)
|-
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.
|-
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.
|-
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.
|-
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.
|-
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.
|-
| [[SPEED]] || RW || Gets or sets the speed of the weapon.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.
|-
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.
|-
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.
|-
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.
|-
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.
|-
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.
|-
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)
|-
| [[TYPE]] || RW || Gets or sets the item's type.
|-
| [[VALUE]] || RW || Gets or sets the base value of the item.
|-
| [[WEIGHT]] || RW || Gets or sets the weight of the item.
|-
| [[WEIGHTREDUCTION]] || RW || Gets or sets the percent of weight reduction of the item.
|}

==Multi Definitions==
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.

===Properties===
Here is a list of all multi definition properties.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''
|-
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.
|-
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)
|-
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.
|-
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)
|-
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)
|-
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).
|-
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.
|-
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)
|-
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)
|-
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)
|-
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.
|}

'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.

==Examples==
<spherescript>//
// Blue Gold
//
[ITEMDEF i_gold_blue]
ID=i_gold // inherits from i_gold
NAME=Blue Gold // named Blue Gold
TYPE=t_gold // is type t_gold
VALUE=10 // valued at gold

ON=@Create
COLOR = colors_blue

//
// Small Stone and Plaster House (from default script pack)
//
[ITEMDEF 04064] // item ID 0x4064 (in mul files)
DEFNAME=i_multi_house_stone_plaster_small
NAME=Small Stone and Plaster House
TYPE=t_multi
VALUE=43800 // valued at 43800 gold
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript>

[[Category: Reference Compendium]]
[[Category: Definitions]]

Main Page

2023-01-15T19:04:22Z

Jhobean: CHange changelog link

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Starting with SphereServer'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Setup of Sphere'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Sphere 101'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''Extra Tutorials'''
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''
* [[Bitwise Operations]] ''(How to work with FLAGS/ATTR)''
* [[Script Debugging]] ''(How to fix your scripts)''
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
'''IMPORTANT LINKS'''
</div>
<div style="padding:0px 0px 5px 10px;">
* [https://github.com/Sphereserver SphereServer Official Github]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Download Nightly Builds] ''(Plus! Extra downloads, like tools and scripts!)''
* [https://github.com/Sphereserver/Source-X/blob/master/Changelog.txt SphereX Changelog] | [https://github.com/Sphereserver/Source/blob/master/changelog.txt 56d Changelog]
* [https://discord.gg/BZj2fEA Join us at Discord] ''(We will solve most of your doubts over there)''
</div>
</div>
</div>
.

<div style="background-color:#a7bcdc; color:#000; min-width:650px; padding:1px; text-align:center; width:100%;">
'''Reference Compendium'''
</div>
<div style="min-width:650px; width:100%;">
<div style="border-right:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:33%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Definitions|'''Definitions''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[CHARDEF|Characters]]
* [[DIALOG|Dialogs]]
* [[EVENTS|Events]]
* [[ITEMDEF|Items]]
* [[MENU|Menus]]
* [[REGIONRESOURCE|Region Resources]]
* [[REGIONTYPE|Region Types]]
* [[AREADEF|Regions]]
* [[ROOMDEF|Rooms]]
* [[SKILLCLASS|Skill Classes]]
* [[SKILLMENU|Skill Menus]]
* [[SKILL|Skills]]
* [[SPAWN|Spawn Groups]]
* [[SPELL|Spells]]
* [[TYPEDEF|Types]]
</div>
</div>
<div style="border-left:1px solid #a7bcdc; float:left; height:100%; margin-right:-1px; width:67%;">
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Objects|'''Objects''']]
</div>
<div style="border-bottom:1px solid #a7bcdc; padding:0px 0px 5px 10px;">
* [[Accounts]]
* [[Characters]]
* [[Database]]
* [[Files]]
* [[GM Pages]]
* [[Items]]
** ''[[Special Items]]''
* [[Map Points]]
* [[Parties]]
* [[Regions]]
* [[Rooms]]
* [[Sectors]]
* [[Server]]
</div>
<div style="border-bottom:1px solid #a7bcdc; color:#a7bcdc; font-size:18px; padding-left:10px;">
[[:Category:Scripts|'''Scripts''']]
</div>
<div style="padding:0px 0px 5px 10px;">
* [[:Category:Functions|Functions and Triggers]]
* [[:Category:Variables|General Functions, Properties and References]]
* [[Intrinsic Functions]]
* [[:Category:Statements|Statements]]
* [[:Category:Triggers|Triggers]]
</div>
</div>
.
----

.
==Sphere 3rd Party Tools==
* [http://forum.spherecommunity.net/sshare.php?srt=4&uid=603 Axis II] - GM Tool for Sphere that will allow you to place objects in-game, spawns, traveling and many other useful functions for shard admins and GMs.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=3 vSCP] - vSCP is the most complete and up-to-date syntax editor for sphere scripting. It does contain syntax highlighting, autocomplete, folding markers to specify blocks of code that can expand or collapse, bookmarks, autoindent, find/replace/gotoline, help guide for all the sphere elements added to your code, and more!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=2 vServerLauncher] - Install and run the latest build of sphereserver in a few clicks with vServerLauncher. It's pretty quick and simple!
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=5 SphereService] - Relaunch SphereSvr.exe everytime it closes/crashes. Automatically runs at windows startup and works in a silent mode minimized to Tray.
* [http://forum.spherecommunity.net/sshare.php?srt=4&prj=4 vCrypter] - Type the client version and the tool will calculate the correct UO login keys for classic or enhanced clients.

==Other Articles==

* [[Armor Calculation]]
* [[Client Changes]]
* [[Common Scripting Misconceptions]]
* [[Custom Object Properties]]
* [[Error Codes]]
* [[Experience System]]
* [[How Combat Works]]
* [[Occam's Razor]]
* [[Optimization|Optimization Theory]]
* [[Override TAGs]]
* [[Revisions Changelog]]
* [[Sendpacket]]
* [[Skill Gain Theory]]
* [[The Process of Scripting]]
* [[Building Component Reference]]

==Credits==

'''Special thanks to:'''

[[WhoIsWho|XuN, Nolok, Ben, and Drk]], for their hard work on the X branch taking Sphere into the next decade.

[[WhoIsWho|Ben, Cloud_Br, Ellessar, Jdog, Lord Zerofiz, Mordaunt, Nazghul-ll, RanXerox, Rattlehead, Sandman, Sharlenwar, ShiryuX, thelegbra, Maximus, WarAngel and Valios]], for helping to add content.

[[WhoIsWho|Daleth]], for writing the Sphere Reference Project, and [[WhoIsWho|Mordaunt]] for converting it to .chm format.

[[WhoIsWho|Tracker]], for writing the Sphere 56 Tracking Changes in Sphereserver.net

[[WhoIsWho|Taran]], for writing the original and now famous Sphere Scripting for Dummies tutorials, and [[WhoIsWho|MrSugarCube]] for bringing it up-to-date directly from source.

[[WhoIsWho|Ben, Khaos, Ranxerox, Shiryux, Furio, Radiant, Vjaka, Nazghul-ll, Ellessar, Torfo, Shadow Dragon, MrSugarCube and coruja747]] for continuing to develop Sphere into a powerful and very customizable Ultima Online emulator.

[[WhoIsWho|Crius]], for providing hosting for the original SphereWiki, and [[WhoIsWho|Torfo]] for providing the current hosting.

==External Links==

* [[Useful Links]] ''(An ongoing list of useful links for community members)''
* [http://www.spherecommunity.net/ Official SphereServer Website]
* [https://forum.spherecommunity.net/sshare.php?srt=4 Nightly builds]
* [http://nightly.prerelease.sphere.torfo.org/ Nightly builds - OUTDATED, use the link above]
* [http://spherepack.codeplex.com/ Sphere Community Pack 2.0]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]

Script Pack

2022-11-03T00:25:52Z

Jhobean:

Script pack for Sphere X version (recommended) [https://github.com/Sphereserver/Scripts-X Github] [https://github.com/Sphereserver/Scripts-X/archive/refs/heads/main.zip File]

Script pack for Sphere 56d version [https://github.com/Sphereserver/Scripts Github] [https://github.com/Sphereserver/Scripts/archive/refs/heads/master.zip File]

Script Pack

2022-11-03T00:24:40Z

Jhobean:

Script pack for Sphere X version [https://github.com/Sphereserver/Scripts-X Github] [https://github.com/Sphereserver/Scripts-X/archive/refs/heads/main.zip File]

Special Items

2022-05-07T23:07:49Z

Jhobean:

{{Languages|Special_Items}}

Certain types of items have extended functionality, and therefore have additional properties, functions or references to the ones already listed on the [[Items]] page. The following sections describe what these are.

==Multis==
Multis have a TYPE t_multi, t_multi_custom or t_ship. These are multi-piece items that are usually stored in the client's multi.mul file, but are only considered to be one item to both the server and client (so when you approach a castle, there is a significant reduction in lag since the server doesn't have to tell the client to display thousands of wall pieces).

===Properties and Functions===
Here is a list of all multi properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[COMP]] || R || Gets the number of components defined in the [[ITEMDEF]].
|-
| [[COMP]]''.n.key''' || R || Gets the KEY (ID,DX,DY,DZ,D) of the nth component defined in the [[ITEMDEF]].
|-
| [[MULTICREATE]] ''owner_uid'' || W || When a multi is created via SERV.[[NEWITEM]], this function must be used to initialise the multi-region.
|}

==Customizable Multis==
Customizable multis are represented by the TYPE of t_multi_custom. These are designed to be used with the AOS House Designer tool that is present since the 4.0.0 series of UO clients.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[DESIGNER]] || R || Gets the [[Characters|character]] currently modifying the house design.
|}

===Properties and Functions===
Here is a list of all custom multi properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ADDITEM]] ''item_id, dx, dy, dz'' || W || Adds an item to the house design.
|-
| [[ADDMULTI]] ''multi_id, dx, dy, dz'' || W || Adds a multi to the house design.
|-
| [[CLEAR]] || W || Removes all items from the house design.
|-
| [[COMMIT]] || W || Commits all changes that have been made to the house design, updating the state of the building.
|-
| [[COMPONENTS]] || R || Gets the number of components in the house design.
|-
| [[CUSTOMIZE]] ''character_uid'' || W || Enters the building into edit mode for the specified character (or SRC).
|-
| [[DESIGN]]''.n.KEY'' || R || Gets a property (ID,DX,DY,DZ,D,FIXTURE) from the nth component in the house design.
|-
| [[EDITAREA]] || R || Gets the designable area rectangle of the multi (left,top,right,bottom)
|-
| [[ENDCUSTOMIZE]] || W || Exits the current designer from edit mode.
|-
| [[FIXTURES]] || R || Gets the number of fixtures in the house design.
|-
| [[REMOVEITEM]] ''item_id, dx, dy, dz'' || W || Removes an item from the house design.
|-
| [[RESET]] || W || Resets the house design back to the house foundation.
|-
| [[RESYNC]] ''character_uid'' || W || Resends the current building state to the specified character (or SRC).
|-
| [[REVERT]] || W || Undoes all of the changes made to the house design since the last commit.
|-
| [[REVISION]] || R || Gets the revision number of the house design.
|}

==Ships==
Ships have the TYPE t_ship, and are another extended version of multis that are designed to be used to sail around the world.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[HATCH]] || R || Gets the ship's [[Items|hatch]].
|-
| [[TILLER]] || R || Gets the ship's [[Items|tiller]].
|-
| [[PLANK]]''.n'' || R || Gets the nth ship [[Items|plank]]. (zero-based)
|}

===Properties and Functions===
Here is a list of all ship properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PLANKS]] || R || Gets the number of planks on the ship.
|-
| [[SHIPANCHORDROP]] || W || Drops the ship's anchor, preventing it from moving.
|-
| [[SHIPANCHORRAISE]] || W || Raises the ship's anchor, allowing it to move.
|-
| [[SHIPBACK]] || W || Begins moving the ship backwards.
|-
| [[SHIPBACKLEFT]] || W || Begins moving the ship backwards and to its left.
|-
| [[SHIPBACKRIGHT]] || W || Begins moving the ship backwards and to its right.
|-
| [[SHIPDOWN]] || W || Begins moving the ship downards, if ATTR_MAGIC is set.
|-
| [[SHIPDRIFTLEFT]] || W || Begins moving the ship to its left.
|-
| [[SHIPDRIFTRIGHT]] || W || Begins moving the ship to its right.
|-
| [[SHIPFACE]] ''direction'' || W || Sets the direction of the ship.
|-
| [[SHIPFORE]] || W || Begins moving the ship forwards.
|-
| [[SHIPFORELEFT]] || W || Begins moving the ship forwards and to its left.
|-
| [[SHIPFORERIGHT]] || W || Begins moving the ship forwards and to its right.
|-
| [[SHIPGATE]] ''location'' || W || Moves the entire ship and its contents to a specified location.
|-
| [[SHIPLAND]] || W || Moves the ship to ground level, if ATTR_MAGIC is set.
|-
| [[SHIPMOVE]] ''direction'' || W || Begins moving the ship in the specified direction.
|-
| [[SHIPSPEED]].TILES || R || Gets the number of tiles that ths ship moves in one step.
|-
| [[SHIPSPEED]].PERIOD || R || Gets the length of time between each step, in tenths of a second.
|-
| [[SHIPSTOP]] || W || Stops the ship.
|-
| [[SHIPTURN]] || W || Turns the ship to face the opposite direction.
|-
| [[SHIPTURNLEFT]] || W || Rotates the ship to its left.
|-
| [[SHIPTURNRIGHT]] || W || Rotates the ship to its right.
|-
| [[SHIPUP]] || W || Begins moving the ship upwards, if ATTR_MAGIC is set.
|}

==Maps==
The TYPEs t_map and t_map_blank are used to represent maps. These display a map to the player when used, that can be marked with a series of pins (markers) to plot a route.

===Properties and Functions===
Here is a list of all map properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PIN]]''.n'' <br /> [[PIN]] ''x, y'' || RW || Gets the position of the ''nth'' pin (zero-based), or adds a pin to the map at the specified location.
|-
| [[MORE1H]],[[MORE1L]] || RW || Gets the top left coordinates (x,y) of the area displayed on t_map.
|-
| [[MORE2H]],[[MORE2L]] || RW || Gets the bottom right coordinates (x,y) of the area displayed on t_map.
|}

==Messages / Books==
Messages (t_message) and books (t_book) possess a range of properties and functions that are used to store their title, author and body text.

===Properties and Functions===
Here is a list of all message properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AUTHOR]] || RW || Gets or sets the author of the message.
|-
| [[BODY]]''.n'' || RW || Gets the nth line of text from the message, or appends a new line of text to the message.
|-
| [[ERASE]] ''page_num'' || W || Removes all lines of text from the message, or if a page number (one-based) if supplied erases just a single line.
|-
| [[PAGE]]''.n'' || W || Sets the text of the nth single line of the message. (zero-based)
|-
| [[PAGES]] || R || Gets the number of lines of text in the message.
|-
| [[TITLE]] || RW || Gets or sets the title of message.
|}

==Communication Crystals==
Communication crystals have the TYPE of t_comm_crystal.

===Properties and Functions===
Here is a list of all communication crystal properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[SPEECH]] ''-/+speech_defname'' || RW || Gets a list of attached SPEECH blocks, or adds to or removes from the attached speech..
|}

==Guild/Town Stones==
Guild and Town stones are defined by the types t_stone_guild and t_stone_town. Whilst a lot of functionality has been moved into the script pack, there are still some special properties, functions and references that can be used.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GUILD]]''.n || R || Gets the nth linked [[#Guild.2FTown_Members|guild or town]]. (zero-based)
|-
| [[GUILDFROMUID]]''stone_uid || R || Gets the linked [[#Guild.2FTown_Members|guild or town]] with a specified UID.
|-
| [[MEMBER]]''.n || R || Gets the nth member of the [[#Guild.2FTown_Members|guild or town]]. (zero-based)
|-
| [[MEMBERFROMUID]].''character_uid || R || Gets the [[#Guild.2FTown_Members|member]] of the guild with a specified UID.
|}

===Properties and Functions===
Here is a list of all guild/town stone properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ABBREV]] || RW || Gets or sets the guild/town abbreviation.
|-
| [[ABBREVIATIONTOGGLE]] || R || Returns one of the ''STONECONFIG_VARIOUSNAME_*'' defnames depending on whether SRC has their abbreviation showing or not.
|-
| [[ALIGN]] || RW || Gets or sets the alignment of the guild/town.
|-
| [[ALIGNTYPE]] || R || Returns the name of the guild or town's alignment.
|-
| [[ALLGUILDS]] ''flags, command'' || W || Performs the given comamnd on all linked guilds or towns based on flags. (0 = All, 1 = War Declared by 'Us' only, 2 = War Declared by 'Them' only, 3 = War Declayed by both)
|-
| [[ALLMEMBERS]] ''priv, command'' || W || Performs the given command on all guild or town members with the specified privelege level. (-1 = All)
|-
| [[APPLYTOJOIN]] ''character_uid'' || W || Adds a character as a candidate to the guild or town.
|-
| [[CHANGEALIGN]] ''alignment'' || W || Changes the guild or town alignment.
|-
| [[DECLAREPEACE]] ''stone_uid'' || W || Declares peace towards another guild or town.
|-
| [[DECLAREWAR]] ''stone_uid'' || W || Declares war towards another guild or town.
|-
| [[ELECTMASTER]] || W || Selects a new guild or town master based on which member has the most votes.
|-
| [[GUILD]].COUNT || R || Gets the number linked guilds or towns.
|-
| [[INVITEWAR]] ''stone_uid, who_declared'' || W || Invites another guild or town to go to war (''who_declared'', 0 = They declared, 1 = We declared)
|-
| [[JOINASMEMBER]] ''character_uid'' || W || Adds a character as a full member of the guild or town.
|-
| [[LOYALTO]] || R || Returns the name of the guild or town member that SRC has declared fealty to.
|-
| [[MASTER]] || R || Returns the name of the guild or town master.
|-
| [[MASTERGENDERTITLE]] || R || Returns the gender of the guild or town mastser.
|-
| [[MASTERTITLE]] || R || Returns the title of the guild or town master.
|-
| [[MASTERUID]] || RW || Gets the UID of the guild/town master, or sets it to the UID of a new master.
|-
| [[MEMBER]].COUNT ''priv'' || R || Gets the number of members in the guild/town with at least the given privileges (or all if not supplied).
|-
| [[RESIGN]] ''character_uid'' || W || Removes a character from the guild or town.
|-
| [[TOGGLEABBREVIATION]] ''character_uid'' || W || Toggles the display of guild/town abbreviation for a member or SRC.
|-
| [[WEBPAGE]] || RW || Gets or sets the guild or town's webpage.
|-
| [[CHARTER]]''.n'' || EW || Gets or sets the nth line of the guild/town charter. (zero-based)
|}

==Guild/Town Members==
When accessing a member of a guild or town via the [[MEMBER]].x,r [[MEMBERFROMUID]].uid, [[GUILD]].x, or [[GUILDFROMUID]].uid references, you access a special "Guild/Town Member" object which has specific properties, references and functions available. If you attempt to access something that doesn't exist in any of the following tables then the command is 'redirected' to the actual character or item the member object is linked to (so something like ''<MEMBER.x.STR>'' would work because the STR property exists on the [[Characters|character]]).

===Properties and Functions===
Here is a list of all guild/town member properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

====Character Members====

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACCOUNTGOLD]] || RW || Gets or sets the amount of gold the member has in their guild/town account.
|-
| [[ISCANDIDATE]] || R || Returns 1 if the member is a candidate of the guild/town.
|-
| [[ISMASTER]] || R || Returns 1 if the member is a guild/town master.
|-
| [[LOYALTO]] || RW || Gets or sets the UID of who the member has declared fealty towards.
|-
| [[PRIV]] || RW || Gets or sets the member's privilege level within the guild/town.
|-
| [[PRIVNAME]] || R || Returns the name of the member's privilege level within the guild/town.
|-
| [[TITLE]] || RW || Gets or sets the member's title within the guild/town.
|-
| [[SHOWABBREV]] || RW || Gets or sets whether or not the member's abbreviation is shown.
|}

====Item Members====

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ISENEMY]] || R || Returns 1 if the other guild/town is considered an enemy.
|-
| [[THEYALLIANCE]] || RW || Gets or sets whether or not the other guild/town has declared an alliance with the guild/town.
|-
| [[THEYWAR]] || RW || Gets or sets whether or not the other guild/town has declared war.
|-
| [[WEALLIANCE]] || RW || Gets or sets whether or not the guild/town has declared an alliance with the other guild/town.
|-
| [[WEWAR]] || RW || Gets or sets whether or not the guild/town has declared war with the other guild/town.
|}

==Containers==
Container items (backpacks, bankboxes, bags, etc) can be used to hold other items. These items have the [[TYPE]] of t_container.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] from inside the container. (zero-based)
|-
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found inside the container with the matching [[BASEID]].
|-
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found inside the container with the matching [[TYPE]].
|}

===Properties and Functions===
Here is a list of all custom multi properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[COUNT]] || R || Returns the number of items inside the container.
|-
| [[DELETE]] ''nth'' || W || Deletes the nth item from inside the container. (1-based)
|-
| [[EMPTY]] || W || Deletes all items inside the container.
|-
| [[FCOUNT]] || R || Returns the total number of items inside the container, including subcontainers.
|-
| [[FIXWEIGHT]] || W || Recalculates the total weight of the container and its contained items.
|-
| [[OPEN]] || W || Opens the container, for SRC to view its contents.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item inside the container, including subcontainers.
|-
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found inside the container, including subcontainers.
|}

==Vendable Items==
When an item has value, either explicitly in the ITEMDEF's [[VALUE]] property or implicity in the ITEMDEF's [[RESOURCES]] property, it is considered a "Vendable Item" that can be sold on vendors.

===Properties and Functions===
Here is a list of all vendable item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PRICE]] || RW || Gets or sets the price of the item. (affect only the sell/buy price on player vendor. NPC use the value)
|-
| [[QUALITY]] || RW || Gets or sets the quality of the item.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

Special Items

2022-05-07T23:06:47Z

Jhobean:

{{Languages|Special_Items}}

Certain types of items have extended functionality, and therefore have additional properties, functions or references to the ones already listed on the [[Items]] page. The following sections describe what these are.

==Multis==
Multis have a TYPE t_multi, t_multi_custom or t_ship. These are multi-piece items that are usually stored in the client's multi.mul file, but are only considered to be one item to both the server and client (so when you approach a castle, there is a significant reduction in lag since the server doesn't have to tell the client to display thousands of wall pieces).

===Properties and Functions===
Here is a list of all multi properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[COMP]] || R || Gets the number of components defined in the [[ITEMDEF]].
|-
| [[COMP]]''.n.key''' || R || Gets the KEY (ID,DX,DY,DZ,D) of the nth component defined in the [[ITEMDEF]].
|-
| [[MULTICREATE]] ''owner_uid'' || W || When a multi is created via SERV.[[NEWITEM]], this function must be used to initialise the multi-region.
|}

==Customizable Multis==
Customizable multis are represented by the TYPE of t_multi_custom. These are designed to be used with the AOS House Designer tool that is present since the 4.0.0 series of UO clients.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[DESIGNER]] || R || Gets the [[Characters|character]] currently modifying the house design.
|}

===Properties and Functions===
Here is a list of all custom multi properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ADDITEM]] ''item_id, dx, dy, dz'' || W || Adds an item to the house design.
|-
| [[ADDMULTI]] ''multi_id, dx, dy, dz'' || W || Adds a multi to the house design.
|-
| [[CLEAR]] || W || Removes all items from the house design.
|-
| [[COMMIT]] || W || Commits all changes that have been made to the house design, updating the state of the building.
|-
| [[COMPONENTS]] || R || Gets the number of components in the house design.
|-
| [[CUSTOMIZE]] ''character_uid'' || W || Enters the building into edit mode for the specified character (or SRC).
|-
| [[DESIGN]]''.n.KEY'' || R || Gets a property (ID,DX,DY,DZ,D,FIXTURE) from the nth component in the house design.
|-
| [[EDITAREA]] || R || Gets the designable area rectangle of the multi (left,top,right,bottom)
|-
| [[ENDCUSTOMIZE]] || W || Exits the current designer from edit mode.
|-
| [[FIXTURES]] || R || Gets the number of fixtures in the house design.
|-
| [[REMOVEITEM]] ''item_id, dx, dy, dz'' || W || Removes an item from the house design.
|-
| [[RESET]] || W || Resets the house design back to the house foundation.
|-
| [[RESYNC]] ''character_uid'' || W || Resends the current building state to the specified character (or SRC).
|-
| [[REVERT]] || W || Undoes all of the changes made to the house design since the last commit.
|-
| [[REVISION]] || R || Gets the revision number of the house design.
|}

==Ships==
Ships have the TYPE t_ship, and are another extended version of multis that are designed to be used to sail around the world.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[HATCH]] || R || Gets the ship's [[Items|hatch]].
|-
| [[TILLER]] || R || Gets the ship's [[Items|tiller]].
|-
| [[PLANK]]''.n'' || R || Gets the nth ship [[Items|plank]]. (zero-based)
|}

===Properties and Functions===
Here is a list of all ship properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PLANKS]] || R || Gets the number of planks on the ship.
|-
| [[SHIPANCHORDROP]] || W || Drops the ship's anchor, preventing it from moving.
|-
| [[SHIPANCHORRAISE]] || W || Raises the ship's anchor, allowing it to move.
|-
| [[SHIPBACK]] || W || Begins moving the ship backwards.
|-
| [[SHIPBACKLEFT]] || W || Begins moving the ship backwards and to its left.
|-
| [[SHIPBACKRIGHT]] || W || Begins moving the ship backwards and to its right.
|-
| [[SHIPDOWN]] || W || Begins moving the ship downards, if ATTR_MAGIC is set.
|-
| [[SHIPDRIFTLEFT]] || W || Begins moving the ship to its left.
|-
| [[SHIPDRIFTRIGHT]] || W || Begins moving the ship to its right.
|-
| [[SHIPFACE]] ''direction'' || W || Sets the direction of the ship.
|-
| [[SHIPFORE]] || W || Begins moving the ship forwards.
|-
| [[SHIPFORELEFT]] || W || Begins moving the ship forwards and to its left.
|-
| [[SHIPFORERIGHT]] || W || Begins moving the ship forwards and to its right.
|-
| [[SHIPGATE]] ''location'' || W || Moves the entire ship and its contents to a specified location.
|-
| [[SHIPLAND]] || W || Moves the ship to ground level, if ATTR_MAGIC is set.
|-
| [[SHIPMOVE]] ''direction'' || W || Begins moving the ship in the specified direction.
|-
| [[SHIPSPEED]].TILES || R || Gets the number of tiles that ths ship moves in one step.
|-
| [[SHIPSPEED]].PERIOD || R || Gets the length of time between each step, in tenths of a second.
|-
| [[SHIPSTOP]] || W || Stops the ship.
|-
| [[SHIPTURN]] || W || Turns the ship to face the opposite direction.
|-
| [[SHIPTURNLEFT]] || W || Rotates the ship to its left.
|-
| [[SHIPTURNRIGHT]] || W || Rotates the ship to its right.
|-
| [[SHIPUP]] || W || Begins moving the ship upwards, if ATTR_MAGIC is set.
|}

==Maps==
The TYPEs t_map and t_map_blank are used to represent maps. These display a map to the player when used, that can be marked with a series of pins (markers) to plot a route.

===Properties and Functions===
Here is a list of all map properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PIN]]''.n'' <br /> [[PIN]] ''x, y'' || RW || Gets the position of the ''nth'' pin (zero-based), or adds a pin to the map at the specified location.
|-
| [[MORE1H]],[[MORE1L]] || RW || Gets the top left coordinates (x,y) of the area displayed on t_map.
|-
| [[MORE2H]],[[MORE2L]] || RW || Gets the bottom right coordinates (x,y) of the area displayed on t_map.
|}

==Messages / Books==
Messages (t_message) and books (t_book) possess a range of properties and functions that are used to store their title, author and body text.

===Properties and Functions===
Here is a list of all message properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AUTHOR]] || RW || Gets or sets the author of the message.
|-
| [[BODY]]''.n'' || RW || Gets the nth line of text from the message, or appends a new line of text to the message.
|-
| [[ERASE]] ''page_num'' || W || Removes all lines of text from the message, or if a page number (one-based) if supplied erases just a single line.
|-
| [[PAGE]]''.n'' || W || Sets the text of the nth single line of the message. (zero-based)
|-
| [[PAGES]] || R || Gets the number of lines of text in the message.
|-
| [[TITLE]] || RW || Gets or sets the title of message.
|}

==Communication Crystals==
Communication crystals have the TYPE of t_comm_crystal.

===Properties and Functions===
Here is a list of all communication crystal properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[SPEECH]] ''-/+speech_defname'' || RW || Gets a list of attached SPEECH blocks, or adds to or removes from the attached speech..
|}

==Guild/Town Stones==
Guild and Town stones are defined by the types t_stone_guild and t_stone_town. Whilst a lot of functionality has been moved into the script pack, there are still some special properties, functions and references that can be used.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GUILD]]''.n || R || Gets the nth linked [[#Guild.2FTown_Members|guild or town]]. (zero-based)
|-
| [[GUILDFROMUID]]''stone_uid || R || Gets the linked [[#Guild.2FTown_Members|guild or town]] with a specified UID.
|-
| [[MEMBER]]''.n || R || Gets the nth member of the [[#Guild.2FTown_Members|guild or town]]. (zero-based)
|-
| [[MEMBERFROMUID]].''character_uid || R || Gets the [[#Guild.2FTown_Members|member]] of the guild with a specified UID.
|}

===Properties and Functions===
Here is a list of all guild/town stone properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ABBREV]] || RW || Gets or sets the guild/town abbreviation.
|-
| [[ABBREVIATIONTOGGLE]] || R || Returns one of the ''STONECONFIG_VARIOUSNAME_*'' defnames depending on whether SRC has their abbreviation showing or not.
|-
| [[ALIGN]] || RW || Gets or sets the alignment of the guild/town.
|-
| [[ALIGNTYPE]] || R || Returns the name of the guild or town's alignment.
|-
| [[ALLGUILDS]] ''flags, command'' || W || Performs the given comamnd on all linked guilds or towns based on flags. (0 = All, 1 = War Declared by 'Us' only, 2 = War Declared by 'Them' only, 3 = War Declayed by both)
|-
| [[ALLMEMBERS]] ''priv, command'' || W || Performs the given command on all guild or town members with the specified privelege level. (-1 = All)
|-
| [[APPLYTOJOIN]] ''character_uid'' || W || Adds a character as a candidate to the guild or town.
|-
| [[CHANGEALIGN]] ''alignment'' || W || Changes the guild or town alignment.
|-
| [[DECLAREPEACE]] ''stone_uid'' || W || Declares peace towards another guild or town.
|-
| [[DECLAREWAR]] ''stone_uid'' || W || Declares war towards another guild or town.
|-
| [[ELECTMASTER]] || W || Selects a new guild or town master based on which member has the most votes.
|-
| [[GUILD]].COUNT || R || Gets the number linked guilds or towns.
|-
| [[INVITEWAR]] ''stone_uid, who_declared'' || W || Invites another guild or town to go to war (''who_declared'', 0 = They declared, 1 = We declared)
|-
| [[JOINASMEMBER]] ''character_uid'' || W || Adds a character as a full member of the guild or town.
|-
| [[LOYALTO]] || R || Returns the name of the guild or town member that SRC has declared fealty to.
|-
| [[MASTER]] || R || Returns the name of the guild or town master.
|-
| [[MASTERGENDERTITLE]] || R || Returns the gender of the guild or town mastser.
|-
| [[MASTERTITLE]] || R || Returns the title of the guild or town master.
|-
| [[MASTERUID]] || RW || Gets the UID of the guild/town master, or sets it to the UID of a new master.
|-
| [[MEMBER]].COUNT ''priv'' || R || Gets the number of members in the guild/town with at least the given privileges (or all if not supplied).
|-
| [[RESIGN]] ''character_uid'' || W || Removes a character from the guild or town.
|-
| [[TOGGLEABBREVIATION]] ''character_uid'' || W || Toggles the display of guild/town abbreviation for a member or SRC.
|-
| [[WEBPAGE]] || RW || Gets or sets the guild or town's webpage.
|-
| [[CHARTER]]''.n'' || EW || Gets or sets the nth line of the guild/town charter. (zero-based)
|}

==Guild/Town Members==
When accessing a member of a guild or town via the [[MEMBER]].x,r [[MEMBERFROMUID]].uid, [[GUILD]].x, or [[GUILDFROMUID]].uid references, you access a special "Guild/Town Member" object which has specific properties, references and functions available. If you attempt to access something that doesn't exist in any of the following tables then the command is 'redirected' to the actual character or item the member object is linked to (so something like ''<MEMBER.x.STR>'' would work because the STR property exists on the [[Characters|character]]).

===Properties and Functions===
Here is a list of all guild/town member properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

====Character Members====

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACCOUNTGOLD]] || RW || Gets or sets the amount of gold the member has in their guild/town account.
|-
| [[ISCANDIDATE]] || R || Returns 1 if the member is a candidate of the guild/town.
|-
| [[ISMASTER]] || R || Returns 1 if the member is a guild/town master.
|-
| [[LOYALTO]] || RW || Gets or sets the UID of who the member has declared fealty towards.
|-
| [[PRIV]] || RW || Gets or sets the member's privilege level within the guild/town.
|-
| [[PRIVNAME]] || R || Returns the name of the member's privilege level within the guild/town.
|-
| [[TITLE]] || RW || Gets or sets the member's title within the guild/town.
|-
| [[SHOWABBREV]] || RW || Gets or sets whether or not the member's abbreviation is shown.
|}

====Item Members====

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ISENEMY]] || R || Returns 1 if the other guild/town is considered an enemy.
|-
| [[THEYALLIANCE]] || RW || Gets or sets whether or not the other guild/town has declared an alliance with the guild/town.
|-
| [[THEYWAR]] || RW || Gets or sets whether or not the other guild/town has declared war.
|-
| [[WEALLIANCE]] || RW || Gets or sets whether or not the guild/town has declared an alliance with the other guild/town.
|-
| [[WEWAR]] || RW || Gets or sets whether or not the guild/town has declared war with the other guild/town.
|}

==Containers==
Container items (backpacks, bankboxes, bags, etc) can be used to hold other items. These items have the [[TYPE]] of t_container.

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] from inside the container. (zero-based)
|-
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found inside the container with the matching [[BASEID]].
|-
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found inside the container with the matching [[TYPE]].
|}

===Properties and Functions===
Here is a list of all custom multi properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[COUNT]] || R || Returns the number of items inside the container.
|-
| [[DELETE]] ''nth'' || W || Deletes the nth item from inside the container. (1-based)
|-
| [[EMPTY]] || W || Deletes all items inside the container.
|-
| [[FCOUNT]] || R || Returns the total number of items inside the container, including subcontainers.
|-
| [[FIXWEIGHT]] || W || Recalculates the total weight of the container and its contained items.
|-
| [[OPEN]] || W || Opens the container, for SRC to view its contents.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item inside the container, including subcontainers.
|-
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found inside the container, including subcontainers.
|}

==Vendable Items==
When an item has value, either explicitly in the ITEMDEF's [[VALUE]] property or implicity in the ITEMDEF's [[RESOURCES]] property, it is considered a "Vendable Item" that can be sold on vendors.

===Properties and Functions===
Here is a list of all vendable item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PRICE]] || RW || Gets or sets the price of the item. (affect only the sell/buy price on player vendor)
|-
| [[QUALITY]] || RW || Gets or sets the quality of the item.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

@GetHit

2021-10-07T12:17:26Z

Jhobean:

{{Languages|@GetHit}}

==Description==
This trigger fires when a character receives damage.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] being damaged.
|-
| [[SRC]] || The [[Characters|character]] responsible for the damage.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being applied. (Before Slayer calulation if applicable)
|-
| ARGN2 || IO || The type of damage being applied.
|-
| ARGN3 || IO || Hits will be fixed to this amount after the hit if the value is greater than it, default = maxhits.
|-
| LOCAL.ITEMDAMAGECHANCE || IO || Sets the chance for the hitted part of the body (Armor or shield, if any) to be damaged (Default: 40).
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents damage from being applied.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@ItemDropOn Self

2021-10-05T22:44:00Z

Jhobean:

==Description==
This trigger fires when a character drops an item inside another item (e.g. a backpack).

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ACT]] || The [[Items|item]] that is being dropped on to.
|-
| [[ARGO]] || The [[Items|item]] being dropped on to the item.
|-
| [[I]] || The [[Characters|character]] dropping the item.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the item from being dropped on to the item. If no CONT is set, item will drop on ground.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

@DropOn Self

2021-10-05T22:42:18Z

Jhobean:

==Description==
This trigger fires when an item has an item dropped on to it. For example, when an item is placed inside a backpack this trigger will fire on the backpack.

Fires on:
* [[Items]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|item]] being dropped on to the item.
|-
| [[I]] || The [[Items|item]] that is being dropped on to.
|-
| [[SRC]] || The [[Characters|character]] dropping the item.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the item from being dropped on to the item. If no CONT is set, item will drop on ground
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

@Attack

2021-10-05T21:37:32Z

Jhobean:

==Description==
This trigger fires when one character initiates an attack on another.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] initiating the attack.
|-
| [[SRC]] || The [[Characters|character]] being attacked.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGN1]] || Threat being assigned to the target after starting the fight (Only for NPCs).
|-
| [[ARGN2]] ||replace Ignore status. 1->Force to ignore attacker 0->Force to unignore attacker (X-ONLY)
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from attacking.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@Attack

2021-10-05T21:36:58Z

Jhobean:

==Description==
This trigger fires when one character initiates an attack on another.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] initiating the attack.
|-
| [[SRC]] || The [[Characters|character]] being attacked.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGN1]] || Threat being assigned to the target after starting the fight (Only for NPCs).
| [[ARGN2]] || (X-ONLY) replace Ignore status. 1->Force to ignore attacker 0->Force to unignore attacker
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from attacking.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

Sectors

2021-09-16T01:07:39Z

Jhobean:

__FORCETOC__
The world is split into fixed-size sectors (by default, 64x64 tiles). Environmental settings (light, weather, etc) are stored on a per-sector basis. Accessing sectors in scripts can be accomplished using the SECTOR reference from a [[Characters|character]], [[Items|item]] or [[Map Points|map point]] object. The following table details the various properties of the sector object in SphereServer:

==Properties and Functions==
Here is a list of all sector properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ALLCHARS]] ''command'' || R || Executes ''command'' on all characters inside the sector.
|-
| [[ALLCHARSIDLE]] ''command'' || R || Executes ''command'' on all disconnected characters inside the sector.
|-
| [[ALLCLIENTS]] ''command'' || R || Executes ''command'' on all clients inside the sector.
|-
| [[ALLITEMS]] ''command'' || R || Executes ''command'' on all items inside the sector.
|-
| [[CANSLEEP]] || R || Returns 1 if the sector have all condition to sleep. (X ONLY)
|-
| [[CLIENTS]] || R || Gets the number of clients in the sector.
|-
| [[COLDCHANCE]] || RW || Gets or sets the chance of snow for the sector.
|-
| [[COMPLEXITY]] || R || Gets the number of characters in the sector.
|-
| [[COMPLEXITY]].HIGH || R || Returns 1 if the sector has a high complexity. (less than 5 characters)
|-
| [[COMPLEXITY]].MEDIUM || R || Returns 1 if the sector has a medium complexity. (less than 10 characters)
|-
| [[COMPLEXITY]].LOW || R || Returns 1 if the sector has a low complexity. (10+ characters)
|-
| [[DRY]] || W || Sets the weather to dry.
|-
| [[ISDARK]] || R || Returns 1 if the light level in the sector is considered to be dark.
|-
| [[ISNIGHTTIME]] || R || Returns 1 if the local time of day is between 9pm and 7am.
|-
| [[ISSLEEPING]] || R || Returns 1 if the sector is sleeping. (X ONLY)
|-
| [[ITEMCOUNT]] || R || Returns the number of items in the sector.
|-
| [[LIGHT]] || RW || Gets or sets the light level for the sector.
|-
| [[LOCALTIME]] || R || Gets the local time of day, as a descriptive string.
|-
| [[LOCALTOD]] || R || Gets the local time of day, in minutes.
|-
| [[NUMBER]] || R || Gets the index number of the sector.
|-
| [[RAIN]] || W || Sets the weather to raining.
|-
| [[RAINCHANCE]] || RW || Gets or sets the chance of rain for the sector.
|-
| [[RESPAWN]] ''ALL'' || W || Resurrects dead NPC characters (not corpses). If ''ALL'' is provided then all sectors will be affected.
|-
| [[RESTOCK]] ''ALL'' || W || Restocks all NPCs in the sector. If ''ALL'' is provided then all sectors will be affected.
|-
| [[SEASON]] || RW || Gets or sets the current season in the sector.
|-
| [[SNOW]] || W || Sets the weather to snowing.
|-
| [[WEATHER]] || RW || Gets or sets the current weather in the sector.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

Where to get Sphere

2021-08-20T01:45:01Z

Jhobean:

{{Languages|Where_to_get_Sphere}}

There are two different sources for downloading Sphere: Pre-Releases and Automated Builds. Below is a summary of what each is to help you choose between them.

==Prerelease Builds==
Prerelease builds are periodically released when the Sphere developers feel that enough progress has been made and are relatively happy with the stability of the build (i.e. the build actually runs!). Since there is not yet a "final" build of Sphere, the prereleases are the closest "Stable" thing that you can get.

Visit the [https://forum.spherecommunity.net/sshare.php?srt=4 Pre-releases] website to find the latest prerelease download for Sphere. There different Version but Sphere X is the more recent, more performant and the one where there some active dev.

This build is more than likely the one you want to download. ''If you are unsure, then review the [[#Which Do I Want?|Which Do I Want?]] section for more information.''

==Automated Builds==
on every modification an automated process will compile a new Sphere executable directly from the latest development code. If you want the latest cutting edge features that aren't available in the latest prerelease then you may want to consider using an automated build.

Visit the [https://ci.appveyor.com/project/cbnolok/sphereserver-x/history SphereServer Nightly Automated Builds] website to download all latest automated build for Sphere.

Before you rush over and download an automated build, take care of the following warnings:
* Since these builds are compiled directly from the latest development source code, it is not recommended that you use these at all on a live server unless you know exactly what you are doing and have performed thorough tests first!
* The Sphere development team will not provide any support for using these builds. If you encounter a problem then you will be completely on your own.

==Which Do I Want?==
If you're unsure of which to use the best option is to simply use the latest prerelease. Automated builds are only intended to be used by advanced users or testers, who may want to test some of the newer features before they are released.

Here is a brief comparison of the two build types:

{| border="1" cellpadding="4"
| '''[[#Prerelease Builds|Prerelease Builds]]''' || '''[[#Automated Builds|Automated Builds]]'''
|-
| Support available in [https://discord.gg/NufqpAw]Discord or the Forum || No support available at all
|-
| Increased chance of stability || Decreased chance of stability
|-
| Compiled manually from a more stable code branch || Compiled automatically from the development code branch
|-
| Does not contain the very latest features and bugfixes || Contains the very latest features and bugfixes
|-
| Released periodically (sometimes months apart) || Released daily
|}

To summarise, the prerelease builds are supported and specifically released by the Sphere development team at appropriate times when it is felt that enough development work has been made for a new release to be worthwhile. Unless you urgently need an as-of-yet unreleased feature or bugfix there should be no reason for you, as an end-user, to want to download an automated build.

'''''Note:''''' ''If your only reason for choosing to use an automated Sphere build is that you don't want to wait for an official prerelease containing a new feature or bugfix then you should reconsider this decision. Whilst you may enjoy having the feature or bugfix in question, there is also an increased chance that some of the work has not been completed, or a new bug may have been introduced, which could consequently destabalise your server!''

[[Category: Setting Up Sphere]]

Installing Sphere

2021-08-20T01:36:23Z

Jhobean:

{{Languages|Installing_Sphere}}
==Windows==

Start by downloading Sphere. See the [[Where to get Sphere]] page for download links. You should end up with two different zip files, one containing the Sphere executable and the other containing the [[Script Pack]].

# Extract the SphereServer.zip file to wherever you want to run it from. I would recommend "c:\sphere"
# Extract Scripts.zip to the directory where you previously extracted the file in the previous step. Now you should have the directory scripts in "c:\sphere".
# Create three new folders, one named "accounts", another called "logs", and the third one called "save".
# Now, go to your "save" folder, recently created. And create an empty text file (I recommend using the Start Menu to access Notepad instead of "Right Click => New"). Write an empty line and add "[EOF]" in the second one. Save the file as "spheredata.SCP" (not .txt).
# Copy this file four times an rename them as: spherestatics, spherechars.scp, spheremultis.scp and sphereworld.scp
# Now, [[Configuring_Sphere.ini|configure your sphere.ini]]. This is a must before running Sphere for the first time!
# Double Click on SphereSvr.exe to launch the Console. This black window is your server console from which you can enter commands.
# Create an Account for yourself. In the console, type in "<font color="darkred">account add USERNAME PASSWORD</font>". With whatever username and password you want. Then, type in "<font color="darkred">account USERNAME plevel 7</font>" to grant your account Owner privileges.

Now you can go around your map and explore some parts of it. You can use the navigation bar on the left to read various tutorials to learn how to script and learn something about Sphere. After that, read the other articles and check the [[Main_Page#Reference Compendium|reference compendium]] if you need something special.

==Linux==
===Preface===
Installing Sphere on a Linux box is not more difficult as doing this task on a Windows PC. Either way you will have to have basic knowledge about your operation system, and you should not rely on that you simply have to doubleclick like mad to get the beast up and running.

Even more, this tutorial will assume that you are using a shell on the linux box, and that you have root access. You do not trust your skills to type a command without mistakes, or no one will trust your knowledge enough to give you system administrator privileges on his Linux PC? Well, then - your busted. Go home, and play Solitaire on a neat little Windows box, ok?

Finally, this tutorial will NOT cover the ways to get the necessary files onto the Linux server. If you cannot figure this out yourself - read the last sentence of the paragraph before. THIS IS NOT A LESSON "Linux for Dummies"! Do your homework, and learn. There are many books about Linux' basics, even E-Books you can download free of charge. Surfing to [http://www.linux.org http://www.linux.org] will be a good point to start.

One last word about syntax: LINUX commands and filenames are case sensitive! So if later on a file cannot be found it usually is because you typed something like "sphere.INI" instead of "sphere.ini".

And in this document lines in italics are denoting what you have to type into (or read from) the shell.

===Preparations===
On the Linux box you will need a MySQL client installation. You do not need a server if you do not plan to use the database features, but Sphere will not start without the proper MySQL client libraries. Period.

You also need access to a Sphere prerelease FOR LINUX, the default script package for this version, and eventually additional libraries (libboost for recent releases).

===Installation Step-By-Step===
'''1)''' As user root, create a user named 'sphere'. Set or create it's home directory (usually /home/sphere/), give it the correct owner and permissions:

useradd -d /home/sphere sphere
mkdir /home/sphere
chown sphere /home/sphere
chmod 700 /home/sphere

'''2)''' Copy the files from the Sphere LINUX package and the scriptpack into this newly created directory. Create all missing directories like "save", "logs", "accounts" as they are named in your sphere.ini and spheretables.scp. You should end up with a structure like this:

/home/sphere --- spheresvr
| sphere.ini
| sphereCrypt.ini
|-------------------- accounts/
|-------------------- logs/
|-------------------- muls/
|-------------------- save/
|-------------------- scripts/

'''3)''' After copying all related files to their respective positions, make sure that they all have the correct permissions and ownerships. Still as root do:

cd ~sphere
chown -R sphere *
find . -type d | xargs chmod 0700
find . -type f | xargs chmod 0600
chmod 4700 spheresvr

'''4)''' Still as root, print the shared library dependencies:

ldd spheresvr

the output should be something like this:

longbow:/home/sphere# ldd spheresvr
libpthread.so.0 => /lib/libpthread.so.0 (0x4001f000)
libmysqlclient.so.15 => /usr/lib/libmysqlclient.so.15 (0x40071000)
libboost_regex-gcc-1_33_1.so => /usr/lib/libboost_regex-gcc-1_33_1.so (0x40243000)
libstdc++.so.6 => /usr/lib/libstdc++.so.6 (0x402ea000)
libm.so.6 => /lib/libm.so.6 (0x403c9000)
libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x403ef000)
libc.so.6 => /lib/libc.so.6 (0x403fa000)
/lib/ld-linux.so.2 (0x40000000)
libcrypt.so.1 => /lib/libcrypt.so.1 (0x4051c000)
libnsl.so.1 => /lib/libnsl.so.1 (0x4054a000)
libz.so.1 => /usr/lib/libz.so.1 (0x40561000)

<strong>LOOK FOR MISSING LIBRARIES!</strong> If something is missing, just install it. You should know how to do. If it's just libboost what is missing, you have got this with the preparations. Copy it into /usr/lib/ and type:

ldconfig

===Test the Installation===

It does matter if you start your test as user ''root'' or user ''sphere''... But setting the permissions of the spheresvr executable to 4700 forces it to always be started as it's owner, and if you followed the earlier instuctions, that owner is ''sphere''. So start it like this:

cd ~sphere
./spheresvr

You will get the usual startup yaddayadda, perhaps including some warnings such as:

longbow:/home/sphere# ./spheresvr
WARNING:(sphere.ini,587)'scripts/spherestatusbase.html' not found...
ERROR:(sphere.ini,587)Can't open web page input 'spherestatusbase1.htm'
Sphere Version 0.56b [Linux] by www.sphereserver.com, compiled at Sep 15 2006 (23:23:07)
Signal handlers installed.
Expansion maps supported: T2A, LBR, AOS, SE, ML
ERROR:(spheretables.scp,59)Unable to open directory scripts/custom/
ERROR:(spheretables.scp,59)DirList=-1 for 'scripts/custom/'
Allocating map sectors: 0=7168 1=7168 2=900 3=1280 4=32761
Indexing 211 scripts...
Loading scripts/sphere_defs.scp
[...]

Finally your Sphere will tell you something like:

[...]
Loading save/spheredata...
Loading save/spherestatics...
Loading save/sphereworld...
Loading save/spherechars...
166 Objects accounted for
Option flags: CommandSysmsgs + NoHouseMuteSpeech
Experimental flags: DiagonalWalkCheck + ScriptsReturnStrings + NewTriggersEnable + NewPositionChecks + WalkCheck + ScriptProfiler + SizeOptimize
Admin=me@my.email.com, URL=www.myshard.com, Lang=English, TZ=0
Startup complete. items=0, chars=0
Creating thread.

You can safely ignore script warnings and errors regarding missing web pages. But if the sphere issues other errors, or terminates, dont just stare at the error number like the rabbit stares at the snake: The text immediately above the error will tell you what's wrong. So fix it. For example, after starting the server, if you see errors like:

16:55:FATAL:Segmentation fault 16:55:FATAL:Error Pri=1, Code=11, Desc='Segmentation fault', in CChar::CanMoveWalkTo() #1 "Check Valid Move"

...the filesystem ACLs may be wrong, specifically the ACLs on the UO mul and uop files in the UO client directory. There are numerous solutions, but one way to fix this is to change the permissions on these files to 644.

But I digress.... Assuming no catestrophic failures, you are now in the sphere console and can issue the common commands (type '?' to get a list). So create an account, activate it, edit the login.cfg (or host details) on your windows box with the client installation to point to the address of the Linux box, and be the first to log in.

To stop the Sphere, type 'S' in the console, then 'x'. Linux will tell you something about deinstalling handlers and shutting down. But often it will just "hang" after this, not really terminating. Clear this situation by typing CTRL-c

===Preparing for production===
Perhaps you closed your shell during the test. Then you should have noticed that the operating system killed your Sphere at the same moment. That's not a bug but wanted behaviour: Linux is a multi user os, and when a user logs out processes started by him shall not accidentally kept running.

But of course you will not be able to keep open the console all the time, at least if your Linux box can only be reached remotely, perhaps by ssh. If it's the main service running on the box, you should create a startup script what starts spheresvr in an endless loop, thus restarting it in the event it should crash. To do this, first install the 'screen' utility using the packet manager of your distribution. Then use the text editor of your choice and create a script like this:

#!/bin/sh
cd ~sphere
while true; do
screen -D -m /home/sphere/spheresvr
sleep 30
done

This way the server will be run in a virtual window to what you always can attach with 'screen -r'. Read the manpage for screen for more information.

Then take it to the next level! Perhaps create an /etc/init.d/sphereserver script to start, stop, or restart the server... then softlink that script in the various /etc/rc*.d/ directories so that the sphere server automatically starts when the linux server is rebooted... maybe setup a cron job to automatically rotate and archive the log files that sphere creates.

==FreeBSD==
We currently have no guide for this OS. Anyway, the developers have posted a list of required stuff. Here is the list:

Compiled on:

FreeBSD freebsdvbox.fastwebnet.it 7.0-RELEASE FreeBSD 7.0-RELEASE #0: Sun Feb 24 19:59:52 UTC 2008 root@logan.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC i386

With:

Using built-in specs.
Target: i386-portbld-freebsd7.0<br />
Configured with: ./..//gcc-4.1-20071105/configure --disable-nls --with-system-zlib --with-libiconv-prefix=/usr/local --program-suffix=41 --libdir=/usr/local/lib/gcc-4.1.3 --with-gxx-include-dir=/usr/local/lib/gcc-4.1.3/include/c++/ --disable-rpath --prefix=/usr/local --mandir=/usr/local/man --infodir=/usr/local/info/gcc41 i386-portbld-freebsd7.0
Thread model: posix
gcc version 4.1.3 20071105 (prerelease)

Linked Against:

libthr.so.3 => /lib/libthr.so.3 (0x281f3000)
libmysqlclient.so.15 => /usr/local/lib/mysql/libmysqlclient.so.15 (0x28206000)
libstdc++.so.6 => /usr/lib/libstdc++.so.6 (0x28265000)
libm.so.5 => /lib/libm.so.5 (0x2835a000)
libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x2836f000)
libc.so.7 => /lib/libc.so.7 (0x2837a000)
libcrypt.so.4 => /lib/libcrypt.so.4 (0x28476000)
libz.so.4 => /lib/libz.so.4 (0x2848f000)

If you use this release, please check [http://www.sphereserver.net/index.php?showtopic=44153 this topic].

[[Category: Setting Up Sphere]]

@SpellFail

2021-03-30T14:23:55Z

Jhobean: Add New sphere X argument to the trigger

==Description==
This trigger fires when a character fails to cast a spell.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|item]] used to cast the spell (e.g. a wand or scroll).
|-
| [[I]] || The [[Characters|character]] failing to cast the spell.
|-
| [[SRC]] || The [[Characters|character]] failing to cast the spell.
|}

==Arguments==
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The spell that was being cast.
|}

The following arguments are use only in the X version:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN2 || IO || The mana loss if the spell is failed.
|-
| local.tithingloss || IO || The tithing points loss if the spell is failed.
While both are writeable, they only works if ManaLossFail or ReagentLossFail ( also for tithing points) are enabled in the sphere.ini
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents normal fail behaviours (fail message, fizzle effect, reagent loss).
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

Items

2021-01-27T03:01:19Z

Jhobean: Add detail about new feature TImerF stop

{{Languages|Items}}

__FORCETOC__
Generally speaking, there are two types of "things" in the game; characters and items. Compared to characters, items are very complex. Items have a number of different uses, for example a sword is an item that players can see and equip to increase the damage they can do in combat. Some items in the game can not be seen by the players, but they have as much impact on the player as their sword, for example, a memory item is equipped every time a player is under the effects of a spell. Some [[Special Items|special types of item]] also have additional properties that can be accessed via scripts. The following tables detail the various properties of items in SphereServer:

==References==
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[CONT]] || RW || Gets or sets the [[Characters|character]] or [[Special Items#Containers|container item]] that the object is inside. When an item's CONT is changed, it bypasses the typical behavior (for example, you can force an item to be "in" a container and bypass @dropon triggers, or force an item to be equipped to a player and bypass @equiptest and @equip triggers -- but be careful, because in this second scenario it may end up in an invalid layer.)
|-
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to. Note, you can make circular LINK's, but a single item cannot be linked to more than one other item.
|-
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the object is in.
|-
| [[ROOM]] || R || Gets the [[Rooms|room]] that the object is in.
|-
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the object is at.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the object is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the item.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[ITEMDEF]] that defines the item.
|}

==Properties and Functions==
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.

{| border="1" cellspacing="4" cellpadding="4"
! Name !! '''Read/Write''' !! '''Description'''
|-
| [[ADDCIRCLE]] ''spell_circle'' || W || Adds all of the spells in the given Magery circle to the spellbook.
|-
| [[ADDSPELL]] ''spell_id'' || RW || Gets whether or not a spell exists in the spellbook, or adds a spell to the spellbook.
|-
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.
|-
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.
|-
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.
|-
| [[AMMOSOUNDHIT]] || RW || Overrides the hit sound on weapons.
|-
| [[AMMOSOUNDMISS]] || RW || Overrides the miss sound on weapons.
|-
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.
|-
| [[AMOUNT]] || RW || Gets the amount of items this icon represents (e.g. a pile of gold or any stacked item).
|-
| [[ATTR]] || RW || Gets or sets the item's attribute flags.
|-
| [[BOUNCE]] || W || Moves the item to SRC's backpack (triggering the ''you put the item in your pack'' message.
|-
| [[CAN]] || RW || Gets or Sets the can_flags (Setting can be only done in the Itemdef itself).
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the item.
|-
| [[CANSEELOS]] ''point_or_uid'' || R || Returns 1 if SRC has line of sight to the item or character (uid) or point (location).
|-
| [[CANSEELOSFLAG]] ''flags,point_or_uid'' || R || Returns 1 if SRC has line of sight to the item. The ''flags'' are defined in the los_flags section of the sphere_defs.scp file and can be used to modify what tests take place. The ''point_or_uid'' is an object or position that can be used to test line of sight to something other than SRC. Note, the delimiter for FLAG values is ;
|-
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the item that start with the given prefix.
|-
| [[COLOR]] || RW || Gets or sets the object's hue.
|-
| [[CONSUME]] ''amount'' || W || Deducts an amount from the item, deleting it at 0.
|-
| [[CONTCONSUME]] ''resource_list'' || W || Deletes items from inside the container.
|-
| [[CONTGRID]] || RW || If in a container, gets or sets the grid number that the item occupies (in KR's grid view)
|-
| [[CONTP]] || RW || Gets or sets the position of the item within its container.
|-
| [[DAMAGE]] ''chance, type, source'' || W || If ''chance'' is greater than (Rand(maxhits*16)), inflicts damage of ''type'' (the damage type flags are defined in the sphere_defs.scp file) upon the item. You can optionally specify the ''source'' of the damage.
|-
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.
|-
| [[DECAY]] ''time'' || W || Sets the decay timer (in tenths of a second) for the item.
|-
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DISPID]] || RW || Gets or sets the ID that the item will appear as to players.
|-
| [[DISPIDDEC]] || RW || Same as [[DISPID]], except it returns the ID as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and SRC. If ''point_or_uid'' is used, SRC can be replaced with a map location or another object.
|-
| [[DMGCOLD]] || RW || Gets or sets the amount of cold damage the weapon will give.
|-
| [[DMGENERGY]] || RW || Gets or sets the amount of energy damage the weapon will give.
|-
| [[DMGFIRE]] || RW || Gets or sets the amount of fire damage the weapon will give.
|-
| [[DMGPOISON]] || RW || Gets or sets the amount of poison damage the weapon will give.
|-
| [[DROP]] || W || Drops the item to the ground.
|-
| [[DUPE]] || W || Clones the item.
|-
| [[EDIT]] || W || Displays an editing dialog for the item to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EQUIP]] || W || Equips the item to SRC.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[FIX]] || W || Re-aligns the item or character's Z level to ground level (if items are on the ground, the top item's ''Z+HEIGHT'' is used).
|-
| [[FLIP]] || W || Rotates the item clockwise.
|-
| [[FRUIT]] || RW || Gets or sets the fruit that will be produced by the crops.
|-
| [[HEIGHT]] || R || Gets the height of the item.
|-
| [[HITS]] || RW || Gets or sets the number of hitpoints the item has.
|-
| [[HITPOINTS]] || RW || Gets or sets the number of hitpoints the item has.
|-
| [[ID]] || RW || Gets or sets the ID of the item.
|-
| [[INFO]] || W || Displays an information dialog about the item to SRC.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE and is within ''distance''.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE and is within ''distance''.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player character.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.
|-
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[LAYER]] || RW || Gets or sets the layer that the item occupies when equipped (possible layers are defined in the sphere_defs.scp file).
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXHITS]] || RW || Gets or sets the maximum number of hitpoints the item can have.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this item to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this item to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the item's armour rating if it is clothing, armor, or a shield. This gets or sets a modifier for the item's damage if it is a weapon type.
|-
| [[MORE1]] || RW || Gets or sets the MORE1 value for the item.
|-
| [[MORE1H]] || RW || Gets or sets the upper 4 bytes of the item's MORE1 value.
|-
| [[MORE1L]] || RW || Gets or sets the lower 4 bytes of the item's MORE1 value.
|-
| [[MORE2]] || RW || Gets or sets the MORE2 value for the item.
|-
| [[MORE2H]] || RW || Gets or sets the upper 4 bytes of the item's MORE2 value.
|-
| [[MORE2L]] || RW || Gets or sets the lower 4 bytes of the item's MORE2 value.
|-
| [[MOREM]] || RW || Gets or sets the MOREM value for the item.
|-
| [[MOREX]] || RW || Gets or sets the MOREX value for the item.
|-
| [[MOREY]] || RW || Gets or sets the MOREY value for the item.
|-
| [[MOREZ]] || RW || Gets or sets the MOREZ value for the item.
|-
| [[MOREP]] || RW || Gets or sets the MOREP value for the item.
|-
| [[MOVE]] ''direction amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position. Possible ''direction'' values are N,S,W, or E. Note, you can combine directions (like: MOVE SW 1) but nonsensical directions (like: MOVE WE 2) have the nonsense removed.
|-
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the object to a random location near another object within a certain distance.
|-
| [[MOVETO]] ''location'' || W || Moves the object to a specific location (note, the AREADEF or ROOMDEF must have a P defined).
|-
| [[NAME]] || RW || Gets or sets the object's name.
|-
| [[NUDGEDOWN]] ''amount'' || W || Decreases the object's Z level.
|-
| [[NUDGEUP]] ''amount'' || W || Increases the object's Z level.
|-
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.
|-
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.
|-
| [[REMOVE]] || W || Deletes the object.
|-
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.
|-
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.
|-
| [[SAY]] ''message'' || W || Makes the object speak a message.
|-
| [[SAYU]] ''message'' || W || Makes the object speak a UTF-8 message
|-
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || Makes the object speak a UNICODE message.
|-
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.
|-
| [[SERIAL]] || R || Gets the item's unique ID in the world.
|-
| [[SEXTANTP]] ''location'' || R || Converts the item's location or a specified location into sextant coordinates.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this object.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the item to be affected by a spell.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC. ''F'' makes the ''function'' available, and when added, the function name must be the 1st argument. ''M'' allows you to place a ''multi'' item, in which case the multi number must be passed as an argument. ''G'' forces the target to only be the ground. ''W'' checks the criminal status of the player before (or after?) the target selection is made.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Schedules a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the object.
|-
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the item. (On X version wild character * is available for defining the function name or the argument)
|-
| [[TRIGGER]] ''trig_name, trigger_argtype, argument1, argument2, ...'' || R || Fires a custom trigger (trig_name), allowing you to define the behavior of the arguments (the types are defined under trigger_argtype in the sphere_defs.scp file). The result of the trigger's RETURN value is returned. For example:
LOCAL.result=<TRIGGER @CustomTrigger,<DEF.tat_as_argn>,1,2,3>
|-
| [[TYPE]] || RW || Gets or sets the item type. You can use built-in or custom [[TYPEDEF]]s as a value.
|-
| [[UID]] || R || Gets the item's unique ID in the world.
|-
| [[UNEQUIP]] || W || Unequips the item and places it in SRC's backpack.
|-
| [[UPDATE]] || W || Updates the state of the item to nearby clients.
|-
| [[UPDATEX]] || W || Updates the state of the item to nearby clients, removing it from their view first to ensure a full refresh.
|-
| [[USE]] ''check_los'' || W || Uses the item, as if SRC had double clicked it.
|-
| [[USEITEM]] || W || Double clicks the item, with SRC as the source of the event, without checking for line of sight.
|-
| [[WEIGHT]] || R || Gets the weight of the item.
|-
| [[Z]] || R || Gets the Z position of the item.
|}

==Triggers==
Here is a list of all item triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@Buy]] || Fires when the item is being bought from a vendor.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips are about to be sent to a client.
|-
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.
|-
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.
|-
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.
|-
| [[@Damage]] || Fires when the item receives damage.
|-
| [[@DClick]] || Fires when the object is double-clicked.
|-
| [[@Destroy]] || Fires when the object is being deleted.
|-
| [[@DropOn_Char]] || Fires when the item has been dropped on to a character.
|-
| [[@DropOn_Ground]] || Fires when the item has been dropped on to the ground.
|-
| [[@DropOn_Item]] || Fires when the item is dropped on to another item.
|-
| [[@DropOn_Self]] || Fires when an item has been dropped on to this item.
|-
| [[@DropOn_Trade]] || Fires when an item is being dropped on a Trade Window.
|-
| [[@Dye]] || Fires when an item is having its colored changed.
|-
| [[@Equip]] || Fires when the item has been equipped.
|-
| [[@EquipTest]] || Fires when the item is about to be equipped.
|-
| [[@PickUp_Ground]] || Fires when the item ihas been picked up from the ground.
|-
| [[@PickUp_Pack]] || Fires when the item is picked up from inside a container.
|-
| [[@PickUp_Self]] || Fires when an item has been picked up from inside the item.
|-
| [[@PickUp_Stack]] || Fires when the item is picked up from a stack.
|-
| [[@Sell]] || Fires when the item is sold to a vendor.
|-
| [[@SpellEffect]] || Fires when the object is hit by the effects of a spell.
|-
| [[@Step]] || Fires when a character steps on the item.
|-
| [[@TargOn_Cancel]] || Fires when a target is cancelled from the item.
|-
| [[@TargOn_Char]] || Fires when a character is targeted from the item.
|-
| [[@TargOn_Ground]] || Fires when the ground is targeted from the item.
|-
| [[@TargOn_Item]] || Fires when an item is targeted from this item.
|-
| [[@Timer]] || Fires when the item's timer expires.
|-
| [[@ToolTip]] || Fires when old-style tooltips are requested for the item.
|-
| [[@UnEquip]] || Fires when the item is unequipped.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

Characters

2021-01-25T12:26:47Z

Jhobean: Add * char ont function stop

{{Languages|Characters}}

__FORCETOC__
A character can be either a player or an NPC.

==References==
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.
|-
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.
|-
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)
|-
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].
|-
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.
|-
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].
|-
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.
|-
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.
|-
| [[OWNER]] || R || Gets the character that owns this character. (RW in Experimental Build)
|-
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.
|-
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.
|-
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.
|-
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.
|-
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

==Properties and Functions==
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef.
|-
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.
|-
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.
|-
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.
|-
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the character.
|-
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.
|-
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.
|-
| [[COLOR]] || RW || Gets or sets the character's hue.
|-
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.
|-
| [[COUNT]] || R || Returns the number of items equipped to the character.
|-
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).
|-
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.
|-
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.

When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.

|-
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]
|-
| [[DEX]] || RW || Gets or sets the character's total dexterity.
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.
|-
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.
|-
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).
|-
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).
|-
| [[DIR]] || RW || Gets or setes the direction that the character is facing.
|-
| [[DISCONNECT]] || W || Disconnects the character.
|-
| [[DISMOUNT]] || W || Dismounts the character from their ride.
|-
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.
|-
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.
|-
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.
|-
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.
|-
| [[DUPE]] || W || Creates a clone of the character.
|-
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.
|-
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.
|-
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.
|-
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.
|-
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[EXP]] || RW || Gets or sets the character's experience points.
|-
| [[FACE]] ''object_uid'' || W || Turns the character to face a specified object or SRC.
|-
| [[FAME]] || RW || Gets or sets the character's fame.
|-
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.
|-
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems
|-
| [[FLAGS]] || RW || Gets or sets the character's flags.
|-
| [[FIX]] || W || Re-aligns the character's Z level to ground level.
|-
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.
|-
| [[FLIP]] || W || Rotates the character.
|-
| [[FONT]] || RW || Gets or sets the character's speech font.
|-
| [[FOOD]] || RW || Gets or sets the character's food level.
|-
| [[FORGIVE]] || W || Revokes the character's jailed status.
|-
| [[GO]] ''location'' || W || Teleports the character to the specified location.
|-
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.
|-
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]
|-
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)
|-
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].
|-
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.
|-
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).
|-
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.
|-
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].
|-
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].
|-
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.
|-
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.
|-
| [[HEIGHT]] || R || Gets the character's height.
|-
| [[HITS]] || RW || Gets or sets the character's hitpoints.
|-
| [[HOME]] || RW || Gets or sets the character's home location.
|-
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.
|-
| [[ID]] || R || Gets the character's ID.
|-
| [[INFO]] || W || Displays an information dialog about the character to SRC.
|-
| [[INT]] || RW || Gets or sets the character's total intelligence.
|-
| [[INVIS]] || W || Sets whether or not the character is invisible.
|-
| [[INVUL]] || W || Sets whether or not the character is invulnerable.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.
|-
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.
|-
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.
|-
| [[KARMA]] || RW || Gets or sets the character's karma.
|-
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.
|-
| [[KILL]] || W || Kills the character.
|-
| [[LEVEL]] || RW || Gets or sets the character's experience level.
|-
| [[LIGHT]] || RW || Gets or sets the character's personal light level.
|-
| [[LUCK]] || RW || Gets or sets the luck value for the character.
|-
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.
|-
| [[MANA]] || RW || Gets or sets the character's mana.
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.
|-
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.
|-
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.
|-
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.
|-
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.
|-
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.
|-
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.
|-
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.
|-
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.
|-
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.
|-
| [[MOUNT]] || R || Gets the UID of the character's mount.
|-
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.
|-
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).
|-
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.
|-
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.
|-
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.
|-
| [[NAME]] || RW || Gets or sets the character's name.
|-
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.
|-
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.
|-
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.
|-
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.
|-
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.
|-
| [[NPC]] || RW || Gets or sets the character's AI type.
|-
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.
|-
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.
|-
| [[OBODY]] || RW || Gets or sets the character's original body.
|-
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.
|-
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.
|-
| [[OSKIN]] || RW || Gets or sets the character's original colour.
|-
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).
|-
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).
|-
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).
|-
| [[PACK]] || W || Opens the character's backpack for SRC to view.
|-
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.
|-
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.
|-
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.
|-
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.
|-
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.
|-
| [[RANGE]] || R || Gets the combat range of the character.
|-
| [[RELEASE]] || W || Clears the character's owners.
|-
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.
|-
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.
|-
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.
|-
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.
|-
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.
|-
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.
|-
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.
|-
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.
|-
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.
|-
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.
|-
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.
|-
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.
|-
| [[SAY]] ''message'' || W || Makes the character speak a message.
|-
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message
|-
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.
|-
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.
|-
| [[SERIAL]] || R || Gets the item's unique ID in the world.
|-
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.
|-
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.
|-
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.
|-
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.
|-
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.
|-
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.
|-
| [[STR]] || RW || Gets or sets the character's total strength.
|-
| [[SUICIDE]] || W || Forces the character to commit suicide.
|-
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.
|-
| [[SUMMONTO]] || W || Teleports the character to SRC's position.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.
|-
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)
|-
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.
|-
| [[TITLE]] || RW || Gets or sets the character's title.
|-
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.
|-
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.
|-
| [[UID]] || R || Gets the item's unique ID in the world.
|-
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.
|-
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.
|-
| [[UPDATE]] || W || Updates the state of the character to nearby clients.
|-
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.
|-
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.
|-
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.
|-
| [[WEIGHT]] || R || Gets the weight of the character.
|-
| [[WHERE]] || W || Describes the character's location to SRC.
|-
| [[Z]] || R || Gets the Z position of the character.
|}

==Triggers==
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@Attack]] || Fires when the character begins attacking another.
|-
| [[@CallGuards]] || Fires when the character calls for guards.
|-
| [[@CharAttack]] || Fires when the character is attacked by another character.
|-
| [[@CharClick]] || Fires when the character is clicked by another character.
|-
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.
|-
| [[@CharDClick]] || Fires when the character double clicks another character.
|-
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.
|-
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.
|-
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.
|-
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.
|-
| [[@CombatStart]] || Fires when adding first attacker to my list.
|-
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.
|-
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.
|-
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.
|-
| [[@Criminal]] || Fires when the character becomes a criminal.
|-
| [[@DClick]] || Fires when the object is double-clicked.
|-
| [[@Death]] || Fires when the character's hitpoints reaches zero.
|-
| [[@DeathCorpse]] || Fires when a corpse is created for the character.
|-
| [[@Destroy]] || Fires when the object is being deleted.
|-
| [[@Dismount]] || Fires when the character dismounts their ride.
|-
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.
|-
| [[@Eat]] || Fires when the character eats something.
|-
| [[@EnvironChange]] || Fires when the environment changes for the character.
|-
| [[@ExpChange]] || Fires when the character's experience points change.
|-
| [[@ExpLevelChange]] || Fires when the character's experience level changes.
|-
| [[@FameChange]] || Fires when the character's fame changes.
|-
| [[@GetHit]] || Fires when the character receives damage.
|-
| [[@Hit]] || Fires when the character hits another in combat.
|-
| [[@HitMiss]] || Fires when the character fails to hit another in combat.
|-
| [[@HitTry]] || Fires when the character tries to hit another in combat.
|-
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.
|-
| [[@HouseDesignExit]] || Fires when the character exits house design mode.
|-
| [[@Hunger]] || Fires when the character's food level decreases.
|-
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.
|-
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.
|-
| [[@ItemClick]] || Fires when the character single-clicks an item.
|-
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.
|-
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.
|-
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.
|-
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.
|-
| [[@ItemDamage]] || Fires when the character damages an item.
|-
| [[@ItemDClick]] || Fires when the character double-clicks an item.
|-
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.
|-
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.
|-
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.
|-
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.
|-
| [[@ItemEquip]] || Fires when the character equips an item.
|-
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.
|-
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.
|-
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.
|-
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.
|-
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.
|-
| [[@ItemSell]] || Fires when the character sells an item to a vendor.
|-
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.
|-
| [[@ItemStep]] || Fires when the character steps on an item.
|-
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.
|-
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.
|-
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.
|-
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.
|-
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.
|-
| [[@ItemUnEquip]] || Fires when the character unequips an item.
|-
| [[@Jailed]] || Fires when the character is sent to jail.
|-
| [[@KarmaChange]] || Fires when the character's karma changes.
|-
| [[@Kill]] || Fires when the character kills another character.
|-
| [[@Login]] || Fires when the character logs in.
|-
| [[@Logout]] || Fires when the character logs out.
|-
| [[@Mount]] || Fires when the character mounts a ride.
|-
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.
|-
| [[@MurderMark]] || Fires when the character is about to gain a kill.
|-
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.
|-
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.
|-
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.
|-
| [[@NPCActFollow]] || Fires when the NPC follows another character.
|-
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.
|-
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.
|-
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.
|-
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.
|-
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.
|-
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].
|-
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.
|-
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.
|-
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.
|-
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.
|-
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).
|-
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)
|-
| [[@PersonalSpace]] || Fires when the character is stepped on.
|-
| [[@PetDesert]] || Fires when the character deserts its owner.
|-
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.
|-
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.
|-
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@Resurrect]] || Fires when the character is being resurrected.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.
|-
| [[@TradeClose]] || Fires when a trade window is closed.
|-
| [[@TradeCreate]] || Fires when a player begins a trade with another player.
|-
| [[@UserBugReport]] || Fires when the player submits a bug report.
|-
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.
|-
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)
|-
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini
|-
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.
|-
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.
|-
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.
|-
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.
|-
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.
|-
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.
|-
| [[@UserSpecialMove]] || Fires when the player uses a special move.
|-
| [[@UserStats]] || Fires when the player opens the status window.
|-
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+
|-
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.
|-
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.
|-
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.
|}

==Players==
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.
|-
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].
|-
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.
|}

===Properties and Functions===
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.
|-
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.
|-
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.
|-
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.
|-
| [[KICK]] || W || Disconnects and blocks the player's account.
|-
| [[KILLS]] || RW || Gets the number of murders the player has committed.
|-
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.
|-
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.
|-
| [[PASSWORD]] || W || Sets or clears the player's password.
|-
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.
|-
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.
|-
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.
|-
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]
|}

==NPCs==
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:

===Properties and Functions===
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.
|-
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.
|-
| [[BYE]] || W || Ends the NPC's current action.
|-
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.
|-
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.
|-
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.
|-
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.
|-
| [[NPC]] || RW || Gets or sets the NPC's AI type.
|-
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.
|-
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.
|-
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.
|-
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)
|-
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.
|-
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.
|-
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.
|-
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.
|-
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.
|-
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)
|-
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)
|-
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)
|-
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)
|-
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)
|-
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.
|-
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.
|-
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.
|-
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.
|}

==Clients==
When a client is controlling a character, the following references, properties and functions will be available:

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.
|-
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.
|-
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.
|-
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.
|-
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.
|-
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.
|-
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.
|}

===Properties and Functions===
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.
|-
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.
|-
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.
|-
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.
|-
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.
|-
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.
|-
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.
|-
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.
|-
| [[BANKSELF]] || W || Opens up the client's bankbox.
|-
| [[CAST]] ''spell_id' || W || Begins casting a spell.
|-
| [[CHARLIST]] || W || Displays the client's character list screen.
|-
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.
|-
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.
|-
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.
|-
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).
|-
| [[CTAG]] || RW || Gets or sets the value of a CTAG.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.
|-
| [[TELE]] || W || Casts the teleport spell.
|-
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.
|-
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.
|-
| [[VERSION]] || W || Displays the server description to the client.
|-
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.
|-
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

Where to get Sphere

2021-01-22T14:00:46Z

Jhobean: Change broken link

{{Languages|Where_to_get_Sphere}}

There are two different sources for downloading Sphere: Pre-Releases and Automated Builds. Below is a summary of what each is to help you choose between them.

==Prerelease Builds==
Prerelease builds are periodically released when the Sphere developers feel that enough progress has been made and are relatively happy with the stability of the build (i.e. the build actually runs!). Since there is not yet a "final" build of Sphere 56b, the prereleases are the closest thing that you can get.

Visit the [https://forum.spherecommunity.net/sshare.php?srt=4 Pre-releases] website to find the latest prerelease download for Sphere.

This build is more than likely the one you want to download. ''If you are unsure, then review the [[#Which Do I Want?|Which Do I Want?]] section for more information.''

==Automated Builds==
Every night an automated process will compile a new Sphere 56b executable directly from the latest development code. If you want the latest cutting edge features that aren't available in the latest prerelease then you may want to consider using an automated build.

Visit the [https://ci.appveyor.com/project/cbnolok/sphereserver-x/history SphereServer Nightly Automated Builds] website to download all latest automated build for Sphere.

Before you rush over and download an automated build, take care of the following warnings:
* Since these builds are compiled directly from the latest development source code, it is not recommended that you use these at all on a live server unless you know exactly what you are doing and have performed thorough tests first!
* The Sphere development team will not provide any support for using these builds. If you encounter a problem then you will be completely on your own.

==Which Do I Want?==
If you're unsure of which to use the best option is to simply use the latest prerelease. Automated builds are only intended to be used by advanced users or testers, who may want to test some of the newer features before they are released.

Here is a brief comparison of the two build types:

{| border="1" cellpadding="4"
| '''[[#Prerelease Builds|Prerelease Builds]]''' || '''[[#Automated Builds|Automated Builds]]'''
|-
| Support available in the forums || No support available at all
|-
| Increased chance of stability || Decreased chance of stability
|-
| Compiled manually from a more stable code branch || Compiled automatically from the development code branch
|-
| Does not contain the very latest features and bugfixes || Contains the very latest features and bugfixes
|-
| Released periodically (sometimes months apart) || Released daily
|}

To summarise, the prerelease builds are supported and specifically released by the Sphere development team at appropriate times when it is felt that enough development work has been made for a new release to be worthwhile. Unless you urgently need an as-of-yet unreleased feature or bugfix there should be no reason for you, as an end-user, to want to download an automated build.

'''''Note:''''' ''If your only reason for choosing to use an automated Sphere build is that you don't want to wait for an official prerelease containing a new feature or bugfix then you should reconsider this decision. Whilst you may enjoy having the feature or bugfix in question, there is also an increased chance that some of the work has not been completed, or a new bug may have been introduced, which could consequently destabalise your server!''

[[Category: Setting Up Sphere]]

Characters

2021-01-17T02:20:04Z

Jhobean:

{{Languages|Characters}}

__FORCETOC__
A character can be either a player or an NPC.

==References==
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.
|-
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.
|-
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)
|-
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].
|-
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.
|-
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].
|-
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.
|-
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.
|-
| [[OWNER]] || R || Gets the character that owns this character. (RW in Experimental Build)
|-
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.
|-
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.
|-
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.
|-
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.
|-
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

==Properties and Functions==
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef.
|-
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.
|-
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.
|-
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.
|-
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the character.
|-
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.
|-
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.
|-
| [[COLOR]] || RW || Gets or sets the character's hue.
|-
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.
|-
| [[COUNT]] || R || Returns the number of items equipped to the character.
|-
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).
|-
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.
|-
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.

When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.

|-
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]
|-
| [[DEX]] || RW || Gets or sets the character's total dexterity.
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.
|-
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.
|-
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).
|-
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).
|-
| [[DIR]] || RW || Gets or setes the direction that the character is facing.
|-
| [[DISCONNECT]] || W || Disconnects the character.
|-
| [[DISMOUNT]] || W || Dismounts the character from their ride.
|-
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.
|-
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.
|-
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.
|-
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.
|-
| [[DUPE]] || W || Creates a clone of the character.
|-
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.
|-
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.
|-
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.
|-
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.
|-
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[EXP]] || RW || Gets or sets the character's experience points.
|-
| [[FACE]] ''object_uid'' || W || Turns the character to face a specified object or SRC.
|-
| [[FAME]] || RW || Gets or sets the character's fame.
|-
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.
|-
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems
|-
| [[FLAGS]] || RW || Gets or sets the character's flags.
|-
| [[FIX]] || W || Re-aligns the character's Z level to ground level.
|-
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.
|-
| [[FLIP]] || W || Rotates the character.
|-
| [[FONT]] || RW || Gets or sets the character's speech font.
|-
| [[FOOD]] || RW || Gets or sets the character's food level.
|-
| [[FORGIVE]] || W || Revokes the character's jailed status.
|-
| [[GO]] ''location'' || W || Teleports the character to the specified location.
|-
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.
|-
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]
|-
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)
|-
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].
|-
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.
|-
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).
|-
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.
|-
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].
|-
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].
|-
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.
|-
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.
|-
| [[HEIGHT]] || R || Gets the character's height.
|-
| [[HITS]] || RW || Gets or sets the character's hitpoints.
|-
| [[HOME]] || RW || Gets or sets the character's home location.
|-
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.
|-
| [[ID]] || R || Gets the character's ID.
|-
| [[INFO]] || W || Displays an information dialog about the character to SRC.
|-
| [[INT]] || RW || Gets or sets the character's total intelligence.
|-
| [[INVIS]] || W || Sets whether or not the character is invisible.
|-
| [[INVUL]] || W || Sets whether or not the character is invulnerable.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.
|-
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.
|-
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.
|-
| [[KARMA]] || RW || Gets or sets the character's karma.
|-
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.
|-
| [[KILL]] || W || Kills the character.
|-
| [[LEVEL]] || RW || Gets or sets the character's experience level.
|-
| [[LIGHT]] || RW || Gets or sets the character's personal light level.
|-
| [[LUCK]] || RW || Gets or sets the luck value for the character.
|-
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.
|-
| [[MANA]] || RW || Gets or sets the character's mana.
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.
|-
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.
|-
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.
|-
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.
|-
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.
|-
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.
|-
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.
|-
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.
|-
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.
|-
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.
|-
| [[MOUNT]] || R || Gets the UID of the character's mount.
|-
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.
|-
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).
|-
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.
|-
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.
|-
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.
|-
| [[NAME]] || RW || Gets or sets the character's name.
|-
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.
|-
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.
|-
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.
|-
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.
|-
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.
|-
| [[NPC]] || RW || Gets or sets the character's AI type.
|-
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.
|-
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.
|-
| [[OBODY]] || RW || Gets or sets the character's original body.
|-
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.
|-
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.
|-
| [[OSKIN]] || RW || Gets or sets the character's original colour.
|-
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).
|-
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).
|-
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).
|-
| [[PACK]] || W || Opens the character's backpack for SRC to view.
|-
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.
|-
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.
|-
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.
|-
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.
|-
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.
|-
| [[RANGE]] || R || Gets the combat range of the character.
|-
| [[RELEASE]] || W || Clears the character's owners.
|-
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.
|-
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.
|-
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.
|-
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.
|-
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.
|-
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.
|-
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.
|-
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.
|-
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.
|-
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.
|-
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.
|-
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.
|-
| [[SAY]] ''message'' || W || Makes the character speak a message.
|-
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message
|-
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.
|-
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.
|-
| [[SERIAL]] || R || Gets the item's unique ID in the world.
|-
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.
|-
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.
|-
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.
|-
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.
|-
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.
|-
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.
|-
| [[STR]] || RW || Gets or sets the character's total strength.
|-
| [[SUICIDE]] || W || Forces the character to commit suicide.
|-
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.
|-
| [[SUMMONTO]] || W || Teleports the character to SRC's position.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.
|-
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character.
|-
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.
|-
| [[TITLE]] || RW || Gets or sets the character's title.
|-
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.
|-
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.
|-
| [[UID]] || R || Gets the item's unique ID in the world.
|-
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.
|-
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.
|-
| [[UPDATE]] || W || Updates the state of the character to nearby clients.
|-
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.
|-
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.
|-
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.
|-
| [[WEIGHT]] || R || Gets the weight of the character.
|-
| [[WHERE]] || W || Describes the character's location to SRC.
|-
| [[Z]] || R || Gets the Z position of the character.
|}

==Triggers==
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@Attack]] || Fires when the character begins attacking another.
|-
| [[@CallGuards]] || Fires when the character calls for guards.
|-
| [[@CharAttack]] || Fires when the character is attacked by another character.
|-
| [[@CharClick]] || Fires when the character is clicked by another character.
|-
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.
|-
| [[@CharDClick]] || Fires when the character double clicks another character.
|-
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.
|-
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.
|-
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.
|-
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.
|-
| [[@CombatStart]] || Fires when adding first attacker to my list.
|-
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.
|-
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.
|-
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.
|-
| [[@Criminal]] || Fires when the character becomes a criminal.
|-
| [[@DClick]] || Fires when the object is double-clicked.
|-
| [[@Death]] || Fires when the character's hitpoints reaches zero.
|-
| [[@DeathCorpse]] || Fires when a corpse is created for the character.
|-
| [[@Destroy]] || Fires when the object is being deleted.
|-
| [[@Dismount]] || Fires when the character dismounts their ride.
|-
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.
|-
| [[@Eat]] || Fires when the character eats something.
|-
| [[@EnvironChange]] || Fires when the environment changes for the character.
|-
| [[@ExpChange]] || Fires when the character's experience points change.
|-
| [[@ExpLevelChange]] || Fires when the character's experience level changes.
|-
| [[@FameChange]] || Fires when the character's fame changes.
|-
| [[@GetHit]] || Fires when the character receives damage.
|-
| [[@Hit]] || Fires when the character hits another in combat.
|-
| [[@HitMiss]] || Fires when the character fails to hit another in combat.
|-
| [[@HitTry]] || Fires when the character tries to hit another in combat.
|-
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.
|-
| [[@HouseDesignExit]] || Fires when the character exits house design mode.
|-
| [[@Hunger]] || Fires when the character's food level decreases.
|-
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.
|-
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.
|-
| [[@ItemClick]] || Fires when the character single-clicks an item.
|-
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.
|-
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.
|-
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.
|-
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.
|-
| [[@ItemDamage]] || Fires when the character damages an item.
|-
| [[@ItemDClick]] || Fires when the character double-clicks an item.
|-
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.
|-
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.
|-
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.
|-
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.
|-
| [[@ItemEquip]] || Fires when the character equips an item.
|-
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.
|-
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.
|-
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.
|-
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.
|-
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.
|-
| [[@ItemSell]] || Fires when the character sells an item to a vendor.
|-
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.
|-
| [[@ItemStep]] || Fires when the character steps on an item.
|-
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.
|-
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.
|-
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.
|-
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.
|-
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.
|-
| [[@ItemUnEquip]] || Fires when the character unequips an item.
|-
| [[@Jailed]] || Fires when the character is sent to jail.
|-
| [[@KarmaChange]] || Fires when the character's karma changes.
|-
| [[@Kill]] || Fires when the character kills another character.
|-
| [[@Login]] || Fires when the character logs in.
|-
| [[@Logout]] || Fires when the character logs out.
|-
| [[@Mount]] || Fires when the character mounts a ride.
|-
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.
|-
| [[@MurderMark]] || Fires when the character is about to gain a kill.
|-
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.
|-
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.
|-
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.
|-
| [[@NPCActFollow]] || Fires when the NPC follows another character.
|-
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.
|-
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.
|-
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.
|-
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.
|-
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.
|-
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].
|-
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.
|-
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.
|-
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.
|-
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.
|-
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).
|-
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)
|-
| [[@PersonalSpace]] || Fires when the character is stepped on.
|-
| [[@PetDesert]] || Fires when the character deserts its owner.
|-
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.
|-
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.
|-
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@Resurrect]] || Fires when the character is being resurrected.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.
|-
| [[@TradeClose]] || Fires when a trade window is closed.
|-
| [[@TradeCreate]] || Fires when a player begins a trade with another player.
|-
| [[@UserBugReport]] || Fires when the player submits a bug report.
|-
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.
|-
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)
|-
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini
|-
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.
|-
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.
|-
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.
|-
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.
|-
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.
|-
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.
|-
| [[@UserSpecialMove]] || Fires when the player uses a special move.
|-
| [[@UserStats]] || Fires when the player opens the status window.
|-
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+
|-
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.
|-
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.
|-
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.
|}

==Players==
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.
|-
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].
|-
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.
|}

===Properties and Functions===
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.
|-
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.
|-
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.
|-
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.
|-
| [[KICK]] || W || Disconnects and blocks the player's account.
|-
| [[KILLS]] || RW || Gets the number of murders the player has committed.
|-
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.
|-
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.
|-
| [[PASSWORD]] || W || Sets or clears the player's password.
|-
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.
|-
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.
|-
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.
|-
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]
|}

==NPCs==
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:

===Properties and Functions===
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.
|-
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.
|-
| [[BYE]] || W || Ends the NPC's current action.
|-
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.
|-
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.
|-
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.
|-
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.
|-
| [[NPC]] || RW || Gets or sets the NPC's AI type.
|-
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.
|-
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.
|-
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.
|-
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)
|-
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.
|-
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.
|-
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.
|-
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.
|-
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.
|-
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)
|-
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)
|-
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)
|-
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)
|-
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)
|-
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.
|-
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.
|-
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.
|-
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.
|}

==Clients==
When a client is controlling a character, the following references, properties and functions will be available:

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.
|-
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.
|-
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.
|-
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.
|-
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.
|-
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.
|-
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.
|}

===Properties and Functions===
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.
|-
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.
|-
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.
|-
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.
|-
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.
|-
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.
|-
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.
|-
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.
|-
| [[BANKSELF]] || W || Opens up the client's bankbox.
|-
| [[CAST]] ''spell_id' || W || Begins casting a spell.
|-
| [[CHARLIST]] || W || Displays the client's character list screen.
|-
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.
|-
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.
|-
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.
|-
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).
|-
| [[CTAG]] || RW || Gets or sets the value of a CTAG.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.
|-
| [[TELE]] || W || Casts the teleport spell.
|-
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.
|-
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.
|-
| [[VERSION]] || W || Displays the server description to the client.
|-
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.
|-
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]

Characters

2021-01-16T22:05:03Z

Jhobean: Add detail of tenth of second on create field fos X

{{Languages|Characters}}

__FORCETOC__
A character can be either a player or an NPC.

==References==
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.
|-
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.
|-
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)
|-
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].
|-
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.
|-
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].
|-
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.
|-
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.
|-
| [[OWNER]] || R || Gets the character that owns this character. (RW in Experimental Build)
|-
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.
|-
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.
|-
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.
|-
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.
|-
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

==Properties and Functions==
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef.
|-
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.
|-
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.
|-
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.
|-
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the character.
|-
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.
|-
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.
|-
| [[COLOR]] || RW || Gets or sets the character's hue.
|-
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.
|-
| [[COUNT]] || R || Returns the number of items equipped to the character.
|-
| [[CREATE]] || RW || Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).
|-
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.
|-
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.

When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.

|-
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]
|-
| [[DEX]] || RW || Gets or sets the character's total dexterity.
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.
|-
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.
|-
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).
|-
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).
|-
| [[DIR]] || RW || Gets or setes the direction that the character is facing.
|-
| [[DISCONNECT]] || W || Disconnects the character.
|-
| [[DISMOUNT]] || W || Dismounts the character from their ride.
|-
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.
|-
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.
|-
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.
|-
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.
|-
| [[DUPE]] || W || Creates a clone of the character.
|-
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.
|-
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.
|-
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.
|-
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.
|-
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[EXP]] || RW || Gets or sets the character's experience points.
|-
| [[FACE]] ''object_uid'' || W || Turns the character to face a specified object or SRC.
|-
| [[FAME]] || RW || Gets or sets the character's fame.
|-
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.
|-
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems
|-
| [[FLAGS]] || RW || Gets or sets the character's flags.
|-
| [[FIX]] || W || Re-aligns the character's Z level to ground level.
|-
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.
|-
| [[FLIP]] || W || Rotates the character.
|-
| [[FONT]] || RW || Gets or sets the character's speech font.
|-
| [[FOOD]] || RW || Gets or sets the character's food level.
|-
| [[FORGIVE]] || W || Revokes the character's jailed status.
|-
| [[GO]] ''location'' || W || Teleports the character to the specified location.
|-
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.
|-
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]
|-
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)
|-
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].
|-
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.
|-
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).
|-
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.
|-
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].
|-
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].
|-
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.
|-
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.
|-
| [[HEIGHT]] || R || Gets the character's height.
|-
| [[HITS]] || RW || Gets or sets the character's hitpoints.
|-
| [[HOME]] || RW || Gets or sets the character's home location.
|-
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.
|-
| [[ID]] || R || Gets the character's ID.
|-
| [[INFO]] || W || Displays an information dialog about the character to SRC.
|-
| [[INT]] || RW || Gets or sets the character's total intelligence.
|-
| [[INVIS]] || W || Sets whether or not the character is invisible.
|-
| [[INVUL]] || W || Sets whether or not the character is invulnerable.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.
|-
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.
|-
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.
|-
| [[KARMA]] || RW || Gets or sets the character's karma.
|-
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.
|-
| [[KILL]] || W || Kills the character.
|-
| [[LEVEL]] || RW || Gets or sets the character's experience level.
|-
| [[LIGHT]] || RW || Gets or sets the character's personal light level.
|-
| [[LUCK]] || RW || Gets or sets the luck value for the character.
|-
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.
|-
| [[MANA]] || RW || Gets or sets the character's mana.
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.
|-
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.
|-
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.
|-
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.
|-
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.
|-
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.
|-
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.
|-
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.
|-
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.
|-
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.
|-
| [[MOUNT]] || R || Gets the UID of the character's mount.
|-
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.
|-
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).
|-
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.
|-
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.
|-
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.
|-
| [[NAME]] || RW || Gets or sets the character's name.
|-
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.
|-
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.
|-
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.
|-
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.
|-
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.
|-
| [[NPC]] || RW || Gets or sets the character's AI type.
|-
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.
|-
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.
|-
| [[OBODY]] || RW || Gets or sets the character's original body.
|-
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.
|-
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.
|-
| [[OSKIN]] || RW || Gets or sets the character's original colour.
|-
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).
|-
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).
|-
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).
|-
| [[PACK]] || W || Opens the character's backpack for SRC to view.
|-
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.
|-
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.
|-
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.
|-
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.
|-
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.
|-
| [[RANGE]] || R || Gets the combat range of the character.
|-
| [[RELEASE]] || W || Clears the character's owners.
|-
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.
|-
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.
|-
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.
|-
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.
|-
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.
|-
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.
|-
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.
|-
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.
|-
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.
|-
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.
|-
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.
|-
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.
|-
| [[SAY]] ''message'' || W || Makes the character speak a message.
|-
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message
|-
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.
|-
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.
|-
| [[SERIAL]] || R || Gets the item's unique ID in the world.
|-
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.
|-
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.
|-
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.
|-
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.
|-
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.
|-
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.
|-
| [[STR]] || RW || Gets or sets the character's total strength.
|-
| [[SUICIDE]] || W || Forces the character to commit suicide.
|-
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.
|-
| [[SUMMONTO]] || W || Teleports the character to SRC's position.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.
|-
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character.
|-
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.
|-
| [[TITLE]] || RW || Gets or sets the character's title.
|-
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.
|-
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.
|-
| [[UID]] || R || Gets the item's unique ID in the world.
|-
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.
|-
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.
|-
| [[UPDATE]] || W || Updates the state of the character to nearby clients.
|-
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.
|-
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.
|-
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.
|-
| [[WEIGHT]] || R || Gets the weight of the character.
|-
| [[WHERE]] || W || Describes the character's location to SRC.
|-
| [[Z]] || R || Gets the Z position of the character.
|}

==Triggers==
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@Attack]] || Fires when the character begins attacking another.
|-
| [[@CallGuards]] || Fires when the character calls for guards.
|-
| [[@CharAttack]] || Fires when the character is attacked by another character.
|-
| [[@CharClick]] || Fires when the character is clicked by another character.
|-
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.
|-
| [[@CharDClick]] || Fires when the character double clicks another character.
|-
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.
|-
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.
|-
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.
|-
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.
|-
| [[@CombatStart]] || Fires when adding first attacker to my list.
|-
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.
|-
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.
|-
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.
|-
| [[@Criminal]] || Fires when the character becomes a criminal.
|-
| [[@DClick]] || Fires when the object is double-clicked.
|-
| [[@Death]] || Fires when the character's hitpoints reaches zero.
|-
| [[@DeathCorpse]] || Fires when a corpse is created for the character.
|-
| [[@Destroy]] || Fires when the object is being deleted.
|-
| [[@Dismount]] || Fires when the character dismounts their ride.
|-
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.
|-
| [[@Eat]] || Fires when the character eats something.
|-
| [[@EnvironChange]] || Fires when the environment changes for the character.
|-
| [[@ExpChange]] || Fires when the character's experience points change.
|-
| [[@ExpLevelChange]] || Fires when the character's experience level changes.
|-
| [[@FameChange]] || Fires when the character's fame changes.
|-
| [[@GetHit]] || Fires when the character receives damage.
|-
| [[@Hit]] || Fires when the character hits another in combat.
|-
| [[@HitMiss]] || Fires when the character fails to hit another in combat.
|-
| [[@HitTry]] || Fires when the character tries to hit another in combat.
|-
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.
|-
| [[@HouseDesignExit]] || Fires when the character exits house design mode.
|-
| [[@Hunger]] || Fires when the character's food level decreases.
|-
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.
|-
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.
|-
| [[@ItemClick]] || Fires when the character single-clicks an item.
|-
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.
|-
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.
|-
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.
|-
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.
|-
| [[@ItemDamage]] || Fires when the character damages an item.
|-
| [[@ItemDClick]] || Fires when the character double-clicks an item.
|-
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.
|-
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.
|-
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.
|-
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.
|-
| [[@ItemEquip]] || Fires when the character equips an item.
|-
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.
|-
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.
|-
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.
|-
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.
|-
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.
|-
| [[@ItemSell]] || Fires when the character sells an item to a vendor.
|-
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.
|-
| [[@ItemStep]] || Fires when the character steps on an item.
|-
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.
|-
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.
|-
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.
|-
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.
|-
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.
|-
| [[@ItemUnEquip]] || Fires when the character unequips an item.
|-
| [[@Jailed]] || Fires when the character is sent to jail.
|-
| [[@KarmaChange]] || Fires when the character's karma changes.
|-
| [[@Kill]] || Fires when the character kills another character.
|-
| [[@Login]] || Fires when the character logs in.
|-
| [[@Logout]] || Fires when the character logs out.
|-
| [[@Mount]] || Fires when the character mounts a ride.
|-
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.
|-
| [[@MurderMark]] || Fires when the character is about to gain a kill.
|-
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.
|-
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.
|-
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.
|-
| [[@NPCActFollow]] || Fires when the NPC follows another character.
|-
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.
|-
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.
|-
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.
|-
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.
|-
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.
|-
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].
|-
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.
|-
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.
|-
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.
|-
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.
|-
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).
|-
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)
|-
| [[@PersonalSpace]] || Fires when the character is stepped on.
|-
| [[@PetDesert]] || Fires when the character deserts its owner.
|-
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.
|-
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.
|-
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@Resurrect]] || Fires when the character is being resurrected.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.
|-
| [[@TradeClose]] || Fires when a trade window is closed.
|-
| [[@TradeCreate]] || Fires when a player begins a trade with another player.
|-
| [[@UserBugReport]] || Fires when the player submits a bug report.
|-
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.
|-
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)
|-
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini
|-
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.
|-
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.
|-
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.
|-
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.
|-
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.
|-
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.
|-
| [[@UserSpecialMove]] || Fires when the player uses a special move.
|-
| [[@UserStats]] || Fires when the player opens the status window.
|-
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+
|-
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.
|-
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.
|-
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.
|}

==Players==
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.
|-
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].
|-
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.
|}

===Properties and Functions===
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.
|-
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.
|-
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.
|-
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.
|-
| [[KICK]] || W || Disconnects and blocks the player's account.
|-
| [[KILLS]] || RW || Gets the number of murders the player has committed.
|-
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.
|-
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.
|-
| [[PASSWORD]] || W || Sets or clears the player's password.
|-
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.
|-
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.
|-
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.
|-
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]
|}

==NPCs==
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:

===Properties and Functions===
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.
|-
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.
|-
| [[BYE]] || W || Ends the NPC's current action.
|-
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.
|-
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.
|-
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.
|-
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.
|-
| [[NPC]] || RW || Gets or sets the NPC's AI type.
|-
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.
|-
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.
|-
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.
|-
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)
|-
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.
|-
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.
|-
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.
|-
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.
|-
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.
|-
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)
|-
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)
|-
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)
|-
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)
|-
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)
|-
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.
|-
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.
|-
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.
|-
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.
|}

==Clients==
When a client is controlling a character, the following references, properties and functions will be available:

===References===
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''<REFNAME>'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''<REFNAME.KEY>'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.
|-
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.
|-
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.
|-
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.
|-
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.
|-
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.
|-
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.
|}

===Properties and Functions===
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.
|-
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.
|-
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.
|-
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.
|-
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.
|-
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.
|-
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.
|-
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.
|-
| [[BANKSELF]] || W || Opens up the client's bankbox.
|-
| [[CAST]] ''spell_id' || W || Begins casting a spell.
|-
| [[CHARLIST]] || W || Displays the client's character list screen.
|-
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.
|-
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.
|-
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.
|-
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).
|-
| [[CTAG]] || RW || Gets or sets the value of a CTAG.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.
|-
| [[TELE]] || W || Casts the teleport spell.
|-
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.
|-
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.
|-
| [[VERSION]] || W || Displays the server description to the client.
|-
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.
|-
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.
|}

[[Category: Reference Compendium]]
[[Category: Objects]]