SphereWiki - User contributions [en]

Characters

2010-02-18T13:15:48Z

Dzhony: /* Triggers */

__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'''
|-
| [[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.
|-
| [[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.
|-
| [[REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.
|-
| [[ROOM]] || R || Gets the [[Rooms|room]] that the character is in.
|-
| [[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]] || R || Gets the number of opponents who have damaged the character.
|-
| [[ATTACKER]]''.LAST'' || R || Gets the UID of the opponent who most recently damaged the character.
|-
| [[ATTACKER]]''.MAX'' || R || Gets the UID of the opponent who has dealt the most damage to the character.
|-
| [[ATTACKER]]''.n.DAM'' || R || Gets the amount of damage that the nth opponent has dealt to the character. (zero-based)
|-
| [[ATTACKER]]''.n.ELAPSED'' || R || Gets the length of time since the nth opponent has damaged the characer, in seconds. (zero-based)
|-
| [[ATTACKER]]''.n.UID'' || R || Gets the UID of the nth opponent who has damaged the characer. (zero-based)
|-
| [[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.
|-
| [[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.
|-
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.
|-
| [[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.
|-
| [[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.
|-
| [[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.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[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.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the character is in a party.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[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.
|-
| [[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.
|-
| [[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.
|-
| [[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'' [[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.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.
|-
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.
|-
| [[RESPOISON]] || RW || Gets or sets the character's 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, skill_amount'' || R || Returns 1 if the character has the specified amount of skill.
|-
| [[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 t he 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.
|-
| [[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 object.
|-
| [[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.
|-
| [[@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.
|-
| [[@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.
|-
| [[@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).
|-
| [[@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.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@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.
|-
| [[@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.
|-
| [[@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.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts 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.
|-
| [[@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'''
|-
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the player has,
|-
| [[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.
|-
| [[LUCK]] || RW || Gets or sets the luck value for the player.
|-
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the player can have.
|-
| [[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.
|-
| [[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)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR, DEX or INT.
|-
| [[TITHING]] || RW || Gets or sets the number of tithing points the player has.
|}

==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.
|-
| [[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'' || W || Displays an arrow on the client's screen that points to the specified world coordinates.
|-
| [[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.
|-
| [[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.
|-
| [[TARGTXT]] || 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

2010-02-18T13:15:01Z

Dzhony: /* Triggers */ - added missing @HitTry trigger

__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'''
|-
| [[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.
|-
| [[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.
|-
| [[REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.
|-
| [[ROOM]] || R || Gets the [[Rooms|room]] that the character is in.
|-
| [[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]] || R || Gets the number of opponents who have damaged the character.
|-
| [[ATTACKER]]''.LAST'' || R || Gets the UID of the opponent who most recently damaged the character.
|-
| [[ATTACKER]]''.MAX'' || R || Gets the UID of the opponent who has dealt the most damage to the character.
|-
| [[ATTACKER]]''.n.DAM'' || R || Gets the amount of damage that the nth opponent has dealt to the character. (zero-based)
|-
| [[ATTACKER]]''.n.ELAPSED'' || R || Gets the length of time since the nth opponent has damaged the characer, in seconds. (zero-based)
|-
| [[ATTACKER]]''.n.UID'' || R || Gets the UID of the nth opponent who has damaged the characer. (zero-based)
|-
| [[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.
|-
| [[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.
|-
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.
|-
| [[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.
|-
| [[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.
|-
| [[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.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[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.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the character is in a party.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[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.
|-
| [[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.
|-
| [[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.
|-
| [[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'' [[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.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.
|-
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.
|-
| [[RESPOISON]] || RW || Gets or sets the character's 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, skill_amount'' || R || Returns 1 if the character has the specified amount of skill.
|-
| [[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 t he 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.
|-
| [[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 object.
|-
| [[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.
|-
| [[@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.
|-
| [[@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 before 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.
|-
| [[@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).
|-
| [[@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.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@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.
|-
| [[@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.
|-
| [[@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.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts 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.
|-
| [[@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'''
|-
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the player has,
|-
| [[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.
|-
| [[LUCK]] || RW || Gets or sets the luck value for the player.
|-
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the player can have.
|-
| [[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.
|-
| [[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)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR, DEX or INT.
|-
| [[TITHING]] || RW || Gets or sets the number of tithing points the player has.
|}

==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.
|-
| [[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'' || W || Displays an arrow on the client's screen that points to the specified world coordinates.
|-
| [[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.
|-
| [[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.
|-
| [[TARGTXT]] || 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]]

Special Items

2009-11-28T13:12:26Z

Dzhony: /* Properties and Functions */ t_map coordinates in MORE1 and MORE2

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'' [[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.
|-
| [[QUALITY]] || RW || Gets or sets the quality of the item.
|}

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

Server

2009-06-27T12:30:03Z

Dzhony: /* References */

__FORCETOC__
The server object is a global object that can be accessed from any script, by using the SERV reference. The following tables detail the various properties of the server in SphereServer:

==References==
References return pointers to other objects (e.g. the CHAR.n reference allows you to access the characters that are attached to the account). 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'''
|-
| [[ACCOUNT]]''.n'' || R || Gets the nth [[Accounts|account]] on the server. (zero-based)
|-
| [[ACCOUNT]]''.name'' || R || Gets the [[Accounts|account]] with the specified name.
|-
| [[AREA]]''.defname'' || R || Gets the [[Regions|region]] with the specified defname.
|-
| [[CHARDEF (Reference)|CHARDEF]]''.defname'' || R || Gets the [[CHARDEF|character definition]] for ''defname''.
|-
| [[CLIENT]]''.n'' || R || Gets the nth [[Characters#Clients|client]] on the server. '''Note:''' The nth client may not be an ingame player character, <CLIENT.n> first as it returns 1 for ingame clients and 0 for non-player clients.
|-
| [[GMPAGE]]''.n'' || R || Gets the nth [[GM Pages|GM page]] on the server.
|-
| [[GUILDSTONES]]''.n'' || R || Gets the nth [[Special Items#Guild.2FTown_Stones|guild stone]] on the server. (zero-based)
|-
| [[ITEMDEF (Reference)|ITEMDEF]]''.defname'' || R || Gets the [[ITEMDEF|item definition]] for ''defname''.
|-
| [[LASTNEWCHAR]] || R || Gets the last [[Characters|character]] created on the server.
|-
| [[LASTNEWITEM]] || R || Gets the last [[Items|item]] created on the server.
|-
| [[MAP]]''(x, y, map)'' [[MAP]]''(x, y, z, map)'' || R || Gets the [[Map Points|map point]] for a specified location.
|-
| [[REGIONRESOURCE (Reference)|REGIONRESOURCE]]''.defname'' || R || Gets the [[REGIONRESOURCE|region resource definition]] for ''defname''.
|-
| [[REGIONTYPE (Reference)|REGIONTYPE]]''.defname'' || R || Gets the [[REGIONTYPE|region type definition]] for ''defname''.
|-
| [[ROOM (Reference)|ROOM]]''.defname'' || R || Gets the [[Rooms|room]] with the specified defname.
|-
| [[SKILL (Reference)|SKILL]]''.defname'' || R || Gets the [[SKILL|skill definition]] for ''defname''.
|-
| [[SKILLCLASS (Reference)|SKILLCLASS]]''.defname'' || R || Gets the [[SKILLCLASS|skillclass]] for ''defname''.
|-
| [[SPELL (Reference)|SPELL]]''.defname'' || R || Gets the [[SPELL|spell definition]] for ''defname''.
|-
| [[SPELL (Reference)|SPELL]]''.n'' || R || Gets the nth [[SPELL|spell definition]], ordered by skill requirements (1-based, ascending).
|-
| [[TOWNSTONES]]''.n'' || R || Gets the nth [[Special Items#Guild.2FTown_Stones|town stone]] on the server. (zero-based)
|}

==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. Settings from Sphere.ini can also be accessed from the server object, but they are not listed in this table.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACCOUNT]] ADD ''name password'' || W || Creates an account with the specified name and password.
|-
| [[ACCOUNT]] ADDMD5 ''name hash'' || W || Creates an account with the specified name and MD5 password hash.
|-
| [[ACCOUNT]] BLOCKED ''days command'' || W || Executes ''command'' on all accounts that have been unused for ''days'' days and are currently blocked.
|-
| [[ACCOUNT]] JAILED ''days command'' || W || Executes ''command'' on all accounts that have been unused for ''days'' days and are currently jailed.
|-
| [[ACCOUNT]] UNUSED ''days command'' || W || Executes ''command'' on all accounts that have been unused for ''days'' days.
|-
| [[ACCOUNT]] UPDATE || W || Saves the accounts to file.
|-
| [[ACCOUNT]] ''name command'' || W || Executes ''command'' on the account with the specified name.
|-
| [[ACCOUNTS]] || RW || Gets or sets the number of accounts on the server.
|-
| [[ALLCLIENTS]] ''command'' || W || Executes ''command'' on all online player characters.
|-
| [[B]] ''message'' || W || Broadcasts ''message'' to all clients on the server.
|-
| [[BLOCKIP]] ''address, time'' || W || Blocks an IP address for ''time'', in tenths of a second (-1 = permanent).
|-
| [[CHARS]] || RW || Gets or sets the number of characters on the server.
|-
| [[CLEARLISTS]] ''mask'' || W || Removes all LISTs whose name contains ''mask''.
|-
| [[CLEARVARS]] ''prefix'' || W || Removes all VARs that start with the given prefix.
|-
| [[CLIENTS]] || R || Gets the total number of connected clients.
|-
| [[CONSOLE]] ''command'' || W || Executes ''command'' as if it had been typed directly into the server console.
|-
| [[EXPORT]] ''file, flags, distance'' || W || Exports all objects within ''distance'' tiles of SRC to a file. (Flags: 1 = Items, 2 = Characters, 3 = Both)
|-
| [[GARBAGE]] || W || Forces an immediate garbage collection (checks for invalid objects and fixes them if possible, or else removes them).
|-
| [[GMPAGES]] || R || Returns the total number of GM pages.
|-
| [[GUILDS]] || R || Returns the total number of guild ''and'' town stones.
|-
| [[GUILDSTONES]].COUNT || R || Returns the total number of guild stones on the server.
|-
| [[HEARALL]] || RW || Gets or sets whether player speech is logged to server console and log file.
|-
| [[IMPORT]] ''file, flags, distance'' || W || Imports previously exported items that were within ''distance'' tiles. (Flags: 1 = Items, 2 = Characters, 3 = Both)
|-
| [[INFORMATION]] || W || Displays server information to SRC.
|-
| [[ITEMS]] || RW || Gets or sets the number of items on the server.
|-
| [[LOAD]] ''file'' || W || Loads a script file.
|-
| [[LOG]] ''message'' || W || Logs ''message'' to server console and logs.
|-
| [[LOOKUPSKILL]] ''skill_name'' || R || Looks up a skill name or key, and returns its skill number.
|-
| [[MAP]]''.map_num.ALLSECTORS command'' || W || Executes ''command'' on all sectors of a map.
|-
| [[MAPLIST]]''.map_num'' || R || Returns 1 if ''map_num'' is a valid map number.
|-
| [[MAPLIST]]''.map_num''.BOUND.X || R || Returns the maximum X coordinate for a map.
|-
| [[MAPLIST]]''.map_num''.BOUND.Y || R || Returns the maximum Y coordinate for a map.
|-
| [[MAPLIST]]''.map_num''.CENTER.X || R || Returns the central X coordinate of a map.
|-
| [[MAPLIST]]''.map_num''.CENTER.Y || R || Returns the central Y coordinate of a map.
|-
| [[MAPLIST]]''.map_num''.SECTOR.COLS || R || Returns the number of sector columns on a map.
|-
| [[MAPLIST]]''.map_num''.SECTOR.QTY || R || Returns the number of sectors on a map.
|-
| [[MAPLIST]]''.map_num''.SECTOR.ROWs || R || Returns the number of sector rows on a map.
|-
| [[MAPLIST]]''.map_num''.SECTOR.SIZE || R || Returns the size of the sectors on a map.
|-
| [[MEM]] || R || Returns the total amount of memory being used, in kilobytes.
|-
| [[PRINTLISTS]] ''LOG'' || W || Displays a list of all LISTs to SRC, or the server console.
|-
| [[REGEN]]0 || RW || Gets or sets the length of time it takes for characters to regenerate 1 health point, in seconds.
|-
| [[REGEN]]1 || RW || Gets or sets the length of time it takes for characters to regenerate 1 mana point, in seconds.
|-
| [[REGEN]]2 || RW || Gets or sets the length of time it takes for characters to regenerate 1 stamina point, in seconds.
|-
| [[REGEN]]3 || RW || Gets or sets the length of time it takes for characters to lose 1 food point, in seconds.
|-
| [[RESPAWN]] || W || Respawns all dead NPCs (not corpses) in the world.
|-
| [[RESTOCK]] || W || Restocks all NPCs in the world.
|-
| [[RESTORE]] ''file, account_name, character_name'' || W || Restores a player character from a backup save.
|-
| [[RESYNC]] || W || Checks all script files for any changes made since they were last loaded.
|-
| [[RTICKS]] || R || Returns the real-world time, as a timestamp.
|-
| [[RTICKS]].FORMAT ''timestamp, format'' || R || Returns the real-world timestamp as a formatted datetime string.
|-
| [[RTICKS]].FROMTIME ''year, month, day, hour, minutes, seconds'' || R || Returns the specified real-world time, as a timestamp.
|-
| [[RTIME]] || R || Returns the real-world time, as a formatted string.
|-
| [[RTIME]].FORMAT ''format'' || R || Returns the real-world time, as a formatted string.
|-
| [[SAVE]] ''force_immediate'' || W || Begins a world save. If background saving is enabled, ''force_immediate'' can be used to force a foreground save.
|-
| [[SAVECOUNT]] || R || Returns the number of world saves that have taken place.
|-
| [[SAVESTATICS]] || W || Performs a statics save.
|-
| [[SHRINKMEM]] || W || Temporarily reduces memory usage.
|-
| [[SHUTDOWN]] ''time'' || W || Schedules a server shutdown in ''time'' minutes.
|-
| [[TIME]] || R || Returns the total server uptime, in tenths of a second.
|-
| [[TOWNSTONES]].COUNT || R || Returns the total number of town stones on the server.
|-
| [[UNBLOCKIP]] ''address'' || W || Unblocks a previously blocked IP address.
|-
| [[VARLIST]] ''LOG'' || W || Displays a list of all VARs to SRC, or the server console.
|-
| [[VERSION]] || R || Returns the SphereServer version.
|}

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

Items

2009-06-25T14:37:10Z

Dzhony: /* References */ ContP

__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.
|-
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to.
|-
| [[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.
|-
| [[CONTP]] || RW || Gets or sets the position of the object, placed inside a container.
|-
| [[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 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.
|-
| [[AMOUNT]] || RW || Gets the amount of this items this item represent (e.g. a pile of gold).
|-
| [[ATTR]] || RW || Gets or sets the item's attribute flags.
|-
| [[BOUNCE]] || W || Moves the item to SRC's backpack.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the item.
|-
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the item.
|-
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the item, with flags to modify what tests take place.
|-
| [[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]] ''amount, type, source'' || W || Inflicts damage upon the item.
|-
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.
|-
| [[DECAY]] ''time'' || W || Sets the decay timer for the item.
|-
| [[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 either SRC, 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's Z level to ground level.
|-
| [[FLIP]] || W || Rotates the item.
|-
| [[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.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.
|-
| [[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.
|-
| [[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.
|-
| [[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'' [[MOVE]] ''x y'' || W || Moves the object relative to its current position.
|-
| [[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.
|-
| [[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.
|-
| [[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 object.
|-
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.
|-
| [[TYPE]] || RW || Gets or sets the item type.
|-
| [[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.
|-
| [[@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]]

Items

2009-06-25T14:36:02Z

Dzhony: /* References */

__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.
|-
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to.
|-
| [[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.
|-
| [[CONTP]] || RW || Gets or sets the [[Position|position]] of the item inside a container that the object is inside.
|-
| [[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 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.
|-
| [[AMOUNT]] || RW || Gets the amount of this items this item represent (e.g. a pile of gold).
|-
| [[ATTR]] || RW || Gets or sets the item's attribute flags.
|-
| [[BOUNCE]] || W || Moves the item to SRC's backpack.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the item.
|-
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the item.
|-
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the item, with flags to modify what tests take place.
|-
| [[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]] ''amount, type, source'' || W || Inflicts damage upon the item.
|-
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.
|-
| [[DECAY]] ''time'' || W || Sets the decay timer for the item.
|-
| [[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 either SRC, 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's Z level to ground level.
|-
| [[FLIP]] || W || Rotates the item.
|-
| [[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.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.
|-
| [[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.
|-
| [[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.
|-
| [[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'' [[MOVE]] ''x y'' || W || Moves the object relative to its current position.
|-
| [[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.
|-
| [[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.
|-
| [[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 object.
|-
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.
|-
| [[TYPE]] || RW || Gets or sets the item type.
|-
| [[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.
|-
| [[@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]]