SphereWiki - User contributions [en]

ROOMDEF

2014-01-16T21:57:08Z

Anubis:

__FORCETOC__
Within [[Regions|regions]] you can also define rooms, which are basically 'sub-regions' that exist inside the area which may represent buildings within a town or a boss room within a dungeon. Rooms are almost identical to regions, except they cannot possess triggers, events or tags.

The syntax for defining a room is as follows:

<tt>
[ROOMDEF ''defname''] 
RECT=''left, top, right, bottom, map'' 
RECT=''left, top, right, bottom, map'' 
RECT=''left, top, right, bottom, map'' 
</tt>

==Properties==
Within the room definition the following properties are also available to customise the behaviour of the area.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ANNOUNCE]] || RW || Gets or sets whether or not there will be an announcement when someone enters or exits the room.
|-
| [[ARENA]] || RW || Gets or sets whether or not the room is considered to be an arena.
|-
| [[BUILDABLE]] || RW || Gets or sets whether or not players can place buildings and ships in the room.
|-
| [[EVENTS (Property)|EVENTS]] ''regiontype_defname'' || W || Adds a region event to the region.
|-
| [[FLAGS]] || RW || Gets or sets the room's attributes.
|-
| [[GATE]] || RW || Gets or sets whether or not casting the gate travel spell is allowed in the room.
|-
| [[GROUP]] || RW || Gets or sets a group name for the room.
|-
| [[GUARDED]] || RW || Gets or sets whether or not guards can be called within the room.
|-
| [[MAGIC]] || RW || Gets or sets whether or not there is an anti-magic field in the room.
|-
| [[MARK]] || RW || Gets or sets whether or not casting the mark spell is allowed in the room.
|-
| [[NAME]] || RW || Gets or sets the name of the room.
|-
| [[NOBUILD]] || RW || Gets or sets whether or not players can place buildings in the room.
|-
| [[NODECAY]] || RW || Gets or sets whether or not items will decay in the room.
|-
| [[NOPVP]] || RW || Gets or sets whether or not PvP combat is allowed in the room.
|-
| [[P]] || RW || Gets or sets the location of the room (used when using the [[GO]] command).
|-
| [[RECALL]] || RW || Gets or sets whether or not casting the recall spell is allowed in the room.
|-
| [[RECALLIN]] || RW || Gets or sets whether or not it is possible to use the recall spell to enter the room.
|-
| [[RECALLOUT]] || RW || Gets or sets whether players can recall out of the room.
|-
| [[SAFE]] || RW || Gets or sets whether or not the room is a safe zone.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[UNDERGROUND]] || RW || Gets or sets whether or not the room is considered to be underground.
|}

==Triggers==
Within the room definition the following properties are also available to customise the behaviour of the area.

{| border="1" cellspacing="4" cellpadding="4"
| '''Trigger''' || '''Description'''
|-
| [[@Enter]] || Fires when a room is entered (56c)
|-
| [[@Exit]] || Fires when a room is exited (56c)
|-
| [[@Step]] || Fires when a step is taken inside a room (56c)
|}

==Examples==

<spherescript>
//
// A House in Minoc, from the default script pack.
//
[ROOMDEF a_house_1]
NAME=House
GROUP=Minoc
FLAGS=04000
P=2484,472,0,0
RECT=2479,463,2489,481,0
RECT=2489,471,2497,481,0
</spherescript>

<spherescript>
//
// A Secret Cave, from the default script pack.
//
[ROOMDEF a_secret_cave_1]
NAME=Secret Cave
GROUP=Hidden Valley
P=1653,2967,0,0
RECT=1648,2957,1658,2977,0
</spherescript>

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

Server

2014-01-14T23:13:01Z

Anubis: /* Properties and Functions */

{{Languages|Server}}

__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''.
|-
| [[DEF]]''.defname'' || R || Gets the value for ''defname''. Def0.defname can also be used similar to tag0 and ctag0.
|-
| [[CLIENT]]''.n'' || R || Gets the nth [[Characters#Clients|client]] on the server. (zero-based) '''Note:''' The nth client may not be an ingame player character, check <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. (zero-based)
|-
| [[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''.
|-
| [[SPAWN (Reference)|SPAWN]]''.defname'' || R || Gets the [[SPAWN|spawn group]] 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.
|-
| [[MAP]]''.map_num.''SECTOR.''sector_num command'' || RW || Executes ''command'' on sector ''sector_num'' 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.
More information : [[Serv.rtime.format]]
|-
| [[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.
|-
| [[SYSCMD]] ''cmd'' || W || Executes ''cmd'' and waits for it to finish executing. Returns <0 if an error occurred. Requires OF_FileCommands.
|-
| [[SYSSPAWN]] ''cmd'' || W || Executes ''cmd'' and does not wait for the program to finish executing. Returns <0 if an error occurred. Requires OF_FileCommands.
|-
| [[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]]

Characters

2014-01-10T23:41:04Z

Anubis: /* Properties and Functions */

{{Languages|Characters}}

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[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.
|-
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.
|-
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]
|-
| [[DEX]] || RW || Gets or sets the character's total dexterity.
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.
|-
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.
|-
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).
|-
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).
|-
| [[DIR]] || RW || Gets or setes the direction that the character is facing.
|-
| [[DISCONNECT]] || W || Disconnects the character.
|-
| [[DISMOUNT]] || W || Dismounts the character from their ride.
|-
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.
|-
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.
|-
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.
|-
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.
|-
| [[DUPE]] || W || Creates a clone of the character.
|-
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.
|-
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.
|-
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.
|-
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.
|-
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[EXP]] || RW || Gets or sets the character's experience points.
|-
| [[FACE]] ''object_uid'' || W || Turns the character to face a specified object or SRC.
|-
| [[FAME]] || RW || Gets or sets the character's fame.
|-
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.
|-
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems
|-
| [[FLAGS]] || RW || Gets or sets the character's flags.
|-
| [[FIX]] || W || Re-aligns the character's Z level to ground level.
|-
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.
|-
| [[FLIP]] || W || Rotates the character.
|-
| [[FONT]] || RW || Gets or sets the character's speech font.
|-
| [[FOOD]] || RW || Gets or sets the character's food level.
|-
| [[FORGIVE]] || W || Revokes the character's jailed status.
|-
| [[GO]] ''location'' || W || Teleports the character to the specified location.
|-
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.
|-
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]
|-
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)
|-
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].
|-
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.
|-
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).
|-
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.
|-
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].
|-
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].
|-
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.
|-
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.
|-
| [[HEIGHT]] || R || Gets the character's height.
|-
| [[HITS]] || RW || Gets or sets the character's hitpoints.
|-
| [[HOME]] || RW || Gets or sets the character's home location.
|-
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.
|-
| [[ID]] || R || Gets the character's ID.
|-
| [[INFO]] || W || Displays an information dialog about the character to SRC.
|-
| [[INT]] || RW || Gets or sets the character's total intelligence.
|-
| [[INVIS]] || W || Sets whether or not the character is invisible.
|-
| [[INVUL]] || W || Sets whether or not the character is invulnerable.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.
|-
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.
|-
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.
|-
| [[KARMA]] || RW || Gets or sets the character's karma.
|-
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.
|-
| [[KILL]] || W || Kills the character.
|-
| [[LEVEL]] || RW || Gets or sets the character's experience level.
|-
| [[LIGHT]] || RW || Gets or sets the character's personal light level.
|-
| [[LUCK]] || RW || Gets or sets the luck value for the character.
|-
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.
|-
| [[MANA]] || RW || Gets or sets the character's mana.
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.
|-
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.
|-
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.
|-
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.
|-
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.
|-
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.
|-
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.
|-
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.
|-
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.
|-
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.
|-
| [[MOUNT]] || R || Gets the UID of the character's mount.
|-
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.
|-
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).
|-
| [[MOVE]] ''direction, amount'' [[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]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[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, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.
|-
| [[STR]] || RW || Gets or sets the character's total strength.
|-
| [[SUICIDE]] || W || Forces the character to commit suicide.
|-
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.
|-
| [[SUMMONTO]] || W || Teleports the character to SRC's position.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.
|-
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character.
|-
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.
|-
| [[TITLE]] || RW || Gets or sets the character's title.
|-
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.
|-
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.
|-
| [[UID]] || R || Gets the item's unique ID in the world.
|-
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.
|-
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.
|-
| [[UPDATE]] || W || Updates the state of the character to nearby clients.
|-
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.
|-
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.
|-
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.
|-
| [[WEIGHT]] || R || Gets the weight of the character.
|-
| [[WHERE]] || W || Describes the character's location to SRC.
|-
| [[Z]] || R || Gets the Z position of the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@Attack]] || Fires when the character begins attacking another.
|-
| [[@CallGuards]] || Fires when the character calls for guards.
|-
| [[@CharAttack]] || Fires when the character is attacked by another character.
|-
| [[@CharClick]] || Fires when the character is clicked by another character.
|-
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.
|-
| [[@CharDClick]] || Fires when the character double clicks another character.
|-
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.
|-
| [[@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.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@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.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@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'''
|-
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.
|-
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.
|-
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)
|-
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.
|-
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.
|-
| [[KICK]] || W || Disconnects and blocks the player's account.
|-
| [[KILLS]] || RW || Gets the number of murders the player has committed.
|-
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.
|-
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.
|-
| [[PASSWORD]] || W || Sets or clears the player's password.
|-
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.
|-
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.
|-
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill.
|-
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]
|}

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

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

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

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

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

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

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

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

2013-10-08T22:23:18Z

Anubis: /* Properties and Functions */

{{Languages|Characters}}

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[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.
|-
| [[ID]] || R || Gets the character's ID.
|-
| [[INFO]] || W || Displays an information dialog about the character to SRC.
|-
| [[INT]] || RW || Gets or sets the character's total intelligence.
|-
| [[INVIS]] || W || Sets whether or not the character is invisible.
|-
| [[INVUL]] || W || Sets whether or not the character is invulnerable.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.
|-
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.
|-
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.
|-
| [[KARMA]] || RW || Gets or sets the character's karma.
|-
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.
|-
| [[KILL]] || W || Kills the character.
|-
| [[LEVEL]] || RW || Gets or sets the character's experience level.
|-
| [[LIGHT]] || RW || Gets or sets the character's personal light level.
|-
| [[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]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[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, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.
|-
| [[STR]] || RW || Gets or sets the character's total strength.
|-
| [[SUICIDE]] || W || Forces the character to commit suicide.
|-
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.
|-
| [[SUMMONTO]] || W || Teleports the character to SRC's position.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.
|-
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character.
|-
| [[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.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@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.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@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, 4=Can not Walk or Run)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]
|-
| [[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.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[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]]

@Success (Spell Trigger)

2013-09-06T02:04:46Z

Anubis: /* Arguments */

==Description==
This trigger fires when a character successfully casts a spell.

Fires on:
* [[SPELL|Spells]]

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The spell that was cast.
|-
| ARGN2 || I || The strength of the spell.
|-
| LOCAL.CREATEOBJECT1 || O || For field spells, overrides the item [[BASEID]] to use for the east-west direction.

For summon spells, overrides the character [[BASEID]] to summon.
|-
| LOCAL.CREATEOBJECT2 || O || For field spells, overrides the item [[BASEID]] to use for the north-south direction.
|-
| LOCAL.FIELDGAUGE || O || For field spells, overrides the default gauge of the field (1).
|-
| LOCAL.FIELDWIDTH || O || For field spells, overrides the default width of the field (7).
|-
| LOCAL.AREARADIUS || O || For Area of effect (AoE) spells, overrides the default radius of the effect (4).
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Aborts casting the spell.
|}

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

Characters

2013-07-28T01:21:16Z

Anubis: /* Properties and Functions */

{{Languages|Characters}}

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[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.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].
|-
| [[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, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[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.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@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.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@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, 4=Can not Walk or Run)
|-
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]
|-
| [[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.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[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

2013-07-21T02:06:13Z

Anubis: /* Properties and Functions */

{{Languages|Characters}}

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[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.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].
|-
| [[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, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[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.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@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.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@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, 4=Can not Walk or Run)
|-
| [[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.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[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

2013-07-21T02:04:19Z

Anubis: /* Properties and Functions */

{{Languages|Characters}}

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[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, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[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.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@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.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@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, 4=Can not Walk or Run)
|-
| [[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.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[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

2013-07-21T02:02:15Z

Anubis: /* Properties and Functions */

{{Languages|Characters}}

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[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, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[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.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@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.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@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.
|-
| [[ISINPARTY]] || R || Returns 1 if the player is in a party
|-
| [[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, 4=Can not Walk or Run)
|-
| [[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.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[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]]

@SpellEffect

2013-07-20T19:54:22Z

Anubis: /* Arguments */

==Description==
This trigger fires when an object is hit by the effects of a spell. The object may have been targeted directly or it may have been hit by an area-effect spell.

Fires on:
* [[Characters]]
* [[Items]]

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The number of the spell that has hit the object.
|-
| ARGN2 || IO || The strength of the spell.
|-
| ARGN3 || IO || A multiplier for the spell's duration or effect. '''Note:''' Only used when a character is hit by a spell.
|-
| LOCAL.DamageType || IO || Type of damage the spell causes (bitmask of dam_*)
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || For scripted spells, prevents any hardcoded behaviour from taking place.
|-
| 1 || Prevents the object from being affected by the spell.
|}

'''Note:''' For the recall and gate travel spells, returning 0 prevents the spell from proceeding and returning 1 has no effect.

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

@Hit

2013-07-20T19:42:16Z

Anubis: /* Arguments */

{{Languages|@Hit}}

==Description==
This trigger fires when a character hits someone using a combat skill.

Fires on:
* [[Characters]]

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being dealt.
|-
| LOCAL.ARROW || I || UID of the arrow used (Archery only)
|}

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

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

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

@Hit

2013-07-20T19:41:55Z

Anubis: /* References */

{{Languages|@Hit}}

==Description==
This trigger fires when a character hits someone using a combat skill.

Fires on:
* [[Characters]]

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being dealt.
|}

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

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

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

@Hit

2013-07-20T19:40:20Z

Anubis: /* References */

{{Languages|@Hit}}

==Description==
This trigger fires when a character hits someone using a combat skill.

Fires on:
* [[Characters]]

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

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

The following variables are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''In/Out''' || '''Description '''
|-
| LOCAL.ARROW || I || UID of the arrow used (Archery only)
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being dealt.
|}

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

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

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

@Hit

2013-07-20T19:38:31Z

Anubis: /* References */

{{Languages|@Hit}}

==Description==
This trigger fires when a character hits someone using a combat skill.

Fires on:
* [[Characters]]

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

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

The following variables are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description '''
|-
| LOCAL.ARROW || UID of the arrow used (Archery only)
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being dealt.
|}

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

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

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

Sectors

2013-03-30T17:36:24Z

Anubis: /* Properties and Functions */

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

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

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

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

Override TAGs

2013-03-21T00:51:51Z

Anubis: /* Item-based Override TAGs */

{{Languages|Override_TAGs}}

==Override Common Data==
Ever wondered why you can't change for example 'TDATA' values on a per-item basis? Or some default values from Sphere.ini?

The reason is simple: The majority of items, characters and situation will not need individual values there and are working fine with the default ones (either hardcoded or set in the INI or the *DEF sections), so it simply would be a waste of memory to store them again on each game object. Therefore for example a single crossbow in the world reads what items it needs as ammunition not from it's "WORLDITEM" data object, but from it's ITEMDEF (the TDATA property).

Alas, as time goes by for some stuff it showed reasonable to allow overriding the default values for a single item, character or even region. Nevertheless it still would be a waste of resources to give all crossbows an "ammunition" property what on almost all of them will read: "default". So the Sphere developers decided to store the respective individual changes in TAGs: If the TAG exists it will be used, if not, the default is used.

Common to most overrides is the syntax of the TAG's name: '''TAG.OVERRIDE.*''' - where "'''*'''" denotes the name of the respective tag. But there are also some others what were named before this naming scheme was established.

==Item-based Override TAGs==

{| border="1"
| '''TAG.ALWAYSSEND'''
| When optional flag OF_OsiMultiSight is on, all items inside a multi are not sent until entering the multi. If you want an item to be always sent, set TAG.ALWYASSEND to 1. This tag also can also go under the ITEMDEF section of an item.
|-
| '''TAG.NOSAVE'''
| If set to 1 the object will NOT be saved.
|-
| '''TAG.OVERRIDE.AMMOANIM'''
| Overrides TDATA4 for bow/crossbow type weapons.
|-
| '''TAG.OVERRIDE.AMMOANIMHUE'''
| Sets the colour of the effect when firing bow/crossbow type weapons.
|-
| '''TAG.OVERRIDE.AMMOANIMRENDER'''
| Sets the render mode of the effect when firing bow/crossbow type weapons.
|-
| '''TAG.OVERRIDE.AMMOTYPE'''
| Overrides TDATA3 for bow/crossbow type weapons.
|-
| '''TAG.OVERRIDE.DAMAGETYPE'''
| Sets the damage type for a weapon (ARGN2 in @GetHit trigger).
|-
| '''TAG.OVERRIDE.DOORSOUND_CLOSE'''
| Overrides the sound that will be played for a door when it is being closed.
|-
| '''TAG.OVERRIDE.DOORSOUND_OPEN'''
| Overrides the sound that will be played for a door when it is being opened.
|-
| '''TAG.OVERRIDE.DROPSOUND'''
| Overrides the sound that will be played when the item is dropped somewhere.
|-
| '''TAG.OVERRIDE_LIGHT'''
| Overrides TDATA3 for lights (T_LIGHT_LIT, T_LIGHT_OUT). Take notice that there is an underscore in this TAG's name.
|-
| '''TAG.OVERRIDE.MAXITEMS'''
| Overrides the maximum number of items that can be placed into a container (default: 255)
|-
| '''TAG.OVERRIDE.MAXWEIGHT'''
| Overrides the maximum total weight that can be placed into a container.
|-
| '''TAG.OVERRIDE.PORTCULUSSOUND'''
| Overrides the sound that will be played for a portcullis when it is used.
|-
| '''TAG.OVERRIDE.PRACTICEMAX.SKILL_$skillid'''
| Overrides SKILLPRACTICEMAX setting from Sphere.ini for a particular skill. $skillid is the numeric ID of the skill.
|-
| '''TAG.OVERRIDE.RANGE'''
| Overrides the RANGE property of the ITEMDEF for a weapon. If this tag exists on both the character and the weapon then the largest value will be used.
|-
| '''TAG.OVERRIDE.SHIPSPEED.PERIOD'''
| Overrides SHIPSPEED.PERIOD for a ship (the length of time it takes for the ship to move one step, in tenths of a second)
|-
| '''TAG.OVERRIDE.SHIPSPEED.TILES'''
| Overrides SHIPSPEED.TILES for a ship (the number of tiles that a ship moves in one step)
|-
| '''TAG.OVERRIDE.SKILL'''
| Overrides the SKILL property of the ITEMDEF for a weapon.
|-
| '''TAG.OVERRIDE.SPEED'''
| Overrides the SPEED for a weapon.
|-
| '''TAG.OVERRIDE.SOUND_HIT'''
| Overrides the hit sound for a weapon. Take notice that there is an underscore in this TAG's name.
|-
| '''TAG.OVERRIDE.SOUND_MISS'''
| Overrides the miss sound for a weapon. Take notice that there is an underscore in this TAG's name.
|}

==Character-based Override TAGs==

{| border="1"
| '''TAG.DEATHFLAGS'''
| Changes some death related behaviour. The list of supported flags are in sphere_defs.scp.
|-
| '''TAG.MAXPLAYERPETS'''
| Overrides the maximum number of pets that a player can stable. Default is 10.
|-
| '''TAG.NAME.ALT'''
| Sets an alternative name, useful for incognito effects.
|-
| '''TAG.NAME.HUE'''
| Changes the colour of the name displayed above a character.
|-
| '''TAG.NAME.PREFIX'''
| Sets some text to display before the character's name.
|-
| '''TAG.NAME.SUFFIX'''
| Sets some text to display after the character's name.
|-
| '''TAG.NOSKILLMSG'''
| When set to 1, character will receive the "gainradius_not_met" defmessage (sphere_msgs.scp) when skillgain is aborted due to the GAINRADIUS on a skill.
|-

| '''TAG.OVERRIDE.BREATH.DAM'''
| Overrides Damage done from fire breathing.
|-
| '''TAG.OVERRIDE.MOVERATE'''
| Overrides the MOVERATE property of the CHARDEF.
|-
| '''TAG.OVERRIDE.RANGE'''
| Overrides the RANGE property of the CHARDEF. If this tag exists on both the character and the weapon then the largest value will be used.
|-
| '''TAG.OVERRIDE.REGEN_$statid'''
| This is used as a modifier for the REGEN rate from Sphere.ini. The value is ''subtracted'' from the normal REGEN rate.
|-
| '''TAG.OVERRIDE.REGENVAL_$statid'''
| A modifier for the amount of points gained when a stat regenerates. The value is ''added'' to the normal regeneration amount.
|-
| '''TAG.OVERRIDE.ROCK'''
| Sets the ID of an item that the NPC can throw at enemies.
|-
| '''TAG.OVERRIDE.ROCK.DAM'''
| Overrides the damage done by rock throwing.
|-
| '''TAG.OVERRIDE.RUNNINGPENALTY'''
| Overrides RUNNINGPENALTY from Sphere.ini
|-
| '''TAG.OVERRIDE.SKILLCAP_$skillid'''
| Overrides skill settings from the character's SKILLCLASS. $skillid is the numeric ID of the skill.
|-
| '''TAG.OVERRIDE.SKILLSUM'''
| Overrides SKILLSUM setting from the character's SKILLCLASS.
|-
| '''TAG.OVERRIDE.SPIDERWEB
| When set to 1, NPC will be able to drop spider webs (for a giant spider, if this set to 1 then it will stop it from dropping webs)
|-
| '''TAG.OVERRIDE.STAMINALOSSATWEIGHT'''
| Overrides STAMINALOSSATWEIGHT from Sphere.ini
|-
| '''TAG.OVERRIDE.STATCAP_$statid'''
| Overrides STR/DEX/INT settings from the character's SKILLCLASS. (0=STR, 1=INT, 2=DEX)
|-
| '''TAG.OVERRIDE.STATSUM
| Overrides STATSUM setting from the character's SKILLCLASS.
|-
| '''TAG.OVERRIDE.TRAINSKILLMAX'''
| Overrides NPCTRAINMAX setting from Sphere.ini
|-
| '''TAG.OVERRIDE.TRAINSKILLMAXPERCENT'''
| Overrides NPCTRAINPERCENT setting from Sphere.ini
|-
| '''TAG.PARTY_AUTODECLINEINVITE'''
| When set to 1, character will automatically decline party invitations.
|-
| '''TAG.PARTY_CANLOOTME'''
| When set to 1, party members will be allow to loot this character without it being counted as a criminal action (linked to the option in the party menu).
|-
| '''TAG.VENDORMARKUP'''
| This value is added to the markup percentage that vendors apply to their buy and sell prices. Since the default markup is 15%, this means that a vendor will sell something worth 100gp at 115gp and buy it back for 85gp. If you set this tag to -15 the markup will be cancelled out to 0%, or you can raise/lower it if you want your vendor to sell things at a higher/lower price.
|}

==Region-based Override TAGs==

{| border="1"
| '''TAG.OVERRIDE.GUARDS'''
| Specifies the character that will be summoned when guards are called in the region, overriding the <tt>guards {c_h_guard 1 c_h_guard_f 1}</tt> defname in sphere_defs.scp
|-
| '''TAG.VENDORMARKUP'''
| This value is added to the markup percentage that vendors apply to their buy and sell prices. Since the default markup is 15%, this means that a vendor will sell something worth 100gp at 115gp and buy it back for 85gp. If you set this tag to -15 the markup will be cancelled out to 0%, or you can raise/lower it if you want your vendor to sell things at a higher/lower price. If the vendor has this tag set directly on them then this region TAG will not be used.
|}

[[Category: Articles]]

EFFECT

2013-03-18T22:01:58Z

Anubis: /* Effect Types */

=Usage=
'''EFFECT type, item_id, speed, loop, explode, colour(hue), rendermode'''

=Description=
Type is a number 0-3 from the table below
Item_id is the base id (under 4000) of the item or animation(first id of the animation loop usually) used for the effect
Speed is a number determining the speed of the animation and the travel speed if it's a projectile, with 1 being the slowest and higher numbers being faster
Loop specifies the time the animation will play, 16 is a good default. (This is NOT frames of animation, as a high speed results in more frames per given loop setting)
Explode is a boolean defining whether the projectile should make an explosion animation when reaching the character

=Effect Types=
{| border="1" cellspacing="4" cellpadding="4"
| '''Effect Number''' || '''Short''' || '''Long Description'''
|-
| 0 || Standard flying object || The object will follow its target until it hits, and then explode if that flag is set||
|-
| 1 || Lightning effect || This is the only way to achieve the lightning effect in-game ||
|-
| 2 || Ground-based effect || This effect will stay at a particular point on the map until it expires. As a result, it will appear lower than a type 3 effect. This is the only way to get an effect onto an item.||
|-
| 3 ||Character-based effect || This effect will follow the character as he moves, the way a flamestrike does when the spell is cast. The bottom of the effect is somewhere around the character's knees.
|-
| 4 ||Flash effect || (New 6+ (needs verification)) Clients Only) Provides a screen-wide effect. All other parameters besides Item Id is ignored. Item Id controls the flash type:

{| border="1" cellspacing="4" cellpadding="4"
| '''Item Id''' || '''Effect''' || '''Description'''
|-
| 0 || Fade to Black (Slow) || Fades the screen to black before returning to normal similar to the death effect found on some client versions
|-
| 1 || Fade to White (Slow) || Fades the screen slowly to complete white followed by a return to normal
|-
| 2 || Fade to white (Fast) || Fades the screen quickly to complete white followed by a return to normal (lightning flash type effect)
|-
| 3 || Fade to White then Black (Slow) || Fades to complete white then to black. Behaves as if effect 1 is played immediately followed by effect 0.
|-
| 4 || Fade to Black (Fast) || Fades the screen quickly to complete black followed by a return to normal
|}

|}

Server

2013-03-17T23:06:59Z

Anubis: /* References */

{{Languages|Server}}

__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''.
|-
| [[DEF]]''.defname'' || R || Gets the value for ''defname''. Def0.defname can also be used similar to tag0 and ctag0.
|-
| [[CLIENT]]''.n'' || R || Gets the nth [[Characters#Clients|client]] on the server. (zero-based) '''Note:''' The nth client may not be an ingame player character, check <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. (zero-based)
|-
| [[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''.
|-
| [[SPAWN (Reference)|SPAWN]]''.defname'' || R || Gets the [[SPAWN|spawn group]] 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.
|-
| [[MAP]]''.map_num.''SECTOR.''sector_num command'' || RW || Executes ''command'' on sector ''sector_num'' 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]]

ATTACKER

2013-03-06T17:50:35Z

Anubis: /* Properties and Functions */

{{Languages|ATTACKER}}
__FORCETOC__
==Properties and Functions==
Here is a list of all attacker 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.

This parameters must use with [[#Properties and Functions|ATTACKER]]. For examples, please go [[#Examples|Examples]].

{| border="1" cellspacing="4" cellpadding="4"
| '''ATTACKER'''''.key'' || '''Read/Write''' || '''Description'''
|-
| || R || Gets the number of opponents who have damaged the character.
|-
| ''n'' || R || Gets the UID of the nth opponent who has damaged the character. (zero-based)
|-
| [[CLEAR]] || R || Clears the attacker list
|-
| [[LAST]] || R || Gets the UID of the opponent who most recently damaged the character.
|-
| [[MAX]] || R || Gets the UID of the opponent who has dealt the most damage to the character.
|-
| ''n''.[[DAMAGE]] || R || Gets the amount of damage that the nth opponent has dealt to the character. (zero-based)
|-
| ''n''.[[ELAPSED]] || R || Gets the length of time since the nth opponent has damaged the character, in seconds. (zero-based)
|-
| ''n''.[[UID]] || R || Gets the UID of the nth opponent who has damaged the character. (zero-based)
|}

==Examples==
The following examples are about [[#Properties_and_Functions|attacker]].

'''ATTACKER'''
----
<spherescript>
[Events e_example]
On=@Death
SERV.LOG Number Of Attacker: <attacker>
</spherescript>

You will see ''number of attacker'' output to the console.

'''ATTACKER'''''.n'''''[.UID]'''
----
<spherescript>
[Events e_example]
On=@Death
SERV.LOG First Attacker: <uid.<attacker.0>.name>
SERV.LOG Fourth Attacker: <uid.<attacker.3.uid>.name>
</spherescript>

You will see ''first and fourth attackers'' output to the concole.

OR

<spherescript>
[Events e_example]
On=@Death
for 0 <eval <ATTACKER>-1>
SERV.LOG <eval <DLOCAL._FOR>+1>. Attacker: <uid.<attacker.<dlocal._for>>.name>
endfor
</spherescript>

You will see ''all attackers'' output to the console.

'''ATTACKER.LAST'''
----
<spherescript>
[Events e_example]
On=@Death
SERV.LOG Last Attacker: <uid.<attacker.last>.name>
</spherescript>

You will see ''last attacker'' output to the console.

'''ATTACKER.MAX'''
----
<spherescript>
[Events e_example]
On=@Death
SERV.LOG Max Attacker: <uid.<attacker.max>.name>
</spherescript>

You will see ''the attacker who dealt the most damage to the character'' output to the console.

'''ATTACKER'''''.n'''''.DAMAGE'''
----
<spherescript>
[Events e_example]
On=@Death
SERV.LOG Damage from first player: <attacker.0.damage>
</spherescript>

You will see ''amount of damage which first attacker has dealt'' output to the console.

'''ATTACKER'''''.n'''''.ELAPSED'''
----
<spherescript>
[Events e_example]
On=@Death
SERV.LOG Attack time of the first player: <attacker.0.elapsed>
</spherescript>

You will see ''the length of time since the first opponent has damaged'' output to the console.

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

@RegionResourceFound

2013-03-03T02:57:50Z

Anubis: Created page with "==Description== This trigger fires when a resource is being gathered. (Equivalent trigger @ResourceFound on Regions) Fires on: * Characters ==Refere..."

==Description==
This trigger fires when a resource is being gathered. (Equivalent trigger [[@ResourceFound]] on [[Regions]])

Fires on:
* [[Characters|Characters]]

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|worldgem bit]] that represents the resource in the world.
|-
| [[I]] || The [[REGIONRESOURCE|region resource]] being gathered.
|-
| [[SRC]] || The [[Characters|character]] gathering the resource.
|}

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Sets the amount of resource to zero, preventing it from being gathered.
|}

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

Characters

2013-03-03T02:53:10Z

Anubis: /* Triggers */

{{Languages|Characters}}

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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.
|-
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[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, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.
|-
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)
|-
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)
|-
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.
|-
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.
|-
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).
|-
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.
|-
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.
|-
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.
|-
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.
|-
| [[STAM]] || RW || Gets or sets the character's stamina.
|-
| [[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.
|-
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@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.
|-
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@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, 4=Can not Walk or Run)
|-
| [[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.
|-
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.
|-
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.
|-
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.
|-
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.
|-
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.
|-
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.
|-
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.
|-
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.
|-
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.
|-
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.
|-
| [[GOTARG]] || W || Teleports the client to their targeted item.
|-
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.
|-
| [[INFO]] || W || Displays an information dialog to the client for an object they target.
|-
| [[INFORMATION]] || W || Displays server information to the client.
|-
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].
|-
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.
|-
| [[LINK]] || W || Allows the client to target two objects to link them together.
|-
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.
|-
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.
|-
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.
|-
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.
|-
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.
|-
| [[PAGE]] || W || Displays the GM page menu to the client.
|-
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.
|-
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.
|-
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.
|-
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.
|-
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.
|-
| [[RESEND]] || W || Forces a full refresh of the client's screen.
|-
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.
|-
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)
|-
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.
|-
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.
|-
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.
|-
| [[SELF]] || W || Forces the client to target itself.
|-
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.
|-
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.
|-
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.
|-
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.
|-
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.
|-
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.
|-
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.
|-
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.
|-
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.
|-
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.
|-
| [[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]]

Regions

2013-03-03T02:49:14Z

Anubis: /* Triggers */

{{Languages|Regions}}

__FORCETOC__
Areas in the world, such as dungeons and cities are defined by regions. Accessing regions in scripts can be accomplished using the REGION reference from a [[Characters|character]], [[Items|item]] or [[Map Points|map point]] object, or the AREA.region_id reference from the [[Server|server]] object. The following tables detail the various properties of the region object 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'''
|-
| [[REGION]] || R || For regions linked to a multi, gets the region that contains the multi region. Only valid for reading values.
|}

==Properties and Functions==
Here is a list of all region 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. Properties from the [[AREADEF|region definition]] can also be accessed from the region object. If an attempt is made to execute (not read) a command that does not exist on the region or its definition, then the command will be called on all sectors that touch the region area.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ALLCLIENTS]] ''command'' || W || Executes ''command'' on all clients inside the region boundaries.
|-
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the region that start with the given prefix.
|-
| [[CLIENTS]] || R || Gets the total number of clients that are inside the sectors that touch the region.
|-
| [[DEFNAME]] || R || Gets the region's defname.
|-
| [[EVENTS (Property)|EVENTS]] ''+/-regiontype_defname'' || RW || Gets a list of attached region events, or adds or removes a region event to or from the region.
|-
| [[ISEVENT]]''.regiontype_defname'' || R || Returns 1 if the region has a specified region event attached.
|-
| [[MAP]] || R || Gets the map that the region exists on.
|-
| [[RECT]] || R || Gets the number of rectangles that this region is made from.
|-
| [[RECT]]''.n'' || R || Gets the nth rectangle that this region is made from.
|-
| [[RESOURCES]] ''+/-regiontype_defname'' || RW || Gets a list of attached region events, or adds or removes a region event to or from the region.
|-
| [[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 region.
|-
| [[TAGLIST]] || W || Outputs a list of the region's TAGs.
|-
| [[TYPE]] || R || If the region is linked to a multi, returns the multi's [[BASEID]] property.
|-
| [[UID]] || R || Gets the region's unique ID in the world.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@CliPeriodic]] || Fires multiple times approximately every 30 seconds, for each client in the region.
|-
| [[@Enter]] || Fires when a character enters the region.
|-
| [[@Exit]] || Fires when a character exits the region.
|-
| [[@RegPeriodic]] || Fires once approximately every 30 seconds, as long as there is at least one client in the region.
|-
| [[@ResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@ResourceTest]] || Fires once for every resource listed in a REGIONTYPE, to check if the player (SRC) can get it. It is called only if the player meets the SKILLMAKE requirements for the item set in REAP.
|-
| [[@Step]] || Fires whenever a character takes a step within the region.
|}

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

Regions

2013-03-03T02:48:40Z

Anubis: /* Triggers */

{{Languages|Regions}}

__FORCETOC__
Areas in the world, such as dungeons and cities are defined by regions. Accessing regions in scripts can be accomplished using the REGION reference from a [[Characters|character]], [[Items|item]] or [[Map Points|map point]] object, or the AREA.region_id reference from the [[Server|server]] object. The following tables detail the various properties of the region object 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'''
|-
| [[REGION]] || R || For regions linked to a multi, gets the region that contains the multi region. Only valid for reading values.
|}

==Properties and Functions==
Here is a list of all region 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. Properties from the [[AREADEF|region definition]] can also be accessed from the region object. If an attempt is made to execute (not read) a command that does not exist on the region or its definition, then the command will be called on all sectors that touch the region area.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ALLCLIENTS]] ''command'' || W || Executes ''command'' on all clients inside the region boundaries.
|-
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the region that start with the given prefix.
|-
| [[CLIENTS]] || R || Gets the total number of clients that are inside the sectors that touch the region.
|-
| [[DEFNAME]] || R || Gets the region's defname.
|-
| [[EVENTS (Property)|EVENTS]] ''+/-regiontype_defname'' || RW || Gets a list of attached region events, or adds or removes a region event to or from the region.
|-
| [[ISEVENT]]''.regiontype_defname'' || R || Returns 1 if the region has a specified region event attached.
|-
| [[MAP]] || R || Gets the map that the region exists on.
|-
| [[RECT]] || R || Gets the number of rectangles that this region is made from.
|-
| [[RECT]]''.n'' || R || Gets the nth rectangle that this region is made from.
|-
| [[RESOURCES]] ''+/-regiontype_defname'' || RW || Gets a list of attached region events, or adds or removes a region event to or from the region.
|-
| [[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 region.
|-
| [[TAGLIST]] || W || Outputs a list of the region's TAGs.
|-
| [[TYPE]] || R || If the region is linked to a multi, returns the multi's [[BASEID]] property.
|-
| [[UID]] || R || Gets the region's unique ID in the world.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@CliPeriodic]] || Fires multiple times approximately every 30 seconds, for each client in the region.
|-
| [[@Enter]] || Fires when a character enters the region.
|-
| [[@Exit]] || Fires when a character exits the region.
|-
| [[@RegPeriodic]] || Fires once approximately every 30 seconds, as long as there is at least one client in the region.
|-
| [[@ResourceFound]] || Fires after a resource has been selected and the resource bit has been created.
|-
| [[@ResourceTest]] || Fires once for every resource listed in a REGIONTYPE, to check if the player (SRC)
can get it. It is called only if the player meets the SKILLMAKE requirements for the item set in REAP.
|-
| [[@Step]] || Fires whenever a character takes a step within the region.
|}

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