SphereWiki - User contributions [en]

Es:Chapter 1

2012-03-02T01:01:57Z

MrSugarCube: Reverted edits by CorineEwing (Talk) to last version by Sirius

{{Idiomas|Chapter_1}}

==Números==

La primera cosa de la que te das cuenta cuando echas un vistazo a los scripts de SPHERE, es la amplia variedad de formas que hay para escribir los números. Dado que los números son realmente importantes para un programador de SPHERE, esta será la primera lección de todas. Una vez acabes la lección, espero que tengas un entendimiento general del sistema hexadecimal, decimal y binario, y la forma que tiene SPHERE de identificar cada uno. También sabrás cómo generar números aleatorios ya sea de una serie o de una lista de elecciónes.

La primera cosa que necesitas comprender es que la forma en la que contamos no es la unica forma de contar. Nuestro sistema de numeración contiene diez dígitos (0, 1, 2, 3, 4, 5, 6, 7, 8, y 9). Pero, al decimo número, tenemos que añadir una columna al número y reestablecer la primera columna a cero (1, 2, 3, 4, 5, 6, 7, 8, 9, 10). Esa es la razón por la que nuestros sistema de numeración funciona en la forma en la que lo hace.

En el sistema decimal, sin darnos cuenta, escribimos los numeros para que se entiendan como potencias de diez. Por ejemplo, si tomamos el número 17282 (que me acabo de inventar), y lo dividimos, obtenemos esto:

{| border="1"
| Potencia de diez || 4 || 3 || 2 || 1 || 0
|-
| Diez a esa potencia || 10000 || 1000 || 100 || 10 || 1
|-
| Dígito || 1 || 7 || 2 || 8 || 2
|}

Para conseguir el número 17282 a partir de esto, sólo tenemos que tomar la potencia de diez de la fila superior, multiplicarlo por el número de la fila inferior, y sumar todos los resultados. Así pues obtendremos 10000 + 7000 + 200 + 80 + 2. Evidentemente, esto es mucho más simple, y ni siquiera nos damos cuenta de que lo estamos haciendo. Probablemente estés pensando "Vaaaaale, ¿qué se piensa Taran que está consiguiendo con esto?" Pues bien, no somos tan especiales como para que nuestro sistema de cuentas sea el único con el que se cuenta.

Por ejemplo, hay otro sistema numérico que es utilizado caso exclusivamente por los ordenadores. Éste solo contiene dos dígitos (1 y 0) y es por ello por lo que es llamado 'Sistema binario' (que significa 'dos'). Los números binarios tienen un aspecto parecido a este: 101011101101, y los verás con frecuencia en anuncios de ordenadores y electrónica (Muchas veces se los muestra saliendo de un grabador de CDs en anuncios de televisión). A los dígitos del sistema binario se les llama BITs (Abreviatura del inglés 'BInary digiT' - Dígito Binario). Los números en binario son prácitamente imposibles de traducir directamente al decimal, así que hay que echar algunas cuentas.

El binario funciona de la misma manera que el decimal: sumando potencias de un número. En el caso del binario, dado que sólo hay dos dígitos en todo el sistema, ese número naturalmente es 'dos'. Aquí hay algunas potencias de dos. Algunas personas pueden encontrar estos números algo familiares.

{| border="1"
| Potencia de 2 || Número Binario || Número Decimal
|-
| 0 || 1 || 1
|-
| 1 || 10 || 2
|-
| 2 || 100 || 4
|-
| 3 || 1000 || 8
|-
| 4 || 10000 || 16
|-
| 5 || 100000 || 32
|-
| 6 || 1000000 || 64
|-
| 7 || 10000000 || 128
|-
| 8 || 100000000 || 256
|-
| 9 || 1000000000 || 512
|-
| 10 || 10000000000 || 1024
|}

Absurdo, ¿verdad? :)

¡Necesitamos un sistema mejor! La razon por la que obtenemos unos resultados tan extraños es que 10 no forma parte de las potencias de dos. Necesitamos encontrar un sistema cuya base SEA una potencia de dos. El sistema que con más frecuencia se usa es base-16, or hexadecimal. Estoy seguro de que si has seguido los foros de SPHERE, habrás visto la palabra hex danzando por ahí. No, no es una palabrota ni un hechizo malvado, es la forma rápida de decir "hexadecimal".

{| border="1"
| Binario || Decimal || Hexadecimal
|-
| 1 || 1 || 1
|-
| 10 || 2 || 2
|-
| 11 || 3 || 3
|-
| 100 || 4 || 4
|-
| 101 || 5 || 5
|-
| 110 || 6 || 6
|-
| 111 || 7 || 7
|-
| 1000 || 8 || 8
|-
| 1001 || 9 || 9
|-
| 1010 || 10 || A
|-
| 1011 || 11 || B
|-
| 1100 || 12 || C
|-
| 1101 || 13 || D
|-
| 1110 || 14 || E
|-
| 1111 || 15 || F
|-
| 10000 || 16 || 10
|}

¿Has visto como funciona? Hay seis dígitos adicionales añadidos al final del sistema numérico, y representados por las letras del alfabeto (los dígitos se nos acabaron en el 9 y de alguna manera había que representar los que faltaban, ¿no?)

Ahora, durante la programacion de SPHERE, prácticamente NUNCA vas a manejar números binarios que NO sean potencias de dos, y si lo haces, simplemente puedes usar una calculadora científica para hacerte una idea del resultado. Pero es múchísimo más fácil en hexadecimal.

(Esta es la última tabla, ¡¡Lo prometo!!)
{| border="1"
| Binario || Hexadecimal
|-
| 000000001 (1) || 01
|-
| 000000010 (2) || 02
|-
| 000000100 (3) || 04
|-
| 000001000 (4) || 08
|-
| 000010000 (5) || 010
|-
| 000100000 (6) || 020
|-
| 001000000 (7) || 040
|-
| 010000000 (8) || 080
|-
| 100000000 (9) || 0100
|}

Como puedes ver, hay una especie de patrón en la columna hexadecimal. Puedes estar pensando que hay algún tipo de patrón con los números 1, 2, 4 y 8. Y estarias pensando acertadamente. otro detalle del que quizás te des cuenta es del de los ceros que hay delante de cada número hexadecimal (como 0100, en vez de simplemente 100). En SPHERE, ese 0 le dice al script "¡Oiga!, ¡este número está en HEX!" ya que 0100 y 100 son números muy distintos (0100 en hexadecimal equivale a 256 en decimal; 100 en decimal equivale, evidentemente, a 100 en decimal y por otro lado 100 en binario equivale a 4 en decimal; así que un poco si que cambia la cosa ¿verdad?).

Digamos que, para un script de SPHERE, necesitas establecer el decimotercer bit de un número (FLAGS, por ejemplo), podrías escribir algo parecido a:

'''SRC.FLAGS |= 8192'''

Pero, ¿realmente te acordarías de que 8192 es 2 elevado a la 13ª potencia? Lo dudo mucho. Lo que sería más fácil, es recorrer toda la lista de cabeza hasta llegar al 13er numero. (¡Recuerda!, ¡¡COMIENZA EN CERO cuando estés contando potencias!!)

{| border="1"
| 01 || 02 || 04 || 08 || 010 || 020 || 040 || 080 || 0100 || 0200 || 0400 || 0800 || 01000 || 02000
|-
| 2^0 || 2^1 || 2^2 || 2^3 || 2^4 || 2^5 || 2^6 || 2^7 || 2^8 || 2^9 || 2^10 || 2^11 || 2^12 || 2^13
|}

Y ahí tienes. Las primeras 14 potencias de dos traducidas a hexademical.

'''SRC.FLAGS |= 02000'''

El código de arriba es idéntico al ejemplo anterior. 8192 (decimal) es IGUAL que 02000 (hexadecimal)

'''8192 = 02000'''

Podrías decir, "¿Y cómo sé yo que no te estás inventando todo esto?" Pues bien, nuestros maravillosos amigos de Microsoft nos han provisto de una herramienta genial para convertir de decimal a binario, hexadecimal y octal (OTRO sistema de numeración que no se utiliza en SPHERE, así que pasaremos de él). Se llama 'Calculadora'. Puedes encontrarla en el botón 'Inicio', yendo a 'Programas', y luego 'Accesorios'. La calculadora debería estar sentada por alli viéndose preciosa. Una vez abierta la calculadora, Ve al menu 'Ver' y pulsa sobre 'Científica'. El display debería cambiar drásticamente. Para convertir los numeros entre los distintos sistemas numéricos, simplemente pincha en el sistema original (Dec), escribe un número (8192), y pulsa en el botón del otro sistema (Hex). Auto-mágicamente, Windows convertirá tu número decimal en hexadecimal. Pégale un cero delante, y SPHERE estará encantado de comerse ese suculento plato.

Probablmente esta sea la cosa más dificil para entender de la programación en SPHERE. Afortunadamente, debido a la siguiente sección, no tendrás que estar tratando con numeros tan feos todo el rato. Si después de todo este tochaco, aún sigues leyendo esto, ¡Sé que lo vas a hacer genial!

¡Vamos a por algo de programación en SPHERE!

==Defnames (Definiendo nombres)==

Aqui hay una lista de numeros bastante feos que puedes encontrarte mientras programas SPHERE.

{| border="1"
| El número feote || Lo que significa...
|-
| 0EED || ID de una moneda de oro
|-
| 0DDA || ID de un portal rojo
|-
| 1650,1440 || Coordenadas de Britain
|-
| 021 || Código numérico para el color rojo
|-
| 04000 || El color transparente
|-
| 04000EFAD || Identificador de un objeto
|-
| 4 || El PLEVEL de un GM
|-
| 2048 (or 0800) || Marca (FLAG) del hechizo Incógnito
|-
| 010 (or 16) || Tipo de memoria para los agresores
|}

Evidentemente, nadie va a querer acordarse de esos números. En los viejos tiempos, antes de SPHERE y TUS (pre-.50 SPHERE) e incluso en las nieblas de Grayworld (pre-.41 TUS), todos teníamos que acordarnos de esos números. Conozco todos los números que he dicho (excepto el identificador, que me lo acabo de inventar), y una docena más, lo digo de verdad. Afortunadamente para todos aquellos que no quereis sentaros a empollar números, SPHERE ha desarrollado un sistema por el cual las cosas pueden ser identificadas por nombres en lugar de números.

De hecho, las cosas aún se identifican por números. Son los números los que se identifican por nombres.

En el juego, escribe .add 0EED y pulsa intro. Aparecerá un cursor de objetivo y crearás una moneda de oro.

Ahora escribe .add i_gold y pulsa intro. Crearás la misma moneda de oro.

¿Cual de los dos es más facil de recordar, 0EED ó i_gold?. yo diría que i_gold gana de lejos. Pero, ¿cómo ocurre esta magia? Echémosle un vistazo al script que define una moneda de oro. No te molestes en entenderlo. ¡Explicaré los scripts de objetos en la siguente sección! Podemos encontrar este script en el archivo sphere_item_resources.scp.

<tt>[ITEMDEF 0eed] 
//gold coin 
DEFNAME=i_gold 
TYPE=T_GOLD 
VALUE=1 
CATEGORY=Provisiones - Miscelanea 
SUBSECTION=Monedas 
DESCRIPTION=Moneda de oro 
DUPELIST=0eee,0eef </tt>

He remarcado la linea que realmente importa para los propósitos de esta lección en rojo. Fíjate en ese 0EED en la primera línea del script, e ignora el resto. Ese 0EED es el auténtico número de ese objeto. Estudiaremos más números de objetos en la siguiente sección

Pero la verdadera línea que quiero que te fijes es en DEFNAME=i_gold. Ahí es donde el script le dice al servidor, "Quiero que el objeto 0EED sea identidifcado con el texto i_gold a partir de ahora." Si has intentado acceder a i_gold antes de que el servidor lea este script (Un poco más acerca de reordenar scripts en el [[Capítulo 2]]), escupirá uno de sus errores, pero ahora ya sabe a que te refieres, y por lo tanto lo puedes usar en juego o en otros scripts.

Deberias darle SIEMPRE a los objetos que crees un DEFNAME que se ajuste a ese objeto. Normalmente el nombre por defecto se definirá en el mismo identficador [ITEMDEF] (de nuevo, más de esto luego), pero si insistes en usar números, asegurate de darle un nombre fácil de recordar (Y no gulash_dorada para definir a una espada vikinga). Esto lo hará mas facil de recordar que los números.

Otra manera de definir un DEFNAME es usando la cabecera [DEFNAME] en un script. He aquí un ejemplo:

<tt>[DEFNAME colores] 
color_azul 02 
color_rojo 021 
color_verde 041 </tt>

Encontraras un script parecido en spheredefs.scp, otro de los archivos que debería ser cargado antes que ningún otro.

Aquí está el análisis, línea por línea:

'''Línea 1''': Aquí es donde defines el tipo de script y el nombre por defecto (Sí, colores es el nombre por defecto de este script). Esto le dice al servido qué tipo de script se debe esperar entre este y el siguiente identificador (Los identificadores son las lineas encerradas en corchetes). Todos los identificadores tienen este formato. El primer parámetro es el tipo de script. Éstos son variados, y los explicaré conforme vayamos llegando. El segundo puede ser tanto un ID como un nombre por defecto. En la mayoría de las veces, en los scripts que escribas, será un nombre. La única excepción que se me ocurre es que utilices un programa para parchear el cliente y añadir nuevos tipos de objeto.

'''Lines 2-4''': Éstas definen cada DEFNAME. Viene a decir que color_azul equivale a 02, color_rojo equivale a 021, y color_verde equivale a 041. Puedes utilizar todos los espacios que quieras entre el nombre y el valor. Las definiciones contenidas en spheredefs.scp están entre las más útiles que puedas llegar a encontrarte, dado que evitan que tengas que escribir números tan feos como los vistos en la sección anterior. Estas incluyen cosas como nombres para marcas (flags), atributos de objetos, música en MIDI o MP3, tipos de memoria, y otras muchas cosas. Échale un ojo al archivo para ver qué es lo que este te ofrece.

Esto es lo que hay que saber sobre DEFNAMEs. Ya veremos un poco más conforme vayamos cubriendo otros tipos de scripts.

Aprendamos algo acerca de objetos.

==ITEMDEF (Definiendo Objetos)==
O, cómo hacer una montaña de un grano de arena, al estilo SPHERE.

La mayoría de la gente crea scritps de objetos de una forma mucho más dificil de lo que realmente es. Para propósitos de este tutorial, y dado que hay uno más avanzado para luego, sólamente veremos lo más básico de un script de objetos, línea a línea. Usaremos el script de la moneda de oro de la lección anterior.

Helo aquí, ¡Coloreado convenientente para disfrute de tus ojos!

<spherescript>[ITEMDEF 0EED]
//moneda de oro
DEFNAME=i_gold
TYPE=T_GOLD
VALUE=1
CATEGORY=Provisiones - Miscelanea
SUBSECTION=Monedas
DESCRIPTION=Moneda de oro
DUPELIST=0EEE,0EEF</spherescript>

Esto es lo más simple en scripts de objetos, ya que no tiene ningún comportamiento más allá de la pura existencia. Repasaré linea por linea, describiéndote que hace cada una, y cómo afecta al resultado final.

'''Línea 1''': [ITEMDEF 0EED]

La primera línea de un script de objetos es probablemente la más importante. Básicamente esta linea le dice al servidor "Oiga, ¡esto es un objeto y quiero que se llame 0EED!" El servidor, entonces mira uno de los archivos del cliente (Especificamente art.idx), Identifica si es o no es un objeto Build-in. Creo que todos los objetos por debajo de 04500 están definidos como objetos built-in, así que no definas nunca un objeto en ese rango. Escribiendo esta línea, le dices al servidor que lo siguiente es un script de objet. También defines 0EED como objeto válido, ¡Lo cual ayuda bastante cuando intentes darle oro a tus jugadores!

'''N.T.: Dejo el resto del artículo pendiente para otra ocasión u otra persona. Disculpad las molestias, seguiré mañana.'''

'''Línea 2''': // moneda de oro

This is the SPHERE version of comment. C programmers will recognize the format immediately. If you type // on any line of code, everything beyond that is ignored by the script reader. This can be on a line by itself, or at the end of a line to explain what the specific line does. In all cases, it won't affect your program, just make it easier to read.

'''Línea 3''': DEFNAME=i_gold

You should know by now what this does! If you don't, go back and read the previous lesson! It tells the server that i_gold and 0eed mean the same thing. In item scripts, all parameters are defined in that format:

variable=value

You will see later on, when we get into scripting, how that format will help you more than you would believe. Items have a good number of variables that you can define, including:

* DEFNAME
* ID
* TYPE
* VALUE
* RESOURCES
Other variables depend on the value of the TYPE. Which leads us right into...

'''Line 4''': TYPE=t_gold

The first thing you might say is "What the heck is t_gold?" Well it's a DEFNAME. Actually it's a number. And that number is 72. If you want to check me on this, look in spheredefs.scp, it's there! Writing TYPE=72 would have the exact same effect.

There are, currently, 183 built-in item types. These are hardcoded item types that contain predefined actions for an item. If an item has no type, when you click it, you get the "You cannot think of a way to use that item" message. There is a complete list of types, and how to set them up, here . All you need to know for now is that setting the type of this item to t_gold has no effect other than to make the item act like a gold coin (i.e. you can buy stuff with it!) Setting another item to type t_gold would probably make the server think that you can buy stuff with that item too. I've never tried this. It might be an interesting way to have unique currencies...

'''Line 5''': VALUE=1

This defines how much the item costs when purchased, in gold. Of course, this is one gold piece, which is worth, well, one gold piece. So the value of the item is one.

'''Lines 6-8''': CATEGORY, SUBSECTION, DESCRIPTION

These are lines used only by SPHERE's GM tool, Axis, which actually saves you a lot of work by typing ".add i_gold" for you. More importantly, it types ".add 01737" and things like that for you, for items that were not important enough to get their own separate DEFNAME.

'''Line 9''': DUPEITEM

It would be a ton of work for the SPHERE team to define all 8000 items that came with the game, especially when many of them are the same. (For an example of this, use the .xflip command on a door or sign. It cycles through all of the DUPEITEMs for that the item being flipped.) The numbers listed here are item numbers, which probably have not been defined yet. Here is the script for item 0eee:

<spherescript>[ITEMDEF 0EEE]
//gold coins
DUPEITEM=0EED
CATEGORY=Provisions - Miscellaneous
SUBSECTION=Coins
DESCRIPTION=Gold Coins</spherescript>

As you can see, there is only one parameter for this whole item. It reiterates the DUPEITEM and sends the server looking to our 0eed (or i_gold) item for more information, such as TYPE and VALUE. DUPEITEM only exists to save typing. You probably won't use it.

==CHARDEF==
Or, what it takes to make a naked man who can stand around and say "Huh?"

NPCs... They make the world go around. They are what makes UO a unique multiplayer game. The monsters and NPCs you create make your server unique from any other. This section of chapter one will cover how to create a simple naked man who walks around and says little more than "Huh?" (or "Stop thief!" if you tell him to!).

First of all, we'll look at the script for a simple naked man. I'm pulling this out of spherechar_human.scp.

<spherescript>[CHARDEF 0190]
DEFNAME=c_man
Name=Man
ICON=i_pet_MAN
CAN=MT_EQUIP|MT_WALK|MT_RUN|MT_USEHANDS
RESOURCES=i_flesh_head, i_flesh_torso, i_flesh_right_arm, i_flesh_left_arm
FOODTYPE=15 t_food, t_fruit
DESIRES=i_gold,e_notoriety
AVERSIONS=t_TRAP,t_eerie_stuff
SHELTER=r_house
BLOODCOLOR=0

TSPEECH=spk_human_prime
TSPEECH=spk_human_default
TEVENTS=e_Human_HearUnk
DESCRIPTION=Man
SUBSECTION=Miscellaneous
CATEGORY=Civilized</spherescript>

As you can see, it doesn't look a lot different than the item scripts we examined in the previous section. There are a lot of variables set that are the same, including DEFNAME, DESCRIPTION, and the other Axis variables.

But, there are a lot of new things here that we will again go over, one line at a time! And it's longer this time! Let the good times roll! (Sorry if you're not American.. All my American clichés are probably growing irritating!)

'''Line 1''': [CHARDEF 0190]

Surprise surprise! It's an identifier, telling the server that we are going to be defined a character between this and the next [identifier]. And we also tell it that our character, or NPC, will have the ID 0190. The server knows that this ID is one of the built-in IDs. In fact, it's the ID of a naked man. You also know that 0190 is hexadecimal is 400 in decimal right? :) Well why didn't you know that! Oh I'm just kidding, you don't need to know things like that.

'''Line 2''': DEFNAME=c_man

Nothing new here. c_man is now the same as 0190. Most character DEFNAMEs will begin with C and then an underscore (c_) like you see above.

'''Line 3''': Name=Man

Oh oh! Something new! Items come with default names, built in to the server. Characters don't. So we have to assign him a name. We can give him any name we want, but since this isn't a specific man, we just give him a name telling us what he is. In this case "Man".

'''Line 4''': ICON=i_pet_man

It took me a while to figure this one out. ICON defines what little picture you see when you're using the Tracking skill and all those little miniature creatures appear in the window. Those are actually items, all the i_pet items. To find out what the i_pet item for your creature should be, create him in the game using .addnpc, then use the .shrink command on him. The ID of the item that he becomes is your i_pet item.

'''Line 5''': CAN=mt_*

(In case you don't know, * means "anything" for those who use Linux.)

This is one of the most important lines of your character script, next to the ID we give him in the first line. First, because it allows us to tell the game what our NPC can do and what he can't do. There are only a few mt_* items, all of which are defined in spheredefs.scp. For the purpose of the lesson, I am going to copy them here. (The purple comments are mine.)

<spherescript>MT_NONMOVER 0 // We can't move at all
MT_GHOST 01 // We can walk through doors and such, like a ghost
MT_SWIM 02 // I can swim! (Water elementals, dolphins, etc)
MT_WALK 04 // I can move. Set this if you want your creature to move.
MT_FLY 010 // Moves through (supposed to be over) trees
MT_FIRE_IMMUNE 020 // Immune to damage by fire. Setting this on a player is bad. :)
MT_EQUIP 00100 // Can equip things
MT_USEHANDS 00200 // Can use his hands to carry things (or open doors)
MT_MALE 0 // Is a male
MT_FEMALE 00800 // Is a female
MT_NONHUM 01000 // Non-human. I'm not sure what this does.
MT_RUN 02000 // Can move really fast!</spherescript>

According to this chart, we can see that if we don't give a creature a CAN flag, it will be an MT_MALE and an MT_NONMOVER (the two zeros). You can see from the example that by putting a | (found by pressing shift+backslash) between two CAN flags, we can give him more than one. In this case, we allow our man to equip things, walk, run, and use his hands. (An interesting fact is, even creatures that don't have hands can be set to use their hands, thus allowing them to carry light sources. Fire elementals do this. That's how they glow.)

'''Line 6''': RESOURCES

Resources is a very morbid name for this setting. Especially for a person. These are the items that you get whenever you chop up this creature's corpse. Scary eh? :)

'''Line 7-10''': FOODTYPE, DESIRES, AVERSIONS

'''FOODTYPE''': Defines what kind of food the npc will eat and if NPC_AI_FOOD is on it'll make the npc look for this food + grass when he's hunger.

'''DESIRES''': Defines what kind of items will the npc be interested in, if NPC_AI_EXTRA is on it'll show what items the npc will loot of players corpses or walk towards when it's on the ground.

'''AVERSIONS''': No idea, but I think it tells the npc what sort of NPCs he'll try to fight, for example: I have a horse with e_horse as an event, and an imp without any events, if the npc has AVERSIONS=e_horse it'll prefer to fight the horse.

'''Line 11''': BLOODCOLOR

Ever wanted to make your players have green blood? This is where you do it! A color number or a color defname will work fine. (Try to learn the numbers for common colors, it makes it so much easier.)

The rest of it: TSPEECH and TEVENTS

We're going to cover these in sections of their own. They are probably the most complex topics in scripting! (How many times do you suppose I'm going to say that before it's actually true?)

''Some other things:''

On 56B we have some other fields like MOVERATE,RESLEVEL,RESDISPDNID and RESDISPDNHUE. They sound some difficult and strange thing but they aren't. Here's the explanation for them:

'''MOVERATE''': This setting (that can only be writed at the npc chardef) controls how fast the npc moves. The smaller the value, the faster the npc is. For example, if I have a horse chardef with default moverate (100) and another with moverate=60, the one with 60 will walk and run a lot faster than the other horse. This is great for making really difficult monsters to kill.

'''RESLEVEL''': This tells sphere what version of uo this monster is from, for example, a Wanderer of the Void will have RESLEVEL=3 (3=AOS) (see sphere_defs.scp for a complete list), so only accounts with RESDISP 3 or bigger can see this monster as he really is.

''NOTE'': If you set a lower value for RESLEVEL, if the player doesn't have this npc anim he'll crash.

'''RESDISPDNID''': As you probably have seen, I used a lot of "as he really" is, exactly because of this setting, this tells the client what monster will the player see instead of the correct one. For example, this Wanderer of the Void will show as Wanderer of the Void for those who has ACCOUNT.RESDISP=3 or bigger, but for those who has smaller values it'll show as a c_spectre (if you so define).

'''RESDISPDNHUE''': This defines what color will the player see the monster if the RESDISPDNID id is shown to him (have an account.resdisp lower than the reslevel of this char)

Here's an example for those new settings:

<spherescript>[CHARDEF 310]
DEFNAME=c_Wailing_Banshee
NAME=Wailing Banshee
SOUND=snd_monster_zombie1
ICON=i_pet_wailingbanshee
DAM=11,16
RESDISPDNID=c_spectre
RESLEVEL=3
RESDISPDNHUE=01
ARMOR=20
CAN=MT_WALK|MT_FLY
DESIRES=i_gold,e_notoriety,e_horses,c_man,c_woman,t_corpse
CATEGORY=New Monsters
SUBSECTION=AOS
DESCRIPTION=Wailing Banshee

ON=@Create
NPC = brain_monster
FAME = {100 3000}
KARMA = {-5000 -6999}
STR = {126 166}
INT = {86 115}
DEX = {41 75}
MAGICRESISTANCE = {75.0 95.0}
TACTICS = {45.0 75.0}
WRESTLING = {50.0 70.0}

ON=@NpcRestock
ITEM = i_gold, {50 100}
ITEM = i_reag_daemon_bone, {2 6}</spherescript>

And there you have it. A simple character script and some new things. Read the chapter that is all about making NPCs later in the tutorial.

==TEMPLATE==
Or, how to put great laggy quantities of items into one unlaggy container.

You've all seen it. Those shards out there that don't use TEMPLATEs. When you kill, say, a dragon, on those shards, and go to loot him, you find that rather than neatly organized containers, there are 100 potions scattered about the loot window. Not only that, but all your magical weapons are buried neatly beneath them!

How do we solve this problem? Well, SPHERE has given us the handy tool of TEMPLATEs. These allow you to define a container item, AND the items inside of it, AT THE SAME TIME. Isn't that neat? I thought so too, when I first figured out what they were. Let's do our traditional take-apart-the-script section. I'll place a nice TEMPLATE from the file spheretemp_loot.scp.

<tt>[TEMPLATE 101505] 
DEFNAME=backpack_poor 
CATEGORY=Item Templates 
SUBSECTION=Loot Templates 
DESCRIPTION=Poor Backpack 
CONTAINER=i_backpack 
ITEM={ random_food 1 0 3 },{ 1 3 } 
ITEM={ random_bottle 1 0 8 } 
ITEM={ random_light 1 0 8 } 
ITEM={ random_male_tops 1 0 4 } 
COLOR=colors_all 
ITEM={ random_male_pants 1 0 4 } 
COLOR=colors_all 
ITEM=POOR_GOLD_PILE </tt>

Wow, that looks confusing. But don't worry, by the time we're done, you'll know exactly what it means!

[TEMPLATE 101505]: First of all, we look at the header for our template. An interesting thing about templates is that the item name cannot be a DEFNAME like all other scripts. It must be a ridiculously high number like 101505.

DEFNAME=backpack_poor: Of course, SPHERE developers are not entirely evil, and have provided us with the ability to give these scary numbers a DEFNAME for easier access. You tell me, which would you rather type? ".add 101505" or ".add backpack_poor"? I thought so.

CATEGORY, SUBSECTION, DESCRIPTION: Axis crap. Optional. See the previous sections for a description of what these do.

CONTAINER=i_backpack: Ahh, now we're getting down to the meat of this thing. This specifies the holding container that all other items in this template will be in. When you add the item in game, you will see this container. In this case, it's a backpack. Simple enough. This can be any valid item with a TYPE of t_container or t_container_locked.

ITEM={ random_food 1 0 3},{1 3} Well, that's certainly cryptic. I think we need to break this line down even further.

But first, we're going to cover RANDOM SELECTORS! Sounds like fun doesn't it? Nah, it doesn't sound fun to me either, but it's absolutely necessary to a good shard.

Basically, they are an easy way to get different numbers with one command. What fun would a shard be where you killed a dragon and got a Platemail of Magic Stuff and a Super Duper Sword of Power every single time? Everyone would be running around with them. What we need is some variety!

There are two types of random selectors: weighted random and ranged random. Weighted random makes a statement like this: "Ok, 1 out of 10 times pick Number A, 3 out of 10 times pick Number B, and 6 out of 10 times pick number C". Ranged random makes a statement like this: "Pick any number between the two numbers I give you".

Our example actually has an example of both ranged random and weighted random. We'll cover them in the order they appear:

{ random_food 1 0 3}

This is a weighted random selector. The way to interpret these is to take the numbers that appear between the parentheses and divide them into sets of two:

random_food 1 
0 3

Add up the second numbers in both sets, and we get 4. This tells SPHERE, "Ok, 1 out of four times, I want you to pick random_food, and 3 out of four times, I want you to pick zero." You can even have random sets within random sets, but then it just gets confusing.

{ { random_food 1 0 3} 1 random_clothing 1}

Can you figure it out?

random_clothing 1
{ random_food 1 0 3} 1

2 is our magic number in this case. One out of two times, SPHERE will pick random_clothing, and one out of two times, SPHERE will pick our previous random selector, which will then select one of its own options. If you're confused at this point, don't worry. This is extremely rare, and we'll see in a moment how templates help us to solve this problem.

I did mention, though, that there is another type of random selector, and you can probably see what it is:

{1 3}

NOTE: Spacing here is important. There must be ZERO spaces between the { and the first number, or the } and the last number. It will behave strangely otherwise.

This tells SPHERE "Pick a number between 1 and 3, inclusive". Inclusive means that SPHERE can pick 1, 3, or any number in between. In this case, the range is rather limited. SPHERE will give you a 1, 2 or 3 here. Ranged random selectors are actually more often used inside of weighted random selectors.

{ {1 3} 3 {4 9} 1}

"One out of four times, pick a number between 4 and 9. Three out of four times, pick a number between 1 and 3."

And with that out of the way, we're going to analyze the actual line of the script from above. The Piece What the Line does ITEM=
This tells the script "Ok, we're going to add an item to this container. Anything after the = tells the script exactly what it is we're adding and in what amounts. You could easily say ITEM=i_platemail_chest, or something like that, without the mysterious { } sections, but the reason templates are interesting is because they can vary greatly.

{ random_food 1 0 3}

This is the item you will be creating. As we can see from our weighted random selector lesson, 1 out of 4 times, it will be random_food, and 3 out of 4 times, it will be zero. If an ITEM is zero, nothing will be created this time. Basically this is saying "There will be a one in four chance of getting random_food in this container." What is random_food you ask? Well, it happens to be another TEMPLATE, defined in spheretemplate.scp, I believe.

{1 3} This is the amount of the item that will be created. You should recognize this as a ranged random selector. This tells SPHERE to put between 1 and 3 of this item into the container. Of course, if the item is zero as selected above, this has no effect since one nothing and three nothings are still nothing.

So basically, that is a template script. You then fill it with as many items as you want. You may also notice the following construction:

ITEM=i_sword_long,R11

This is a shorthand way of writing this:

ITEM={ i_sword_long 1 0 10 }

R11 means "one out of 11 chance of finding this item". And you can add an amount selector to the end of that as well, which makes it look long and scary:

ITEM=i_sword_long,R11,{4 5}

But why would you want 4 or 5 long swords in one item? That would be bizzare. :)

And that's about it for templates. Congratulations, you're finished with chapter 1. Now you should be able to understand the examples to follow on the next section. You may also have some questions which are addressed in the common questions area. If you have a question which is not addressed there, perhaps it is too advanced of a topic for chapter 1. I assure you almost every aspect of SPHERE scripting will be covered in later chapters.

''(A template example by Belgar)''

<tt>[TEMPLATE tm_necromancer] 
CONTAINER=i_bag 
ITEM=random_necro_scroll 
ITEM=random_necro_scroll 
ITEM=random_necro_reagent, {5 12} 
ITEM=random_reagent, {5 12} 
ITEM=random_necro_reagent, {5 12} </tt>

==Examples==
Or, um. Well I guess there really isn't another way to say "Examples".

This shall be my attempt to create the most basic new items available. You will see things in these examples that are NOT mentioned in the tutorials. The major factor will be ON=@Create, which is the primary topic of Chapter 2. Just know for now that things you can change in game (color, etc) must go under ON=@Create.

'''Example 1''': A Red Sword

<tt>[ITEMDEF i_sword_red] 
ID=i_sword_viking 
TYPE=t_weapon_sword 
NAME=The Red Sword 
CATEGORY=Weapons 
SUBSECTION=New Swords 
DESCRIPTION=Red Sword 

ON=@Create
:COLOR=colors_red // This is a comment. Comments are ignored by SPHERE. </tt>

Wait, what is this weird // thing we've got going here? That's called a comment. It's completely ignored by SPHERE, so you can write whatever you want to the end of the line after //. You cannot have multi-line comments in SPHERE unless you use a new //, so don't even try it. SPHERE will give funky errors and then you'll have fun finding them.

'''Example 2''': A blue ettin

<tt>[CHARDEF c_ettin_blue] 
ID=02 // You could just as easily use c_ettin here. 
NAME=My Blue Ettin 
 
 
ON=@Create 
:COLOR=02 // This is a dark blue color. It's often used for Counselor robes. Remember it. </tt>

'''Example 3''': A template from the file, since I'm too lazy to write one myself

<tt>[TEMPLATE 101521] 
DEFNAME=goodie_meager_1 
CATEGORY=Item Templates 
SUBSECTION=Loot Templates 
DESCRIPTION=Meager Goodie 1 
ITEM={ meager_gold_pile 1 backpack_meager 1 pouch_meager 1 } 
ITEM={ random_boots 1 0 4 } 
ITEM={ random_gorget 1 0 4 } 
ITEM={ random_staff 1 0 4 } 
ITEM={ random_necklace 1 0 4 } 
ITEM={ i_cape 1 0 9 } 
COLOR=colors_all </tt>

You may notice something new here (especially since I highlighted it in red), and yes, it is legal. Any lines between ITEM= lines will affect the previously created item. The COLOR= line here affects the ITEM created by the line

ITEM={ i_cape 1 0 9 }

Remember, the best way to learn this type of scripts is to read the scripts provided for you in files like sphereitem_colorarm.scp and sphereitem_beers.scp.

[[Category:Tutorials]]
<math>Formel hier einfügen</math>

Main Page

2012-02-02T19:25:43Z

MrSugarCube: Reverted edits by Culuz4lmbe (Talk) to last version by MrSugarCube

{{Languages|Main_Page}}

Welcome to the retake of Taran's famous "[http://www.cs.rit.edu/~djr7581/ Sphere Scripting for Dummies tutorials]" and information. His tutorial was made for Sphere 55i, but now that Sphere 56b is about to be released we have decided to rewrite his tutorials and update the information to reflect the latest changes and additions.

'''Where should I start?'''

If you want to learn to script for Sphere 56b you should start by first reading the [[#Setting Up Sphere|Setting Up Sphere]] section. It will teach you how to set up a basic empty world to start your path. After that you should try reading the [[#Tutorials|Tutorials]], go slow, don't try to go through everything in one day as it takes time to read and fully understand everything.

'''I learned how to script! And now?'''

If you have finished the 10 chapters then we encourage you to read the tutortials and other articles below. They may not be as important as the others but they are still quite useful and contain lots of useful information. Try making your own scripts and share with others at the [http://www.sphereserver.net/index.php SphereServer Forums]. You can also ask for help if you can't resolve something by yourself. Remember to use the [[#Reference Compendium|Reference Compendium]] below as it is really useful.

'''I want to contribute!'''

Maintaining the information on this site involves a huge amount of work and not many of us have the time to do it. If you wish to help out then please feel free to do so! All you need to do to get started is [[Special:UserLogin|create an account]] if you haven't done so already. You can then edit any page by using the "Edit" link in the rop right corner. Before you go do this, you may want to start by reading the [[Contribution Guide]].

'''Special thanks to:'''

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

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

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

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

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

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

----

==Setting up Sphere==

* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]

==Tutorials==

Here are the chapters of Taran's original compendium, updated for Sphere56b:

* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''

In addition to these there are some more advanced tutorials that have been contributed by other members. Once you have read the above 10 tutorials you may wish to read these to learn more:

* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''

==Reference Compendium==

* [[:Category:Definitions|Definitions]]
** [[CHARDEF|Characters]]
** [[DIALOG|Dialogs]]
** [[EVENTS|Events]]
** [[ITEMDEF|Items]]
** [[MENU|Menus]]
** [[REGIONRESOURCE|Region Resources]]
** [[REGIONTYPE|Region Types]]
** [[AREADEF|Regions]]
** [[ROOMDEF|Rooms]]
** [[SKILLCLASS|Skill Classes]]
** [[SKILLMENU|Skill Menus]]
** [[SKILL|Skills]]
** [[SPAWN|Spawn Groups]]
** [[SPELL|Spells]]
** [[TYPEDEF|Types]]
* [[:Category:Objects|Objects]]
** [[Accounts]]
** [[Characters]]
** [[Database]]
** [[Files]]
** [[GM Pages]]
** [[Items]]
*** [[Special Items]]
** [[Map Points]]
** [[Parties]]
** [[Regions]]
** [[Rooms]]
** [[Sectors]]
** [[Server]]
* [[:Category:Scripts|Scripts]]
** [[:Category:Functions|Functions and Triggers]]
** [[:Category:Variables|General Functions, Properties and References]]
** [[Intrinsic Functions]]
** [[:Category:Statements|Statements]]

==Other Articles==

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

==External Links==

* [http://www.sphereserver.net/ Official SphereServer Website]
* [http://prerelease.sphereserver.net/ Official Sphere 56b Downloads]
* [http://scriptsharing.dv-team.de/ ScriptSharing]
* [http://www.cs.rit.edu/~djr7581/ Taran's Scripting for Dummies (Sphere 55i)]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]
[[de:Main Page/de]]

Main Page

2011-12-29T11:16:00Z

MrSugarCube: Reverted edits by Jamxq4upbe (Talk) to last version by MrSugarCube

@Logout

2011-12-22T22:20:11Z

MrSugarCube: Reverted edits by Chruse Arroyo (Talk) to last version by MrSugarCube

==Description==
This trigger fires when a player logs out.

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] who logged out.
|-
| [[SRC]] || The [[Characters#Players|player]] who logged out.
|}

==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 length of time that the character will linger in the world, in tenths of a second.
|-
| ARGN2 || IO || If non-zero, the character will instantly log out.
|}

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

''No return values are handled by this trigger.''

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

Es:AREADEF

2011-12-22T22:20:05Z

MrSugarCube: Reverted edits by Chruse Arroyo (Talk) to last version by Davidcrma

{{Languages|AREADEF}}

__FORCETOC__
Las Areas en el mundo, como las dungeons (Cuevas) o las ciudades están definidas por rectangulos. Las regiones están compuestas por una o más rectangulos en en el mapa

La sintaxis básica para definir una región es la siguiente:

<tt>
[AREADEF ''nombre por defecto''] 
RECT=''izquierda, arriba, derecha, abajo, mapa'' 
RECT=''izquierda, arriba, derecha, abajo, mapa'' 
RECT='''izquierda, arriba, derecha, abajo, mapa'' 
</tt>

==Propiedades==
Sin definir la región las siguiente propiedades están también disponbiles para el comportamiento del area:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ANNOUNCE]] || Leer y Escribir || Obtiene o Configura si un mensaje debe aparecer al salir o entrar en la zona.
|-
| [[ARENA]] || Leer y Escribir || Obtiene o Cofigura si la zona es tratada como una arena.
|-
| [[BUILDABLE]] || Leer y Escribir || Obtiene o Configura si los jugadores pueden construir en la zona.
|-
| [[EVENTS (Property)|EVENTS]] ''tiporegion_nombrepordefecto'' || Escribir || Añade un evento a una zona
|-
| [[FLAGS]] || Leer y Escribir || Obtiene o Configura los atributos de la zona-
|-
| [[GATE]] || Leer y Escribir || Obtiene o Configura si el Hechizo Gate Travel (Invocar Portal) está permitido.
|-
| [[GROUP]] || Leer y Escribir || Obtiene o Configura el nombre de la Región mayor en la que está incluida la zona
|-
| [[GUARDED]] || Leer y Escribir || Obtiene o Configura si los guardias deben estar en la zona.
|-
| [[MAGIC]] || Leer y Escribir || Obtiene o Configura si existe un bloqueo de la magia en la zona.
|-
| [[MARK]] || Leer y Escribir || Obtiene o Configura si el hechizo Mark (Marcar runa) está permitido en la zona.
|-
| [[NAME]] || Leer y Escribir || Obtiene o Configura el nombre de la región.
|-
| [[NOBUILD]] || Leer y Escribir || Obtiene o Configura si está prohibido construir en la zona.
|-
| [[NODECAY]] || Leer y Escribir || Obtiene o Configura si los objetos no tienen decay (El objeto desaparece tras un tiempo) en la zona
|-
| [[NOPVP]] || Leer y Escribir || Obtiene o Configura si el PvP está permitido en la zona.
|-
| [[P]] || Leer y Escribir || Obtiene o Configura la posición de la zona.
|-
| [[RECALL]] || Leer y Escribir || Obtiene o Configura si el hechizo Recall (Volver a un lugar mediante runa) está permitido en la zona.
|-
| [[RECALLIN]] || Leer y Escribir || Obtiene o Configura si el hechizo Recall (Volver a un lugar mediante runa) está permitido para entrar en la zona.
|-
| [[RECALLOUT]] || Leer y Escribir || Obtiene o Configura si el hechizo Recall (Volver a un lugar mediante runa) está permitido para salir la zona.
|-
| [[RECT]] ''izquierda, arriba, derecha, abajo, mapa'' || Escribir || Añade un rectángulo del mapa a la zona.
|-
| [[RESOURCES]] ''tiporegion_nombrepordefecto'' || Escribir || Añade un evento de región a la región.
|-
| [[SAFE]] || Leer y Escribir || Obtiene o Configura si la zona es segura.
|-
| [[TAG]]''.name'' || Leer y Escribir || Obtiene o Configura el Valor del TAG
|-
| [[UNDERGROUND]] || Leer y Escribir || Obtiene o Configura si se supone que la zona está bajo Tierra.
|}

==Ejemplo==

<spherescript>
//
// La región del mundo del paquete de scripts.
//
[AREADEF a_world]
EVENTS=r_default,r_default_rock,r_default_water,r_default_tree,r_default_grass
NAME=Felucca
GROUP=ALLMAP
P=1323,1624,55,0
RECT=0,0,7168,4096,0
</spherescript>

<spherescript>
//
// Castillo de Lord British's del paquete de scripts.
//
[AREADEF a_lord_britishs_castle_1]
EVENTS=r_default,r_default_rock,r_default_water,r_default_tree,r_default_grass
NAME=Lord British's Castle
GROUP=Britain
FLAGS=0648e
P=1392,1625,30,0
RECT=1294,1679,1411,1697,0
RECT=1295,1559,1313,1577,0
RECT=1392,1559,1410,1577,0
RECT=1302,1577,1410,1680,0
RECT=1313,1563,1392,1577,0
EVENTS=r_brit_castle
TAG.GUARDOWNER=Lord British's Personal
</spherescript>

[[Category: Compendio de Referencias]]
[[Category: Definiciones]]

Main Page

2011-12-16T13:19:59Z

MrSugarCube: Reverted edits by Duax2ogrwo (Talk) to last version by MrSugarCube

Main Page

2011-12-14T07:32:51Z

MrSugarCube: Reverted edits by Jamqweb9ba (Talk) to last version by MrSugarCube

Help:Contents

2011-11-29T11:23:00Z

MrSugarCube: Reverted edits by Cheaptara (Talk) to last version by MrSugarCube

==Welcome==
Hello and welcome to the unofficial SphereServer Wiki! You are likely at this page because you are new to the wiki! This wiki is an in-depth guide and documentation to the SphereServer scripting language.

==Where to Go From Here==
When you first view the wiki page, you will be at the [[Main Page]]. This page is the main portal which links to all of the main articles and sections! If you look at the Main Page, you will notice many different things.

At the top of the page is a basic introduction and welcome message and a list of credits to different people involved in the writing of this wiki and Sphereserver. This part of the page also contains very important information on how to become a writer for this wiki! Be sure to check it out if you would like to join the writing team.

Next on the page is a table of contents, which displays all of the main sections on the [[Main Page]]. You can use this table to quickly navigate to the section of the page you wish to view.

After the table of contents comes the real important stuff! The first section after the table of contents is the [[Main Page#Setting up Sphere|Setting up Sphere]] section! This will be the first place a new user will want to look! This section contains three articles which detail how to get Sphere, how to install it, and how to configure it.

The [[Main Page#Tutorials|Tutorials]] section of the page – the next section on the page – is the place to learn to script. Beginning at the basics and ending at some of the more advanced topics of the Sphere scripting engine, these in-depth tutorials will get you on your feet and perfecting your shard in no time!

After the tutorials comes the [[Main Page#Reference Compendium|Reference Compendium]], which is a very important section for both new and old Sphere script-writers. Each page of the Reference Compendium contains a very detailed list of functions and properties that can be used in various parts of SphereScript.

[[Main Page#Other Articles|Other Articles]] is a list of all other articles on the wiki which don't fit into any of the other categories. Many of these articles are theories and ideas about various parts of a shard, or of scripting itself.

The final section on the page, [[Main Page#External Links|External Links]], contains a brief list of important SphereServer-related links.

==Where Can I Get More Help?==
You can visit the official SphereServer forums: [http://www.sphereserver.net/ http://www.sphereserver.net]

[[Category: Navigation]]

Client Changes

2011-11-29T11:22:55Z

MrSugarCube: Reverted edits by Cheaptara (Talk) to last version by Sirius

{{Languages|Client_Changes}}

==2D/3D Client Updates==
'''Client Patch 5.0.8.1''' 
On Monday, February 12, 2007 at 1:00PM PST (January 31 9:00PM GMT), we will deploy Client Patch 5.0.8.1
* Added live event content
* Winter is ending, and the spring rains have begun! The snow has melted and should no longer display on the ground, trees, or radar.
* Areas which have had falling snow will have falling rain instead

'''Client Patch 5.0.8.2''' 
On Tuesday, February 13, 2007 at 5:00PM PST (February 14 1:00AM GMT), we will deploy Client Patch 5.0.8.2
* Fixed display issue with Rose in the 3d client

'''Client Patch 5.0.8.3''' 
On Tuesday, March 20, 2007 at 5:00PM PDT (March 21 1:00AM GMT), we will deploy Client Patch 5.0.8.3
* Added Event Content

'''Client Patch 5.0.8.4''' 
On Tuesday, March 20, 2007 at 11:00PM PDT (March 21 7:00AM GMT), we will deploy Client Patch 5.0.8.4
* Fixed issue with Heartwood not displaying

'''Client Patch 5.0.9.0''' 
On Friday, March 23, 2007 at 12:00PM PDT (March 23 8:00PM GMT), we will deploy Client Patch 5.0.9.0. This is a MANDATORY patch.
* Fixed a cliloc error with stockings
* Fixed a cliloc error displayed when trying to log in with a blocked account
* Additional technical changes

'''Client Patch 6.0.1.1''' 
02 May 2007 20:09:38 EST
We have deployed client patch 6.0.1.1 - this client patch will require a server publish for all the fixes to be visible.
* Fixed many world art issues
* Fixed entrance blocking issue with the Shadowlord base
* Potential fix for Win98 and ME users' "out of memory" issue

'''Client Patch 6.0.1.2''' 
08 May 2007 15:35:36 EST
At 12:00PM PDT (7PM GMT) on Tuesday, May 8, we will be deploying client patch 6.0.1.2.
* Updated clilocs (NOTE! Some ninjitsu spells will appear to have changed requirements- the actual changes will not occur until the server is updated.)
* Many map and world art fixes
* Further Windows 98 optimizations

'''Client Patch 6.0.1.3''' 
17 May 2007 20:14:10 EST
At 4:30PM PDT (11:30PM GMT) on Thursday May 17th we will be deploying client patch 6.0.1.3:
* Updated clilocs
* Many map and world art fixes

'''2D Client Patch 6.0.1.5''' 
22 Jun 2007 19:45:05 EST
The following 2D Client patch (6.0.1.5) will be deployed at 4:00PM PDT (11:00PM GMT) on Friday, June 22:
* Added live event content
* Fixed bug with certain gates in custom houses that became impassable

'''2D Client Patch 6.0.1.6''' 
27 Jun 2007 18:14:40 EST
Beginning between 6:00PM and 8:00PM PDT on June 27 (June 28 1:00AM-3:00AM GMT) the 2D client will be patched to version 6.0.1.6, which include the following changes:
* Updated clilocs
* Added live event content

'''2D Client Patch 6.0.1.8''' 
23 Jul 2007 15:36:36 EST
At 11:30AM PDT (6:30PM GMT) on Monday, July 23, 2D client patch vers 6.0.1.8 will be deployed. This patch contains the following changes:
* Version number change

'''2D Client vers. 6.0.1.9''' 
26 Jul 2007 18:22:28 EST
At 2:00PM PDT (9:00PM GMT) on Thursday, July 26, 2D client version number 6.0.1.9 was deployed:
* Polished Destard, Deceit, Paroxymus

'''2D Client vers. 6.0.1.10''' 
06 Aug 2007 18:45:49 EST
At 2:30PM PDT (9:30PM GMT) on Monday, August 6, the 2D client will be updated to version 6.0.1.10. Notes after the jump:
* Map file changes for compatibility

'''2D Client vers. 6.0.2.0''' 
28 Aug 2007 18:45:55 EST
At 2:30PM PDT (9:30PM GMT) on Tuesday, August 28, the 2D client will be updated to version 6.0.2.0 Notes after the jump:
* Clilocs have been updated
* Unused tiles in some caves have been fixed

'''2D Client vers. 6.0.3.0''' 
20 Sep 2007 17:32:12 EST
At 1pm PDT (8PM GMT) on Thursday, Sept. 20, the 2D client will be updated to version 6.0.3.0. Notes after the jump:
* Added art for new items
* updated clilocs

'''2D Client vers. 6.0.3.1''' 
25 Sep 2007 14:32:39 EST
At 10:30AM PDT, the 2D client will be updated to version 6.0.3.1, which contains the following:
* Fixed unused tiles in front of dungeons

'''2D Client vers. 6.0.4.0''' 
18 Oct 2007 16:16:36 EST
At 1:00PM PDT (8:00PM GMT) on Thursday, October 18, the 2D client will be updated to version 6.0.4.0 Notes after the jump:
* Updated Magincia tiles to be vulnerable to the rage of Daemons

'''2D Client vers. 6.0.5.0''' 
20 Nov 2007 18:13:42 EST
At 3:15PM PST (11:15PM GMT) on Tuesday, November 20, the 2D client will be updated to version 6.0.5.0 Notes after the jump:
* Updated clilocs
* Added decoration in many areas, including the Doom Gauntlet and Serpent's Hold

'''2D Client vers. 6.0.6.0''' 
07 Feb 2008 17:30:51 EST
At 5:30PM EST (10:30PM GMT) the 2D client will be updated to version 6.0.6.0. Notes after the jump:
* Added live event content
* Added worldbuilding updates to New Haven moongate
* Updated clilocs

'''2D Client vers. 6.0.6.1''' 
19 Feb 2008 13:26:35 EST
At 1:30PM EST (6:30PM GMT) the 2D client will be updated to version 6.0.6.1. Notes after the jump:
* Fixed an issue that could cause rubberbanding and/or movement lag

'''2D Client vers. 6.0.6.2''' 
20 Mar 2008 15:19:21 EST
At 4:30PM EDT the 2D client will be updated to version 6.0.6.2. Notes after the jump:
* Fixed several areas where players might get stuck
* Fixed a client crash
* Removed the "2d/3d" client picker

==KR Client Updates==
'''KR Client Patch 2.47.1.5''' 
18 Oct 2007 16:48:53 EST
* Fixed an issue with flying creatures' movement animations
* Players can now target items on ther hotbars, provided the item is in their backpack or equipped.
* Using recall in your hot bar will not bring up a cursor if you have something targeted
* Fixed a crash when mousing over UI
* Client will timeout and disconnect properly when inactive for 10-15 minutes
* Now item properties will have each word's first letter capitalized for easier reading
* Fixed a bug with the theme music when logging in and out multiple times
* Fixed a crash when exiting the game while customizing a house.
* Items that are too heavy to pick up should no longer highlight or put up a properties box when moused over.
* Can't start to move unmovable things anymore (things too far away or too heavy)
* Item properties windows will now hue the strength requirement line red if you don't meet the strength requirement, just like they do in 2d.
* Fixed a bug with input being sent incorrectly when the KR window loses focus
* Players can now sort the shard list by the percent full that each shard is. More populated shards will be at the top. Test center and other language shards appear lower on the list due to other sorting effects that are happening. Also adds highlighting to selectable text on the shard list, in addition to reformatting the layout slightly.
* Foliage should fade more intelligently as players walk under trees
* Cursor hand should be silver in Felucca, gold in Trammel
* Mouse now always points to "west" direction when it is over a window. This "west" direction is in-game "west" direction, not the screen's west direction.
* Resource targeting macros are not depleting the veins.
* Fixed a bug where the Help buttons in japanese mode pointed to US CS pages
* Items should no longer get shuffled around when you cross server lines
* Players will now no longer have the two party related context menu items in their context menu until they have accepted the invite to join a party.
* The word "CONTINUE" was being cut off on a button on the release pet confirmation gump. The button label has now been changed to use the word "OKAY" instead.
* It is now a lot easier to drop things on the ground.
* Buttons on user waypoint gumps now stay inside their gump when language is set to Japanese.
* Male's Jester tunic uses the correct art, and the in-game colors should be closer to paper doll's.
* Fixed issue with system slowness related to the chat window

'''KR Client Patch 2.47.1.10''' 
06 Nov 2007 16:52:36 EST
* Fixed a bug with moving and looting heavy items from containers and backpacks.

'''KR Client Patch 2.48.0.3''' 
20 Nov 2007 18:13:22 EST
New Features:
* Legacy Art Mode - enable this in Options: User Settings: Graphics, then restart the client to enable
* Fully Moddable UI
* Substantial number of client optimizations - should run much smoother now
* Improved the guild ui
* Added legacy container art - enable this in Options: User Settings: Graphics (no restart needed for this one)
* Fixed a number of windows that weren't updating properly, ncluding party window, pet window, draggable health bars, and more
* The item properties "blessed" "blessed for playername" and "insured for playername" are now colored blue for increased visibility
* "Macros" and "Actions" are two separate items on the main menu
* Improved the layout of the veteran rewards window
* Improved the animal lore window
* Polished spellbook window
* Polished char creation window
* Improved npc vendor window
* Empty slots on the paperdoll now have a tooltip telling you what goes in it
* Removed the "add by ID" option in the friends list (since there's no way to find an ID, it was not usable)
* Improved the art and functionality of the party window
* Added a line to specify what the target is in the tooltip for a hotbar slot
* Chat Improvements:
** The default chat config now only has one tab with all chat in it.
** Added a "reset chat to default" option in settings
** Added /r or /reply command to automatically reply to the last person to send you a /tell
** /tell now requires a comma after the player name (it will also handle multi-word names)
** Shift-left clicking on a line of chat will copy it to the clipboard
** Party, guild, alliance and faction messages will not show as overhead text
** The chat context menus now has a color selection option for text color, overhead chat color, and chat window background color
* Map Improvements:
** Added a settings:interface item to reset map icons to default
** Added 40 new icons for waypoints
** Waypoint icons on the map will show sextant coordinates when you mouse over them
* UI Improvements and Fixes:
** You can now target a player or creature by clicking the name over their head
** Added a user settings option to use the mouse wheel for targeting - can choose target friendly or target enemy
** Added stat hotbar icons - you can drag off icons from the stats window to your hotbar, where it will display the number of your stat. (mouseover the icon for the name of the stat)
** Health, mana, and stamina stat icons will change when their value is under 10 - the weight icon will glow when you approach your weight limit
** Added dual monitor support - the kr window can now be stretched across two monitors
** Static objects (trees, etc) will now display their name when you click on them
** If you have your bandages in your hotbar, a timer will count down when you use them, telling you how long it will be until the bandage is applied
** Fixed a few bugs with tree foliage not fading correctly
** When you drag a stack of items, the number of items will automatically be selected
** Skill icons in your hotbar will now show your skill points in their tooltip
** Made toggle UI, screenshot, toggle circle of transparency, reload ui all configurable keybindings
** Turn off hotbar page flipping if legacy chat is enabled (use shift 0-9 to change hotbars in legacy mode)
** Players can now target items on ther hotbars, provided the item is in their backpack or equiped.
** Added a default targeting for spells, different spells now have a different default target instead of defaulting always to current target.
** Many macros can now be interrupted by the ESC key
* General Fixes and Improvements:
** Added decoration in many areas, including the doom gauntlet and serpent's hold
** Shortened the hiryu's tail
** Made giant beetle's beak shorter
** Made ostards' tails shorter
** Tweaked and added a number of creature graphics and animations
** The skills available in Character Creation now match 2d
** Items behind other items should be easier to select in freeform view
** Tweaked appearance of trees to make them blend with the background less

'''KR Client Patch 2.48.0.7''' 
21 Nov 2007 17:02:49 EST
* Fixed problem with client loading in fullscreen mode
* Fixed issue with no sounds playing
* Fixed issue with legacy container art not displaying for Armoires
* Fixed spelling of "Holiday Stocking" legacy container

'''KR Client Patch 2.50.0.3''' 
07 Feb 2008 18:12:35 EST
* KR: Removed clouds from the daytime display
* Various localization updates for text
* Default tab name is now Chat instead of System
* Fixed hueing in the Paperdoll
* Treasure maps fixed
* KR: Shopkeeper window revamped. Now supports click and holding on + or -
* Many broken animations fixed

'''KR Client Patch 2.51.0.3''' 
20 Mar 2008 15:20:28 EST
* Fixed a number of stuck areas
* Fixed various incorrect tiles

[[Category: Articles]]

Main Page

2011-11-24T23:43:59Z

MrSugarCube: Reverted edits by Ryanapfksc (Talk) to last version by MrSugarCube

Main Page

2011-11-05T08:29:21Z

MrSugarCube: Reverted edits by Richzgmjpe (Talk) to last version by Sirius

Override TAGs

2011-09-14T23:52:52Z

MrSugarCube: Clarified behaviour of TAG.OVERRIDE.REGEN and TAG.OVERRIDE.REGENVAL

{{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.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.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.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]]

@Rename

2011-06-18T15:43:59Z

MrSugarCube: Expanded description of RETURN 1 during character creation

==Description==
This trigger fires when a player renames another character. The trigger also fires at character creation when the player's name is set.

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Characters|character]] being renamed.
|-
| [[I]] || The [[Characters#Players|player]] renaming the character.
|-
| [[SRC]] || The [[Characters#Players|player]] renaming the character.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGS || I || The name that is being set.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Disallows the new name.
'''Note:''' During character creation, this will force the character to be named using the NAMES_HUMANMALE or NAMES_HUMANFEMALE [[NAMES|name pool]].
|}

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

Error Codes

2011-05-02T02:08:47Z

MrSugarCube: Changed description of garbage collection codes 1103 and 1104 to indicate how the NPC is linked to its mount item

{{Languages|Error_Codes}}

__FORCETOC__
==Exit Codes==
When Sphere closes, an 'exit code' will normally be shown in the console to describe why it is being shut down. In general, an exit code less than 0 is considered to be an error code, and values above 0 are normal shutdown codes. In most cases, a more descriptive error will be shown in the console and/or log file to help better diagnose the reason behind error codes.

The following table lists all of the current codes and their meanings.

{| border="1" cellpadding="3"
| '''Code''' || '''Description'''
|-
| -10 || Unexpected error occurred
|-
| -9 || Failed to bind server port
|-
| -8 || Failed to load world save(s)
|-
| -3 || Failed to load server settings (script, ini, mul files)
|-
| -1 || Shutdown via commandline (/?, /T and /Q switches)
|-
| 1 || X in console ''or'' SIGHUP signal, terminal closed (Linux Only)
|-
| 2 || SHUTDOWN command
|-
| 4 || Service shutdown ''(Windows Only)''
|-
| 5 || Console window closed ''(Windows Only)''
|-
| 6 || SIGABRT signal, process aborted ''(Linux Only)''
|}

==Garbage Collection==
The purpose of garbage collection is to validate all of the server objects and free up unused UIDs. Garbage collection is initiated:
* After the world save is loaded at startup.
* Before a world save begins, if the [[FORCEGARBAGECOLLECT]] setting is enabled in Sphere.ini.
* After the [[IMPORT]] or [[RESTORE]] functions have been used on the [[Server|server]] object.
* When the 'G' command is entered via the Sphere console
* When the [[GARBAGE]] function is used on the [[Server|server]] object.

When garbage collection encounters a problem with an object it may attempt to automatically correct the error, otherwise the object will be removed. When an object is removed by garbage collection there will normally be an error shown in the console describing the item that was removed along with the reason. The following table lists all of the garbage collection codes along with their description:

{| border="1" cellpadding="3"
| '''Code''' || '''Message''' || '''Description''' ||
|-
| 1102 || Disconnected charr not acting as such || A character has been marked disconnected from the world, but it is not listed in the sector's disconnected character's list. || *
|-
| 1103 || Ridden NPC not acting as such || An NPC has the [[FLAGS|statf_ridden]] flag set, but does not have its [[ACTION]] property set to 111. ||
|-
| 1104 || Ridden NPC without a mount item || An NPC has the [[FLAGS|statf_ridden]] flag set, but its [[ACTARG1]] property isn't set to the [[UID]] of an item whose [[TYPE]] property is set to [[TYPE|t_figurine]] or [[TYPE|t_eq_horse]]. ||
|-
| 1105 || Ridden NPC with a mislinked mount item || An NPC has the [[FLAGS|statf_ridden]] flag set, but its [[ACTARG1]] property isn't set to the [[UID]] of an item whose [[MORE2]] property matches the NPC's [[UID]]. ||
|-
| 1106 || Disconnected NPC neither dead nor ridden || An NPC has been disconnected from the world, but does not have either one of the [[FLAGS|statf_ridden]] or [[FLAGS|statf_dead]] flags set. ||
|-
| 1107 || In game char that is neither a player nor an NPC || A character is not a player or an NPC. || *
|-
| 1108 || Char not on a valid position || A character's [[P|position]] is outside of the map boundaries. ||
|-
| 1203 || Ridden NPC not acting as such || Same as 1103. ||
|-
| 1204 || Ridden NPC without a mount item || Same as 1104. ||
|-
| 1205 || In game char that is neither a player nor an NPC || Same as 1107. ||
|-
| 2102 || Item without ITEMDEF || An item does not have an [[ITEMDEF]] section. || *
|-
| 2103 || Item ITEMDEF with ID = 0 || An item's [[ITEMDEF]] has an [[ID]] of zero. || *
|-
| 2104 || Disconnected item || An item has been marked as disconnected from the world. || *
|-
| 2105 || Item not on a valid position || An item is not in a container and its [[P|position]] is outside of the map boundaries. ||
|-
| 2106 || Item flagged as being in a container but it isn't || An item is flagged as not being top level, but it does not have a container. ||
|-
| 2202 || Item flagged as equipped but it isn't || An item is flagged as being equipped, but its parent is not a character. ||
|-
| 2205 || Mislinked item || An item's [[LINK]] property matches its [[UID]], or has been set to a [[UID]] that doesn't exist. ||
|-
| 2206 || Gm Robe / Deathshroud not on a char || A GM robe or death shroud ([[ID]] of 0204E or 0204F) is not equipped to a character. ||
|-
| 2207 || Deathshroud not on a dead char || A death shroud ([[ID]] of 0204F) is equipped to a character without the [[FLAGS|statf_dead]] flag set. ||
|-
| 2208 || Gm Robe on a char without privilege || A GM robe ([[ID]] of 0204E) is equipped to a character whose [[PLEVEL]] is less than 2. ||
|-
| 2220 || Trade window memory not equipped in the correct layer || A [[TYPE|t_eq_trade window]] item type is not equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_none]], or is equipped to an NPC. ||
|-
| 2221 || Client linger memory not equipped in the correct layer || A [[TYPE|t_eq_client_linger]] item type is not equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_flag_clientlinger]], or is equipped to an NPC. ||
|-
| 2222 || Memory not equipped / not in the memory layer / without color || A memory item ([[ID]] of 02007) is not equipped, or a non-memory item has had its [[TYPE]] set to [[TYPE|t_eq_memory_obj]] after creation. ||
|-
| 2226 || Mount memory not equipped in the correct layer || A [[TYPE|t_eq_horse]] item type is not equipped, or has its [[LAYER]] property set to something other than [[LAYER|layer_horse]]. ||
|-
| 2227 || Hair/Beard item not equipped / not in a corpse / not in a vendor box || A [[TYPE|t_hair]] or [[TYPE|t_beard]] item type that isn't equipped, is either not in a container or its container has an [[ID]] other than 02006 or 02AF8. ||
|-
| 2228 || Hair/Beard item not equipped / not in a corpse / not in a vendor box || A [[TYPE|t_hair]] or [[TYPE|t_beard]] item is equipped, but has its [[LAYER]] property set to something other than [[LAYER|layer_hair]] or [[LAYER|layer_beard]]. ||
|-
| 2229 || Game piece not in a game board || A [[TYPE|t_game_piece]] item has been found outside of a container. ||
|-
| 2230 || Item equipped in the trade window layer but it isn't a trade window || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_none]], but its [[TYPE|type]] is not [[TYPE|t_eq_trade_window]]. ||
|-
| 2231 || Item equipped in the memory layer but it isn't a memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_special]], but its [[TYPE|type]] is not [[TYPE|t_eq_memory_obj]] or [[TYPE|t_eq_script]]. ||
|-
| 2233 || Item equipped in the mount memory layer but it isn't a mount memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_horse]], but its [[TYPE|type]] is not [[TYPE|t_eq_horse]]. ||
|-
| 2234 || Item equipped in the client linger layer but it isn't a client linger memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_flag_clientlinger]], but its [[TYPE|type]] is not [[TYPE|t_eq_client_linger]]. ||
|-
| 2235 || Item equipped in the murder memory layer but it isn't a murder memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_flag_murders]], but the character is an NPC or the player has its [[KILLS]] property set to 0. ||
|-
| 2236 || Item flagged as decay but without timer set || A top-level item has the [[ATTR|attr_decay]] flag set, but its [[TIMER]] property has not been set. ||
|-
| 3101 || Object is totaly lost, no parent exists || An object has no parent. || *
|-
| 3102 || Object was deleted or UID is incorrect || An object does not have a valid [[UID]]. || *
|-
| 3201 || Object not correctly loaded by server (UID conflict) || More than one object has the same [[UID]] value. || *
|-
| 4222 || Memory not equipped / not in the memory layer / without color || A memory item is not flagged as equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_special]], or has its [[COLOR]] property set to 0. ||
|-
| 4223 || Memory not on a char || A memory item is flagged as equipped, but it's [[CONT|parent]] is not a character. ||
|-
| 4224 || Stone/Guild memory mislinked || A memory item's [[COLOR]] property has one of the [[COLOR|memory_guild]] or [[COLOR|memory_town]] flags set, but the [[LINK]] property is not set to the [[UID]] of a guild or town stone. ||
|-
| 4225 || Stone/Guild memory linked to the wrong stone || A memory item's [[COLOR]] property has one of the [[COLOR|memory_guild]] or [[COLOR|memory_town]] flags set, but the character the memory is equipped to is not a member of the guild or town. ||
|-
| 7101 || Object's UID does not match up with server's UID table. || An object does not have the expected [[UID]] value. || *
|-
| 7102 || Object does not exist. || An object does not exist. || *
|-
| FFFF || Bad memory allocation || An exception was thrown whilst checking the object's validity. || *
|}

'''Note''': ''Garbage collection codes marked with * generally indicate a serious error within an object's internal state and should not normally be seen. If you are experiencing and are able to reliably reproduce any such errors then please report the details to the [http://tracker.sphere.torfo.org/bugs/main_page.php bug tracker].''

Error Codes

2011-05-02T01:27:08Z

MrSugarCube:

{{Languages|Error_Codes}}

__FORCETOC__
==Exit Codes==
When Sphere closes, an 'exit code' will normally be shown in the console to describe why it is being shut down. In general, an exit code less than 0 is considered to be an error code, and values above 0 are normal shutdown codes. In most cases, a more descriptive error will be shown in the console and/or log file to help better diagnose the reason behind error codes.

The following table lists all of the current codes and their meanings.

{| border="1" cellpadding="3"
| '''Code''' || '''Description'''
|-
| -10 || Unexpected error occurred
|-
| -9 || Failed to bind server port
|-
| -8 || Failed to load world save(s)
|-
| -3 || Failed to load server settings (script, ini, mul files)
|-
| -1 || Shutdown via commandline (/?, /T and /Q switches)
|-
| 1 || X in console ''or'' SIGHUP signal, terminal closed (Linux Only)
|-
| 2 || SHUTDOWN command
|-
| 4 || Service shutdown ''(Windows Only)''
|-
| 5 || Console window closed ''(Windows Only)''
|-
| 6 || SIGABRT signal, process aborted ''(Linux Only)''
|}

==Garbage Collection==
The purpose of garbage collection is to validate all of the server objects and free up unused UIDs. Garbage collection is initiated:
* After the world save is loaded at startup.
* Before a world save begins, if the [[FORCEGARBAGECOLLECT]] setting is enabled in Sphere.ini.
* After the [[IMPORT]] or [[RESTORE]] functions have been used on the [[Server|server]] object.
* When the 'G' command is entered via the Sphere console
* When the [[GARBAGE]] function is used on the [[Server|server]] object.

When garbage collection encounters a problem with an object it may attempt to automatically correct the error, otherwise the object will be removed. When an object is removed by garbage collection there will normally be an error shown in the console describing the item that was removed along with the reason. The following table lists all of the garbage collection codes along with their description:

{| border="1" cellpadding="3"
| '''Code''' || '''Message''' || '''Description''' ||
|-
| 1102 || Disconnected charr not acting as such || A character has been marked disconnected from the world, but it is not listed in the sector's disconnected character's list. || *
|-
| 1103 || Ridden NPC not acting as such || An NPC has the [[FLAGS|statf_ridden]] flag set, but does not have its [[ACTION]] property set to 111. ||
|-
| 1104 || Ridden NPC without a mount item || An NPC has the [[FLAGS|statf_ridden]] flag set, but its rider does not have a mount item. ||
|-
| 1105 || Ridden NPC with a mislinked mount item || An NPC has the [[FLAGS|statf_ridden]] flag set, but the mount item's [[MORE2]] property does not match the NPC's [[UID]]. ||
|-
| 1106 || Disconnected NPC neither dead nor ridden || An NPC has been disconnected from the world, but does not have either one of the [[FLAGS|statf_ridden]] or [[FLAGS|statf_dead]] flags set. ||
|-
| 1107 || In game char that is neither a player nor an NPC || A character is not a player or an NPC. || *
|-
| 1108 || Char not on a valid position || A character's [[P|position]] is outside of the map boundaries. ||
|-
| 1203 || Ridden NPC not acting as such || Same as 1103. ||
|-
| 1204 || Ridden NPC without a mount item || Same as 1104. ||
|-
| 1205 || In game char that is neither a player nor an NPC || Same as 1107. ||
|-
| 2102 || Item without ITEMDEF || An item does not have an [[ITEMDEF]] section. || *
|-
| 2103 || Item ITEMDEF with ID = 0 || An item's [[ITEMDEF]] has an [[ID]] of zero. || *
|-
| 2104 || Disconnected item || An item has been marked as disconnected from the world. || *
|-
| 2105 || Item not on a valid position || An item is not in a container and its [[P|position]] is outside of the map boundaries. ||
|-
| 2106 || Item flagged as being in a container but it isn't || An item is flagged as not being top level, but it does not have a container. ||
|-
| 2202 || Item flagged as equipped but it isn't || An item is flagged as being equipped, but its parent is not a character. ||
|-
| 2205 || Mislinked item || An item's [[LINK]] property matches its [[UID]], or has been set to a [[UID]] that doesn't exist. ||
|-
| 2206 || Gm Robe / Deathshroud not on a char || A GM robe or death shroud ([[ID]] of 0204E or 0204F) is not equipped to a character. ||
|-
| 2207 || Deathshroud not on a dead char || A death shroud ([[ID]] of 0204F) is equipped to a character without the [[FLAGS|statf_dead]] flag set. ||
|-
| 2208 || Gm Robe on a char without privilege || A GM robe ([[ID]] of 0204E) is equipped to a character whose [[PLEVEL]] is less than 2. ||
|-
| 2220 || Trade window memory not equipped in the correct layer || A [[TYPE|t_eq_trade window]] item type is not equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_none]], or is equipped to an NPC. ||
|-
| 2221 || Client linger memory not equipped in the correct layer || A [[TYPE|t_eq_client_linger]] item type is not equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_flag_clientlinger]], or is equipped to an NPC. ||
|-
| 2222 || Memory not equipped / not in the memory layer / without color || A memory item ([[ID]] of 02007) is not equipped, or a non-memory item has had its [[TYPE]] set to [[TYPE|t_eq_memory_obj]] after creation. ||
|-
| 2226 || Mount memory not equipped in the correct layer || A [[TYPE|t_eq_horse]] item type is not equipped, or has its [[LAYER]] property set to something other than [[LAYER|layer_horse]]. ||
|-
| 2227 || Hair/Beard item not equipped / not in a corpse / not in a vendor box || A [[TYPE|t_hair]] or [[TYPE|t_beard]] item type that isn't equipped, is either not in a container or its container has an [[ID]] other than 02006 or 02AF8. ||
|-
| 2228 || Hair/Beard item not equipped / not in a corpse / not in a vendor box || A [[TYPE|t_hair]] or [[TYPE|t_beard]] item is equipped, but has its [[LAYER]] property set to something other than [[LAYER|layer_hair]] or [[LAYER|layer_beard]]. ||
|-
| 2229 || Game piece not in a game board || A [[TYPE|t_game_piece]] item has been found outside of a container. ||
|-
| 2230 || Item equipped in the trade window layer but it isn't a trade window || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_none]], but its [[TYPE|type]] is not [[TYPE|t_eq_trade_window]]. ||
|-
| 2231 || Item equipped in the memory layer but it isn't a memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_special]], but its [[TYPE|type]] is not [[TYPE|t_eq_memory_obj]] or [[TYPE|t_eq_script]]. ||
|-
| 2233 || Item equipped in the mount memory layer but it isn't a mount memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_horse]], but its [[TYPE|type]] is not [[TYPE|t_eq_horse]]. ||
|-
| 2234 || Item equipped in the client linger layer but it isn't a client linger memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_flag_clientlinger]], but its [[TYPE|type]] is not [[TYPE|t_eq_client_linger]]. ||
|-
| 2235 || Item equipped in the murder memory layer but it isn't a murder memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_flag_murders]], but the character is an NPC or the player has its [[KILLS]] property set to 0. ||
|-
| 2236 || Item flagged as decay but without timer set || A top-level item has the [[ATTR|attr_decay]] flag set, but its [[TIMER]] property has not been set. ||
|-
| 3101 || Object is totaly lost, no parent exists || An object has no parent. || *
|-
| 3102 || Object was deleted or UID is incorrect || An object does not have a valid [[UID]]. || *
|-
| 3201 || Object not correctly loaded by server (UID conflict) || More than one object has the same [[UID]] value. || *
|-
| 4222 || Memory not equipped / not in the memory layer / without color || A memory item is not flagged as equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_special]], or has its [[COLOR]] property set to 0. ||
|-
| 4223 || Memory not on a char || A memory item is flagged as equipped, but it's [[CONT|parent]] is not a character. ||
|-
| 4224 || Stone/Guild memory mislinked || A memory item's [[COLOR]] property has one of the [[COLOR|memory_guild]] or [[COLOR|memory_town]] flags set, but the [[LINK]] property is not set to the [[UID]] of a guild or town stone. ||
|-
| 4225 || Stone/Guild memory linked to the wrong stone || A memory item's [[COLOR]] property has one of the [[COLOR|memory_guild]] or [[COLOR|memory_town]] flags set, but the character the memory is equipped to is not a member of the guild or town. ||
|-
| 7101 || Object's UID does not match up with server's UID table. || An object does not have the expected [[UID]] value. || *
|-
| 7102 || Object does not exist. || An object does not exist. || *
|-
| FFFF || Bad memory allocation || An exception was thrown whilst checking the object's validity. || *
|}

'''Note''': ''Garbage collection codes marked with * generally indicate a serious error within an object's internal state and should not normally be seen. If you are experiencing and are able to reliably reproduce any such errors then please report the details to the [http://tracker.sphere.torfo.org/bugs/main_page.php bug tracker].''

Error Codes

2011-05-02T01:22:25Z

MrSugarCube: Tried to improve the garbage collection table with more accurate error descriptions, and the actual error message to help with searching

{{Languages|Error_Codes}}

__FORCETOC__
==Exit Codes==
When Sphere closes, an 'exit code' will normally be shown in the console to describe why it is being shut down. In general, an exit code less than 0 is considered to be an error code, and values above 0 are normal shutdown codes. In most cases, a more descriptive error will be shown in the console and/or log file to help better diagnose the reason behind error codes.

The following table lists all of the current codes and their meanings.

{| border="1" cellpadding="3"
| '''Code''' || '''Description'''
|-
| -10 || Unexpected error occurred
|-
| -9 || Failed to bind server port
|-
| -8 || Failed to load world save(s)
|-
| -3 || Failed to load server settings (script, ini, mul files)
|-
| -1 || Shutdown via commandline (/?, /T and /Q switches)
|-
| 1 || X in console ''or'' SIGHUP signal, terminal closed (Linux Only)
|-
| 2 || SHUTDOWN command
|-
| 4 || Service shutdown ''(Windows Only)''
|-
| 5 || Console window closed ''(Windows Only)''
|-
| 6 || SIGABRT signal, process aborted ''(Linux Only)''
|}

==Garbage Collection==
The purpose of garbage collection is to validate all of the server objects and free up unused UIDs. Garbage collection is initiated:
* After the world save is loaded at startup.
* Before a world save begins, if the [[FORCEGARBAGECOLLECT]] setting is enabled in Sphere.ini.
* After the [[IMPORT]] or [[RESTORE]] functions have been used on the [[Server|server]] object.
* When the 'G' command is entered via the Sphere console
* When the [[GARBAGE]] function is used on the [[Server|server]] object.

When garbage collection encounters a problem with an object it may attempt to automatically correct the error, otherwise the object will be removed. When an object is removed by garbage collection there will normally be an error shown in the console describing the item that was removed along with the reason. The following table lists all of the garbage collection codes along with their description:

{| border="1" cellpadding="3"
| '''Code''' || '''Message''' || '''Description''' ||
|-
| 1102 || Disconnected charr not acting as such || A character has been marked disconnected from the world, but it is not listed in the sector's disconnected character's list. || *
|-
| 1103 || Ridden NPC not acting as such || An NPC has the [[FLAGS|statf_ridden]] flag set, but does not have its [[ACTION]] property set to 111. ||
|-
| 1104 || Ridden NPC without a mount item || An NPC has the [[FLAGS|statf_ridden]] flag set, but its rider does not have a mount item. ||
|-
| 1105 || Ridden NPC with a mislinked mount item || An NPC has the [[FLAGS|statf_ridden]] flag set, but the mount item's [[MORE2]] property does not match the NPC's [[UID]]. ||
|-
| 1106 || Disconnected NPC neither dead nor ridden || An NPC has been disconnected from the world, but does not have either one of the [[FLAGS|statf_ridden]] or [[FLAGS|statf_dead]] flags set. ||
|-
| 1107 || In game char that is neither a player nor an NPC || A character is not a player or an NPC. || *
|-
| 1108 || Char not on a valid position || A character's [[P|position]] is outside of the map boundaries. ||
|-
| 1203 || Ridden NPC not acting as such || Same as 1103. ||
|-
| 1204 || Ridden NPC without a mount item || Same as 1104. ||
|-
| 1205 || In game char that is neither a player nor an NPC || Same as 1107. ||
|-
| 2102 || Item without ITEMDEF || An item does not have an [[ITEMDEF]] section. || *
|-
| 2103 || Item ITEMDEF with ID = 0 || An item's [[ITEMDEF]] has an [[ID]] of zero. || *
|-
| 2104 || Disconnected item || An item has been marked as disconnected from the world. || *
|-
| 2105 || Item not on a valid position || An item is not in a container and its [[P|position]] is outside of the map boundaries. ||
|-
| 2106 || Item flagged as being in a container but it isn't || An item is flagged as not being top level, but it does not have a container. ||
|-
| 2202 || Item flagged as equipped but it isn't || An item is flagged as being equipped, but its parent is not a character. ||
|-
| 2205 || Mislinked item || An item's [[LINK]] property matches its [[UID]], or has been set to a [[UID]] that doesn't exist. ||
|-
| 2206 || Gm Robe / Deathshroud not on a char || A GM robe or death shroud ([[ID]] of 0204E or 0204F) is not equipped to a character. ||
|-
| 2207 || Deathshroud not on a dead char || A death shroud ([[ID]] of 0204F) is equipped to a character without the [[FLAGS|statf_dead]] flag set. ||
|-
| 2208 || Gm Robe on a char without privilege || A GM robe ([[ID]] of 0204E) is equipped to a character whose [[PLEVEL]] is less than 2. ||
|-
| 2220 || Trade window memory not equipped in the correct layer || A [[TYPE|t_eq_trade window]] item type is not equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_none]], or is equipped to an NPC. ||
|-
| 2221 || Client linger memory not equipped in the correct layer || A [[TYPE|t_eq_client_linger]] item type is not equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_flag_clientlinger]], or is equipped to an NPC. ||
|-
| 2222 || Memory not equipped / not in the memory layer / without color || A memory item ([[ID]] of 02007) is not equipped, or a non-memory item has had its [[TYPE]] set to [[TYPE|t_eq_memory_obj]] after creation. ||
|-
| 2226 || Mount memory not equipped in the correct layer || A [[TYPE|t_eq_horse]] item type is not equipped, or has its [[LAYER]] property set to something other than [[LAYER|layer_horse]]. ||
|-
| 2227 || Hair/Beard item not equipped / not in a corpse / not in a vendor box || A [[TYPE|t_hair]] or [[TYPE|t_beard]] item type that isn't equipped, is either not in a container or its container has an [[ID]] other than 02006 or 02AF8. ||
|-
| 2228 || Hair/Beard item not equipped / not in a corpse / not in a vendor box || A [[TYPE|t_hair]] or [[TYPE|t_beard]] item is equipped, but has its [[LAYER]] property set to something other than [[LAYER|layer_hair]] or [[LAYER|layer_beard]]. ||
|-
| 2229 || Game piece not in a game board || A [[TYPE|t_game_piece]] item has been found outside of a container. ||
|-
| 2230 || Item equipped in the trade window layer but it isn't a trade window || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_none]], but its [[TYPE|type]] is not [[TYPE|t_eq_trade_window]]. ||
|-
| 2231 || Item equipped in the memory layer but it isn't a memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_special]], but its [[TYPE|type]] is not [[TYPE|t_eq_memory_obj]] or [[TYPE|t_eq_script]]. ||
|-
| 2233 || Item equipped in the mount memory layer but it isn't a mount memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_horse]], but its [[TYPE|type]] is not [[TYPE|t_eq_horse]]. ||
|-
| 2234 || Item equipped in the client linger layer but it isn't a client linger memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_flag_clientlinger]], but its [[TYPE|type]] is not [[TYPE|t_eq_client_linger]]. ||
|-
| 2235 || Item equipped in the murder memory layer but it isn't a murder memory || An equipped item has been found with its [[LAYER]] property set to [[LAYER|layer_flag_murders]], but the character is an NPC or the player has its [[KILLS]] property set to 0. ||
|-
| 2236 || Item flagged as decay but without timer set || A top-level item has the [[ATTR|attr_decay]] flag set, but its [[TIMER]] property has not been set. ||
|-
| 3101 || Object is totaly lost, no parent exists || An object has no parent. || *
|-
| 3102 || Object was deleted or UID is incorrect || An object does not have a valid [[UID]]. || *
|-
| 3201 || Object not correctly loaded by server (UID conflict) || More than one object has the same [[UID]] value. || *
|-
| 4222 || Memory not equipped / not in the memory layer / without color || A memory item is not flagged as equipped, has its [[LAYER]] property set to something other than [[LAYER|layer_special]], or has its [[COLOR]] property set to 0. ||
|-
| 4223 || Memory not on a char || A memory item is flagged as equipped, but it's [[CONT|parent]] is not a character. ||
|-
| 4224 || Stone/Guild memory mislinked || A memory item's [[COLOR]] property has one of the [[COLOR|memory_guild]] or [[COLOR|memory_town]] flags set, but the [[LINK]] property is not set to the [[UID]] of a guild or town stone. ||
|-
| 4225 || Stone/Guild memory linked to the wrong stone || A memory item's [[COLOR]] property has one of the [[COLOR|memory_guild]] or [[COLOR|memory_town]] flags set, but the character the memory is equipped to is not a member of the guild or town. ||
|-
| 7101 || Object's UID does not match up with server's UID table. || An object does not have the expected [[UID]] value. || *
|-
| 7102 || Object does not exist. || An object does not exist. || *
|-
| FFFF || Bad memory allocation || An exception was thrown whilst checking the object's validity. || *
|}

'''Note''': ''Garbage collection codes marked with * generally indicate a serious error within an object's internal state. If you are experiencing and are able to reliably reproduce any such errors then please report the details to the [http://tracker.sphere.torfo.org/bugs/main_page.php bug tracker].''

Server

2011-01-29T04:44:21Z

MrSugarCube: State zero-based indexes for GMPAGE.n and CLIENT.n

{{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''.
|-
| [[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.
|-
| [[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]]

Characters

2010-05-29T18:03:32Z

MrSugarCube: Corrected the description of the SKILLCHECK function.

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

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AC]] || R || Returns the character's total defense.
|-
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value.
|-
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.
|-
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.
|-
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.
|-
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.
|-
| [[ACTP]] || RW || Gets or sets the character's ACTP value.
|-
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.
|-
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.
|-
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.
|-
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.
|-
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.
|-
| [[ATTACKER]] || R || Gets the number of opponents who have damaged the character.
|-
| [[ATTACKER]]''.LAST'' || R || Gets the UID of the opponent who most recently damaged the character.
|-
| [[ATTACKER]]''.MAX'' || R || Gets the UID of the opponent who has dealt the most damage to the character.
|-
| [[ATTACKER]]''.n.DAM'' || R || Gets the amount of damage that the nth opponent has dealt to the character. (zero-based)
|-
| [[ATTACKER]]''.n.ELAPSED'' || R || Gets the length of time since the nth opponent has damaged the characer, in seconds. (zero-based)
|-
| [[ATTACKER]]''.n.UID'' || R || Gets the UID of the nth opponent who has damaged the characer. (zero-based)
|-
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.
|-
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.
|-
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.
|-
| [[BODY]] || RW || Gets or sets the character's body.
|-
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.
|-
| [[BOW]] || W || Makes the character bow to SRC.
|-
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.
|-
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.
|-
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.
|-
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the character.
|-
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.
|-
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.
|-
| [[COLOR]] || RW || Gets or sets the character's hue.
|-
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.
|-
| [[COUNT]] || R || Returns the number of items equipped to the character.
|-
| [[CREATE]] || RW || Gets or sets the character's age since creation, in seconds.
|-
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.
|-
| [[DEX]] || RW || Gets or sets the character's total dexterity.
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.
|-
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.
|-
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).
|-
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).
|-
| [[DIR]] || RW || Gets or setes the direction that the character is facing.
|-
| [[DISCONNECT]] || W || Disconnects the character.
|-
| [[DISMOUNT]] || W || Dismounts the character from their ride.
|-
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.
|-
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.
|-
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.
|-
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.
|-
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.
|-
| [[DUPE]] || W || Creates a clone of the character.
|-
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.
|-
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.
|-
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.
|-
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.
|-
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[EXP]] || RW || Gets or sets the character's experience points.
|-
| [[FACE]] ''object_uid'' || W || Turns the character to face a specified object or SRC.
|-
| [[FAME]] || RW || Gets or sets the character's fame.
|-
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.
|-
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems
|-
| [[FLAGS]] || RW || Gets or sets the character's flags.
|-
| [[FIX]] || W || Re-aligns the character's Z level to ground level.
|-
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.
|-
| [[FLIP]] || W || Rotates the character.
|-
| [[FONT]] || RW || Gets or sets the character's speech font.
|-
| [[FOOD]] || RW || Gets or sets the character's food level.
|-
| [[FORGIVE]] || W || Revokes the character's jailed status.
|-
| [[GO]] ''location'' || W || Teleports the character to the specified location.
|-
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.
|-
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]
|-
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)
|-
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].
|-
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.
|-
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).
|-
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.
|-
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].
|-
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].
|-
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.
|-
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.
|-
| [[HEIGHT]] || R || Gets the character's height.
|-
| [[HITS]] || RW || Gets or sets the character's hitpoints.
|-
| [[HOME]] || RW || Gets or sets the character's home location.
|-
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.
|-
| [[INVIS]] || W || Sets whether or not the character is invisible.
|-
| [[INVUL]] || W || Sets whether or not the character is invulnerable.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[ID]] || R || Gets the character's ID.
|-
| [[INFO]] || W || Displays an information dialog about the character to SRC.
|-
| [[INT]] || RW || Gets or sets the character's total intelligence.
|-
| [[ISGM]] || R || Returns 1 if the character is in GM mode.
|-
| [[ISINPARTY]] || R || Returns 1 if the character is in a party.
|-
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.
|-
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.
|-
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.
|-
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.
|-
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.
|-
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.
|-
| [[KARMA]] || RW || Gets or sets the character's karma.
|-
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.
|-
| [[KILL]] || W || Kills the character.
|-
| [[LEVEL]] || RW || Gets or sets the character's experience level.
|-
| [[LIGHT]] || RW || Gets or sets the character's personal light level.
|-
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.
|-
| [[MANA]] || RW || Gets or sets the character's mana.
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.
|-
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.
|-
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.
|-
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.
|-
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.
|-
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.
|-
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.
|-
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.
|-
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.
|-
| [[MOUNT]] || R || Gets the UID of the character's mount.
|-
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.
|-
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).
|-
| [[MOVE]] ''direction, amount'' [[MOVE]] ''x y'' || W || Moves the object relative to its current position.
|-
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.
|-
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.
|-
| [[NAME]] || RW || Gets or sets the character's name.
|-
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.
|-
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.
|-
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.
|-
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.
|-
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.
|-
| [[NPC]] || RW || Gets or sets the character's AI type.
|-
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.
|-
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.
|-
| [[OBODY]] || RW || Gets or sets the character's original body.
|-
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.
|-
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.
|-
| [[OSKIN]] || RW || Gets or sets the character's original colour.
|-
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).
|-
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).
|-
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).
|-
| [[PACK]] || W || Opens the character's backpack for SRC to view.
|-
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.
|-
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.
|-
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.
|-
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.
|-
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.
|-
| [[RANGE]] || R || Gets the combat range of the character.
|-
| [[RELEASE]] || W || Clears the character's owners.
|-
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.
|-
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.
|-
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.
|-
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.
|-
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.
|-
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.
|-
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.
|-
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.
|-
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.
|-
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.
|-
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.
|-
| [[SAY]] ''message'' || W || Makes the character speak a message.
|-
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message
|-
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.
|-
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.
|-
| [[SERIAL]] || R || Gets the item's unique ID in the world.
|-
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.
|-
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.
|-
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.
|-
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.
|-
| [[SKILLCHECK]] ''skill_id, 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.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.
|-
| [[@UserBugReport]] || Fires when the player submits a bug report.
|-
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.
|-
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)
|-
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini
|-
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.
|-
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.
|-
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.
|-
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.
|-
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.
|-
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.
|-
| [[@UserSpecialMove]] || Fires when the player uses a special move.
|-
| [[@UserStats]] || Fires when the player opens the status window.
|-
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.
|-
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.
|-
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.
|}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@HitTry

2010-02-21T18:49:20Z

MrSugarCube: Created page with '==Description== This trigger fires when a character is about to swing their weapon or fist using a combat skill. Fires on: * Characters ==References== The following objec...'

==Description==
This trigger fires when a character is about to swing their weapon or fist 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 time, in tenths of a second, until the swing will complete.
|}

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

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

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

Server

2010-02-21T18:43:09Z

MrSugarCube:

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACCOUNT]]''.n'' || R || Gets the nth [[Accounts|account]] on the server. (zero-based)
|-
| [[ACCOUNT]]''.name'' || R || Gets the [[Accounts|account]] with the specified name.
|-
| [[AREA]]''.defname'' || R || Gets the [[Regions|region]] with the specified defname.
|-
| [[CHARDEF (Reference)|CHARDEF]]''.defname'' || R || Gets the [[CHARDEF|character definition]] for ''defname''.
|-
| [[CLIENT]]''.n'' || R || Gets the nth [[Characters#Clients|client]] on the server. '''Note:''' The nth client may not be an ingame player character, <CLIENT.n> first as it returns 1 for ingame clients and 0 for non-player clients.
|-
| [[GMPAGE]]''.n'' || R || Gets the nth [[GM Pages|GM page]] on the server.
|-
| [[GUILDSTONES]]''.n'' || R || Gets the nth [[Special Items#Guild.2FTown_Stones|guild stone]] on the server. (zero-based)
|-
| [[ITEMDEF (Reference)|ITEMDEF]]''.defname'' || R || Gets the [[ITEMDEF|item definition]] for ''defname''.
|-
| [[LASTNEWCHAR]] || R || Gets the last [[Characters|character]] created on the server.
|-
| [[LASTNEWITEM]] || R || Gets the last [[Items|item]] created on the server.
|-
| [[MAP]]''(x, y, map)'' [[MAP]]''(x, y, z, map)'' || R || Gets the [[Map Points|map point]] for a specified location.
|-
| [[REGIONRESOURCE (Reference)|REGIONRESOURCE]]''.defname'' || R || Gets the [[REGIONRESOURCE|region resource definition]] for ''defname''.
|-
| [[REGIONTYPE (Reference)|REGIONTYPE]]''.defname'' || R || Gets the [[REGIONTYPE|region type definition]] for ''defname''.
|-
| [[ROOM (Reference)|ROOM]]''.defname'' || R || Gets the [[Rooms|room]] with the specified defname.
|-
| [[SKILL (Reference)|SKILL]]''.defname'' || R || Gets the [[SKILL|skill definition]] for ''defname''.
|-
| [[SKILLCLASS (Reference)|SKILLCLASS]]''.defname'' || R || Gets the [[SKILLCLASS|skillclass]] for ''defname''.
|-
| [[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.
|-
| [[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]]

SPAWN

2010-02-21T18:41:35Z

MrSugarCube:

__FORCETOC__
Instead of setting the MORE1 property of a spawn to a single [[Characters|character]] defname, a spawn group can be used instead so that a random character is spawned. A spawn group contains a set of character defnames, with optional weights to affect their chances of spawning.

==Syntax==
The syntax for defining a spawn group is:

<tt>
[SPAWN ''defname''] 
ID=''character_defname_1'' ''weight'' 
ID=''character_defname_2'' ''weight'' 
ID=''character_defname_3'' ''weight'' 
''etc..''
 </tt>

The weight parameter can be used to make a defname more likely to be selected than the other defnames in the group. With a weight of 10 for example, a defname would be 10 times more likely to be selected.

==Properties==
The following properties are available when defining a spawn group:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[CALCMEMBERINDEX]] || R || Selects a defname from the spawn group at random, and returns its zero-based index.
|-
| [[DEFNAME]] || W || Sets the spawn group's defname.
|-
| [[ID]] ''defname'' ''weight'' || W || Adds a defname to the spawn group with the specified weight.
|-
| [[RESOURCES]] || R || Gets a list of defnames contained in the spawn group.
|-
| [[RESOURCES]].COUNT || R || Gets the number of defnames in the spawn group.
|-
| [[RESOURCES]]''.n''.KEY || R || Gets the ''nth'' defname in the spawn group. ''(1-based)''
|-
| [[RESOURCES]]''.n''.VAL || R || Gets the weight of the ''nth'' defname in the spawn group. ''(1-based)''
|}

==Examples==
<spherescript>
//
// Undead spawn from default script pack.
//
[SPAWN 08001]
DEFNAME=SPAWN_Undead_Weak
ID=c_spectre,2
ID=c_skeleton_w_axe
ID=c_skeleton_w_sword
ID=c_skeleton,5
ID=c_zombie,10
</spherescript>

<spherescript>
//
// Lists the characters of a spawn in the console, and picks one at random.
// Usage: DescribeSpawn <spawn_defname>
//
[FUNCTION describespawn]
// validate args
IF !(<SERV.SPAWN.<ARGS>>)
SERV.LOG Spawn '<ARGS>' does not exist.
RETURN
ELSEIF !(<SERV.SPAWN.<ARGS>.RESOURCES.COUNT>)
SERV.LOG Spawn '<ARGS>' has no contents.
RETURN
ENDIF

// list characters
SERV.LOG Spawn '<SERV.SPAWN.<ARGS>.DEFNAME>', <SERV.SPAWN.<ARGS>.RESOURCES.COUNT> characters)
FOR 1 <SERV.SPAWN.<ARGS>.RESOURCES.COUNT>
SERV.LOG Character <dLOCAL._FOR>: <dSERV.SPAWN.<ARGS>.RESOURCES.<LOCAL._FOR>.VAL>x <SERV.SPAWN.<ARGS>.RESOURCES.<LOCAL._FOR>.KEY>
ENDFOR

// pick character (obeying weights)
LOCAL.INDEX = <EVAL <SERV.SPAWN.<ARGS>.CALCMEMBERINDEX> + 1>
SERV.LOG Picked '<SERV.SPAWN.<ARGS>.RESOURCES.<LOCAL.INDEX>.KEY>'.
RETURN
</spherescript>

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

Main Page

2010-02-21T18:36:34Z

MrSugarCube:

Welcome to the retake of Taran's famous "[http://www.cs.rit.edu/~djr7581/ Sphere Scripting for Dummies tutorials]" and information. His tutorial was made for Sphere 55i, but now that Sphere 56b is about to be released we have decided to rewrite his tutorials and update the information to reflect the latest changes and additions.

'''Where should I start?'''

If you want to learn to script for Sphere 56b you should start by first reading the [[#Setting Up Sphere|Setting Up Sphere]] section. It will teach you how to set up a basic empty world to start your path. After that you should try reading the [[#Tutorials|Tutorials]], go slow, don't try to go through everything in one day as it takes time to read and fully understand everything.

'''I learned how to script! And now?'''

If you have finished the 10 chapters then we encourage you to read the tutortials and other articles below. They may not be as important as the others but they are still quite useful and contain lots of useful information. Try making your own scripts and share with others at the [http://www.sphereserver.net/index.php SphereServer Forums]. You can also ask for help if you can't resolve something by yourself. Remember to use the [[#Reference Compendium|Reference Compendium]] below as it is really useful.

'''I want to contribute!'''

Maintaining the information on this site involves a huge amount of work and not many of us have the time to do it. If you wish to help out then please feel free to do so! All you need to do to get started is [[Special:UserLogin|create an account]] if you haven't done so already. You can then edit any page by using the "Edit" link in the rop right corner. Before you go do this, you may want to start by reading the [[Contribution Guide]].

'''Special thanks to:'''

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

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

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

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

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

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

----

==Setting up Sphere==

* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]

==Tutorials==

Here are the chapters of Taran's original compendium, updated for Sphere56b:

* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''

In addition to these there are some more advanced tutorials that have been contributed by other members. Once you have read the above 10 tutorials you may wish to read these to learn more:

* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''

==Reference Compendium==

* [[:Category:Definitions|Definitions]]
** [[CHARDEF|Characters]]
** [[DIALOG|Dialogs]]
** [[EVENTS|Events]]
** [[ITEMDEF|Items]]
** [[MENU|Menus]]
** [[REGIONRESOURCE|Region Resources]]
** [[REGIONTYPE|Region Types]]
** [[AREADEF|Regions]]
** [[ROOMDEF|Rooms]]
** [[SKILLCLASS|Skill Classes]]
** [[SKILLMENU|Skill Menus]]
** [[SKILL|Skills]]
** [[SPAWN|Spawn Groups]]
** [[SPELL|Spells]]
** [[TYPEDEF|Types]]
* [[:Category:Objects|Objects]]
** [[Accounts]]
** [[Characters]]
** [[Database]]
** [[Files]]
** [[GM Pages]]
** [[Items]]
*** [[Special Items]]
** [[Map Points]]
** [[Parties]]
** [[Regions]]
** [[Rooms]]
** [[Sectors]]
** [[Server]]
* [[:Category:Scripts|Scripts]]
** [[:Category:Functions|Functions and Triggers]]
** [[:Category:Variables|General Functions, Properties and References]]
** [[Intrinsic Functions]]
** [[:Category:Statements|Statements]]

==Other Articles==

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

==External Links==

* [http://www.sphereserver.net/ Official SphereServer Website]
* [http://prerelease.sphereserver.net/ Official Sphere 56b Downloads]
* [http://scriptsharing.dv-team.de/ ScriptSharing]
* [http://www.cs.rit.edu/~djr7581/ Taran's Scripting for Dummies (Sphere 55i)]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]

Main Page

2010-02-21T18:33:48Z

MrSugarCube:

Welcome to the retake of Taran's famous "[http://www.cs.rit.edu/~djr7581/ Sphere Scripting for Dummies tutorials]" and information. His tutorial was made for Sphere 55i, but now that Sphere 56b is about to be released we have decided to rewrite his tutorials and update the information to reflect the latest changes and additions.

'''Where should I start?'''

If you want to learn to script for Sphere 56b you should start by first reading the [[#Setting Up Sphere|Setting Up Sphere]] section. It will teach you how to set up a basic empty world to start your path. After that you should try reading the [[#Tutorials|Tutorials]], go slow, don't try to go through everything in one day as it takes time to read and fully understand everything.

'''I learned how to script! And now?'''

If you have finished the 10 chapters then we encourage you to read the tutortials and other articles below. They may not be as important as the others but they are still quite useful and contain lots of useful information. Try making your own scripts and share with others at the [http://www.sphereserver.net/index.php SphereServer Forums]. You can also ask for help if you can't resolve something by yourself. Remember to use the [[#Reference Compendium|Reference Compendium]] below as it is really useful.

'''I want to contribute!'''

Maintaining the information on this site involves a huge amount of work and not many of us have the time to do it. If you wish to help out then please feel free to do so! All you need to do to get started is [[Special:UserLogin|create an account]] if you haven't done so already. You can then edit any page by using the "Edit" link in the rop right corner. Before you go do this, you may want to start by reading the [[Contribution Guide]].

'''Special thanks to:'''

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

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

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

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

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

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

----

==Setting up Sphere==

* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]

==Tutorials==

Here are the chapters of Taran's original compendium, updated for Sphere56b:

* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''

In addition to these there are some more advanced tutorials that have been contributed by other members. Once you have read the above 10 tutorials you may wish to read these to learn more:

* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''

==Reference Compendium==

* [[:Category:Definitions|Definitions]]
** [[CHARDEF|Characters]]
** [[DIALOG|Dialogs]]
** [[EVENTS|Events]]
** [[ITEMDEF|Items]]
** [[MENU|Menus]]
** [[REGIONRESOURCE|Region Resources]]
** [[REGIONTYPE|Region Types]]
** [[AREADEF|Regions]]
** [[ROOMDEF|Rooms]]
** [[SKILLCLASS|Skill Classes]]
** [[SKILLMENU|Skill Menus]]
** [[SKILL|Skills]]
** [[SPAWN|Spawn Groups]]
** [[SPELL|Spells]]
** [[TYPEDEF|Types]]
* [[:Category:Objects|Objects]]
** [[Accounts]]
** [[Characters]]
** [[Database]]
** [[Files]]
** [[GM Pages]]
** [[Items]]
*** [[Special Items]]
** [[Map Points]]
** [[Parties]]
** [[Regions]]
** [[Rooms]]
** [[Sectors]]
** [[Server]]
** [[Spawn Groups]]
* [[:Category:Scripts|Scripts]]
** [[:Category:Functions|Functions and Triggers]]
** [[:Category:Variables|General Functions, Properties and References]]
** [[Intrinsic Functions]]
** [[:Category:Statements|Statements]]

==Other Articles==

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

==External Links==

* [http://www.sphereserver.net/ Official SphereServer Website]
* [http://prerelease.sphereserver.net/ Official Sphere 56b Downloads]
* [http://scriptsharing.dv-team.de/ ScriptSharing]
* [http://www.cs.rit.edu/~djr7581/ Taran's Scripting for Dummies (Sphere 55i)]
* [http://uo.torfo.org/packetguide/ Jerrith's UO Packet Guide]
* [http://uo.torfo.org/packetguideKR/ Wyatt&Kons's UOKR Packet Guide]

[[Category: Navigation]]

SPAWN

2010-02-21T18:31:43Z

MrSugarCube: Created page with '__FORCETOC__ Instead of setting the MORE1 property of a spawn to a single character defname, a spawn group can be used instead so that a random character is spawne...'

Talk:@Damage

2010-01-26T19:14:57Z

MrSugarCube: (tidying up a bit)

[[User:Lincemiope|Lincemiope]] 15:40, 26 January 2010 (UTC)

I think the wiki about this trigger is wrong. I tested the @damage and typed this code into the script of a custom executioner's axe.

On=@Damage
src.say I'm the SRC

and the SRC is the one who took the damage and not who dealt it.
----
:[[User:MrSugarCube|MrSugarCube]] 19:13, 26 January 2010 (UTC)
:SRC is not the one who dealt the damage or the one who was damaged, but is the one 'responsible' for the damage - it means something different depending on the situation.
:
:For example:
:* When a weapon takes damage during combat, SRC is the character hit by the weapon.
:* When a piece of armour (or shield) is damaged during combat, SRC is the character who dealt the damage.
:* When a tool takes damage when using a skill (mining, lumberjack, lockpicking), SRC is the character performing the action.
:* When a spider web takes damage, SRC is the character walking on it.
:* When an item is damaged due to someone targeting it with a weapon, SRC is the character who targeted it.
:* When an item is hit by a harmful spell, SRC is the character who cast the spell.
:* When an item is hit by an explosion potion, SRC is the character who used the potion.
:* When the DAMAGE function is used, SRC is the source of the damage (third parameter, or SRC from the script calling the function)

Talk:@Damage

2010-01-26T19:13:19Z

MrSugarCube:

I think the wiki about this trigger is wrong. I tested the @damage and typed this code into the script of a custom executioner's axe.

On=@Damage
src.say I'm the SRC

and the SRC is the one who took the damage and not who dealt it.
----
:[[User:MrSugarCube|MrSugarCube]] 19:13, 26 January 2010 (UTC)
:SRC is not the one who dealt the damage or the one who was damaged, but is the one 'responsible' for the damage - it means something different depending on the situation.
:
:For example:
:* When a weapon takes damage during combat, SRC is the character hit by the weapon.
:* When a piece of armour (or shield) is damaged during combat, SRC is the character who dealt the damage.
:* When a tool takes damage when using a skill (mining, lumberjack, lockpicking), SRC is the character performing the action.
:* When a spider web takes damage, SRC is the character walking on it.
:* When an item is damaged due to someone targeting it with a weapon, SRC is the character who targeted it.
:* When an item is hit by a harmful spell, SRC is the character who cast the spell.
:* When an item is hit by an explosion potion, SRC is the character who used the potion.
:* When the DAMAGE function is used, SRC is the source of the damage (third parameter, or SRC from the script calling the function)

Talk:@Damage

2010-01-26T19:09:27Z

MrSugarCube:

I think the wiki about this trigger is wrong. I tested the @damage and typed this code into the script of a custom executioner's axe.

On=@Damage
src.say I'm the SRC

and the SRC is the one who took the damage and not who dealt it.

SRC is not the one who dealt the damage or the one who was damaged, but is the one 'responsible' for the damage - it means something different depending on the situation.

For example:
* When a weapon takes damage during combat, SRC is the character hit by the weapon.
* When a piece of armour (or shield) is damaged during combat, SRC is the character who dealt the damage.
* When a tool takes damage when using a skill (mining, lumberjack, lockpicking), SRC is the character performing the action.
* When a spider web takes damage, SRC is the character walking on it.
* When an item is damaged due to someone targeting it with a weapon, SRC is the character who targeted it.
* When an item is hit by a harmful spell, SRC is the character who cast the spell.
* When an item is hit by an explosion potion, SRC is the character who used the potion.
* When the DAMAGE function is used, SRC is the source of the damage (third parameter, or SRC from the script calling the function)

@DClick

2010-01-21T07:30:24Z

MrSugarCube: Undo revision 519 by Kristy123 (Talk)

==Description==
This trigger fires when an object is double clicked.

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

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

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

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents any hardcoded behaviour taking place.
|}

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

Revisions Changelog

2009-09-21T10:17:03Z

MrSugarCube: Updated 56b revisions

__FORCETOC__
Following is a list of all changes made to Sphere since version 55a. These changes can also be found by opening and reading the REVISIONS-55-SERIES.txt and REVISIONS-56-SERIES.txt files that are provided with the Sphere download.

You can also retrieve the very latest revisions file for the 56 series from the [http://nightly.prerelease.sphere.torfo.org/files/revisions.txt Automated SVN Builds] page. This file also shows the changes that have been made for the next prerelease.

==REVISIONS-55-SERIES==
<spherescript color="">---- 0.55a --------------------------------------------------------------------
---- * date unknown

new crypt for clients up to 2.0.7
2.0.7 client has strange problem with text containing - or _ in UNICODE speech modes (this can crash the client in some cases)
UNICODESpeech=off will fix for english.
3d beta client support.
new key ACCOUNT.CHARS
new key ACCOUNT.CHAR.x.NAME
use verb serv.server.0.name
bandages only for gm's
Steal Looting corpses
line numbers for errors where not accurate - ftell() is not accurate in text mode !!! does not work with fseek to get you back to the same place !!!
CHECK cant feed pets ? not GM's
Ghosts can't equip scriptable timers ? timers don't expire.
block type [REGION] changed to [REGIONTRIG]
added key RESOURCES= to [AREA]
added new block type [REGIONRESOURCES] in sphereregion.scp
changed [MAPRESDEF] to [REGIONRESOURCE]
ANIM with backwards and TimeDelay = invis in all other clients (client bug really)
x You put the logss in your pack
x. Also you can smelt Chaos and Order shields to get gold and blackrock ingots in mass amounts with no or little work.
x. Also with the guild stones, you can recruit the guildmaster making him a candidate and
take over the guild stone and kick everyone out. Warring guilds tend to make mules and do this sort of thing.
18. Many guild bugs. Players can be "half-way" in a guild now.
The result is other waring guilds are now orange to you and
you are blue to them. They can be half way in the guild two
ways.
18.1. Have the guildmaster never accept you fully in.
18.2. after the guildmaster accepts you in, don't click the stone. You can actually end up half way in a guild with your guild tag on.
19. Another guild bug is people will make a charater with 10 str
and then join it to a guild thats either Chaos or Order.
Then go attack greens, the player will auto attack back and
easily kill the player with 10 str. Thusly giving them a kill
they get guard killed and a near by guildmate loots the corpse of the person that got attacked by the guy with 10 str. No criminal tags are incured on either the looter or the attacker due to the fact that the target was green.

---- 0.55b --------------------------------------------------------------------
---- * date unknown

XBank and XCOLOR problems.
test inscription
DUPE limited to MaxItemComplexity
X (seems ok, script issue ?) word Bank dont work
immunity to ones own spells.
X (seems ok to me) defname of types don't work
x no loss of ar-value on unequipping armor or another item, but unequipping works correct with xedit
X (seems ok, script issue ?) scribing scrolls no longer check to see if magery is high enough to scribe a scroll
x The same with weapons like bow, you can shoot with the unequipt bow after unequip...
X ( seems ok) .shutdown 1 says it will, but never shutsdown :)
X returnvalue for functions . see i_test_rand_ret
slight damage to mining tools as used.
@SkillTry to @SkillStart

---- 0.55c --------------------------------------------------------------------
---- 15/03/2001

sphere list sorting. non letters and repeating letters
SPEECHCOLOR for NPC's
X Equip / unequip items that mod skills.
X (Seem ok ) overly heavy iron ingots ?
X Check - listening equipped items.
prevent NUKE command target in pack.
x test poisoned horse dies while ridden.
x change mapresources causes critical error on resync
i_runebook
CanSee and CanSeeLOS triggers for items
change unreasonable timer max length to 90 days. was 2 hours !
ADD items directly into pack by targetting other item in pack.

---- 0.55d --------------------------------------------------------------------
---- * date unknown

X tag.morep_1=<morep> works
X Check i_rune_book
remove MENU_ADMIN, replace with gump and FUNCTION
test output for scripts and logs should use the \r\n text mode. NotePad will work again.
SKILLDEF effects
"DELAY_HI",
"DELAY_LO",
"EFFECT_HI",
"EFFECT_LO",
missing SKILLMAKE=BLACKSMTIHING x.x for item 01b73 (i_shield_buckler) in sphereitemb5.scp
SPELL_Reactive_Armor = effect_Lo and Effect_Hi = random max percent reflected damage.
Crypt for 3.0.0

---- 0.55e --------------------------------------------------------------------
---- 21/03/2001

X Taste Id doesnt work at all it doesnt give a message period.
burn vs. smelt. flame effect ?
X -npc speech color not working properly
SEEMS OK = no kindling from trees -dagger on tree doesn't yield kindling "this is not a tree"
SEEMS OK = Problem with resources on Multiple planes, not getting any? Problem in map file maybe?
X Polymorph not working
SEEMS OK TO ME - When creating a t_script item, buying off a vendor, not to have the t_script attributes,
the TAGS do not appear to working through the ON=@CREATE .
X Need the @LOGIN @LOGOUT trigger
x Backgammon board has chess pieces
X All drinkable potions create a gold coin in pack instead of empty bottle (probably script TDATA value).
? CLIENT UPDATE BUG? - when u set an amount as a gm it doesnt set the whole stack-it leaves the original 1 and then gives u the diff in a different pile
-NEED to do UPDATE now - couldnt .set flags statf_nightsight
-Setting colors of cchar objects is very strange, I would color my zorn, but no refeash commands would show me the color, when I mounted it, it turned the right color.
- CANT CURSE self - curse, weaken, clumsy, feeblemind all consume regs but have no spell effect (no reduction of stats)
new command SAYUA Color, Mode, Font, Lang, Text
- dices can roll a "0,0", "0,x", "x,0"
SKILLBEST or SKILLBEST.1 to get the best ranked skills
X unicode speech must add lost of "......" , or it will not be displayed. "......." amount = unicode words amount - 2
TEXT problem with new client versions 2.0.7 ?
Yawn anim ?
Fix items that should decay but lose timers.
Eval Int message
TRUE - Drink one potion, then drink a different one - second one drank overwrites the first potion's effect. (IE, poison yourself, drink agility - now agile, but no longer poisoned at all)(all potions, same thing)
TRUE - Var.x=rand(nnn) doesn't save output of Random function (so a number since 0 to nnn-1) but it save the function.
Should use Var.x = <eval rand(nnn)> rand() only works bare if it's an 'if' or other known math function.
i_shield_wood shield made of only wood.

---- 0.55f --------------------------------------------------------------------
---- * date unknown

ARCHERYMINDIST=2
Repairs now require some of the components of the item.
Double fame when order pet to attack.
GM equipping item to NPC.
Stealing can fail
Stealing can get you caught.
-archer npcs AI three steps to fire
X Shovel is destroyed really fast if you mine

---- 0.55g --------------------------------------------------------------------
---- 29/03/2001

BUG - missing reags = success. ?
LASTUSED for player chars. seconds
CHECK -Seems ok = released animals still follow their owner
CHECK -Seems OK- Spawns seems to be hovering around their spawn point and not moving
Meditation:
[SKILL] all 0 to 100 percent.
DELAY=2.0,3.0 // per stroke.
EFFECT=0.0,100.0
ADV_RATE=10.0,200.0,800.0 = reveresd from old.
VALUES=
Bandage washing not working (it seems so anyway might have to wash them somewhere else)
NPC re-lighting torches a million times ?
Ingot smelting yield for one ore is 1.
x) If in war mode, summon a animal, you end up fighting yourself
Healing - you get two messages about applying bandages when you heal yourself/anyonelse unequip on heal healrates totally screwed up 100 heal 100 anat = crazy healing
SECTOR.RAIN SECTOR.DRY weather transition problem.
MORE1l, MORE1h, MORE2l, MORE2h
remove "Rune to:" header
CAN'T FIND THIS- they don't count fists or daggers as a criminal offence,
thus getting the npc's to attack them and making the npc grey and free to kill.
CALL FOR GUARDS WORKS FOR ME - Just hit the blue npc or player one time in war mode. The aggressor WILL NOT
be flagged criminal until the victim die. Or the aggressor can go in peace
mode and let the blue attack. The blue will become grey to him and finally
the aggressor will kill the blue and loot him without any problems. I tested
it, it works. Some players seem to use this for kill any blues in town.
NOT ON SELF = curse, weaken, clumsy, feeblemind all consume regs but have no spell effect (no reduction of stats)

---- 0.55h --------------------------------------------------------------------
---- 04/04/2001

CHECK - OK - refresh potion
keys to houses going blank
3) Hatches on boats wont open?
4) No Keys for tents boxes (Fixed this problem by adding a sign to the multi)
TAGLIST for multi, script, account, cchar
x loot while hidden
player use bandages on self,-> get 2 messages
Stealing off corspses still works, should never be able to steal off a corpse
murderer and criminal titles capitalized.
the bug appears if the archery butte is linked to an item. if the item it is linked to is dclicked, the archery butte reacts as if itself had been dclicked. (Same with pickpocket dips and training dummies and alot of other things).
With GM or PC, if you try to fill a keg with potion you get the you cannot use this yet message. I have a mortar and pestle. Tested at GM alchemy skill for both GM and PC.
In UO3D, if you log into an account that has no characters, you get a message
that says "You already have 5 characters". -- Fixed AD 3/31/2001.
Increased maximum item name length to 256.
The teleports in the map script, like entering dungeons should not allow NPC's to travel through them unless they are pets. This will keep monsters from harder levels roaming to easier levels.
CHECK - .sayua x,x,x,x,test -- Works, but was returning false, so it would say "Not a valid command or format"
It seem the off duty vendor brain act though it's just a vendor that has ran out of goods..
Party System reveals your account name (not password) to any person you ask to join.
CHECK - OK - 55g deletes all shrinked npcs on startup?
CHECK - OK - kills down by 1 each login ?
Can't attack things u can't see.
fix silly torch dupe AGAIN !

---- 0.55i --------------------------------------------------------------------
---- * date unknown

.ACCOUNT name ADD password changed to .ACCOUNT ADD name password
working tool tips
x A way to check if skill requirments when casting like IF (<SRC.CANMAKE>==i_arrow) something like that
x Poison needs to release a paralyzed person
x Item i_fire is being picked up by players when being created suring smelting
set color will not update imediately
5) Resources in Other Mapplanes like (1) and so on (MAP.SCP Attached)
6) Undefined Symbol error on region tags in housing.... Look at lines 4270 & 4263 in sphereitem_housing.scp

---- 0.55j --------------------------------------------------------------------
---- * date unknown

.55j
uid.x.name is broken
i_multi_house_wheat_cottage
UNICODE to UTF8 convert for LINUX
syntax error with " if ((<morey><0) || (<morey>>1000))"
port +1000 for the accounts ?

REGIONRESOURCE replace AMOUNT_LO,AMOUNt_HI with AMOUNT=lo,hi
REGIONRESOURCE replace SKILL_LO,SKILL_HI with SKILL=lo,hi
REGIONRESOURCE add REAPAMOUNT = range of amount to find in 1 try.

---- 0.55 R1 ------------------------------------------------------------------
---- 14/11/2003

11-11-2003, Zorm
Fixed dye anything, now has to be a dye tub
Added checking to strings to prevent exploits
Candle dupe has been fixed
Layer_horse can no longer be picked up by players
Messages in message boards can no longer be picked up by players
Stats max on create character raised from 66 to 80, allows new prof.txt
Now checking colors for pants and shirt when creating a character
Added more checking to a players name when creating characters
Teleport effects should no longer harm players
Pets now clear all old owners when getting a new one
Fixed showing of hp to other players
Administrator account is no longer auto admin
If you attempt a command and can't use it it comes out as normal speech
death menu option is no longer sent
guild mates no longer give you a kill count/karma/fame when you kill them
speech support improved. If you send unicode text it is handled throughout as unicode
non unicode text is sent back out as unicode text

12-11-2003, Kell
- Added @CallGuards as a propper trigger, "return 1" cancels guards being called
- Changed @Logout so that "return 1" disallows instalogout.
- Added support for the following TAGs on characters:
TAG.NAME.ALT (alternate name, good for incognito effects)
TAG.NAME.PREFIX (alternate prefix, if not set, defaults to Notoriety prefix - lady/lord)
TAG.NAME.SUFFIX (suffix for the name)
Note that a space isn't added for prefix or suffix on purpose, to allow text to be
glued to the name. You can add a space by using quotes, as in: TAG.NAME.SUFFIX="text "
- Using open door macro now triggers double click event.
- @DClick is now triggered on NPCs BEFORE attempting to mount, paperdoll or open
backpack ("return 1" cancels)
- If REAPAMOUNT isn't present, AMOUNT/3 will be used (it won't just default to 1).

13-11-2003, Kell
- Player characters with conjured flag get unmounted and the flag removed on death. Useful
to leave no corpse behind ( under ON=@Death : flags = <flags> | statf_conjured ). This would
be better as a server setting.
- Fixed spider webs remaining for days, and spider silk too (increased item count too much)

14-11-2003, Zorm
- Fixed client 1.26.x, it may now log on a 55i server
- Updated addbark, addbarkunicode, addbarkspeechtable to follow OSI better

---- 0.55 R2 ------------------------------------------------------------------
---- 27/11/2003

14-11-2003, Kell
- Fixed parsing of <<args>> or any other nested <var> btw. Also fixed parsing of numerical commands
(skills) so that <7> actually works for accessing skill #7 (this didn't make it to .55R1).
- Fixed dumb log file being created out of place. Will still happen when Sphere is run as
an NT service though.

15-11-2003, Zorm
- Added LOS check for taming
- Changed m_defense from BYTE to WORD, thus fixing the bug with AR > 255
- CanSeeLOS fixed, now checks if target object z is greater then myz + 14 if so blocks
- Kill count decay should be fixed
- Can no longer steal from trade windows or game boards
- ATTR_OWNED items may no longer be magic locked
- Added @DeathCorpse, argn1 = corpse?
- Trade window items are now dumped to back before corpse is made
- Now checks accounts when first sent
- Added @start in skilldefs
- Provoking players disabled

16-11-2003, Kell
- Identified problem regarding vanishing horses. Apparently, they stop acting as ridden, so instead
of deleting them I will just try and restart their behaviour again. If this fails, they still
shouldn't be deleted, and a new message should be printed out. To test, try creating a horse, mount
and then worldsave.
- Made sure that ABORTED skills don't hand out experience for failure. Only those that actually fail do.
( this fixes lumberjacking / mining exploits ).
- Added support for TAG.NAME.HUE (name colour)
- Added @SkillSelect to character events, and @Select to SKILLDEFs ("return 1" aborts).
- Added support for FORCHARS/FORITEMS/FOROBJS the correct way: SRC is retained and the default object
within the FOR block is the object being looped through.
- Added @SkillSuccess to character events, and @Success to SKILLDEFs ("return 1" aborts).
- Changed @SkillStart so that "return 1" actually aborts the skill (same for @Start in SKILLDEFs).
- Changed @Login so that "return 1" disallows logging in.
- Added @UserSkills ("return 1" cancels the skill window being displayed).
- Added @UserStats ( user requested stats update, return value is ignored )
- DBG: Added @SkillMakeItem to character events, triggered after the item has been created:
"return 1" deletes the item
"return 0" bounces the item as usual, but with no extra messages (potion, quality message)
"return" bounces the item as usual.

17-11-2003, Kell
- Hopefully fixed the bug with resyncing SPELL sections.
- Added triggers to SPELL sections, so you can now independently code spells:
@Select ( "return 1" cancels, "return 0" skip checks, "return" default behaviour)
@Start ( "return 1" cancels )
@Fail ( "return 1" cancels the fizzle effect).
@Success
- Changed SERV.LOG to allow writing of messages to the log. New syntax is:
serv.log @enable -- enables logging
serv.log @disable -- disable logging
serv.log @toggle -- toggles logging
serv.log text -- log text to console and file

18-11-2003, Zorm
- Fixed commands going to npcs, as well as more problems with unicode speech
support - BROKEN
- CGTypedArray, SetCount, DestroyElements, crashes on shutdown. Needs more
work to fix
- Fame gain fixed

18-11-2003, Kell
- Moved tags to CObjBase so all types of objects can have tags. Removed special
handling of TAGs from characters, script items and multi items.
- Fixed problem when resycing SKILL sections (spheretables.scp) would mess up
Skill_ defnames ( and the ACTION field on characters ). One no longer needs
to use workarounds like my FIXACTION function. Memory corruption problems
when resyncing SPELL tables should also be fixed.

18-11-2003, DarkStorm
- Started fixing some issues preventing sphere to compile on linux (CSocket.h)
- Managed to make it compile on Linux, comitted all the changes neccesary and
made sure it still compiles on windows.
- Implemented some code changes to remove the ncurses dependency on linux and
activated the console again.
- Implemented Colors on the Linux Console

19-11-2003, DarkStorm
- Added MD5 Password support via MD5PASSWORDS=1 in sphere.ini. If you activate
this, accounts will be saved with the password encoded (existing non-encoded
password will be converted). WARNING: disabling it afterwards won't restore
the passwords to plain text, and thus you won't be able to login with those
accounts. Once enabled, and the accounts file saved this setting should not be
changed (unless you set the passwords by hand).
- Removed the ScriptEngine Folder from the VC++6 project and wrapped an #if
defined() around the three functions that used it. It seems unused in the
productive gameserver, so i think we can remove the additional 400kb of
possibly error prone code.
- Removed the ScriptEngine Folder from the VC++ 7 project too
- Changed the VC++ 6 projects to use the shared CRT. (It's shipped with windows
since 95)
- Rewrote the new[], new, delete and delete[] operators and removed the memory
footprinting.
- Tuned the optimizations for VS.NET 2003 Release mode a bit.
- Removed the StatusReports from ntservice.cpp before it loads the ini for now
Reporting as a service if you aren't a service isn't supposed to be happening,
there needs to be a better fix than mine (maybe a -service argument?)
- added a check to CAccount to filter out accounts named "eof"
- fixed the help provided by .serv.accounts

19-11-2003, Kell
- Added a .DBG command, to put test code in. At the moment it'll be used to try
and crash the server in various ways, to see how it behaves on Linux.

20-11-2003, Kell
- Added INTERRUPT=X,Y to SPELL sections in spheretable_x.scp. This controls
the chance to fizzle a spell when hit in combat, at different Magery levels.
Default is 100.0, 100.0 (always fizzle). With a setting of "100.0 50.0" a GM
mage would only fizzle half the times.
- NPCs equipping stuff that is too heavy for them on @NPCRestock won't
spit hundreds of errors to the console.
- Added LOSTNPCTELEPORT=X to sphere.ini. If X is greater than 0, NPCs that have
a HOME point set will now teleport home if the distance to their HOME is above
X. This fixes it when they go through portals, then get lost in the map.
- Fixed problem with mounted NPCs dying and leaving a lingering object which
could leak later.
- FINALLY made it crash resistant under Linux - it is now trapping most
signals AND launching exceptions correcly. Tested with a single thread
(FREEZERESTARTTIME=0 in sphere.ini) and no background saving. More tests
to come.
- Changed the loading procedure so sphere.ini is loaded prior to any message
being printed to the log file. This allows the LOG= line to be parsed and
log files to be created in the appropriate folder, so to make sure, LOG=
line should be among the first in sphere.ini
- Changed the Linux makefile to include the necessary exception flags.
- "return 1" from a skill's @Start or @Success trigger doesn't trigger @Fail. If you
do want @Fail triggered, set ACTION=-1. This is compatible with .55i scripts, because
seeing as "return 1" didn't work there, scripts which did mean for @Fail to be triggered
should already be using ACTION=-1

21-11-2003, Kell
- Linux version now works with secondary threads (FREEZERESTARTTIME not 0),
and is able to restart the main loop if it freezes.
- Added a toggle to sphere.ini, "EXPERIMENTAL", to allow setting flags
which enable several experimental features. You will see these referenced
in the changelog as EF 0x????.
- EF 0x0001 enables a packet fix for Linux servers, for XCMD_Spy. Enable this
if your clients get a login error.
- EF 0x0002 enables new UNICODE fixes.
- EF 0x0004 enables zorm CanSeeLOS fix. This is required, seeing as that fix
won't allow you to cast uphill - a minor problem, but worth having a flag to
toggle that behaviour.
- EF 0x0008 disables interruption of fight skills if the ACT changes. This
fixes scripts that re-implement combat, and cases where combat with multiple
enemies would break swings.
- EF 0x0010 enables the INTERRUPT field in SPELL sections. INTERRUPT=100.0 100.0
SHOULD yield the standard always fail behaviour, as should not having an
INTERRUPT line at all. But seeing as this wasn't fully tested, you MUST enable
this flag to make any use of the interrupt values.
- Suggested value for EXPERIMENTAL field in sphere.ini is:
EXPERIMENTAL=013

22-11-2003, Kell
- LOSTNPCTELEPORT now checks for homedist, and won't teleport if the NPCs are still
within home-distance. This allows you to have low values.
- Further stability fixes for Linux version, it should now work fine with background
world saves.

22-11-2003, Zorm
- Added login crypt keys for clients up to 3.0.3, must add support for packets up to
0xCC or atleast lengths.
- I think I fixed unicode speech now

22-11-2003, Kell
- Attempted to fix the bug where setting ACT in a @Hit trigger stops
the swing, by restoring it after the trigger.
- Added SKIPDIFFICULTY (0 by default, or 1) to SKILL sections. Setting it to 1
skips the hardcoded difficulty check and allows one to do their own skill difficulty
checks in @Success, and "return 1" in there for a failure.
- Fixed @Select triggers which return 1 leaving the character waiting for an action.

23-11-2003, Zorm
- Experimental Precasting support, enable with experimental flag EF_Precast (flag 020),
this is not well tested - it's a work in progress. Included here just for the sake of
getting feedback.

24-11-2003, Kell
- SERV.SPELL(x).yyy, where x is the number of the spell and yyy is a key from the
SPELLs section, such as MANAUSE or RESOURCES. You can also use RESCAST for a
descriptive name of resources (much like RESMAKE works for items).
- SERV.SKILL(x).yyy, where x is the skill number and yyy is a key from the SKILLs
section, such as KEY or TITLE.
- Experimented with breaking SKILL and SPELL sections to seperate files, loading them
off-order and reloading, no problems found. Notice however that files containing
SPELL sections must load after the base items (like spheretable_x does).

25-11-2003, Kell
- Changed it so NPCs with SPIRITSPEAK equal or above 100.0 are able to see dead players,
like healers can. That allows one to use ON = @NPCSeeNewPlayer and an human brain to
implement NPCs that interact with the dead, without having to put up with healer's
default behaviour.
- Added flag NORESROBE to sphere.ini. If set to 1, players will not be given a robe
when resurrected.

26-11-2003, Kell
- Changed SERV.SPELL and SERV.SKILL so that they accept either number or defname
(SKILL also accepts plain names, like <SERV.SKILL(Magery).TITLE>)
- SERV.ITEMDEF(x).yyy to access data from ITEMDEF sections (similar to the above)
- SERV.CHARDEF(x).yyy to access data from CHARDEF sections (similar to the above)

27-11-2003, Kell
- On the brink of release, fixed a serious problem inherited from .55j where unknown
keywords being evaluated would *silently* come out untouched. As an example,
'<SERV.NONEXISTANT>' would silently come out as '<SERV.NONEXISTANT>' instead of ''
as in .55i. If used with tags, it could end up getting weird values and make it hard
to catch the error, as no error was being shown. It now returns '' for stuff it can't
evaluate, BUT also prints an error in the console. I believe this is the best possible
behaviour.
- Linux version is now declared stable. A minor problem still exists, in that pressing
CTRL-C in the console is not a good way to terminate the server, and will very likely
get it into a loop. This is a minor problem though, still trying to solve it. Test
servers report uptimes of 2-3 days with 10-20 players online (that's all the testing
I could do).
- Added CANMAKESKILL to test ONLY for the ability to make an item skillwise (it ONLY
tests the SKILLMAKE line), not resources.
- Added "fval", which works exactly like "eval", but formats the output in x.x format.
- There seems to be an issue with skills that use @Success to cancel a skill, in that
sometimes the skill won't be registered as finished, and using the skill again will
show the "you must wait" message. Players can just double-tap TAB to overcome this,
or you can use ACTION=-1 to force skill termination. Need some feedback on this, as
this behaviour might actually be due to bad scripts, so feel free to post comments.
- Many issues with the default

---- 0.55 R2a -----------------------------------------------------------------
---- 02/12/2003

30-11-2003, Zorm
- Fixed text going all uppercase sometimes and gm body commands.

01-12-2003, Kell
- Added @EquipTest and @ItemEquipTest (return 1 cancels equiping).
- Changed @SkillItemMake so that "return 1" only deletes the item if it's container hasn't
been set.
- Fixed bug with skills apparently not finishing (also fixes cartography).
- Fixed summoning bug (Linux only). This has to do with doing propper memory initialization
prior to using points.
- Removed all specific handling for SERV.xxx(y).zzz and made it generic. You can now use
either syntax: SERV.xxx(y).zzz or SERV.xxx.y.zzz.
- Changed default release options for speed optimization.

02-12-2003, Kell
- Fixed REAPAMOUNT / AMOUNT. It can now take multi-point values in a format similar to
ADVANCE for skills.
- Added SPEECHSELF= to sphere.ini, to allow setting the name of the speech trigger that
should be called to intercept player speech. Suggested: SPEECHSELF=spk_player
"return 1" in said trigger stops the player from actually talking.
- Removed hard coded "home home home" - one can just use the default spk_player speech if
that feature is desired (but mostly it's not)
- Added SPEECHPET= to sphere.ini, to allow setting the name of the speech trigger that
is called when a pet listens to its master. "return 1" in said trigger stops the pet
from listenning.

---- 0.55 R3 rc1 --------------------------------------------------------------
---- 08/01/2004

09-12-2003
- Added TAGs to CHARDEF/ITEMDEF sections. If a TAG does exists at an instance it overrides
the def value.

10-12-2003, Kell
- Added OptionFlags to sphere.ini, to set multiple options. These will be named OF_
- Added OF_Magic_IgnoreAR = 0001, so that AR doesn't count to stop damage spells.
- Added ACTDIFF to characters to obtain the current action difficulty.
Suggestion: One can use ACTDIFF to modify difficulty within skill Start triggers.
- Added a 6th parameter to the EFFECT command, the hue for the effect.
- Added @Effect trigger to spells, triggered after @SpellEffect
- <TAG0.xxx> can now be used to assume "0" as the default value for a tag.
- TAG0.xxx = yyy can now be used, if yyy is 0, then no tag will be recorded (same as setting
to a zero length string)
Using TAG0, you can thus have tags that are only recorded if they are not 0. This is great
for tags that are usually 0 and are often used (e.g. tags that must exist on all characters).
- Added VAR0 (same functionality as TAG0, but for VAR).

11-12-2003, Kell
- Added OF_Magic_CanHarmSelf = 0002, so that spells with SPELLFLAG_HARM will still affect the
caster (useful for SPELLEFFECT in scripts)
- Changed rand(x) to allow a 2nd parameter rand(x,y) and return a random number between x and y,
if y is present.

12-12-2003, Kell
- You can now use @color,font in SYSMESSAGE and MESSAGE. font ranges from 0 to 9, and I quote:
FONT_BOLD, // 0 - Bold Text = Large plain filled block letters.
FONT_SHAD, // 1 - Text with shadow = small gray
FONT_BOLD_SHAD, // 2 - Bold+Shadow = Large Gray block letters.
FONT_NORMAL, // 3 - Normal (default) = Filled block letters.
FONT_GOTH, // 4 - Gothic = Very large blue letters.
FONT_ITAL, // 5 - Italic Script
FONT_SM_DARK, // 6 - Small Dark Letters = small Blue
FONT_COLOR, // 7 - Colorful Font (Buggy?) = small Gray (hazy)
FONT_RUNE, // 8 - Rune font (Only use capital letters with this!)
FONT_SM_LITE, // 9 - Small Light Letters = small roman gray font.
- Changed SKILLMAKE to allow getting an individual resource in the list. SKILLMAKE.1 gets the first,
SKILLMAKE.1.VAL gets the value and SKILLMAKE.1.KEY gets the associated resource key.

13-12-2003, Kell
- Added "RELEASE" to character verbs, does the same as "release" when spoke to a pet.
- Added @NPCFollow trigger, called when an NPC is following someone.

14-12-2003, Kell
- Changed ATTACK to accept as parameter the UID of the character to attack.
- Changed TRY to make no plevel or touch/distance checks. Use TRYP if you want those checks
(TRYP 0 only checks for touch/distance, not plevel).
- Added an useful keyword to scripts, that allows one to use "OBJ" as pointer to an item. It's
similar to ACT but it can be used anywhere.
Example:
OBJ = <UID>
SAY You are <OBJ.NAME>, with uid <OBJ.UID>.
- Changed MEMORY to allow an UID as parameter, so you can now find the memory related to a specific
UID. If no argument is used, it uses SRC's UID as usual. Also changed it to be read/write.
Example:
MEMORY <SRC.UID> 0200 // set memory
SAY Memory flag regarding <UID> is <MEMORY.<SRC.UID>>.

15-12-2003, Kell
- Changed @UserSkills so that <argn1> is the number of the skill being updated, or -1 for the skill
list. This allows one to stop sending of skill updates to the client.
- NPCs will not say "Yes Master" if SPEECHPET is set in sphere.ini (you can script it in the speech
triggers if you want them to). If SPEECHPET isn't set, they still won't say anything unless they
can see their master (which is great for GMs). Players will no longer respond "Sorry".
- Resource gathering was changed so that the SKILLMAKE of the resource item is checked. Resources
which fail the canmake check are ignored and aren't part of the randomization process. If for some
reason one wants to go back to the old style, just comment SKILLMAKE on the ore itemdefs.
- Added OF_Skill_DiffFirst = 0008. With this flag turned on, difficulty for a skill is calculated BEFORE
calling @Start/@SkillStart. This has the advantage of allowing the difficulty for a skill to be changed
via ACTDIFF within that trigger. Notice that for a skill to fail, ACTDIFF must be set above the current
(modified) skill. Setting ACTDIFF to a negative value means that the skill will abort, that is, @Fail
will not be called and no skill gain will be attempted. To always fail set ACTDIFF to a value above the
possible skill (say, 1001).
This has the sideffect of calling @SpellCast before @Start/@SkillStart. On the other hand, it is the
ultimate tool for implementing your own skill difficulties.
Here's an example of making the difficulty for arms lore AT LEAST the same value as for making the item
(using the primary skill). Characters with skill above ACTDIFF will always succeed.
ON = @Start
if ( <SRC.ACTDIFF> < <SRC.ACT.SKILLMAKE.1.VAL> )
SRC.ACTDIFF = <SRC.ACT.SKILLMAKE.1.VAL>
endif

16-12-2003, Kell
- You can now use NEWITEM, NEWNPC and NEWDUPE in item scripts, the items will be created into "NEW". Using
these commands on a character will create the items in both NEW and ACT. If you want to use these
on a character without changing ACT, use SERV.NEWITEM, etc.
Example:
NEWITEM i_gold
NEW.AMOUNT 100
NEW.P = <TOPOBJ.P>
You can also use NEW as a temporary handler, much like you can use OBJ (and to an extenct, ACT).

17-12-2003, Kell
- Functions can now receive "args" when being evaluated, as in <SRC.myfunction Say hello>
- Added RANGE=min,max or RANGE=max (min defaults to 0) for ITEMDEF and CHARDEF. Default weapon range
is 1. Default character range is 1. Range is calculated as (character + weapon -1).
Example: Assuming all characters are RANGE=1 (which they are), putting RANGE=2 in an halberd
means characters equipping it can hit 1 square further.

18-12-2003, Kell
- The main section for DIALOGs is now fully interpreted like other scripts, allowing you to add logic
to your dialog, use IFs, etc. The only limitation at the moment is that gump commands are only
allowed right in the DIALOG section, and not within FUNCTIONs, but hei... it's better. :)
- Dialogs will no longer conflict with each other, this allows for permanent on-screen dialogs. INPDLG
works too, seeing as there can be only one INPDLG window onscreen at all times.
- Added RESOURCES.n, RESOURCES.n.KEY and RESOURCES.n.VAL to items/characters.

19-12-2003, Kell
- To make writing dialogs easier, added a cursor and relative coordinates:
dorigin 50 50 // sets the origin to x=50, y=50
Using "*" near a coordinate makes it relative to the origin, and displaces the origin by some amount:
dtext *0 *10 0 the origin is now x=50 y=60, so is the last location
Using "+" near a coordinate makes it relative to the last location w/o changing the origin.
dtext +10 - 0 adds 10 to X (y=150, o.y=100)
As an example, imagine writing a list of text with 3 columns, each seperated via 200 x and 20 space
between each row:
dorigin 10 10
// first row
dtext *0 - 5 1:
dtext +10 - 0 the text for row1, col1
dtext *200 - 5 2: // x orig = 200
dtext +10 - 0 the text for row1, col2
dtext *200 - 5 3: // x orig = 400
dtext +10 - 0 the text for row1, col2

And now one only has to go down one row. and the text is quite similar. This isn't too easy to explain, it's
there for whomever might find it useful. If you can't think of a use for it, just ignore it. ;)
- Fixed the bug with FORCHARS/ITEMS/OBJS and keywords starting with "FOR" (like FORensics).
- Changed textadd and gumptext to collapse equal strings of text to the same index. So if you use
gumptext 10 20 This is an example.
gumptext 10 40 This is an example.
gumptext 10 60 This is an example.
It will only generate ONE text id. This does away with the need to have a seperate TEXT section. Granted,
such a section is still useful for keeping strings all in one place (in this case it'd be useful), but it
is no longer mandatory, it becomes simply a matter of style/choice.

20-12-2003, Kell
- Equal PLEVEL should be able to see each other, so they are now.
- You can now open a dialog in a specific page, with DIALOG d_dialog_name pagenumber. This isn't actually
possible with the UO client - what it does is recalculate the dialog page/button numbers so that the selected
page is first. It's completly invisible though, and works perfectly.
- Added a new command - DTEXT - to gumps, which does the handling of text ids for you (d stands for dynamic):
dtext x y color Actual text comes here.
Text added with gumptext is actually added to the [DIALOG ... TEXT] section. If you're only using a given
text string once, then it's actually faster using this than using "text" and adding it to the TEXT section
of the dialog. Simmilar commands, DCROPPEDTEXT and DTEXTENTRY are also in, also taking text instead of an
index. DHTMLGUMP is also in, but notice that the syntax is like HTMLGUMP, except that you ommit the ID and add
the text in the end.
With these changes, you can completly ommit the [DIALOG ... TEXT] section of dialogs. Only those strings
that are commonly used throughout the dialog should you put in the [DIALOG ... TEXT] section.
Internally, both gumptext and textadd simply add stuff to the dialog as needed, and send normal "text"
commands to the client, so they're safe to use. But they free you from having to keep track of a LONG
list of numbers, and allow you to shape and modify your dialog w/o bothering with text ids.
- You can now use FUNCTIONs that issue gump commands. So you actually make your own gump commands!!! Death to
copy & paste dialogs!

21-12-2003, Kell
- Fixed a bug in that setting stats & skills via scripts wouldn't correctly parse things. For instance, numerical
expressions.
- Started work on MANUAL.TXT, to detail the current state of things like triggers and their arguments, seeing as
reading this changelog is probably a difficult task for a lot of people.
- Changed args in functions to be writeable. This is useful in scripts, but for triggers, the server will read
back the values and use the new ones wherever it makes sense. For the time being, these triggers were
changed:
@GetHit, ARGN1 is the damage being apllied, ARGN2 the damage type (as usual, but now writeable).
@Hit, ARGN1 is now the raw damage being applied, prior to armour (writeable). ARGO is the weapon (if any).
@PersonalSpace, ARGN1 is the stamina required to move (writeable). "return 1" stops the movement, "return 0"
allows the movement but shows none of the hard-coded messages. Plain "return" or no return, works as standard.
@Hit, @HitTry and @HitMiss were also changed so that ARGO is the weapon being used (handy so you don't have to
be looking at layers n stuff).
I should add that ACTDIFF is also available, and it can be used to change the difficulty of a skill, even make
a skill succedd that would otherwise fail (by setting it to 0). It can also be used in @HitTry now, and if
set to any non-negative value, a missing hit will instead succeed.
- Added StrEat function, which removes a word up to the space, from a string (<streat("hello there friend")>
or <streat hello there friend> return "there friend")
- Added <SERV.LOOKUPSKILL skill name> which returns the skill number for some text or -1 if not found.
- After some beta-testing, a few fixes to dialogs.
- LOCAL.xxx within functions for LOCAL . They're a bit more efficient on servers with lots of global
vars due to faster lookups ). LOCAL variables always come up initially as "0".
- ARGN1, ARGN2 and ARGN3 are set for functions with numeric arguments. So whenever possible, use these instead
of argv. Example: "myfunction 123 50 89" - these 3 values will be parsed into argn1, argn2 and argn3

22-12-2003, Kell
- Functions can now return strings using "return". Notice that this behaves like TAGs, in that if you do
return 2+2
then "2+2" is returned, and not "4". You'll have to explicitly call "eval" on what you want
to return:
return <eval (2+2)>
Returning strings causes no extra lag, seeing as the old method of returning a value relied on the same
string which is returned (EVALed). So it is actually faster (although hardly noticeable).
This might pose a problem problem if you have "return rand" or similar, instead of "return <eval rand..."
seeing as multiple uses of the return value re-evaluate it, generating a new random number - again,
similar to TAGs.
MAKE SURE YOU HAVE "EVAL" on your "return" lines, wherever you want the result of a calculation to be
returned. The next version will probably not have an EF_ReturnString flag.

- Modified the profiling function to keep track of average consumption over time. The average time is
calculated each second as 90% of the previous average time plus 10% the current time. This poses some
resistence to spikes.
- Added a new keyword to @Create / @NPCRestock and template scripts: FULLINTERP. Set FULLINTERP=1 to allow the
use of functions, ifs, etc. Example:
ON = @NPCRestock
ITEM=i_cape
FULLINTERP
ITEM=i_robe
MY_FUNCTION_CALL
You can use FULLINTERP 0 to disable the feature, after you've enabled it, but it's usually pointless, seeing as
this FULLINTERP affects only the remainder of the current script. Bear in mind that the usual restrictions apply,
seeing as the created NPC is not ingame yet.

23-12-2003, Kell
- Added access to TERRAIN and STATICS either via P.key, MOREP.key or SERV.MAP(x,y).key, with key being one of:
TERRAIN The terrain ID
ISDIRT Checks the terrain ID to see if it's dirt.
ISGRASS guess
ISROCK dunno
ISWATER guess again
STATICS Number of statics in the position
STATICS(n) ID of static Nth static ( eg: <SERV.MAP(200,300).STATICS(0)>. Shows no error in the console
if static isn't present, returning 0 - useful to test for a static w/o counting or looping.
STATICS.n same
STATICS(n).key Get a key from the appropriate ITEMDEF. eg: <SERV.MAP(200,300).STATICS(0).NAME>

- Added basic iterator construct, WHILE, with the following syntax:
WHILE ( condition )
// do stuff, current iteration number in <LOCAL._WHILE>
END // or ENDWHILE

also added FOR, terminated with either END or ENDFOR, with the following syntax:

FOR 5 // loops from 0 to 5, current iteration number in LOCAL._FOR
or FOR 3 5 // loops from 3 to 5, current iteration number in LOCAL._FOR
or FOR K 5 // loops from 0 to 5, current iteration number in LOCAL.K
or FOR K 3 5 // loops from 3 to 5, current iteration number in LOCAL.K
// do stuff
END // or ENDFOR

Changing these LOCAL variables has no effect on the loop.
- Wrote a small assembly function to access the high resolution timer. Works for both windows and Linux,
now being used in profiling. Profiling works on Linux now. It also looks a lot better in the console
thanks to the monospaced font.
- Changed the console font under Windows to Courier, which is monospaced, so things come out aligned in
the console. Under Linux, the console is naturally monospaced.
- You can now add new SKILL sections, up to 70. SERV.MAXSKILL tells you how many skills are loaded. Notice
that they won't be sent to the client though, the client doesn't support them (hint: @UserSkills). There
is also a FLAGS key for SKILL section, with the following values:
[DEFNAME skill_defs]
SKF_SCRIPTED 01 // no hardcoded behaviour, only triggers are called.
// feel free to add new tags you find useful, but only above 01000 please, to make room for future
expansion
This is heavily experimental, mess with it at your own risk.
- SKILLSELECT skill - force a button select event on the skill list

24-12-2003, Kell
- Fixed TYPEDEFS section in spherefs.scp loosing values when resynced.
- Added <CANMOVE dir>, takes a direction as argument (like WALK), returns the area ID we're moving to,
or 0 if no move is possible.
- Added <MOVE dir>, takes a direction as argument (like WALK), returns the TILE flags for that position.
Notice that flag 04 is walkable. Here's a list of flags, you can copy&paste it into spheredefs.scp. This
keyword might change in the future.

[DEFNAME tile_flags] // by Shadowlord
tilef_background 01 // No idea. None whatsoever. Maybe it's the blackness.
tilef_weapon 02 // I smack thee with this here ... club?
tilef_transparent 04 // Yeah. So we can see through it?
tilef_translucent 08 // Okay...
tilef_wall 010 // Hey look, we can't walk through it!
tilef_damaging 020 // Lava, perhaps? Fires, hmm!
tilef_impassable 040 // Mountains and stuff, I'll wager.
tilef_wet 080 // Water? Or mud? Or a slick road in a rainstorm? Probably the first.
tilef_unknown 0100 // Uh...
tilef_surface 0200 // Tables or something?
tilef_bridge 0400 // I wonder why they'd have a flag for that.
tilef_stackable 0800
tilef_window 01000 // So we can see/shoot out?
tilef_noshoot 02000 // ? We can't shoot out or something? So, like a glass window maybe?
tilef_prefixA 04000 // A card
tilef_prefixAn 08000 // An apple
tilef_internal 010000 // hair, beards, etc
tilef_foliage 020000 // Probably bushes and tree leaves and stuff.
tilef_partialHue 040000 // semi-glowy?
tilef_unknown_1 080000 // Well, gee. I should see if it's used on anything...
tilef_map 0100000 // Sounds good to me.
tilef_container 0200000 // They flag these!?
tilef_wearable 0400000 // Omigod!
tilef_lightSource 0800000 // I'm getting tired of typing repetitive shiznit now.
tilef_animated 01000000 // Like fire again. And stuff. Those spinny propeller thingies!
tilef_noDiagonal 02000000 // !?!???!!?
tilef_unknown_2 04000000 // I really hope some of these unknowns are n/w/s/e facing flags.
tilef_armor 08000000 // Armor, okay, so does that count shields? Hmmm?
tilef_roof 010000000 // "Don't fall through me!" Or why isn't it just flagged surface or something?
tilef_door 020000000 // Okay...
tilef_stairBack 040000000 // Don't we have stairs that go forward or left too? This could cover both...
tilef_stairRight 080000000 // Well, whatever, you can climb them, so, hey... Good use for a

NOTE : EF flags change from version to version, so make SURE you're using only the EF
flags you want, if any.

SUMMARY of flags for Sphere.ini:
OptionFlags= // Flags for options that affect server behaviour but not compatibility
0001 // OF_Magic_IgnoreAR
0002 // OF_Magic_CanHarmSelf
0004 // OF_Magic_StackStats (Do NOT set this yet)
0008 // OF_Skill_DiffFirst
0010 // OF_Archery_CanMove
0020 // OF_Magic_PreCast

Experimental= // Flags for options that affect server behaviour and which might affect compatibility
0001 // EF_XCMD_Spy
0002 // EF_UNICODE
0004 // EF_CanSeeLOS
0008 // EF_ReturnString
Suggested value: EXPERIMENTAL=01

01-12-2003, Kell
- Added @EquipTest and @ItemEquipTest (return 1 cancels equiping).
- Changed @SkillItemMake so that "return 1" only deletes the item if it's container hasn't
been set.
- Fixed bug with skills apparently not finishing (also fixes cartography).
- Fixed summoning bug (Linux only). This has to do with doing propper memory initialization
prior to using points.
- Removed all specific handling for SERV.xxx(y).zzz and made it generic. You can now use
either syntax: SERV.xxx(y).zzz or SERV.xxx.y.zzz.
- Changed default release options for speed optimization.

02-12-2003, Kell
- Fixed REAPAMOUNT / AMOUNT. It can now take multi-point values in a format similar to
ADVANCE for skills.
- Added SPEECHSELF= to sphere.ini, to allow setting the name of the speech trigger that
should be called to intercept player speech. Suggested: SPEECHSELF=spk_player
"return 1" in said trigger stops the player from actually talking.
- Removed hard coded "home home home" - one can just use the default spk_player speech if
that feature is desired (but mostly it's not)
- Added SPEECHPET= to sphere.ini, to allow setting the name of the speech trigger that
is called when a pet listens to its master. "return 1" in said trigger stops the pet
from listenning.

09-12-2003
- Added TAGs to CHARDEF/ITEMDEF sections. If a TAG does exists at an instance it overrides
the def value.

10-12-2003, Kell
- Added OptionFlags to sphere.ini, to set multiple options. These will be named OF_
- Added OF_Magic_IgnoreAR = 0001, so that AR doesn't count to stop damage spells.
- Added ACTDIFF to characters to obtain the current action difficulty.
Suggestion: One can use ACTDIFF to modify difficulty within skill Start triggers.
- Added @Effect trigger to spells, triggered after @SpellEffect
- <TAG0.xxx> can now be used to assume "0" as the default value for a tag.
- TAG0.xxx = yyy can now be used, if yyy is 0, then no tag will be recorded (same as setting
to a zero length string)
Using TAG0, you can thus have tags that are only recorded if they are not 0. This is great
for tags that are usually 0 and are often used (e.g. tags that must exist on all characters).
- Added VAR0 (same functionality as TAG0, but for VAR).

11-12-2003, Kell
- Added OF_Magic_CanHarmSelf = 0002, so that spells with SPELLFLAG_HARM will still affect the
caster (useful for SPELLEFFECT in scripts)
- Changed rand(x) to allow a 2nd parameter rand(x,y) and return a random number between x and y,
if y is present.

12-12-2003, Kell
- You can now use @color,font in SYSMESSAGE and MESSAGE. font ranges from 0 to 9, and I quote:
FONT_BOLD, // 0 - Bold Text = Large plain filled block letters.
FONT_SHAD, // 1 - Text with shadow = small gray
FONT_BOLD_SHAD, // 2 - Bold+Shadow = Large Gray block letters.
FONT_NORMAL, // 3 - Normal (default) = Filled block letters.
FONT_GOTH, // 4 - Gothic = Very large blue letters.
FONT_ITAL, // 5 - Italic Script
FONT_SM_DARK, // 6 - Small Dark Letters = small Blue
FONT_COLOR, // 7 - Colorful Font (Buggy?) = small Gray (hazy)
FONT_RUNE, // 8 - Rune font (Only use capital letters with this!)
FONT_SM_LITE, // 9 - Small Light Letters = small roman gray font.
- Changed SKILLMAKE to allow getting an individual resource in the list. SKILLMAKE.1 gets the first,
SKILLMAKE.1.VAL gets the value and SKILLMAKE.1.KEY gets the associated resource key.

13-12-2003, Kell
- Added "RELEASE" to character verbs, does the same as "release" when spoke to a pet.
- Added @NPCFollow trigger, called when an NPC is following someone.

14-12-2003, Kell
- Changed ATTACK to accept as parameter the UID of the character to attack.
- Changed TRY to make no plevel or touch/distance checks. Use TRYP if you want those checks
(TRYP 0 only checks for touch/distance, not plevel).
- Added an useful keyword to scripts, that allows one to use "OBJ" as pointer to an item. It's
similar to ACT but it can be used anywhere.
Example:
OBJ = <UID>
SAY You are <OBJ.NAME>, with uid <OBJ.UID>.
- Changed MEMORY to allow an UID as parameter, so you can now find the memory related to a specific
UID. If no argument is used, it uses SRC's UID as usual. Also changed it to be read/write.
Example:
MEMORY <SRC.UID> 0200 // set memory
SAY Memory flag regarding <UID> is <MEMORY.<SRC.UID>>.

15-12-2003, Kell
- Changed @UserSkills so that <argn1> is the number of the skill being updated, or -1 for the skill
list. This allows one to stop sending of skill updates to the client.
- NPCs will not say "Yes Master" if SPEECHPET is set in sphere.ini (you can script it in the speech
triggers if you want them to). If SPEECHPET isn't set, they still won't say anything unless they
can see their master (which is great for GMs). Players will no longer respond "Sorry".
- Resource gathering was changed so that the SKILLMAKE of the resource item is checked. Resources
which fail the canmake check are ignored and aren't part of the randomization process. If for some
reason one wants to go back to the old style, just comment SKILLMAKE on the ore itemdefs.
- Added OF_Skill_DiffFirst = 0008. With this flag turned on, difficulty for a skill is calculated BEFORE
calling @Start/@SkillStart. This has the advantage of allowing the difficulty for a skill to be changed
via ACTDIFF within that trigger. Notice that for a skill to fail, ACTDIFF must be set above the current
(modified) skill. Setting ACTDIFF to a negative value means that the skill will abort, that is, @Fail
will not be called and no skill gain will be attempted. To always fail set ACTDIFF to a value above the
possible skill (say, 1001).
This has the sideffect of calling @SpellCast before @Start/@SkillStart. On the other hand, it is the
ultimate tool for implementing your own skill difficulties.
Here's an example of making the difficulty for arms lore AT LEAST the same value as for making the item
(using the primary skill). Characters with skill above ACTDIFF will always succeed.
ON = @Start
if ( <SRC.ACTDIFF> < <SRC.ACT.SKILLMAKE.1.VAL> )
SRC.ACTDIFF = <SRC.ACT.SKILLMAKE.1.VAL>
endif

16-12-2003, Kell
- You can now use NEWITEM, NEWNPC and NEWDUPE in item scripts, the items will be created into "NEW". Using
these commands on a character will create the items in both NEW and ACT. If you want to use these
on a character without changing ACT, use SERV.NEWITEM, etc.
Example:
NEWITEM i_gold
NEW.AMOUNT 100
NEW.P = <TOPOBJ.P>
You can also use NEW as a temporary handler, much like you can use OBJ (and to an extenct, ACT).

17-12-2003, Kell
- Functions can now receive "args" when being evaluated, as in <SRC.myfunction Say hello>
- Added RANGE=min,max or RANGE=max (min defaults to 0) for ITEMDEF and CHARDEF. Default weapon range
is 1. Default character range is 1. Range is calculated as (character + weapon -1).
Example: Assuming all characters are RANGE=1 (which they are), putting RANGE=2 in an halberd
means characters equipping it can hit 1 square further.

18-12-2003, Kell
- The main section for DIALOGs is now fully interpreted like other scripts, allowing you to add logic
to your dialog, use IFs, etc. The only limitation at the moment is that gump commands are only
allowed right in the DIALOG section, and not within FUNCTIONs, but hei... it's better. :)
- Dialogs will no longer conflict with each other, this allows for permanent on-screen dialogs. INPDLG
works too, seeing as there can be only one INPDLG window onscreen at all times.
- Added RESOURCES.n, RESOURCES.n.KEY and RESOURCES.n.VAL to items/characters.

19-12-2003, Kell
- To make writing dialogs easier, added a cursor and relative coordinates:
dorigin 50 50 // sets the origin to x=50, y=50
Using "*" near a coordinate makes it relative to the origin, and displaces the origin by some amount:
dtext *0 *10 0 the origin is now x=50 y=60, so is the last location
Using "+" near a coordinate makes it relative to the last location w/o changing the origin.
dtext +10 - 0 adds 10 to X (y=150, o.y=100)
As an example, imagine writing a list of text with 3 columns, each seperated via 200 x and 20 space
between each row:
dorigin 10 10
// first row
dtext *0 - 5 1:
dtext +10 - 0 the text for row1, col1
dtext *200 - 5 2: // x orig = 200
dtext +10 - 0 the text for row1, col2
dtext *200 - 5 3: // x orig = 400
dtext +10 - 0 the text for row1, col2

And now one only has to go down one row. and the text is quite similar. This isn't too easy to explain, it's
there for whomever might find it useful. If you can't think of a use for it, just ignore it. ;)
- Fixed the bug with FORCHARS/ITEMS/OBJS and keywords starting with "FOR" (like FORensics).
- Changed textadd and gumptext to collapse equal strings of text to the same index. So if you use
gumptext 10 20 This is an example.
gumptext 10 40 This is an example.
gumptext 10 60 This is an example.
It will only generate ONE text id. This does away with the need to have a seperate TEXT section. Granted,
such a section is still useful for keeping strings all in one place (in this case it'd be useful), but it
is no longer mandatory, it becomes simply a matter of style/choice.

20-12-2003, Kell
- Equal PLEVEL should be able to see each other, so they are now.
- You can now open a dialog in a specific page, with DIALOG d_dialog_name pagenumber. This isn't actually
possible with the UO client - what it does is recalculate the dialog page/button numbers so that the selected
page is first. It's completly invisible though, and works perfectly.
- Added a new command - DTEXT - to gumps, which does the handling of text ids for you (d stands for dynamic):
dtext x y color Actual text comes here.
Text added with gumptext is actually added to the [DIALOG ... TEXT] section. If you're only using a given
text string once, then it's actually faster using this than using "text" and adding it to the TEXT section
of the dialog. Simmilar commands, DCROPPEDTEXT and DTEXTENTRY are also in, also taking text instead of an
index. DHTMLGUMP is also in, but notice that the syntax is like HTMLGUMP, except that you ommit the ID and add
the text in the end.
With these changes, you can completly ommit the [DIALOG ... TEXT] section of dialogs. Only those strings
that are commonly used throughout the dialog should you put in the [DIALOG ... TEXT] section.
Internally, both gumptext and textadd simply add stuff to the dialog as needed, and send normal "text"
commands to the client, so they're safe to use. But they free you from having to keep track of a LONG
list of numbers, and allow you to shape and modify your dialog w/o bothering with text ids.
- You can now use FUNCTIONs that issue gump commands. So you actually make your own gump commands!!! Death to
copy & paste dialogs!

21-12-2003, Kell
- Fixed a bug in that setting stats & skills via scripts wouldn't correctly parse things. For instance, numerical
expressions.
- Started work on MANUAL.TXT, to detail the current state of things like triggers and their arguments, seeing as
reading this changelog is probably a difficult task for a lot of people.
- Changed args in functions to be writeable. This is useful in scripts, but for triggers, the server will read
back the values and use the new ones wherever it makes sense. For the time being, these triggers were
changed:
@GetHit, ARGN1 is the damage being apllied, ARGN2 the damage type (as usual, but now writeable).
@Hit, ARGN1 is now the raw damage being applied, prior to armour (writeable). ARGO is the weapon (if any).
@PersonalSpace, ARGN1 is the stamina required to move (writeable). "return 1" stops the movement, "return 0"
allows the movement but shows none of the hard-coded messages. Plain "return" or no return, works as standard.
@Hit, @HitTry and @HitMiss were also changed so that ARGO is the weapon being used (handy so you don't have to
be looking at layers n stuff).
I should add that ACTDIFF is also available, and it can be used to change the difficulty of a skill, even make
a skill succedd that would otherwise fail (by setting it to 0). It can also be used in @HitTry now, and if
set to any non-negative value, a missing hit will instead succeed.
- Added StrEat function, which removes a word up to the space, from a string (<streat("hello there friend")>
or <streat hello there friend> return "there friend")
- Added <SERV.LOOKUPSKILL skill name> which returns the skill number for some text or -1 if not found.
- After some beta-testing, a few fixes to dialogs.
- LOCAL.xxx within functions for LOCAL . They're a bit more efficient on servers with lots of global
vars due to faster lookups ). LOCAL variables always come up initially as "0".
- ARGN1, ARGN2 and ARGN3 are set for functions with numeric arguments. So whenever possible, use these instead
of argv. Example: "myfunction 123 50 89" - these 3 values will be parsed into argn1, argn2 and argn3

22-12-2003, Kell
- Functions can now return strings using "return". Notice that this behaves like TAGs, in that if you do
return 2+2
then "2+2" is returned, and not "4". You'll have to explicitly call "eval" on what you want
to return:
return <eval (2+2)>
Returning strings causes no extra lag, seeing as the old method of returning a value relied on the same
string which is returned (EVALed). So it is actually faster (although hardly noticeable).
This might pose a problem problem if you have "return rand" or similar, instead of "return <eval rand..."
seeing as multiple uses of the return value re-evaluate it, generating a new random number - again,
similar to TAGs.
MAKE SURE YOU HAVE "EVAL" on your "return" lines, wherever you want the result of a calculation to be
returned. The next version will probably not have an EF_ReturnString flag.

- Modified the profiling function to keep track of average consumption over time. The average time is
calculated each second as 90% of the previous average time plus 10% the current time. This poses some
resistence to spikes.
- Added a new keyword to @Create / @NPCRestock and template scripts: FULLINTERP. Set FULLINTERP=1 to allow the
use of functions, ifs, etc. Example:
ON = @NPCRestock
ITEM=i_cape
FULLINTERP
ITEM=i_robe
MY_FUNCTION_CALL
You can use FULLINTERP 0 to disable the feature, after you've enabled it, but it's usually pointless, seeing as
this FULLINTERP affects only the remainder of the current script. Bear in mind that the usual restrictions apply,
seeing as the created NPC is not ingame yet.

23-12-2003, Kell
- Added access to TERRAIN and STATICS either via P.key, MOREP.key or SERV.MAP(x,y).key, with key being one of:
TERRAIN The terrain ID
ISDIRT Checks the terrain ID to see if it's dirt.
ISGRASS guess
ISROCK dunno
ISWATER guess again
STATICS Number of statics in the position
STATICS(n) ID of static Nth static ( eg: <SERV.MAP(200,300).STATICS(0)>. Shows no error in the console
if static isn't present, returning 0 - useful to test for a static w/o counting or looping.
STATICS.n same
STATICS(n).key Get a key from the appropriate ITEMDEF. eg: <SERV.MAP(200,300).STATICS(0).NAME>

- Added basic iterator construct, WHILE, with the following syntax:
WHILE ( condition )
// do stuff, current iteration number in <LOCAL._WHILE>
END // or ENDWHILE

also added FOR, terminated with either END or ENDFOR, with the following syntax:

FOR 5 // loops from 0 to 5, current iteration number in LOCAL._FOR
or FOR 3 5 // loops from 3 to 5, current iteration number in LOCAL._FOR
or FOR K 5 // loops from 0 to 5, current iteration number in LOCAL.K
or FOR K 3 5 // loops from 3 to 5, current iteration number in LOCAL.K
// do stuff
END // or ENDFOR

Changing these LOCAL variables has no effect on the loop.
- Wrote a small assembly function to access the high resolution timer. Works for both windows and Linux,
now being used in profiling. Profiling works on Linux now. It also looks a lot better in the console
thanks to the monospaced font.
- Changed the console font under Windows to Courier, which is monospaced, so things come out aligned in
the console. Under Linux, the console is naturally monospaced.
- You can now add new SKILL sections, up to 70. SERV.MAXSKILL tells you how many skills are loaded. Notice
that they won't be sent to the client though, the client doesn't support them (hint: @UserSkills). There
is also a FLAGS key for SKILL section, with the following values:
[DEFNAME skill_defs]
SKF_SCRIPTED 01 // no hardcoded behaviour, only triggers are called.
// feel free to add new tags you find useful, but only above 01000 please, to make room for future
expansion
This is heavily experimental, mess with it at your own risk.
- SKILLSELECT skill - force a button select event on the skill list

24-12-2003, Kell
- Fixed TYPEDEFS section in spherefs.scp loosing values when resynced.
- Added <CANMOVE dir>, takes a direction as argument (like WALK), returns the area ID we're moving to,
or 0 if no move is possible.
- Added <MOVE dir>, takes a direction as argument (like WALK), returns the TILE flags for that position.
Notice that flag 04 is walkable. Here's a list of flags, you can copy&paste it into spheredefs.scp. This
keyword might change in the future.
- It's Xmas! So I'm off to eat some turkey for the next 48 hours. :) Does this count as an entry in the
changelog?

27-12-2003, Kell
- Added support for color & render mode in EFFECT. If no color or render effect are specified, old
effect packet is still sent (which spares 8 bytes). Otherwise the new packet type is sent. Tested
and works with clients from 2.0.3 (should work on all 2.0.* series).
- Consolidated support for 3.0.* clients, they should work fine, up to LBR (they already worked, just
spitted some error messages).
- Added modulus (%) operator in numerical expressions (eg: 12 % 3 == 0).
- Added SENDPACKET command for clients. To make it easier to send WORD(2 bytes) and DWORD(4 bytes) values,
allowed for 'W' and 'D' prefix to values ('B' is also supported for byte but it's redundant). Here's an
example, of setting light level:
SRC.SENDPACKET 04e D<SRC.UID> 20
Both 04e and 20 could use the prefix B, but notice how <SRC.UID> uses the prefix D to specify it takes
the space of a DWORD (4 bytes). So much for complex scripts to break multi-byte stuff in bytes :p
Notice also that each of the parameters is evaluated and truncated, and only then used. For instance,
if you put 0fffffffe (which obviously isn't a byte) in place of a BYTE, what you'll get is effectively
0fe. If you put (2+2) it'll be evaluated to "4" before being used.

28-12-2003, Kell
- Added OSTR, ODEX, OINT.
- Added MODSTR, MODDEX, MODINT - spells affect these.
- STR, DEX and INT are always equal to O + MOD (for the relevant stat). If you have OSTR=50, MODSTR=0 and
then do STR=60, you will get MODSTR=10 (and OSTR unchanged).
*** CHANGED *** read the entry for 19-01-2004
- Added MAXHITS/MAXMANA/MAXSTAM. If set to 0, it defaults to the base max stat (eg, MAXSTR defaults to STR).
MAX always contains MOD for the appropriate stat. That is to say that if you have MAXHITS=100 and MODSTR=10
then internally it'll be recorded as MAXHITS being 90, and if MODSTR changes, so does MAXHITS. This makes
it coherent for stat spells, seeing as they not only change your stats but also max hits/stam/mana.
To make hits depend on STR again, use
MAXHITS = // don't use a value
- You can now write TAGs on accounts. Both TAG and TAG0 are available.
- LOCAL._WHILE fixed, within WHILE loops.
- Changed dialog BUTTON sections to allow
ON = min max
to grab any button with buttonID between min and max (including). Also, argn1 is the buttonID that
actually got selected (even when specify just a buttonID and not a range, as usual). With the buttonID
in argn1 you can write more generic functions with little fuss.

29-12-2003, Kell
- Fixed some skills not getting currectly terminated when another skill was used before they finished. An
example of this is Spells not fizzling when a skill was used before spell ended.
- For skills, @Fail is now only triggered when failure occured due to normal circumstances (eg, failed
difficulty). @Abort is called when failure occurs due to a situation that aborts the skill, such as
using a new skill before finishing the previous one or an invalid circumstance.
If @Fail is triggered, it means that the character will still get a skillcheck for failure (skill raise
through failure), but if you do a "return 1" in there, it won't (check MANUAL.TXT).
- Started implementing propper behaviour for EF_CanSeeLOS. At the moment, it'll check the height of static
items in the path to the target.
- The use of "SECTOR" to access keywords related to sector is now mandatory. So, to access "light" or
"rainchance", SRC.RAINCHANCE used to work, you must do SRC.SECTOR.RAINCHANCE. This has several
advantages - people usually already use SECTOR anyway, so this makes for faster faster execution of
commands on characters, seeing as it has less things to try. It is also more coherent.

30-12-2003, Kell
- Fixed a small problem with KARMA/FAME that had the huge effect of blocking the client once it got different
than 0.
- Added FEATURES= to sphere.ini, to define the features the server will enable on the clients upon connection:
0001 - (T2A) enables chatbutton
0002 - (LBR) enables LBR sound (plays MP3s instead of MIDI)
0004 - (T2A) enables T2A update
0008 - (LBR) enables LBR update (shows monsters)
Standard .55i automatically enabled 0001 - but you could disable it.
- DIALOGCLOSE command. First argument is the dialog name, second argument is the button that should be
triggered on the dialog - 0 if not specified. (eg: DIALOGCLOSE d_my_dialog).
You can put this as one of the first commands in a DIALOG section, to ensure there is only one dialog of
that type on the client.

02-01-2004, Kell
- Added connection control keywords to sphere.ini - a value of 0 disables
any of these settings. These settings are not dumb proof. Make sure you
know what you're doing if you set these:
* ConnectingMax=x, where x is the maximum number of clients that can coexist
in non-game state (http, login, etc). Older clients that are not ingame
get disconnected when new ones come in. Default: 24
* ConnectingMaxIP=x, as above, but per IP. Only a maximum of x simultaneous
"not in game" connections will be allowed per IP. Notice that HTTP
requests for instance, count as "not in game". Default: 8
* ClientMaxIP=x, maximum number of connections per IP. This is intended to
stop flooders, DO NOT SET THIS TOO LOW, or you risk looking stupid. There
are MANY situations where connections can appear as comming from the same
IP - a common one is people connecting from cybercaffes. Default: 0
- Fixed a serious bug where login errors (Bad Login) could leave a lingering
socket. This happened because sockets were made invalid so that they'd get
closed on the next read cycle, therefore losing all information about the
socket. Clients are now flagged for disconnection, and socket handling is
done when clients are freed.
This means that there should always be a "disconnected" message to pair
with a "connected" message.
- You will see two numbers after the IP in connected/disconnected messages.
The first is the number of connections from that IP which are not in-game,
whereas the second is the total number of connections from that IP.
- In savefiles, OSTR and MODSTR are now saved instead of STR. If "STR" is found,
it'll be interpreted as OSTR. This works fine to convert old worldfiles, even
if you have spells, because once they wear off they'll simply make your MODSTR
negative. This works for all stats obviously (simply using STR as an example).
- Changed it so that the first time you set a stat on an NPC, if the Ostat is 0,
it'll update Ostat not MODstat. In other words, and as an example, if you do
STR=20 in @Create, you'll end up with OSTR=20 and MODSTR=0. If you then do
STR=30 on the same NPC, you'll end up with OSTR=20 and MODSTR=10.
**** changed **** see the entry for 19-01-2003
- Fixed a small problem from R3.13 with stat affecting spells not setting MODstat
correctly.

03-01-2004, Kell
- Added unary operators "*=", "+=", "-=", "/=", "%=", "|=", "&=" and "!=". Internally,
what these actually do is change a line in the format:
XXX += YYY
to
XXX = <eval (<XXX> + (YYY))>
So you can do stuff like
MANA += 10/2 // same as MANA = <eval (<MANA> + (10/2))>
ATTR &= ~attr_magic // same as ATTR = <eval (<ATTR> & (~attr_magic))>
- Added ".=" operator, to do string concatenation. Internally what it does is change a line
in the format
XXX .= YYY
to
XXX = <XXX>YYY
This is intended to be used with things that can support strings (NAME, TITLE, VAR, LOCAL, etc)
- First attempt to implement propper LOS check counting with z. To have LOS, you must be
able to walk in a straight line to the target (no news here) AND finish at a reasonable
height, climbing your way to it. So, if you're on a slope you might have LOS, but if
you're standing one floor below you won't. These extra texts have no measurable impact on
performance Enable this behaviour with EF_CanSeeLos (04).
- Diagonal walking (eg, NW) is allowed only if the character can move ortogonally in both
directions (NW -> N and W). This takes care of a few clientside exploits, as well as NPCs
walking through corners. Enable this behaviour with EF_DiagonalWalkCheck (010)
- For the effect of stepping on them, all items were considered to have a height of 3. If you
are standing higher than 3 above an item, you wouldn't trigger a step on it. Changed it so that
if the item's height is above 3, that value is used, and not the hardcoded "3". This allows
one to get @Step events on stuff like tables.
- If no SRC is defined at the time of a @SpellEffect trigger, then the character subject to the
spell will be considered the SRC. This fixes SPELLEFFECT under @Timer triggers.
- Added @NPCLookAtChar and @NPCLookAtItem triggers (check the manual). Do not abuse of these
triggers, as they will affect the CPU usage.

04-01-2004, Kell
- Added ISNEARTYPE, first argument is type, 2nd argument is max distance to search ( if not
specified, 4 is the default ). Also added ISNEARTYPE.P, which returns "0" if false or the
point coordinates if true.
- Changed DISTANCE to accept the UID of an object (item/char) to compare the distance, or a
point. One can now write things like
<DISTANCE <MOREP>> <DISTANCE trinsic> <DISTANCE <SRC.ACT.UID>>
If no argument is supplied, then SRC.UID is used (as default). If the point/UID is invalid
an error is printed to the console.
- Made TIMERD readable (its precision is 10x that of TIMER, same scale of SERV.TIME).
- Made USEITEM not check for visibility. The whole purpose of this keyword is to allow
activating an item via scripts w/o testing for touch, so it doesn't make sense to test
if the item can be seen. DCLICK performs the usual tests though. The "USE" keyword already
allowed one to do "USE 0" not to test for touch, but it also tested for visibility, and it
won't anymore if used like "USE 0".
- Spawns gems now instantly update the display as soon as you set MORE1.
- Double clicking an already negated (more2=0) character spawn sets its timer to 1 so it
respawns next turn.
- Added MOVENEAR keyword for objects(items/chars). 1st argument is the UID of item to move
near to, 2nd argument is the distance to the item. If 3rd argument is present and "0",
then the item will not send an Update. Example:
ON = @DClick
MOVENEAR <SRC.UID> 5 // move to 5 steps away from SRC
Notice that this movement respects walls & such (which is why it is useful).
- Set ARGN1=1 in @Login not to show MOTD scroll.

05-01-2004, Kell
- Fixed possible exploit with \n and textentry and inpdlg.
- AREA and ROOM sections in the following format
[AREA name here]
Should now be written as
[AREADEF a_some_def] // ROOMDEF for rooms
NAME=name here
The advantage of this format is that you can resync it w/o having conflicting regions.
Suggestions: Keep your areas in different formats in seperate files. Either find a script
to convert your old format to the new one or slowly convert by hand.
Move [Teleporters] and [Moongates] to their own files (these can't be resynced).
Note: You do NOT have to use the new format. It is, however, strongly suggested, as
it allows you to change an area without rebooting.
Any future ability to save things on regions will only be available for regions
in the new format (or regions that have a DEFNAME).
- Added CALL instruction to invoke a function, but sharing the LOCAL variables with the called
function. Quite useful when you want to break a function in small pieces that are logically
yet not functionally seperate. In other words, if you invoke a function with CALL, all your
LOCAL will be available to the underlying function. Example
[FUNCTION myfunction1]
LOCAL.VAL1 = 12
CALL myfunction2 1, 2 // LOCAL.VAL1 will be available to myfunction2
// if myfunction2 changes LOCAL.VAL1 it will change here aswell.
If you do not pass arguments to the called function, then args/argn/argv are also shared,
and the process is faster than invoking the function w/o CALL. If you pass arguments to the
function, then only LOCAL is shared, and the process is an infinitesimal amount slower. Not
noticeable, no real impact, but conceptually slower.
This can also be used as <CALL Function ...>, faster without arguments, slower with.
- Recently realized that ALL DEFNAMEs are put into VAR. That means that all itemdefs, chardefs,
etc have an entry in VAR (try <VAR.i_dagger> ). Now, this is potentially confusing and source
for many problems:
1) Whenever you're trying to access a VAR, you go through ALL the existing defnames.
2) You can accidentally create a var that is also a defname... and oooooops!
So to cope with this, changed it so that VAR/VAR0 only contains global variables that can be
modified, whereas DEF/DEF0 contains item defnames and can only be read. The difference in speed
is visible! EVERY time you were accessing a VAR you'd be searching through an array with a few
thousand elements. Now each lookup searches only through the variables your scritps have created
(which even on an extremely scripted shard shouldn't reach a hundred).
This also makes it possible to identify WHICH variables are supposed to be saved.
Although this is a huge change internally, it won't affect scripts except in the following
situation:
1) You defined a DEFNAME flag in scripts that you then changed during execution. This is
highly uncommon, but if you decide you need this sort of behaviour just create the create
the VAR once via scripts, it will be saved to spherevars.scp.
2) You were accessing DEFNAMEs via VAR. No real reason to do it, seeing as DEFs / VARs can
be accessed w/o the VAR. prefix.
If not using DEF or VAR to access a variable, you'll get first the VAR if exists, and then the
DEF. That means that old behaviour is kept.
- VARs are now saved to spheredata.scp. If that file isn't present at boottime the shard will print
a warning, but it will continue, and it'll be created on the next save.
- GMPages will now be saved to spheredata.scp. Too many people are interested in parsing these to
make special stuff (eg webpage interfaces or mirc scripts), so now they won't have to parse the
whole world to read in this stuff.

06-01-2004, Kell
- Added "S" flag to SENDPACKET, allows one to send strings of characters directly. String is not
within quotes it stops at the first space. Example
SENDPACKET 00 S"This is the string to send" 0
SENDPACKET 00 SUpToTheSpace 0
If the string must be null terminated, simply put a 0 in there, as above. Otherwise, you'll probably
need to specify length (strlen function) - depends on packet
- Added new walk limiting code, wildly based on the bit-bucket algorithm used in IP QoS DiffServ
routers: there is a maximum speed at which you can walk (it's fixed, different walking or foot). If
you walk faster than that speed, every tenth of second you walk faster than expected is a point you
loose. Every 10th of second you take above the time expected is a point you win. The number of points
you start with and the maximum is WALKBUFFER in sphere.ini, and I've tested it with values
around 40 for good connections and 70 for laggy connections.
If a player speedwalks, he'll soon drop below 0, and stop moving, then have to compensate with equally
slow walking periods, like it happens when there's a burst of lag.
WALKREGEN is the speed at which you regen walk points, in percentage.
Default values: WALKBUFFER=50 WALKREGEN=25
Hints:
WALKBUFFER lower for more strict control. However, setting it lower also increases the
chance of limiting someone which is just experiencing lag. Raise this value
if you lower WALKREGEN.
WALKREGEN set lower for longer-lasting punishments. It makes sense to lower this value
if you raise WALKBUFFER.
- Removed some EF_ flags that are no longer necessary seeing as they proved to be harmless. Make sure
you consult MANUAL.TXT.
- Changed trigger @DropOn_Item and @ItemDropOn_Item to be activated for container items too.
Activated when item with the trigger is dropped on another item (dropped on something else).
- Added @DropOn_Self and @ItemDropOn_Self, activated when an item is dropped on the item with the
trigger (something was dropped on self).
- Implemented trigger @DropOn_Char and @ItemDropOn_Char.
- If these triggers fail, will only bounce the item if it's still being dragged. That allows the
scripts in the triggers to define a new place for item.
- Made sure clients can only drop stuff into the bankbox if they are standing in the place where it
was opened. This could now be checked within scripts aswell.
- Fixed an Injection exploit regarding accessing the bank away from the place it was opened in.
- Added @SkillGain and @Gain triggers. Check MANUAL.TXT for more info.

07-01-2004, Kell
- Automatically assign a DEFNAME to areas and rooms defined in the old format (AREA / ROOM). This
defname is built upon the NAME, and is made unique by adding a number to it.
- In the console, you can type "d a" to output all the areas and rooms to a file "map_all.scp". I
strongly suggest you replace your map with this file, as it'll allow you to finally get rid of the
old format.
NOTE: Teleporters and Moongates aren't saved in this file, so you should split those to a different
file, to allow areas to be resynced.
- It is strongly suggested that you do the above, and get rid of the old format areas/rooms. Doing it
has the following advantages:
* Loading will be faster, because the server won't have to try and find a good defname for areas.
* You can edit areas, and resync (even change their name) with no conflicts.
* TAGs on areas are only saved for areas that have a valid DEFNAME, so if you do this, TAGs will be
saved on all your areas.
- Added @Targon_Cancel for items.

---- 0.55 R3 rc2 --------------------------------------------------------------
---- 25/01/2004

08-01-2004, Kell
- Fixed VERBOSE=1 causing a catrazillion errors at boot.
- .CAST and .TELE won't show "bad command" sysmessage when they fail.
- If TRY/TRPY are called with an invalid command, they will send the error to the console and not to
the player. This is coherent with how scripts should behave.
- Fixed NPCs not starting with max stats when MAXxxx is used.
- Fixed .admin showing only your own IP.

09-01-2004, Kell
- .serv.account unused xxx delete
- .serv.account add test // missing password will no longer crash
- killing characters with positive karma (actually, it's about commiting a crime, not karma)
- .info not returning to dialog after changing a value (actually, INPDLG wasn't returning to dialog)
- flags on UIDs preserved (040000000 for items, 0d2000000 for skills, etc). GLOBALS renamed to WORLDVARS
due to this (won't go into details here).
- SERV.LOG fixed.
- Fixed plevel 1 players seeing other plevel 1 hidden players
- Added USEHTTP=0/1 in sphere.ini, to disable/enable the built-in HTTP server.
- Added USEGODPORT=0/1 in sphere.ini, to disable the port opened at +1000. As far as I can tell, there is
really no purpose for that port except taking in connections, much like the standard port you set. So it
ships disabled by default.

10-01-2004, Kell
- Fixed a bug where redefining a base type (one in the TYPEDEFS list in spheretables.scp) could lead
to a crash.
- Added a way to assign a TYPEDEF to a terrain type. This means you can define what terrain types are
water, for instance. Example:
[TYPEDEF t_water]
TERRAIN = 00a8 00ab
TERRAIN = 0136 0137
This information is then used by ISNEARTYPE (and it has effect on all the hardcoded behaviour)
when trying to assert if there's t_water around.
Notice that ISWATER checks wether a terrain type is t_water, whereas <ISNEARTYPE t_water> would check
for terrain, statics and dynamic items.
- Changed TYPE when called on an SERV.ITEMDEF.xxx.TYPE to return the typename, and not just a value. So
when called on an water item it should return t_water, and not "30". This also has affect when using
STATICS.x.TYPE.
- Fixed not being able to access properties of TARGP, as in <SRC.TARGP.X> or <SRC.TARGP.TERRAIN>.
- Added "TYPE" to the keywords available on a point. It uses the information above to return what item
type is the terrain at that point. So you can do TARGP.TERRAIN.

11-01-2004, Kell
- Changed .info command to show the type associated with the terrain (t_normal if none).
- Wrote sphere_types.scp - it is a REQUIRED script, as it associates terrain IDs to item types. This
replaces the old hard-coded behaviour (which by the way, was slower). By replacing it, I see no
need to keep the old code, seeing as all you need is to have this script, which will be distributed
from now on.
Add sphere_types.scp in spheretables.scp right after sphere_defs.scp.
- Removed ISWATER, ISGRASS, ISROCK and ISDIRT commands from points (they were introduced in R3). Please
use TYPE instead. For instance, use (<P.TYPE> == t_water) wherever you'd use <P.ISWATER>. Some might
have grown attached to these commands, but unified and coherent scripts are certainly better than
different methods for doing the same. Besides, this offers a lot more control (e.g.: <P.TYPE> == t_lava)
- Added ISNEARTYPE to the keywords accepted by points. So you can do <SRC.TARGP.ISNEARTYPE t_water> and
that will effectively test terrain type, statics, and dynamic items. This is probably what most people
will want to use, seeing as P.TYPE only test for terrain (and not statics or dynamic items).
- Added EF_New_Triggers (010). If set, allows the use of @NPCActFight, @NPCActFollow, @NPCLookAtChar
and @NPCLookAtItem. This flag was added because even having these triggers *might* have some impact
upon performance in very busy shards.
- Removed a "Weird layer" message from whenever you equipped an item to layer_hidden. This is quite an
useful layer for people wanting to expand their shards, so there's really no reason for this error.

12-01-2004, Kell
- Fixed "b" in console not working.
- Added DISTANCEYELL, DISTANCETALK, DISTANCEWHISPER to sphere.ini - a value of -1 turns it into a
broadcast.

13-01-2004, Kell
- The @Create trigger for items works as any other item trigger - it can be fully scripted.
After a LOT of work, you can now also check for SRC under item's @Create. There are situations where
an item can be created without an SRC, but in most cases, there will be one. Eg:
ON = @Create
if ( <SRC.UID> )
SRC.SYSMESSAGE You have created an item!
endif
Bear in mind that @Create is created before the item by the server, so it can still suffer transformations
after it's been created. Particulary, you won't be able to REMOVE an item under a @Create trigger - it
will have no effect.
- Added ISEMPTY and ISNUM. Eg: <ISEMPTY <VAR.TMP>> or <ISNUM <VAR.TMP>>.
- Added STATICS.FINDID.xxx - it will take you to the ITEMDEF of the static item with the supplied ID
- Added @ResourceTest to REGIONRESOURCE sections, called once for each resource in the region that the
character is able to find.
- Added @ResourceFound, triggered after a resource has been selected (@ResourceTest has been called for
all resources available). ARGO is the resource bit to be placed at the location. "return 1" keeps the
resource bit, but sets it to be empty.
- Added DEFMESSAGE section for scripts, allows setting of strings to be used by the server. More will be
added - work in progress. You now REQUIRE a script with these strings.
- Fixed RESOURCES.xxx.val and .key.

19-01-2004, Kell
- Fixed a bug with getting stuck on stuff.
- STR, DEX and INT are always equal to O + MOD (for the relevant stat). If you have OSTR=50, MODSTR=10 and
then do STR=70, you will get OSTR=60 and MODSTR unchanged.

21-01-2004, Kell
- Changed max height difference on CanSeeLOS from PLAYER_HEIGHT/2 to PLAYER_HEIGHT, so that you can access
chests on top of a table.
- Removed the password being shown on console when a password error occurs.
- Made .x* and .set* commands respect PLEVEL. You also need plevel to use the "SET" command to use .x and .set
commands.
- Slightly smarter NPCs against field spells - they will avoid them more often depending on INT.
- Fixed another spot where SRC was undefined in @Create (there might still be more of these).

23-01-2004, Kell
- Fixed buying multiple pets from animal trainers.
- Fixed a bug in FOR where counting down wouldn't work (eg: FOR 10 1 works now)

24-01-2004, Kell
- Fixed bug with NPCs going stale (their timer going -1) - particulary pets.
- Fixed @Effect in SPELL sections to work and have same arguments as @SpellEffect.
- Added SPELLFLAG_SCRIPTED (010000) so that one can more easily override the default behaviour of
spells.

25-01-2004, Kell
- Fixed yet another exploit, with sending a hacked Author in books (tks Balkon)
- Added PROMPT_MSG to SPELL sections and disabled the hard-coded messages. You'll have to fill in the
prompt messages for the spells.

---- 0.55 R3 rc3 --------------------------------------------------------------
---- 06/02/2004

25-01-2004, Kell
- Fixed a bug with @Gain trigger, that regardless of it even existing would reset the skill to the skill
being tested. This turned out in Parrying skill interrupting combat, and other buggy skill behaviour.
- Added EF_Scripts_Parse_Verbs (040). If enabled, verbs (the 1st command in a script line) are parsed
before execution, thus making "TRY" obsolete for that purpose. Example:
LOCAL.MYSTAT = MODSTR
// the following line is parsed to become: str = <<local.mystat>> + 5
<LOCAL.MYSTAT> = <<LOCAL.MYSTAT>> + 5
SYSMESSAGE Stat '<LOCAL.MYSTAT>' increased to <<LOCAL.MYSTAT>>.

26-01-2004, Kell
- Renamed SPELLFLAG_TARG_OBJ to SPELLFLAG_TARG_ITEM. This is really an internal change, but you should
change spheredefs.scp to be:
SPELLFLAG_TARG_ITEM 000002
SPELLFLAG_TARG_CHAR 000004
SPELLFLAG_TARG_OBJ SPELLFLAG_TARG_CHAR | SPELLFLAG_TARG_ITEM
- Made sure a character can only be targeted by a spell with SPELLFLAG_TARG_CHAR, and that an item
can only be targetted by a spell with SPELLFLAG_TARG_ITEM.
- Modified TARGET command to allow 3 possible suffixes (in this order): F, G and W. So you can do
TARGETGW, TARGETFW, etc.
F - Call a function after target ( eg: TARGETF f_rename )
W - Warn against criminal action
G - Target ground
- Made sure flags in the CAN= field for ITEMDEFs work correctly. A few items are missing these flags,
such as i_wall_stone_7 missing CAN_I_BLOCK (so NPCs walk through them).
- Added MULTICREATE command, so you can place multi items via scripts: first set their position then
call MULTICREATE to build them permanently.

27-01-2004, Kell
- Added EF_New_Maps (020), which enables the mapchange packet (0bf, subcmd 08). If enabled, moving to
mapplane 1 or 2 will send a packet for the client to see the appropriate map, and moving to other
mapplanes will send the packet changing back to basic map. This allows one to see the new maps.
However, there is NO support on the server for new maps. That means that you're walking on the new
map only on the clientside, while on the server you're walking on the standard map.
- Server now recognizes bogus extended message 15 - won't send error message to client.
- Added recognition for clients up to 4.0.0c - will not endure AOS features though. Useful for people
with plain AOS installation that wish to play on the server.
- Mind you that this isn't AOS support, it's merely supporting the client.

28-01-2004, Kell
- Fixed TARGP not being set when using a spell.
- Added SPELLFLAG_TARG_NOSELF (0800), which stops spells from being cast on the player itself.
- Fixed accessing LOCAL variables straight within DIALOG sections (also fixes FOR loops).
- "return 1" within a DIALOG section stops the dialog from actually being sent.

30-01-2004, Kell
- Changed SPELLEFFECT to take UID of SRC as 3rd argument, and UID of source item as 4th argument
(optional). To maintain compatibility, a 3rd argument of '1' refers to the current SRC.
Example: CONT.SPELLEFFECT s_fireball 1000 <CONT.UID>
In this example, <cont.uid> will be the SRC of @Effect and @SpellEffect triggers. Say no to
equip fudging :p
- Fixed KARMA going to odd ranges.
- Added EF_Intrinsic_Locals (080), so that after you do LOCAL.X = something, you can access it
via just <X>. Be careful though, not to name local variables after some known keyword, or your
results might how you want them.
Example:
LOCAL.X = 10
SYSMESSAGE X is <X>.

02-02-2004, Kell
- Fixed an exploit that would allow insta-resurrection anywhere (death menu packet).
- Fixed one last \n\r packet exploits.
- Made sure \n or \r are never saved to the world file, so even if some packet exploit got overlooked,
it'll end up causing no harm and issue a warning in the console.. This is likely to be the end of
99% of shard hacking.

03-02-2004, Kell
- Fixed FOR x being 0 based - FOR 5 will now loop from 1 to 5 and not from 0 to 5.
- Fixed "/" character in parsing of simple formulas (so you don't need to use eval when
assigning formulas to TAGs/VARs or in RETURN).
- Fixed @Targon_ground in GM mode with weapons throwing critical exception (it was attempting
to damage a static item, which obviously is not an item at all).
- Targon_ triggers now have argn1 as the id of the static item (if a static was targeted),
and ARGO being the targeted item (reduntant yes, but coherent).
- (intermediary test release here to get some feedback)
- Polymorph spell fixed.

04-02-2004, Kell
- When loading a world with VERSION below "0.55 R3", convert spells that affect stats, by
removing its effect from base stats (old method) then putting the effect into modstats
(new method). This ensures compatibility with spells and cursed items.
Notice that this only works for worlds saved on versions earlier than R3, seeing as worlds
saved on the test versions of R3 made no conversion and thus had items with both formats
which cannot be distinguished.
If for some reason you want to bypass this conversion on an old world, change the version
of the save files to "0.55 R3". If you want to force this conversion on a world saved with
R3 test versions, change its version to "0.55".
- Fixed melee weapons with large RANGE hitting through walls.
- Added ARCHERYMAXDIST to sphere.ini (defaults to 12).
- RANGE works for ranged weapons (bows) too. If no minimum range is set, then ARCHERYMINDIST
is used. If no maximum range is set, then ARCHERYMAXDIST is used.
Notice that on ITEMDEFs, syntax for range is either RANGE=min,max or RANGE=max (assumes 0
as min for melee weapons, or archerymindist for ranged weapons).
- Account delete should be working fine now.
- IPs now accept 255 as a wildcard. So if you add an ip under BLOCKIPs with:
1.2.255.255 you will actually be blocking everyone IP under 1.2
- EOF Account really fixed now (thanks everyone who pointed all the flaws out).
note for programmers: never ignore the return error value of a function :p
- Added <StrPos iPos, ch, string>, where iPos is the position to start at and ch can be
either a single character, or the ascii code for a character.
Example: <strpos 0 32 Where is the first space> --> will return 5.
<strpos 3 e Where is the first 'e'> --> will return 4.
- Added <StrSub iPos, iCount, string>. Returns "iCount" numbers string, starting at iPos.
Example: <strsub 3 4 Oh look at this> --> will return "look".
- Both StrSub and StrPos can take a negative value as iPos. In such a case, the position
is counted from the end of the string. So if you do:
StrSub -5 2 <abcdefg> --> returns "cd".
- Changed StrArg / StrEat to stop at either a space or a comma. These are quick functions
when you just want to take one argument from a string, or just want the string after one
argument. Imagine you have a function that takes 1 number and a string. Instead of using
argv[], you could use strarg to get the number and streat to get the string.

05-02-2004, Kell
- Spells with SPELLFLAG_SCRIPTED can "return 0" in @Effect/@SpellEffect to bypass any
hardcoded effect, w/o cancelling the spell.
- Duration for summon spells now takes in consideration the DURATION field in the SPELL section and
the caster level (yeah, it didn't).
- @SpellEffect/@Effect is triggered on the NPC when it is first summoned (it's always considered to
be the s_summon_creature spell, regardless of spell initially used to summon the NPC).

06-02-2004, Kell
- Spells with both SPELLFLAG_TARG_XYZ and SPELLFLAG_TARG_CHAR/ITEM can be used either on the ground
or on a character / item.

---- 0.55 R3 final ------------------------------------------------------------
---- 31/05/2004
---- * unofficial release [unallowed]

07-02-2004, Kell
- Added FeaturesLogin= to sphere.ini, allows setting of the flags sent in the 0xA9 packet, on login.

08-02-2004, Kell
- Added EVENTS/TEVENTS to items. Order of triggering is as follows:
1) If it's a character activating the trigger, check for triggers sensitive to items (@ItemDClick, etc).
2) triggers in EVENTS on the item
3) triggers in TEVENTS on the item
4) triggers in TYPEDEF section for the corresponding TYPE of the item
5) triggers in ITEMDEF section of the item
6) default hardcoded behaviour (if any).
a "return 1" in any case, stops further processing of triggers.

21-02-2004, Kell
- There is a feature/bug when checking to see wether a player has some specific items, any item of a similar
type will do. It affects these items:
0175d (cloth), 01067 (leather), 01078 (hides), 01bdd (log), 01bd7 (boards), 00f3f (arrow), 01bfb (bolt).
e.g., when the server tries to find an arrow, any t_weapon_arrow will do, and so on.
Added flag EF_Item_Strict_Comparison (0200) to disable this behaviour.

25-03-2004, Radiant
- Added some combat, server and command messages to sphere_msgs.scp.
- Added two file handleing commands:
SERV.WRITEFILE <filename> <text>
SERV.DELETEFILE <filename>
Because these commands can be quite destructive, option flag OF_FileCommands (080) must be enabled
for these commands to work. Be careful, because any GM with access to SERV.* commands could use this!
More will follow soon.
- Added @UserChatButton trigger (return 1 disables default (chat window) behaviour)
- Added @UserMailBag trigger (return 1 disables default (message) behaviour)
NOTE: It seems this is also triggered on login, try using something like
if (<uid> == <src.uid>)
return 1
endif
to prevent this.

26-03-2004, Radiant
- Added <READFILE filename line> statement
If line == 0 this will return the last line of the file, if line == -1 this will return the first line of
the file. This needs OF_FileCommands (080) to be enabled because of obvious security reasons.
This will return "" (nothing) on failure.
- Added <FILELINES filename> statement, returns the amount of lines in a file.
If this is 0 it means the file doesnt exist or cannot be read. This too needs OF_FileCommands (080).
- Added some error and misc. messages to sphere_msgs.scp.
- Added SYSMESSAGEUA (syntax equal to SAYUA).
*** NOTE *** People using Taran's colored sysmessage script will experience problems! Remove Taran's script
and change your scripts to use the hardcoded function instead (which is much faster and efficient anyway).
- Fixed missing return char in TRY console errors and added the UID of the object causing the error.
- Added @Attack trigger (after someone doubleclicked a character to attack).
SRC is the target. "return 1" will cancel the attack.
- Added @UserWarmode trigger, fired when a user hits the warmode button before sphere changes the warmode flag.
ARGN is the current warmode state (1 = in warmode, 0 = peace). "return 1" cancels the warmode change.

27-03-2004, Radiant
- Got sphere to compile on FreeBSD, it's not very stable yet, working on that (problem with signal handlers).
- Added TRYSRC <uid> <verb>, executes <verb> with <uid> as the SRC. Death to equip fudging!
Note that the default object is the object this is called on, so link.trysrc <cont.uid> will make <link> the
default object and <cont> the <src>. Very useful in timers!

28-03-2004, Radiant
- Disabled SENDPACKET S"" and put in a little notice that you should use <ASC> instead.
- Casting recall/gate travel on an item now fires @SpellEffect on that item.

31-03-2004, Radiant
- Added OF_NoItemNaming (0100), prevents sphere from naming items "sword crafted by Player"
- Added EF_No_Pause_Packet (0400), this prevents sphere from sending a Disable Redraw (or pause) packet everytime
a new item/character is sent to the client. This is a bandwidth saver and lag preventer.
This saves about 45 bytes for each action, this doesn't seem much but you can notice the difference.

02-04-2004, Radiant
- Changed skillsum to DWORD, which fixes the problem with high skillsums not working.

04-04-2004, Radiant
- Gate travel spell now LINKs the gate to the person that opened it.

06-04-2004, Radiant
- Healing is now interrupted properly when hit, fixes exception problem.

08-04-2004, Radiant
- Fixed signal locking problem on Linux/FreeBSD, running sphere in multi-threading mode still has problems, I'll look
at that tomorrow. Sphere now survives pretty much every error on Linux/FreeBSD (only tested on FreeBSD), as long as
it's running in single thread mode.

09-04-2004, Radiant
- Threading problem seems to be a little more complicated, but at least sphere runs very stable for me without threading
on FreeBSD. I've tried it on Slackware, which still had alot of problems. I'll leave that for Kell ;)

11-04-2004, Balkon
- Fixed bug when pick up few items from a pile on the ground it's timers become -1
- Added @Pickup_Self - fired on container when item picked up from it, ARGO points to item we picking up
@ItemPickup_Self for chars, ACT - container , ARGO - item we picking up
Removed Reveal() from corpse looting - one can do it using @Pickup_Self if needed
- @Dropon_Char, @ItemDropon_Char now called when drop an item directly on charater either (before secure trade window
shown and @NPCAccept/Refuseitem triggers), ARGO points to character we drop the item on, or character's backpack

11-04-2004, Balkon
- Can't provoce char against an item
- Return 1 in @Login fixed (character will not stay in the world, no "client version check" loop)
- Fixed CONT and TOPOBJ in @EquipTest, item not moved if can't be equipped when doubleclick on it

12-04-2004, Radiant
- Added LOCALLIGHT property on characters, if this is 0 the normal lightlevel (sector) will be used, if this is higher the
LOCALLIGHT value will be sent as lightlevel instead. You will need to use UPDATE after you have changed this, because the
light level is not automatically updated. This overrides nightsight.
(note: if you want to give a character a LOCALLIGHT level of 0, just set the nightsight flag)

13-04-2004, Balkon
- OF_NoHouseMuteSpeech (0200) - if enabled players are able to hear each other inside and outside the house
- Started remaking a CanSeeLos and CanWalk, temporary added EF_CanSeeLos_New (0800) to enable both changes
as for now it fixes shoot through walls an fall through the floor in house regions interception area bugs,
more changes here later...

14-04-2004, Radiant
- @DClick is now triggered before the item is attempted to be equipped

15-04-2004, Balkon
- EF_WalkCheck (01000) - new walk check code, should fix lot of house looting bugs (patched verdata, walk under stairs etc.)
NOTE: in default script pack some stairs are in DUPELIST of items, which are not really a stairs, so they have
wrong CAN flags (CAN_I_CLIMB is not set). Make sure you've fixed your scripts before enabling this EF or you'll
not be able to walk on some of dynamic stairs

16-04-2004, Balkon
- some optimization to EF_WalkCheck, fixing climb height after teleporting and Z changing
- fixed bug when summoned NPC's have loot
- fixed RESOURCES.1 returned string in RESMAKE format
- fixed shafts etc. dupe bug

17-04-2004, Radiant
- Started working on some basic AOS functionality, EF_AgeOfShadows (02000) will enable this.
Currently only enables tooltips (which aren't even working for now). Don't forget to enable flag 020 in FeaturesLogin!
- Fixed a nasty exploit that would allow anyone to crash sphere and/or execute code on your machine without even logging in
(thanks Furio for reporting this)
- Fixed AOS Tooltips, now only shows the name for items and characters. I'll add other things later.
- Added AOS/LBR fading damage counter thing (requires EF_AgeOfShadows). This only shows for you and the person that hit you,
I believe thats how it works on OSI (or doesn't it?). Showing it for everyone would make it laggy in my opinion.

17-04-2004, Balkon
- torch/candle dupe bug seems to be fixed at last :)

18-04-2004, Balkon
- fixed ACCOUNT properties was not accessable for logged out chars
- added ISPLAYER function - just a little feature :)
- added ISONLINE function - for players returns 1 if client is online (connected) and 0 overwise, for NPCs returns 1 when
NPC is in the world or 0 if it is offline (shrinked, mounted pets)
- added NOTOGETFLAG function, returns notoriety flags for specified char, syntax: NOTOGETFLAG Viewer_Serial,Allow_Incognito
returned values:
NOTO_GOOD 1 // good(blue)
NOTO_GUILD_SAME 2 // same guild
NOTO_NEUTRAL 3 // Neutral
NOTO_CRIMINAL 4 // criminal
NOTO_GUILD_WAR 5 // Waring guilds
NOTO_EVIL 6 // evil(red)
if no args specified returns flags for SRC as a viewer, NOTOGETFLAG 0,1 will return flags for SRC as a viewer with
Allow_Incognito = true
NOTE: for red guildmates it will return NOTO_EVIL, not NOTO_GUILD_SAME

18-04-2004, Radiant
- Some additions to AOS tooltips

19-04-2004, Kell
- A few changes to AOS tooltips for cross-platform compatibility (itoa).

19-04-2004, Radiant
- Fixed status updates not sending with EF_No_Pause_Packet flag set
- Made @userStats fire on every status update that is being sent, if ARGN3 == 1 then the user has just opened the status window
- More tooltips stuff, type specific
- Added AOS/LBR Popup Menu's, these can be activated by setting flag 08 in FeaturesLogin (currently only for characters).

19-04-2004, Balkon
- RANGE bug fixed
- updating last regen time for dead chars so that they will not get ticks every tenth of second any more

20-04-2004, Balkon
- some traffic optimization:
short stats change packets now used instead of full status packet when changing only hits/mana/stamina or it's max. values
HITSUPDATERATE in sphere.ini controls how often (in seconds) my changed hits will be sent to others who can see me,
default value is 1, incraise to reduce the traffic usage, 0 value disables sending such updates (like it was on 55i)
- MAXHITS etc. fixed. .MAXHITS 100 will now set MAXHITS to 100, this will include MODSTR so that if you had MODSTR 10 before
setting MAXHITS than when you change MODSTR back to 0 MAXHITS will be 90.
- maxhits displayed for others changed from 25 to 50 for smoother hits line changing on the statusbar

21-04-2004, Radiant
- Added MESSAGEUA, syntax equal to SAYUA and SYSMESSAGEUA
- Fixed lack of argument checking in SAYUA that sometimes causes an exception
- Added support for the "Virtue button" (at the top of the paperdoll on newer clients), fires the @UserVirtue trigger.
- Added support for the new spellbook packets (old ones don't work with AOS), if EF_AgeOfShadows is not set the old packets will
be used (this is for Magery, there is no Necromancy or Paladin stuff (yet)).

22-04-2004, Radiant
- Re-added the "The spell fizzles" message on spell failure

22-04-2004, Balkon
- setting values in quotas for TAGs, VARs and LOCALs now will create text tags, i.e.
TAG.TEST_1 2+2
will create numrecal tag TEST_1 with value 04, but
TAG.TEST_2 "2+2"
will create text tag with text '2+2'.
Text tags and vars are saved quoted also.
- fixed REGION.TAG0.SOMETHING caused 'Undefined symbol "" error' when tag SOMETHING is not set

23-04-2004, Radiant
- Found out that new spellbook packets are broken, still not fixed
- Added support for necro book spells, now reads the spelldefs for these (101 - 116), will add hardcoded behaviour later
- Added @UserExWalkLimit trigger, fired if a user exceeds the Walk limit (is either lagging alot or speedhacking)
RETURN 1 allows the user to walk, no action or RETURN 0 disallows the user to walk
(note: this is pretty expensive because it's fired each time a step is taken while the user's walkbuffer is at 0, so be careful)

24-04-2004, Radiant
- Removed message from WEBLINK command
- Fixed .admin showing japanese text/crashing client with long character names (names are truncated to 30 chars)
- SERV.NEWDUPE and DUPE now sets NEW (and ACT? coded but not tested) for items only, duping chars doesn't work like it should yet
- DCLICK/USE on characters now takes an argument (uid), makes the character DCLICK a certain item/char
- CALL function is no longer case-sensitive
- Added arguments to dialogs, in this form: "DIALOG d_dlg 0 blabla", both <args> and <argv[x]> can be used. <argn> is the page number
(second argument)

25-04-2004, Radiant
- Added COMMANDLOG option in sphere.ini, only logs commands issued by this plevel and higher. (default = 0, log all)

29-04-2004, Balkon
- after some beta testing few fixes in equip and EF_WalkCheck
- added EVENTSPET to sphere.ini - events far all NPCs
- added EF_DiagonalLOSCheck (04000) - to see the object in diagonal direction we must be able to see the point at least
in one of ortogonal directions, this mean you can't see objects only through the "corner", this fixes teleport through
fence NW corner and some other bugs but still allows, for example, closing doors which are in diagonal direction
to you when opened :) Setting this flag may incraise CPU usage.
- alternative name in TAG.NAME.ALT is now used everywhere if tag is set - in character status, corpse names, linked
memories etc. It overrides incognito name also. The real name is only accessable via NAME property.
TAG.NAME.PREFIX now overrides fame prefixes (shown on click). TAG.NAME.PREFIX and TAG.NAME.SUFFIX are now can be combined
with TAG.NAME.ALT

01-05-2004, Balkon
- fixed bug when closing dialog with targeting cursor up canceled targeting
- removed \r check from character profile packet - this allows to have a multiline profile and fixing wrong "Cheater" warnings
- fixed bug when players was able to buy any items from vendor even outside the stock (equipped on him. in his backpack etc.)
- vendor now will simply transfer items to character's backpack if they are stored in his "extras" box or if he is a player's
vendor (they was duped, you bought the copy and the old one deleted before). Shrinked pets will not be unshrinked when sold
from player's vendor (or from extras box).

02-05-2004, Balkon
- EF_CanSeeLos_New is not longer used, all fixes affected by this EF are now included to the code by default.

03-05-2004, Socket (UNSP team)
- Started work on fullfeatured guild/town system. Added MEMBER property to guildstones. You shall use it this way:
<guildstone>.member.X.<property> These properties are available for read/write: ACCOUNTGOLD, LOYALTO, PRIV,
SHOWABBREV, GUILDTITLE. Functions available: IsCandidate (returns 1 if member is a recruit), IsMember (1 if member),
IsMaster (returns 1 if guildmaster). Also, MEMBER.X. construction points directly to character, so you
could use something like MEMBER.X.NAME in your scripts. MEMBER.COUNT returns total number of guildmembers.
- ACCOUNTGOLD guild member's property is now saving to worldsave too.
- Added new GOLDRESERVE property to guildstone.
- Added new <CONT>.COUNT function which returns a total amount of items in the container.
- Added new SERV.CLIENT.x reference. SERV.CLIENT.0. is a newest client and so on, for example <serv.client.0.name>
will return the name of last logged in client. Reference is READ-ONLY for safety. In this case you could save
client uid somewhere and work with his using UID.<uid>. reference.

07-05-2004, Socket
- <CONT>.COUNT now returns an amount of items only in selected container, without counting items in containers inside it.
- Added <CONT>.FCOUNT function, which returns a TOTAL amount of items inside container.

11-05-2004, Balkon
- some fixes, @EquipTest now fired before all internal checks, before item unstacked from the pile, before item in same layer
unequipped (this mean if you have return 1 there char will not unequip previews item)

16-05-2004, Balkon
- fixed @Dropon_char called when dropping item to any container on the char. Now it called only when you really drop the item
on the character - directly on his head or on his backpack if you don't own him. ARGO now always points to character.

19-05-2004, Balkon
- fixed @color,font in MESSAGE and SYSMESSAGE, now it accept hexadecimal values, added 3-rd argument there - unicode flag,
new format is SYSMESSAGE @color,font,unicode text, added @color,font,unicode to SAY and broadcast either. Of course SAYUA,
MESSAGEUA and SYSMESSAGEUA still can be used for this, but @color,font,unicode is accepted in default messages definition
(sphere_msgs.scp), so now we can have default messages in unicode :)
- added OF_SkipUndefMsgs (0400) - if flag is set sphere don't send error strings for undefined default messages,
dont print errors on resync - just ignores it, so now we can disable some default messages if needed.
- SPEED wepaons property now used in fight delay calcilation if set (and not 0), the formula is
DELAY = 15000 / ( ( DEX +100 ) * SPEED )

20-05-2004, Balkon
- some optimization in hit messages (get only messages which really will be sent to client)
- added SPEEDSCALEFACTOR to INI (defaul value is 15000), used in weapon delay calcultions, now formula looks like
DELAY = SPEEDSCALEFACTOR / ( ( DEX + 100 ) * SPEED )
- ARGN1 in @HitTry now is the delay (in tenths of second) left before the hit, can be changed

21-05-2004. Balkon
- added FORCLIENTS and FORPLAYERS loops, difference is that FORPLAYERS will loop through disconnected players which are
still stay in the world (client linger) either.
- if no args specifiead for FORITEMS, FORCHARS, FOROBJS, FORCLIENTS, and FORPLAYERS loops value 18 is used by default
(maximum view distance)
- added FORCONTID and FORCONTTYPE loops, format is FORCONTID i_dagger max_sub_containers. If max_sub_containers is not
present it will search in all subcontainers. If max_sub_containers = 0 - it will search only in this container.
- added FORCHARLAYER layer - loop through all objects in specified layer
- added FORCHARMEMORYTYPE flags - loop through all memory objects with this flags

25-05-2004. Balkon
- fixed bug when after parsing quoted lines when setting VARs, TAGs and LOCALs didn't create text variables

27-05-2004, Socket
- Fixed guild MEMBER.X.KEY for read/write. Now it should be working well. Will return error if you try
to access non-existant member (so it should be better to use MEMBER.COUNT to check bounds).

---- 0.55 R4.0.1 --------------------------------------------------------------
---- 07/06/2004
---- * unofficial release [unallowed]

30-05-2004, Kell
- Little fixes to allow compile under Linux (use strcmpi() for caseless string
comparison, and add casts to (LPCTSTR) on CGStrings).
- Changed version number. I suggest using R4.x.y where xx is increased when
something major is done and yy is for little changes. Set to R4.0.1.
(ps: some people never quite understood what RC* means. After the 20th it
stops being a release candidate, it's more like a candidate to a release
candidate. So after the "powers that be" have adopted and turned that
numbering scheme into a mockery, I suggest we change to something less
confusing.

31-05-2004, Furio
- Added FORCONT loop, format is FORCONT uid_of_container max_sub_containers. It
will loop on every item present in the container. If max_sub_containers is not
present it will search in all subcontainers. If max_sub_containers = 0 - it
will search only in this container. (Thx to Balkon for the base code for
container loops)

07-06-2004, Furio
- Made a blank REVISIONS.TXT because it was getting pretty big.
- Added XOR (^) operator to expressions.

---- 0.55 R4.0.2 --------------------------------------------------------------
---- 22/07/2004
---- * unofficial release [unallowed]

12-06-2004, Furio
- Added two new INI value USECRYPT and USENOCRYPT. The first if 0 don't allow at
encrypted client to login otherwise allow them to log (default is 1). The
second if 0 don't allow at unencrypted client to login otherwise
if 1 -> allow and suppose that the clientversion is >= 2.0.0
if 2 -> n/a
if 3 -> allow and suppose that the clientversion is >= 3.0.0
- Added the most requested security-by-obscurity feature DISGUISEVERSION in
sphere.ini. If set change the version outputted to clients, ircserver,
webserver, listserver, telnetserver to its value otherwise the default build
value is used. (Mind that the version in savefile and in console startup is
the default build version)
- Fixed (i hope) bug with Mozilla/Firefox browser with the status page
- Fixed a buffer overrun bug that could be exploited to crash or run arbitrary
code, in the log system.

20-06-2004, kuch
- Added ClearTags function (removes all the tags from the char/item/account);
Revital did most of the work, but I get the credit.

28-06-2004, Furio
- Fixed multiple gump exploits. In order to do this now memory 08000 is used as
internal memory (is called MEMORY_GUMPRECORD).
- Fixed and refined things for disguise version feature.

02-07-04, kuch
- Added MODMAXWEIGHT: allows you to increase/decrease max carrying capacity of a
char.
- Added MODAR: allows you to increase/decrease the overall AR of a char
NOTE: there are no oStat equivalents (ie oModAr or oModMaxWeight) for the
above.
- Also added the following to avoid possible confusion:
* MAXWEIGHT - same as WEIGHTMAX
* AR - same as AC
* MODAC - same as MODAR
* MODWEIGHTMAX - same as MODMAXWEIGHT

03-07-04, kuch
- Added 135 more strings (mostly from skills) to sphere_msg.scp
- Added new .ini option: WOOLGROWTHTIME: how long in minutes it takes for wool
on sheared sheep to regrow.
- Added new .ini option: SKILLPRACTICEMAX: how high can you train a skill on
dummy/archery_target.

04-07-04, kuch
- Added 93 more strings: NPC speech and skill msgs; there are now 329 string
messages in sphere_msgs.scp.
- Added TAGCOUNT function (works on regions/items/chars/accounts) - returns the
number of tags on that obj
- Fixed CLEARTAGS (now also works on regions)

06-07-04, kuch
- Fixed some weird bug in jobmage.scp and jobnoble.scp
- Added a lot more strings to sphere_msgs.scp; If you find any bugs with them,
kuchervano@hotmail.com me immediately!

07-07-04, Furio
- Fixed DISTANCEWHISPER not working correctly.

07-07-04, kuch
- Added DEFFOOD value to sphere_defs.scp - this is a template of items you want
to get by casting the create food spell; Yes it does not give you a great deal
of control over what you get (ie skillbased for example), but its better than
nothing

09-07-04, Furio
- Fixed bug with ^ operator.

16-07-04, Vjaka
- Fixed bug with armor/weapon when hits were above to hitsmax.
- Cosmetic fix to report Client out overflow error line once per dialog instead
of tons of them.
- Added trigger function f_onchar_delete triggered before client is going to
delete a character. SRC is char, return 1 denyes deletion.
- Added trigger function f_onaccount_login triggered after client entered the
password, ARGS is account name, return 1 disconnects.
- Added spell flag SPELLFLAG_PLAYERONLY 020000 which denies spell being cast by
npc ai (no more npcs casting shrink if not wished to).

17-07-04, Vjaka
- Added @NPCLostTeleport to trigger before NPC is going to be teleported back to
its spawn (by LostNPCTeleport sphere.ini setting), ARGN1 is the distance from
the spawn.
- Added INI switch PAYFROMPACKONLY (default: 0). If set to 1, then buying stuff
from vendors will search pack only for the gold.
- Added @Hunger to trigger before char is going to loss a food level. ARGN1 is
the food level that will be set, return 1 cancels.

19-07-04, Vjaka
- Removed IRC server from default build settings. It is buggy, has holes inside
and probably should not used by anyone.
- Reverted memory information profiling in Win32 version (stability testings).
- Fixed NoMessages and Quick login mode (ARNG1/2 in @Login) now skips sphere
version information and Welcome back.. prompt.
- Fixed some exceptions for ticking events. Some division by zero removed, and
the exceptions are made less critical (actualy the way they should be - quite
local). It means that the server should be more stable now. Also they gives
usualy more information on when the error occured.
- Added @StepStealth triggering on each step made by person in stealth. ARGN1
(in and out) - whatever to reveal him or not.
- Added isnumber(something) - returns 1 if it is a number (only number of radix
10 suits). Useful in argtxt validation.

19-07-04, Furio
- Fixed compatibility issues with Linux for isnumber(something).
- Added TAG.DIALOG_NAME to MEMORY_GUMPRECORD. The tag contains the name of the
dialog opened. Special case are the .admin gump (clientlist), the hair dye
gump (hairdye), a guild hardcoded gump (guild) and if no name is found
(undef). Hope that this will help in checking what gumps are opened on client
screen.
- Added SDIALOG command. It works like DIALOG with the difference that it'll
open a dialog only if it's not present on the client screen.
- Fixed a thing in DISGUISEVERSION. Now .[x]show version shows the disguised
version.

20-07-04, Vjaka
- Fixed compatibility issues with Unix for exceptions
- Added MODAR (MODAC) working on items as well. Now it is for both items and
chars.
- Fixed startup sequence - now tryes to bind a socket before loading the world
saving time on running multiply instances.
- Fixed Windows version buffered output flushing. Also removed log file
buffering.

21-07-04, Kell
- Fixed some compilation issues under Linux (just missing some (DWORD) casts).

22-07-04, Furio
- If PAYFROMPACKONLY (default: 0). is enabled, in the char status only gold from
pack is displayed.
- Fixed minor things on default messages.

22-07-04, Vjaka
- Added server state functions f_onserver_save, f_onserver_save_ok and
f_onserver_save_fail. Arguments are ARGN1 - force save? and ARGN2 - save stage
(for background saves). For f_onserver_save the ARGN1 is writeable and return
1 cancels the save.
Please note, that if background saves are enabled, these functions will be run
tons of times during the worldsave process (at least 6144 [sectors amount]
times).
- Added f_onserver_start function triggered server start.
- Created knownbugs.txt file to be distributed with sphere revisions.

---- 0.55 R4.0.3 --------------------------------------------------------------
---- * not released
---- * unofficial release [unallowed]

23-07-04, Vjaka
- Added some more exceptions debugging. It is going deeper and deeper to engine.
- Added MAXITEMCOMPLEXITY (default: 25) - the amount of items in one tile so
start showing "too many items here".
- Added MAXSECTORCOMPLEXITY (default: 1024) - the amount of items in one sector
to start showing "x items too complex".

24-07-04, Vjaka
- Removed instant logout in guarded areas. use REGION_FLAG_INSTA_LOGOUT instead
if you wish instant logout.
- Added console commands history of 5 latest commands in Windows version. You
can scroll them using UP key.
- Added one minute delay after take of an item from trade window before
accepting the deal.

25-07-04, Vjaka
- Added smsg/smsgu shortcuts for sysmessage/sysmessageua (note, that msg already
existed as a shortcut to message)
- Added SKILLCLASS properties - if written like SRC.SKILLCLASS.NAME, returns
<SERV.SKILLCLASS.<SRC.SKILLCLASS>.NAME>
- Started doing ARGVCOUNT and realised that <ARGV> is the amount of ARGV[x]
variables. Noting that as not found in revisions.
- If player speech longer 5 chars and has 75% capital letters inside, it will
come out in lower case. Works for english chars only. And as for unicode - if
EF_UNICODE is set.
- Added GUILD properties: <SRC.GUILD> returns 0 or guildstone UID,
<SRC.GUILD.NAME> returns guild name
- Removed all old PLOT bit stuff. Use EVENTS instead
- Changed CLEARTAGS - it takes optional argument, clearing tags only if matching
the string (does not support wildcards)
- Added HITS and MAXHITS to items (same as MORE1L and MORE1H). Note: this is
valid for armor and weapon object.
- Telnet has a username. So, Administrator or RemoteAdmin login left for local
logins (127.0.0.1) if LOCALIPADMIN enabled

25-07-04, Furio
- Hopefully tracked down and fixed the arrow bug, and similar problem derived
from NEW (big thx to Handred that finded the point where start looking at for
the fix).

26-07-04, Vjaka
- Fixed broken TEVENTS read method on chars.
- Added QVAL(test1,test2,res1,res2,res3) in addition to current <QVAL?:>
variant. It is useful if dealing with numbers without many IF-s. Sample
<eval qval(<VAR.X>,<VAR.Y>,<VAR.ONE>,<VAR.TWO>,<VAR.THREE>)> will return
<VAR.ONE> if <VAR.X> < <VAR.Y>, <VAR.TWO> if they are equal, and <VAR.THREE>
if the it is greater. If some of the arguments are omited like qval(1,2,,3) it
will default to zero.
- Changed REGISTERSERVER to default an empty string. If you wish to register to
list.sphereserver.net, specify REGISTERSERVER=1 or it's host.
- Added TELEPORTEFFECTSTAFF, TELEPORTEFFECTPLAYERS, the teleport effect for
staff (use hex id of object or 0 here) (default: 03709 for staff, 0372a for
players).

27-07-04, Furio
- Fixed an issue with MOVE/XMOVE command.

27-07-04, Vjaka
- Added command line switch -Gpath/to/saves/ to defrag sphere server UIDs. It
is done because sphere UID management routines has flows which makes not to
reuse empty uids, but generate new, higher. Howewer, space for lower unused
objects is still reserved. It saved 400Mb me (from 600Mb on start to 180Mb)
working for 2.5 hours, but caused all mounts to disappear, maybe some more
flaws. So, use on your own risk. In future versions for 4.0.x Furio is going
to improve the uid subsystem and this will not be needed anymore.

28-07-04, Vjaka
- Changed FILELINES to close the file and READFILE if line number is too big.
- Added DISMOUNT verb on char to dismount him, MOUNT to get UID of ridden one.
- Fixed an issue with SERV.CLIENT.x. causing exceptions.
- Removed 0.55R from version. It is a complicated notation. It's 4.0.x now.
- Fixed MODAR not updating armor class if changed on char or equipped item.

29-07-04, Vjaka
- Limited allshow to MAXCHARCOMPLEXITY*4.
- Fixed issue when telnet connection could not do resync load after pausing.
- Account now has TAG.LastLogged with his previous login date. It is shown upon
login if quick/no-messages login not selected (by @Login trigger).
- Fixed msg_criminal to be shown only if person is not a criminal yet (lags).
- Added read-only COMP reference for multis. Returns amount of components when
called with no params, and has attributes: ID,D,DX,DY,DZ (D mean delta).
- NPC wishes gold and vendable items (not limited to desires listing).
- Added ARGN2 to @NPCLookAtItem (writeable) - the percent level the the NPC
wish this item. If set high, he can loot the item.
- Added GMPAGES and GMPAGE.* verb to access gm pages from scripts. You can
give arguments like you do to .page command, and use 2 specials - DELETE to
delete even not-taken one, and HANDLE [uid] to mark gmpage for character.
Also GMPAGE.x.HANDLED field returns UID of person taken the gmpage.

30-07-2004, Kell
- Added ACCOUNT.NAME

30-07-04, Vjaka
- Speed optimisation working with strings & possible some stack overflow out.

31-07-04, Vjaka
- Fixed several spells (like mark) casting in not allowed region when running.
- Fixed KILLS removal using multi-uo client.
- Changed @Logoff to take 2 writeable arguments: ARGN1 - linger time and ARGN2
instant logoff flag. Return 1 in logoff is now obsolete.

01-08-04, Vjaka
- Added triggers @MurderDecay (ARGN1 - murder count that will be set, ARGN2 -
decay time to set for the next kill) and @MurderMark (ARGN1 - murder count
that will be set, ARGN2 - set criminal flag?). The names are descriptive.
- NPC is now trying to move objects blocking his walkpath. He also investigate
the possibility to loot this item in several cases. Triggers look@item not
called since if there are tons of items in the spot, it will be very laggy.
- Added @Rename trigger (ARGS - new name, ARGO - target char) when renaming a
pet. Return 1 cancels. Also triggered when creating character.
- Items with ATTR_STATIC are now saved to spherestatics.scp and NOT SAVED by
standart world save. So, you need to call .serv.savestatics to save them.
- NPC is now trying to cast good spells as on self and his combat friends also.

02-08-04, Vjaka
- Calling guards are now more speed optimised.
- Defrag mode now supports spherestatics.scp and is much faster.
- Changed FACE and SALUTE to take an optional argument - target object.
- Characters on the way do not disallow GM to place a house anymore.
- Items gets stacked one on the other witheen some height if possible.

03-08-04, Vjaka
- Exceptions catching fixed, some stack information added.
- Added CLEARVARS being same as CLEARTAGS.
- Fixed CLEARTAGS to work normal without arguments.
- Now VENDORMARKUP is taken from region tags if not found on a vendor.

04-08-04, Vjaka
- Default messages working optimised for speed. Removed OF_SkipUndefMsgs.
- Removed OF_Skill_DiffFirst since the actdiff is calculated in any case.
- Started implementing EF_Pathfinding.

05-08-04, Vjaka
- Fixed SERV.ITEMDEF reference to object not being currently in the world.

06-08-04, Vjaka
- Added SERV.resync to resync scripts without the resync delay.
- Now adding a new account automaticaly fills (FIRST/LAST)CONNECTDATE.
- Added @SkillMenu to trigger BEFORE calling any hardcoded skillmenu. So, you
can return 1 to cancel the action. ARGS - the name of the menu, is one of:
sm_polymorph, sm_carpentry, sm_bowcraft, sm_tailor_leather, sm_tailor_cloth,
sm_bolts, sm_carpentry, sm_cartography, sm_tinker, sm_summon, sm_blacksmith,
sm_alchemy, sm_cartography, sm_inscription.

07-08-04, kuch
- Finished the conversions of default messages into the new format: this should
greately improve the execution speed. Also updated sphere_msg.scp to fit new
format. Read the comments inside the file to get more more infomation.

09-08-04, Vjaka
- Added DISGUISENAME to alter the name of the server.
- Added REPLYPEERCONNECTS (default 1) to allow masterserver and peer connects.
- Fixed duplicating hungry messages search.

10-08-04, Vjaka
- Fixed NPC moving some items not actualy blocking their way.

11-08-04, Vjaka
- Added console commands auto-completion on using TAB key. File sphere.dic is
read for the list of definitions. Note: this file SHOULD BE sorted (at least
witheen each separate first letter) to multi-matches to work correctly.

12-08-04, Vjaka
- Added @ItemCreate triggered when an item (ARGO) is created by a client.
- Added auto-completion to telnet connection. The difference from winconsole is
that it fills the word up to end ONLY if there is exact 1 variant, or if
other variants contains this one in self.

13-08-04, Vjaka
- Optimised sysmessages - now nothing is sent to client if the message is empty.
This is useful to clear default messages. If wish to scroll line, use space.
- Fixed exploit to crash clients by renaming pet with some special color. Thanks
TheLegbra reporting that.

15-08-04, Vjaka
- Added EF_Script_Profiler (08000) to add information on functions usage for
weak places (functions or triggers) to be optimised.
- Added EF_Size_Optimise (010000) to save WORLDITEM/CHAR/SCRIPT as W*. This is
not much for now, saving 7+ bytes per object. Loading supports any method.

03-09-04, Vjaka
- Added OverSkillMultiply (default 2). When player skills/stats goes this times
more than skillclass allowed, drop them to skillclass level. Setting this to
0 disables the action.
- Added ACCOUNTS BLOCKED/JAILED arguments. Works exactly like UNUSED, but just
applyes to the blocked/jailed accounts only.
- Only chars in mapplane where the player is are ticked now (lag reduction).

04-09-04, Vjaka
- Added ## command to console to save both world and statics.
- Added X# command to instant shutdown the server with world/statics save.
- Changed "commands uid=... (name) to ''" to show amount if above of 1.
- Server startup crash fixed

08-09-04, Furio
- Fixed issues for the Linux build.
- Disabled information abou "Key" on OnTriggerRun exception for compatibility
problem on the *Nix build. (temporary solution)
- Added .pid file (sphere.pid) on *Nix build, for those who want to write bash
script for checking sphere process easily.

08-09-04, Vjaka
- EF_Pathinding is working perfectly making NPC to select a best path. Howewer,
for maximal speed it is yet checking only static objects blocking his path.
More testings on the speed needed before making it to include dynamics checks.
- Fixed Counselors losing their invis status after worldsave.

10-09-04, Vjaka
- Memory information is now got from system routines instead of internal one. It
will cause this info to appear in UNIX builds, howewer, it will be not be in
WINDOWS systems where PSAPI.DLL is not available (fe: Windows 95/98/NT4.0).
Also this makes ALLOCS useless, since there is no way to get it.
- Added CLIENTS property for sectors and regions to get active clients count.

11-09-04, Vjaka
- Added EF_Clients_Thread (020000) to split clients handling to to other thread.
This will work only in windows build and is not recommendable to change on fly.
This is VERY experimental yet, since sphere is very singlethreaded by design.

13-09-04, Furio
- Fixed memory information on Unix. Now it uses two different methods to get
memory information depending on *Nix system where sphere is running.

13-09-04, Vjaka
- Fixed functions profiler to strip off arguments of a function.
- Fixed console commands like ##, x# showing unknown keyword error in console.
- Fixed murder count set always to 1 by @MurderMark.

14-09-04, Vjaka
- Fixed LOCALs in f_onserver_start/f_onchar_delete.

18-09-04, Vjaka
- Code cleanups, removed some useless (not enabled keywords), same keywords grouped
to one variant for usage for faster work lookups:
1. *WEIGHT[MAX]->*[MAX]WEIGHT, BRAIN->NPC, KNOWLEDGE->SPEECH, COMMENT->TAG.COMMENT
CLI*VER*->CLIENTVERSION, DEF->ARMOR, LISTEN->HEARALL, *PRICE->PRICE, VER->VERSION
WEBPAGEDST->WEPAGEFILE (LoadKeys)
2. CLIENTS->ALLCLIENTS, PARDON->FORGIVE, INVISIBLE->INVIS, INVULNERABLE->INVUL,
R->RUN, W->WALK, CLIENTS->ADMIN, MIDI/MUSIC->MIDILIST, [RE]SYNC->RESEND, ADDITEM->ADD
FOLLOWED->FOLLOW, M->MOVE, PROPS/TWEAK->INFO, SPEAK[U[A]]->SAY[U[A]], SFX->SOUND
SAFE->SECURE (VerbKeys)

20-09-04, Vjaka
- Fixed errors on load if setting VERSION for saves to start from litera.
- Fixed paths in resource testing commands.
- Added EF_Minimize_Triggers (040000) to call as little triggers as needed by a minimum.
- Removed some declared but unused triggers.

23-09-04, Vjaka
- Removed unused EF_Allow_Override (it was not working anyway).
- Added OF_Advanced_AI (including moving objects in the path, helping friends by magic,
pathfinding)
- Renamed EF_Client_Thread to OF_Multithreaded (0400)
- sphere.pid file is now created in Windows builds as well.

25-09-04, Vjaka
- Removed ADDNPC since it is already integrated with ADD command for both items and npc.
- Removed some more duplicates (some really strange) to speed up lookups.
- Added showing of option flags on start.

26-09-04, Vjaka
- Removed different mail operations not working and other code cleanups.
- Bugfix: Disabled moving gold coins to vendor stock (items shifting).
- Bugfix: Disabled moving static/immovable items from ground, spell effect.
- Bugfix: Disabled gaining spell effect by ghost other than ressurection.
- Bugfix: Mounted creature will leave no corpse on death if died while mounted.
- Bugfix: @DeathCorpse is called only if corpse is really created.

27-09-04, Vjaka
- Added ISSTUCK keyword to check if npc can move to N/W/E/S dirs.

29-09-04, Vjaka
- Optimized OF_Advanced_AI, makes NPC to remember the path, recalculating it
not so often (depending on INT).

30-09-04, Furio
- Added OF_Advanced_LOS (0800) this disable EF_CanSeeLOS and EF_DiagonalLOSCheck
and enable a new method to check the LOS (still testing and optimizing).
- Fixed some compatibility problems with Linux build.
- Now Linux build is compiled statically, so no more tons of version linked to
different shared library for each distro.

30-09-04, Vjaka
- Fixed Windows build issue.
- Removed EF_CanSeeLOS, EF_DiagonalLOSCheck, moved that to default LOS checks.
- Bugfix: unable to resurrect on too low strength. Now gets 1 HP at least.
- Average profile information is now saved to worldsaves and loaded.
- Option and Experimental flags are now shown in text on .show command.

03-10-04, Furio
- Optimized some parts in OF_Advanced_LOS.
- Fixed Linux build issue.
- Added ISTEVENT for chars (npc/players) working like ISEVENT

04-10-04, Vjaka
- Regions now does not conflict if are in different mapplanes (useful for new
maps support). You can also specify RECT=left,top,right,bottom,map in the
rect record, specifyed the exact map for this rect to work.
- Started redoing the code to support multiple maps. This will invalidate old
mapplane feature which was 0..255. This is affected mainly by teleports and
moongates since many of default ones had 255 mapplain specifyed. You should
change it to 0, since this is only for map0.
- Added MAP property same as MAPPLANE (in future MAPPLANE will be removed)</spherescript>

==REVISIONS-56-SERIES==
<spherescript color="">---- 0.56a --------------------------------------------------------------------
---- 08/12/2004

06-10-04, Vjaka
- Removed DISGUISE(NAME/VERSION), renamed the current version to 0.56a.

07-10-04, Vjaka
- Removed AGREE config line neccessaty since it is not longer R* series.
- Added startup expansion set support output depending on map*,statics*,staidx*
files found and loaded (T2A, LBR, AOS, SE).
- Removed EF_New_Maps since it is integrated to source now, packet is sent when
needed.
- Moving on other map now moves the same map on the server. But this currently
does not use caching and re-read tile information from map files every time.
Caching of same sectors but in different mapplanes will be in the future.
You should both add regions for these maps, and place corresponding files in
place where all other mul files resides.
- Changed values of EXPERIMENTAL flags to remove empty slots between items.

08-10-04, Vjaka
- Fixed memory leak caused by map cache removal.
- Fixed client screen update on map change.

08-10-04, Furio
- Added PROMPTCONSOLE, it makes the client prompt (like on page request) and send
the response as an argument of a user definied function.
(syntax PROMPTCONSOLE callback function, message to prompt)

10-10-04, Furio
- Added RESDISP properties to account. Accepted values are 0 (PreT2a client),
1 (T2A), 2 (LBR), 3 (AoS), 4 (Samurai Empire). This is used to identify what type
of client is logged in. As default is set at 0, but if the client is T2A is
automatically set to 1 by Sphere. LBR, AoS and SE is not setted automatically and
is leaved to you.
- Added to CHARDEF properties RESLEVEL, RESDISPDNID, RESDISPDNHUE. The first state
from what UO version the anim comes. The second what anim id is showed to older
client version. The third an hue showed to older client (if 0 or null the default
anim hue is used.
- Modified scriptpack to reflect these changes for T2A monsters.

22-10-04, Vjaka
- Added <dVALUE> as a shortcut to <eval <VALUE>> to get a decimal value of a
single expr like a variable. Note, this affects EF_Intrinsic_Locals a bit.
- Commands with .command and spaces before will be treated as without spaces,
since extra space makes privileged chars to reveal self.
- Added TAG.PARTY_CANLOOTME for party. If 1, allows party to loot self.
- Added @Kill trigger (SRC-killer, ARGO-killed)
- Added sector function ALLCHARS,ALLITEMS similar to ALLCLIENTS. For regions
you can use SECTORS.ALLCHARS, SECTORS.ALLITEMS.
- Changed GODPORT to accept port number as well. Old values ( <=0 = disables,
1=ServPort+1000) are still working also.
- Added SYSCMD and SYSSPAWN commands to run external applications. Returns <0 if
there was an error. The first one blocks while program is running while the
second spawns and continues scripts execution. Due to obvious security fear
in these commands, they are disabled if OF_FileCommands is not set. Up to 9
command line arguments are passed to the external application.

23-10-04, Furio
- Fixed minor things in grayproto.
- Updated grayproto (list/sizes of Uo packet in Sphere).
- Finished and debugged the new crypt engine (for crypt clients). Currently up
to latest current OSI client 4.0.5a is supported.

25-10-04, Vjaka
- Fixed exception in writefile when unable to open the file.
- Added account name output when packet dispatch generated an exception.

25-10-2004. Furio
- Still updated grayproto, with new packet infos.

26-10-04, Vjaka
- Fixed SMSG[u] resolve error.
- Fixed <dSOMEVAL> giving some hex results.
- Added update for items moved by NPCs when they blocks the path.

27-10-04, Vjaka
- Now Windows build tryes to use winsock 2.0 if available instead of 1.1.
- Added amount argument to NEWITEM (newitem i_gold,45). Defaults to 1.
- Removed one of occasions with creating an extra log not in logfile path.

27-10-04, Furio
- Fixed a bug in displaying big dialogs with newer clients (4.0.X).
- Fixed a bug where some clients were crashing when adding an item.

28-10-04, Vjaka
- Disabled string 'q'/'Q' to be said by privileged accounts. It is due the
fact that default macro for repeat is Ctrl+Q, and one less Ctrl press will
lead to GM to reveal self existance around, which really is not good.

31-10-04, Furio
- Some fixes related to account creation and bank/box hack.
- Removed EF_AgeOfShadows. It'll be re-added with new features and complete
compatibility for older clients, when enabled.
- Fixed another exploit with Bullettin Boards. Thx to Balkon for reporting it.

01-11-04, Vjaka
- Added .pid file existance notification to warn for double sphere launches.

02-11-04, Vjaka
- Now light level for sectors is saved as LIGHT istead of LOCALLIGHT.
- One more cause for long default message string lookups removed.
- EQUIPHALO now takes an argument - time to work on a person.
- Fixed bug causing objects calculated to be in sector 0 always.
- Added @Destroy trigger for objects.

04-11-04, Vjaka
- Quickfix of OF_Magic_PreCast - now not precasting on NPCs.
- Consume now can take more than 65k at once.
- Added @CreatePlayer to trigger just after the char was created by a player.

05-11-04, Vjaka
- Now "Admin" is shown instead of "GM" if person is admin or owner in title.

06-11-04, Vjaka
- Added sector function ALLCHARSIDLE similar to ALLCHARS, but looping via
disconnected/mounted/etc chars, not accessable by ALLCHARS.
- Added auto map fix to zero map if it is out of bounds. Please note, that
this can cause some problems with MOREM usage as well.

25-11-04, Furio
- Fixed: encryption - client login.
- Fixed: dVALUE evaluating when VALUE is already int.
- Fixed: EQUIPHALO <timer> does not making the light disappearing.
- Updated supported clients to 4.0.6a.
- Removed "Cannot move here!" message.
- Added more information to "MOVE: empty region" error. (uid and point)

30-11-04, Furio
- Fixed: MOREM automatically converted to 0 because of new multi-map feature.
- Added MasterUid property to guildstones

02-12-04, Furio
- Fixed: Gm Page menu not sending gms on page select.
- Fixed: Lord is displayed without space.
- Fixed: TAGAT trying to access to non existing TAGs.
- Modified: Only items with 08000 as attr are moved to spherestatics.scp.
- Modified: Overskillmultiply is 0 by default now.
- Added: ISEVENT for regions.

08-12-04, Furio
- Fixed: EvaluatingIntel on 0 int NPCs.
- Fixed: EQUIPHALO light disappearing on Dispel.

08-12-04, Vjaka
- Fixed exploit submitting invalid amount in buy packet giving free resources
(thanks Breaker and Fallout for reporting this).
- Fixed canmove to accept DIR values (0..8) in addition to a letter arguments.
Same changes affects other places, like move command, etc.
- File locking method optimised. It should improve the multithreading a bit.
- Result of the old "ACCOUNT accname" command changed to be more informational.
- GMs should login with invul and without allshow flags set.
- If reference set to OBJ/NEW does not exist, zero will be storied instead. And
opposite, if it is already deleted, OBJ/NEW value is cleared to zero.
- Fixed exception in f_onaccount_login.

08-12-2004, Various authors
- Fixed some scripts by Vjaka.
- Added new scripts and scripts fixes by Tattooed Corpse.

---- 0.56b --------------------------------------------------------------------
---- * not released yet

09-12-04, Vjaka
- Added map caching supporting all maps. Due to this, sectors are no longer
same in the same spot in different maps, allowing local settings for maps.
- Added ADDCIRCLE=x[,y] to add a circle to a character's spellbook. If y is on,
includes all lower spell circles as well.
- File locking method optimised. It should improve the multithreading a bit.
- Changed [SECTOR x,y] in world saves to x,y,0,map to allow local settings for
sectors in different maps. Old format will default to map 0.
- Since sectors are no longer shared witheen different maps, sectors on maps,
unsupported by server (having no corresponding .mul files) do not get ticks.
- Fixed cause to duplicate saved items in static saves in several occasions.
- Added BADSPAWN command to jump to the first bad spawn found in the world. You
should add this to some of the [PLEVEL records. It also saves the UID into
ACT in case you unable to see it due to some obstacles.
- Removed useless PRIVHIDE (privshow 0/1 is enough for this).

10-12-04, Vjaka
- Fixed some defmessages misprint making unable to override them.
- Fixed @Kill to trigger even if the killer is not an agressor in the fight.
- Changed MAPPLANE->MAP, LOCALLIGHT->LIGHT (.56a supported both variants, but
saved the second). Launch and save in .56a will autoconvert this in saves.
- Now any items with ATTR_STATIC are saved to spherestatics.scp, not only those
who has this flag being the only set.
- Fixed carriage return in accounts unused message.

11-12-04, Furio
- Fixed: bugs with FORCONT* loops.
- Fixed: bug with coloured text in comm crystal.
- Added: SKILLGAIN function to call internal sphere skillgain function. Args are
skill to gain and difficulty (0 to 100).
- Added: REPORTEDCLIVER property for clients. It'll contain the version that
the client is. (this is easy fakeable by 3rd party programs, but still is
useful)

13-12-04, Vjaka
- Fixed resolving functions executing on containers, if the name started from
rescount,restest,fcount or count.
- Fixed isneartype not working if calling under points (like from TARGP).

17-12-04, Vjaka
- Account delete information now contains account name.
- Added NPC keyword GOTO x,y,z,map to execute sphere default movements there.
- Redone pathfinding to support separate thread execution, so it now utilizes
extra thread if OF_Multithreaded is set.
- Advanced AI now includes food search on hunger to eat and gather meal around.
It is executed in separate thread with pathfinding if configured so.

21-12-04, Vjaka
- Changed sector allocations, now allocates only those who are needed by the
server depending on the *.mul files found. Thus, on bare t2a install no space
for other maps will be allocated (saves several Mbytes).
- Random selection {x y} now supports format {x,y} also. Should help using it
with DAM/AR fields of items.
- Added EXP field to characters. No internal support for it yet. But you can
use it in scripts already.
- Empty accounts file is created on-fly if not found. Useful for unpack-n-run.
- Fixed bug with TOTALCONNECTTIME being increased by doubled value, and now is
made more accurate.
- Optimized the UID allocation routine, trying to disallow creating holes in
objects allocation. This should improve memory neccessaty increase for large
or long-lasting servers. Howewer, this does not defrag the current save, only
newly generated UIDs will be optimized - no existant UIDs will be altered.
Garbage Collection should be enabled for this optimization to work.
- Expanded account information in ACCOUNT NAME command by logged char name.

03-01-05, Vjaka
- Added <Rarguments> as a shortcut to <eval rand(arguments)>. Can take either
one, two or no arguments like <R>, <R15>, <R3,15>. If no arguments given,
R1000 is assumed.
- You can now disable broadcast messages (like errors, connects, etc) from the
server log to be sent to your account logged via telnet. You can toggle this
behavior per account via PRIV field of the account (mask 0400). So, only
responces to your commands and some very-basic messages (like world save)
will be sent in this case.

08-01-05, Vjaka
- Added support for virtual maps. Now map numbers 0..255 are supported by the
server.
- Map dimensions are now customizable in INI-file using by the following cmd:
MAPx=max_x,max_y,sector_size,real_map_number.
Here x - the map number for ingame useage (4rd coordinate of the coordinate).
max_x - maximal X coordinate of the map (should be multiply of 8).
max_y - maximal Y coordinate of the map (should be multiply of 8).
sector_size - the sector size (you can play with this if you experience lags
decreasing this value (should be multiply of 8 and both max_x and max_y).
real_map_numer - number used by map files (like: 0 for map0, statics0).
You can also change some attribute of the current map not redefining all
values, skipping the ones you wish to be as default putting 0 instead (for
real map number -1). For example, decreasing sector size for map 0 to 16
from default value of 64 will look in INI file thus: "MAP0=0,0,16,-1".
Please note, that no changes are applied when server is already started.
- Default map numbering has been changed (you can ovverride it easily by MAPx
setting in sphere.ini). Now 0 = map0, 1 = map0, 2 = map2, 3 = map3, 4 = map4.

10-01-05, Furio
- Added: tooltip %d command for gumps (works in SE clients).
- Added: sphere_map*.scp/sphere_map_points*.scp for new maps and fixed the
default one.
- Updated: gray proto with new packets.
- Updated: client support to 4.0.7 family.
- Updated: fix in default script pack.

13-01-05, Furio
- Modified SERV.MAP(x,y) to accept a 3rd parameter, the map. If omitted is
defaulted to 0.
- Added SECTOR access to read-only properties from a point. Example:
SERV.MAP(100,100,1).SECTOR.ITEMCOUNT will give you the itemcount of the
sector that contains the point 100,100 on map 1.
- Added REGION access to read-only properties from a point. (works like
SECTOR one)
- Fixed: gumppic to show hue when used. (Hue usable only for client >= 3)

15-01-05, Vjaka
- Changed the way the server saves allowing more information about the cause of
some exception (which is now not fatal for the save).

17-01-05, Vjaka
- Added LEVEL field to char as the future part of the experience system.
- Added ExperienceSystem, ExperienceMode, LevelSystem, LevelMode, LevelNextAt
fields to the .INI file as a future part of the experience system. Read the
default sphere.ini for more description over these fields.
- PRIV flags are now auto-clearing bits corresponding to not used priv. This is
a solution for a possible incompatibility when the previosely disabled bit
will be reused with other functionality on same world saves.
- Fixed: LAYER_EXTRA is now used ONLY to place the items bought by the vendor.
- Items sold to vendors are auto-deleted exactly upon the sell operation. The
only case they are saved, if they are sold to player vendors.
- Amount of items in sell packet is now limited to the container size.
- Fixed one more sell/buy exploit.

17-01-05, Furio
- Fixed: party system.
- Fixed: group disappeared from gumps.
- Added: scriptable components for the party. Still work in progress.
With <REF>.PARTY refer to the current party of the char.
<REF>.PARTY.MEMBER.x refer to any member of the party.
<REF>.PARTY.MASTER refer to the master of the party.
PARTY.MEMBERS give the count of members
PARTY.MEMBER.x has also ISMASTER and ISLOOTABLE properties.
PARTY.ADDMEMBER[FORCED] you can add a meber by script (forced version works
without the normal /accept behaviour)
PARTY.DISBAND disband the current party
PARTY.REMOVEMEMBER @<N> remove the Nth member
PARTY.REMOVEMEMBER <UID> remove a member in the party with the UID given
(if is the master the party is disbanded)
PARTY.SYSMESSAGE @<N> TEXT send a party sysmessage to the Nth member
PARTY.SYSMESSAGE <UID> TEXT send a party sysmessage to a member in the party
with the UID given
PARTY.SYSMESSAGE TEXT send a sysmessage to the party
PARTY.MESSAGE @<M> TEXT send a message from the Mth member to the party
PARTY.MESSAGE @<M>,<N> TEXT send a message from the Mth member to the Nth
member
PARTY.MESSAGE <UID1> TEXT send a message from the <UID1> to the party
PARTY.MESSAGE <UID1>,<UID2> TEXT send a message from <UID1> member to <UID2>
- Added: TAG/TAG0 for party.

24-01-05, Vjaka
- Fixed bug with some keywords recognition caused by <Rxxx> operator.
- Chardef triggers do not apply to players now.
- Write deleted accounts out to log file

25-01-05, Vjaka
- Fixed vendor selling in case of one item being sold.
- Ensure double character removal from view in "remove 1" case (for allshow).

26-01-05, Vjaka
- Fixed registry settings overriding MULFILES setting in some cases in win32.
- Fixed the way spells are checked whatever they are in a spellbook. New type
of spellbook (186) has been added for script purposes with internal support.
Now the spellbooks (if not default one) can be configured to specify which
number of the lowest spell it contains (stored in MOREZ).
- Fixed casting speel with two or more similar spell books when it does not
exist in one of these books.
- Removed limitation to 1 byte (255) for MOREZ of spellbooks. Now it can hold
2 bytes (65535). Please note, that setting MOREZ via MOREP is incorrect here.

28-01-05, Vjaka
- Fixed bug caused with layer_extra removal from buy menu in older clients.
- Added support for packets filterings. Please note, that you should understand
what are you doing. You can install your handler of a packet X specifying
PACKETx=functionname. This function will be called when the packet is going
to be processed by the server. It has the following arguments set:
ARGN1 = packet number (to allow using one function for different packets)
ARGS = source client ip address
LOCAL.0-LOCAL.9 - first 10 bytes of the packet for parsing contents
If you do return 1 in this function, the packet will NOT be processed.
- Some exceptions debug messaging speed optimised.

29-01-05, Vjaka
- Added argument for RECRUIT on guildstone. If set 1, the member recruited will
become a fully qualifyed member of a guild with abbriviation shown on.

30-01-05, Furio
- Fixed: compatibility problems on Linux.
- Freeze for 0.56b Test1.

03-02-05, Vjaka
- Argument switches of target[f][g][w] functions can be given in any order.
- Fixed removing events on other events execution that leaded skipping others.
- Memory usage is lowered (pre-storage optimized for more accurate values),
approx 30-40% less memory will be used (depending on load structure).

04-02-05, Vjaka
- Logout now quits from chat removing problems with inactive zombies left.
- Characters with Statf_STONE cannot logout (actualy, have 1 hour logout timer).
- You can now access account properties using SERV.ACCOUNT.x. reference where x
is the numerical index of the account (0..SERV.ACCOUNTS) [read-only]
- Fixed extra step made on sector borders.
- Fixed "return"/"return 2" in chardef triggers stopping others from launching.

04-02-05, Furio
- Added support for 4.0.8 clients.
- Fixed some arguments parsing in party functions

05-02-05, Vjaka
- Optimized time profiling on ticking objects.

07-02-05, Vjaka
- Problem with items left with switching virtual maps with one physical should
be solved.
- Added simple mySQL support. New settings MySqlHost, MySqlUser, MySqlPassword,
MySqlDatabase will be used to connect to the DB in case if MYSQL is set to 1.
You will need extra .dll/.so to download for sphere installation. They will
join the packages.

08-02-05, Vjaka
- Fixed several map support bugs with incorrect sector counting (should improve
support of a high map numbers).

11-02-05, Vjaka
- Fixed bug causing incorrect function name lookup in several cases with some
special chars like underline (_).
- Added debug flags 0200 and 0400 to debug experience and level changes from
server console (if enabled).
- Experience system integrated. Few addons about defaults to config comments:
a) experience bonus for crafting counted as a value/100.
b) default experience set on create is str+dex/2+int.
c) manual setting experience will alter level if configured so.
d) dying decreases experience by 10%
e) killing enemy will give experience depending on exp and level of target.

12-02-05, Vjaka
- Added 2 more EXP settings to config: ExperienceKoefPVP and ExperienceKoefPVM,
controlling percents of gaining experience in PvP and PvM combat.
- Added triggers @ExpChange and @ExpLevelChange, where ARGN1 (writeable) is the
change is going to happen. Returning 1 cancels the change.

12-02-05, Furio
- Fixed: another buffer overrun exploit in log system. Thx to Radiant for
reporting it.
- Added: SUPPRESSCAPITALS (default 0) to enable/disable Vjaka system to avoid
long text written only in capital letters.

14-02-05, Vjaka
- OF_Advanced_AI is now obsolete. Currently it is controlled by NPCAI setting
in config file.
- Added MaxLoopTimes value to config (default 10000) to limit a number of
iterations the while/for cycle could have to remove possible deadlocks making
server to stop responding (better use this instead of main loop restart).
- Added MOVERATE to CHARDEFs. It is the percent modifier of the speed of the
NPC - the higher it is, the slower will the NPC be. Default is 100.
- Now double clicking on the log window in windows build will bring up an
editor with corresponded file (if any specifyed in the same line) opened.

15-02-05, Vjaka
- Fixed one more buy menu exploit (probably, the last one) ;).
- Fixed NEWITEM id,amount in case if non-exact value was given (like {x y}).
- Added cont argument to NEWITEM (now it looks NEWITEM id,amount,container).

16-02-05, Furio
- Fixed: compatibility things for Linux/BSD build.

27-02-05, Furio
- Added: STRREV for strings.
- Reverted to dynamic linked executable for the linux build. That permit some
exception handling during signal raise.

01-03-05, Vjaka
- Fixed gaining fame and exp on summoned pets.
- Faster and more intelligent protection from fastloot like ,emptycontainer. The
delays for picking now are 0.3 sec per item. Item with amount (popping dialog
with input) adds extra 0.2 sec delay.

04-03-05, Vjaka
- Fixed an exploit with invalid book packet (thanks Fallout for reporting).
- Fixed @Destroy event not fired.
- Added the minimal delay before accepting sell/buy deal equal to 0.3 sec per
each item. This limits the power of autobuy/autosell/inject sell all.
- Added client property CTAG similar to the TAG array. The difference is that
the contents is not saved, and is destroyed upon logout - useful place to
store your local variables on the client character.

06-03-05, Furio
- Some other fixes to improve Linux build stability.
- Now killing sphere with HUP make the server save and exit.
- Added support for 4.0.9 client encryption.
- Added more comprehensible messages to error output (bad login / garbage / save)

10-03-05, Vjaka
- Fixed placing items from invalid containers upon save loading to world nearby
100,100 coords, these items should be deleted, so they are.
- Limited amount of items shown to client on screen to MaxItemComplexity*30 (by
default 25*30 = 750).
- Removed goldreserve from guilds - use TAGs for this.
- Windows: added build date and time to the About box along with the version.

13-03-05, Furio
- Added SERV.GUILDSTONES.x to referer to the Xth guildstone in the server.
Use SERV.GUILDSTONES.COUNT to get the total number.
- Added SERV.TOWNSTONES working like SERV.GUILDSTONES.
- Added MasterUid property also in write mode. Now you can change the guild
master passing the uid as argument.
- Some minor fix to Linux build.

14-03-05, Vjaka
- Optimised object los check, should decrease waste of cpu on large shards.
- Fixed possible webpage exploit with malformed requests.
- Removed EMAIL property from accounts and all associated commands (EMAIL/
ADDEMAIL,defmessages) - use account TAGs to work with it when needed.
- Removed server status responce from the standart ping/telnet connection.
- Fixed logging in localy when both RemoteAdmin and Administrator accounts were
not found and LOCALIPADMIN was set.
- Fixed misprinted defmessage ncp_* to npc_* (2 matches), sphere_msgs.scp now
comes commented by default - uncomment things only you need to change - most
people will not need this file at all, so by this way we show that.

14-03-05, Furio
- Temp removed "Limited amount of items shown to client on screen".
- Moved FOLLOW from exe to scripts. Now MEMORY_FOLLOW(01000) is unused.
- Modified default info gump with a new one (thx to NHR).

17-03-05, Vjaka
- Removed EF_No_Pause_Packet, it is built in to code now.
- Drop item on vendor to trade quick, removed npc_vendor_sell (from 1.0).
- Setting SLEEPMASK=0 will give no time to sleeping sectors (from 1.0).
- Optimised few widely used checks like touch check.

29-03-05, Vjaka
- Removed debug message about not found pathfinding path.
- Fixed bug causing objects disappear on doubleclick.
- "Limited amount of items shown to client on screen" is back due this was not
the cause of the previous bug ;).
- Removed verbose command. It was anyhow very limited in Release build.
- Added -c command line switch to WIN32 build. It allows changing registered
class name for sphere, which helps working via windows messages with several
sphere servers on the same machine.

05-04-05, Vjaka
- Made ARGN1 writeable in @Hunger.
- Fixed OptionFlags display instead of MagicIngoreAR.

11-04-05, Vjaka
- Packet filtering support heavily expanded. Now you have these variables:
LOCAL.NUM (value) set to amount of data got from the packet
LOCAL.STR (string) all data threated as a string (aware of zero chars)
LOCAL.ACCOUNT (string) current active account if any is logged by the client
LOCAL.CHAR (uid) current active char if any is logged in from the client
and the all data is now given in LOCAL.x, not the only first 10 bytes.
- Returning 1 in PACKETx handler function no longer shows Bad Msg Eat string.
- Removing exception on invalid map point in some drop cases.
- Account named like account keywords (ADD/BLOCKED/etc) denied for creation.

12-04-05, Vjaka
- Walking via others with no penalty fixed (now it more like it was before in
the times of 55i - more correct way). You can override this by changing ARGN1
in @PersonalSpace trigger.
- Fixed message of guard owners always saying previous region guards owners.

14-04-05, Vjaka
- Fixed Sphere accepting a player character as a valid guard in some cases.
- Fixed guard walking to enemy even if they are cheaters (instantkill enabled).
- Added messaging flood control - equal sysmessages one after another will not
be sent to the client (if they are absolutely identifical and no any other
message was between them).
- Added STRIP [DIR/] console command. Reads all scripts and outputs them to new
files with only [...], and base definitions lines. Good for giving script to
your gms to be able to use axis with very basic information.

17-04-05, Vjaka
- Fixed bug with quick trade on player vendors.
- Fixed an exception caused by empty messages in some client events.

21-04-05, Furio
- Added 4.0.10 client keys.
- Fixed: bugs in getting vals from party.

21-04-05, Vjaka
- Fixed some cases (not all!) of scripts clearence by specifying incorrect
directory in STRIP command. There are too many ways to specify direct or
indirect path that will look different but will lead to the same file
starting from symlinks, ending with messing with .. and dir seprarators (\/).
Locking the file is not ok, since it will cause problems with other threads
or applications working with file. So use this either with care, or with no
argument ;)
- Added Axis tags support CATEGORY, SUBSECTION, DESCRIPTION to STRIP command. I
do not use them, so did not add that when making the command :).

23-04-05, Furio
- Some fixes and optimization for Linux code.

03-05-05, Vjaka
- Fixed bug causing impossibility to dress off items in some cases.
- Removed background task and all corresponding to it operations, since they
only looked as working, while doing almost nothing.

14-05-2005, Furio
- Fixed some bugs in client detection.
- Fixed a bug for too short account name login.
- Removed support for encrypted client from 1.25.31 to 1.26.4 (you can use them
only in unencrypted way).
- Fixed problems with allshow.
- Fixed problems with rand(x,y).
- Disabled (temp.) Vjaka's messaging flood control.

24-05-05, Furio
- Fixed some bugs for Linux build.
- Added CanSee check in spellcast.

25-05-05, Vjaka
- Added OF_Flood_Protection as a control of toggling appearence of same
messages and sysmessages one after another. Note, that this setting is always
off for PLEVEL 2 or upper, so GMs will always get everything.
- Fixed copses giving unlimited blood amount. Now, the corpse gets TAG.BLOOD
upon creation to TAG.MAXBLOOD of itemdef. You can also alter TAG.BLOOD upon
creation on the coprse object. The default value is 5.
- Due to multiply requests, TAG.LastLogged is removed just after showing it to
client. It is still there for the purpose to show real last connection date.
- Added INI setting of MOVERATE (default 100) to change the default moving
speed of all NPCs at once. Remember, this is percent setting.
- Fixed bless and curse on items which lead to ultimate stats raise.

28-05-05, Furio
- Fixed: Corpse not appearing.
- Fixed: CTAG sysmessage on set.
- Fixed: FVAL bug.

18-06-05, Vjaka
- Fixed book saving only the first line on each page.
- Fixed exception on allshow.
- Fixed console errors when using looms and repair.

27-06-05, Vjaka
- Removed RESOURCES2 line since it never worked at all.
- Fixed variety of bugs with using some keywords like newitem from functions
called directly from the server (like f_onserver_start). Special char is
created for this purpose to be acting as a default object.
- Region now executes command for all sectors inside if the command is sector
one (you can use REGION.all* instead of REGION.SECTORS.all*) for example.
REGION.SECTORS command is depricated.
- Added StatsFlags setting to cap MAX(HITS/MANA/STAM) status.

01-07-05, Vjaka
- Added f_onserver_exit triggered on server quit. Quite useless since no saves
are occured after then, but good for launching some prog using sysspawn.
- Townstones are now listed in status using TOWNLIST command, splitting town
and guild stones to different links.
- Fixed calling guards on self.

03-07-05, Vjaka
- Fixed fightself bug. It was not fixed before. I did not notice that since do
not use default summon creature spell. Thanks Handred for reporting.
- Trying to improve the rate and distance NPC sees characters around. Now it
should happen faster, since higher distance is checked in areas with little
complexity.
- Spawning NPC distance is now more random. Also now spawning checks the
borders inside disallowing to spawn in unaccessable place. Thus, if you place
spawn in house and the doors are closed, there is no possibility for NPC to
spawn outside the house.
- The death now triggers inventory close to avoid appearing fake items inside
that are no longer in the pack.

04-07-05, Vjaka
- Fixed impossibility to change type of the object to a non-default one.

08-07-05, Furio
- Fixed SERVIP problems (and similar).
- Fixed pet killing not giving criminal status to owner.
- Added: client 4.0.11 keys.
- Fixed: FVAL 0 now gives 0.0
- Touchups on Ef_Walkcheck routines

11-07-05, Vjaka
- Fixed ALLCHARS region/sector command.
- Fixed typedef bug on save.

17-07-05, Furio
- Added SERV.RTIME.FORMAT. It takes as args a string like strftime()
(the list is here http://www.scit.wlv.ac.uk/cgi-bin/mansec?3C+strftime ).
e.g SERV.RTIME.FORMAT %d returns the number of the day.
- Fixed: animal trainer problem with EF_Walkcheck.
- Fixed: magic lock/unlock bugs.
- Fixed: dagger on static crop.

19-07-05, Vjaka
- Multithreading now should be more stable.
- Few misc fixes in combat, like added los check.
- Fixed REGION.ALLCHARS command.

19-07-05, Furio
- Fixed: creating unnamed chars.
- Fixed: creating chars with no title.
- Fixed: creating chars with hacked stats.
- Fixed: writing on console.
- Fixed: problem with spawning with EF Walk flags.
- Fixed: touchups in script pack.
- Added: hardcoded support for AoS/Se/Ml skills.

21-07-05, Furio
- Fixed: Warmode refresh if getting attacked (thx to Torfo).
- Fixed: Training skill out of skillsum cap.
- Fixed: Viewing hidden clients with higher plevel with allshow.
- Fixed: skill name/key/title in sphere_skills.scp
- Fixed: template mispelled (orge instead of ogre).
- Modified: sphere_map*.scp and sphere_point*.scp are now in map/
subdir.
- Modified: only map0 and map1 scp are loaded, to load the others
uncomment the lines in spheretables.scp

22-07-05, Cloud_Br (Script pack)
- Fixed: buying wool from vendors.
- Fixed: Missing flags in sphere_defs.scp
- Added: sphere_item_aos_se.scp containing various AoS/Se item defs.
- Added: spherechar_se.scp containing various npc defs for Se.

23-07-05, Furio
- Fixed: rock throwed by ogres not decaying.
- Fixed: cansee e musical item for provocation.
- Fixed: npc speak on train.
- Fixed: animal lore on mounted pets.

24-07-05, Vjaka
- Fixed: default object operations on server. Will not show extra error msgs.

25-07-05, Furio
- Fixed: npc try to attack mounts causing exceptions.
- Fixed: mounts disappearing. (thx to Gygrazok and Darkraven)
- Fixed: args not used in trigger @PersonalSpace. (thx to Darkraven)
- Fixed: Map teleports teleporting npcs.
- Added: 4th argument to map teleports. If is set to 1 npcs can use the teleport.
By default is 0. Eg: 1,1,1,0=100,100,100,0=my_teleport=1 is enabled,
1,1,1,0=100,100,100,0=my_teleport=0 or 1,1,1,0=100,100,100,0=my_teleport is
disabled.

27-07-05, Vjaka
- Fixed: Several exceptions with latest client.
- Fixed: Extra error msg for show command when server property was specifyed.
- Fixed: Some more timeslices freeing will decrease useless cpu usage in
multithreaded mode.

30-07-05, Furio
- Fixed: exploit with hair dye gump (choosing random color).
- Fixed: x/set respecting plevel.
- Moved: hair dye gump from exe to scripts.

30-07-05, Cloud_Br (Script pack)
- Fixed: problems with spherechars_se.scp
- Added: defs to sphere_backward_compatibility.scp
- Fixed: some areas without guards (map0/map1).

30-07-05, Vjaka
- Added: MySQL support to scripts. You can execute any queries and statements,
as well as get data from mysql link. A special script object similar to the
FILE or OBJ added and is named DB.
DB Properties:
CONNECTED - the current state of database connection (1 or 0)
ROW.NUMROWS - number of rows returned by last query
ROW.NUMCOLS - number of columns returned by last query
ROW.* - list of all columns returned by last query. Both column names and
numbers are saved in the list, so you can use indexes [0..] or column
names [id, name, etc] here.
DB Methods:
CLOSE - disconnects the SQL server
CONNECT - connects to the database (using mysql settings in sphere.ini)
EXECUTE - executes SQL query not filling any results anywhere
QUERY - executes SQL query filling ROW.* properties information
Example of a simple query:
DB.query "SELECT id FROM users WHERE account='<SRC.ACCOUNT.NAME>'"
SERV.log "Got ID = <DB.ROW.id>"
Note: Server does not create connection upon start, so if you wish to make
the connection with the server start, add DB.connect to the function
f_onserver_start.
- Fixed: Map support higher than map 0. Now there should be no more problems
with fix throwing to incorrect Z level (hopefully).

31-07-05, Radiant
- Added: Support for tooltips. Requires OF_Tooltips (02000) and the 020
FeaturesLogin flag. Usable in scripts:
Every object has a OBJPROPS property, which works like tags. Syntax:
OBJPROPS.<name>=<locale id>,[args]
note that <name> can be anything, but the entries are sent in alphabetical
order. So, for example, a bag, the props would look like this:

OBJPROPS.a="1048032" // a bag
OBJPROPS.b="1050044,32,450" // ~1_COUNT~ items, ~2_WEIGHT~ stones
- Fixed: exception occuring during load with unknown keys in sphere.ini

01-08-05, Radiant
- Added: CTAG0 similar to TAG0 version of CTAG.

03-08-05, Radiant
- Horses are now forced to dismount and will die if someone is riding them and
they have statf_dead set or their hitpoints are 0 or below. This should fix
the "ghost" horses appearing sometimes (when horse is poisoned and ridden).

08-08-05, Furio
- Fixed: CTAG0 when setting a value.
- Updated: sphere_backward_compatibility.scp
- Added: FILE obj, enabled by Of_File_Commands. Look in manual.txt for help.

08-08-05, Vjaka
- Added: SQL support for multiply rows. You can use both ways ROW.<column#> and
ROW.<row#>.<column#> for addressing a field you are interested in, but the
first method allows operating on row #0 only.
Sample full-n-ready script to show how to use this feature:
DB.connect
if ( <DB.connected> )
db.query "SELECT * FROM mytable"
for R 0 <eval <DB.ROW.NUMROWS>-1>
SERV.log "--- ROW #<eval <LOCAL.R>> ---"
for C 0 <eval <DB.ROW.NUMCOLS>-1>
SERV.log ".. COLUMN #<LOCAL.C> : <DB.ROW.<eval <LOCAL.R>>.<eval <LOCAL.C>>>"
end
end
endif
- Added: a possibility to specify MySQL port. Just add ':port' to the host
record.
- Fixed: account references in several cases leading to errors.

11-08-05, Radiant
- Fixed 'undefined keyword' error on SKILLMENU with not enough resources on player

13-08-05, Exer (Script pack)
- Added: sphere_item_building_roofs_se.scp (SE roofing items)
- Added: sphere_item_building_walls_se.scp (SE wall items)
- Added: sphere_item_magic_necromancer_aos.scp (SE necromacer items)

13-08-05, Cloud_Br (Script pack)
- Updated: sphere_backward_compatibility.scp
- Updated: sphere_region.scp
- Added: sphere_chars_newer.scp (All monsters of AoS/SE)
- Removed: sphere_chars_aos_se.scp (Obsolete, sobstituted by chars_newer.scp)

15-08-05, Vjaka
- Added: AutoResDisp ini setting (default:0) to setup this resdisp by default
to all accounts. Useful if all your clients are using at least some client.
Recommended setting at least 1 (T2A).

15-08-05, Radiant
- Fixed: potential buffer overflow exploit in file write operations
Also saves one string operation, it's gotten a little faster.
- Fixed: CTAG/CTAG0 got broken in last fix
- Fixed: Extremely long save times
- Moved: .admin from executable to scripts and completely rewritten it.
Please copy sphere_admin.scp from the script pack. Same is going to happen
to .tweak.

16-08-05, Rattlehead (Script pack)
- Added: sphere_item_building_floors_se.scp (SE floor items)
- Added: sphere_item_misc_se.scp (SE misc items)

18-08-05, Radiant
- Added: exception catching around more save sections, should give a better
description if a save error occurs
- Added: sphere no longer cares if an npc is riding a valid horse, so you can
just add a horse item
- Script sphere_admin.scp:
- Staff can see their own IP
- Invisible staff is now printed in red
- Added summon cage
- Fixed: problem in saves and allskills, no check if skill is defined or not.
Broke saves (naked players) on some servers with not all skills (AOS and SE) defined.
- Fixed: Disconnected NPCs (horses) being seen if rider is gone (probably! need feedback)

18-08-05, Gygrazok (Script pack)
- Modified: sphere_admin.scp:
- Start position of dialogs set to 0,21
- Default page of the tweaking menu set to "action"
- + shown before account name for higher privs and - before guest accounts (like the old admin panel)
- Removed PLevel informations in main page to get more space for char name
- Closing tweak dialog brings back to main page
- Added number of online clients in the main page title and changed "Administration Console"
to "Admin Panel", which is shorter
- Added "remove note" button
- Fixed: extra page if you have 15 clients only

19-08-05, Furio
- Removed: OF_Tooltip
- Removed: Features/FeaturesLogin
- Removed: @CreatePlayer
- Added: Feature(T2A/LBR/AOS/SE/ML) to use feature expansion. Look in sphere.ini for usage.
- Added: f_onchar_create in sphere_serv_triggers.scp. With newer clients you'll get
ARGN1 flags - ARGN2 profession chosen - ARGN3 elf
- Added: TRYSRV. It works like TRYSRC but putting automatically as src the server.
- Scripts: Added TRYSRV as plevel 7 command. I highly recommend everyone does this!

19-08-05, Radiant
- Scripts: Added TRYSRC as plevel 7 command. I highly recommend everyone does this!
- Fixed: d console command (area dump) was broken a while ago

21-08-05, Vjaka
- Fixed: 2 exploits due to bad player name parsing (thanks XD for reporting).

21-08-05, Radiant
- Made ROOM object accessable on everything. It is used like REGION, but for ROOMDEF.

22-08-05, Furio
- Fixed: Crash on sell for older clients.
- Fixed: Tooltip not working also if correct ini flags are set.
- Fixed: i_blood_2 created by sphere during hits not decaying.
- Added: TFLAGS accessable as SERV.ITEMDEF.defname.TFLAGS to get tiledata flags of the item.
- Added: p# dump all profiler data to profiler_dump.txt

23-08-05, Radiant
- Added: more exception catching to CSector::OnTick, should print more descriptive errors now
- Fixed: resource gathering bug (mining fishes when switching from pickaxe to fishing rod, etc)
(resource gathering skill is now aborted if resource gathering tool is unequipped)

23-08-05, Vjaka
- Fixed: fatal exceptions referencing PARTY methods (PARTY.MEMBERS) from NPC.
- Fixed: account references for writing in scripts under low-privileged accounts.
Both ways SRC.ACCOUNT.xxx and SERV.ACCOUNT.name.xxx are accessable this way.
- Fixed: invalid message when unlocking container told that I locked it.
- Fixed: NPC_AI_FOOD now obeys homedist and will not search out of the range.
- Fixed: NPC_AI_EXTRA caused npcs moving stonewalls and other spells :)
- Fixed: Pathfinding broken by some of the later changes.

23-08-05, Lynchy (Script pack)
- Added: NPCs from Mondain's Legacy (npcs/spherechar_mondains_legacy.scp)

24-08-05, Furio
- Added: Support for elf body (and ghost) in game.
- Added: Client keys for 5.0.0.
- Added: TAG.MAXPLAYERPETS to Stabler. It's the maximum limits of pets that a player
can stable. If not setted is 10.
- Added: @UserGuildButton for the new guild button on client.
- Added: @UserQuestButton for the new quest button on client.
- Fixed: Spellbook with newer clients (displaying/selecting spell).
- Fixed: Elf NPCs from Mondain's Legacy (npcs/spherechar_mondains_legacy.scp)
- Updated: grayproto to support ML quest button.
- Updated: spheretables.scp (changed plevel of some commands for better security)

24-08-05, Vjaka
- Added: CombatFlags ini setting. Currently it controls two aspects of the
bounce back effect in combat.
- Fixed: Reference to SERV from some triggers including @Enter in regions.
- Fixed: House regions creation for maps bigger than 0.
- Fixed: Players unavailable to call guards on NPCs.
- Fixed: Trigger command that did not work on characters.

25-08-05, Radiant
- Removed: OBJPROPS
- Rewritten tooltips to use a trigger. There is @ClientTooltip on items and characters.
(in the world, only non-static, movable items)
You can use ADDCLILOC on the client in this trigger (SRC), syntax:
ADDCLILOC <cliloc id>,[arguments]
Arguments can also be NULL, to skip an argument.
If this trigger returns 0 or nothing, some default properties will be added to the tooltip
depending on the type.
If it returns 1, no default properties will be added (but the tooltip still be sent).
- Added: @GetTooltip (ARGO = item being sent for) for players. This is like @itemEquip, etc.
Fired before @ClientTooltip, if returns 1 @ClientTooltip is skipped.
Try keeping these triggers light, because they will be fired alot.
- Added: f_onserver_save_finished, called after save is completely done
(ARGS is time it took to save in seconds, 4 digit precision)
- Fixed: exploit to cast spells faster than normal (i.e. cast first clumsy then flamestrike)
with precasting enabled.
- Added: COMMANDPREFIX ini setting. Default is .

25-08-05, Lynchy (Script pack)
- Added some Mondain's Legacy items (not complete yet)

26-08-05, Radiant
- Fixed: MASTERUID no longer changes loyalty, should fix the errors (was undesired behaviour too imo)
Note that in order for this setting to work the person you set this to has to be a full member
of the guild.
- Fixed: REMOVE not working in @EquipTest
- Added: Encryption keys for clients are now in SphereCrypt.ini. When new clients come out,
the new keys can just be added here without the need to upgrade sphere.

26-08-05, Furio
- Fixed: Tooltip sent to wrong client version making them crash.
- Updated: sphere_defs.scp

26-08-05, Cloud_Br (Script pack)
- Updated: sphere_chars_newer.scp (Monsters of AoS/SE)

26-08-05, Gygrazok (Script pack)
- Added: sphere_item_deco_mini_houses.scp (House miniatures of AoS)

28-08-05, Furio
- Fixed: mem leak in CGTypedArray (and derived one).

28-08-05, Radiant
- Added: missing @itemClientTooltip trigger causing wrong triggers to be fired
- Removed: @GetTooltip. Please use @itemClientTooltip trigger now, argo = item
tooltip being sent for (in both @ClientTooltip and @itemClientTooltip)
- Added: Notoriety title and guild abbreviation to default character tooltip
- Changed: Tooltips added in triggers now show below the name if return 0
- Fixed: Game Master title no longer shows on tooltip with privshow off
- Added: Elf bodies to sphere's internal list of humanoids
- Fixed: mem leak in sorted variable arrays (DEF/TAG/CTAG/VAR/LOCAL/etc)

30-08-05, Vjaka
- Added: GenericSounds ini settings to enable/disable all sounds.
- Removed: PlayerGhostSounds since it was not checked anywhere.

30-08-05, Cloud_Br (Script pack)
- Removed: spherechars_newer.scp
- Added: spherechar_lbr.scp (Lbr monsters)
- Added: spherechar_aos.scp (AoS monsters)
- Added: spherechar_se.scp (SE monsters)
- Updated: sphere_item_building_others.scp

02-09-05, Cloud_Br (Script pack)
- Updated: sphere_defs.scp (new sounds)
- Updated: spherechar_lbr.scp (Lbr monsters)
- Updated: spherechar_aos.scp (AoS monsters)
- Updated: spherechar_se.scp (SE monsters)
- Updated: sphere_item_building_others.scp
- Added: sphere_item_icons_new.scp (icons from new expansions)

03-09-2005, Furio
- Fixed: PARTY references (master/member)
- Fixed: hue/hair/beard for elf selectable on char creation
- Updated: sphere protocol (accepts tooltip refresh requests from new clients)
- Added: ISINPARTY to char (check if a player is in party)
- Added: UseDefaultSource (default: 0) if enabled SERV fallback to its default
source when executing commands. You shold set this to 1 if you are operating
with any new objects from functions called directly from the server, like
f_onaccount_login, f_onserver_start and so on.

05-09-2005, Furio
- Updated: Sphere now support the internal client cache for tooltips. This will
avoid wasting of bandwith and client crashes.

05-09-2005, Radiant
- Fixed: incorrect info on tooltips for some types

06-09-2005, Vjaka
- Fixed: some operations workability (SERV.new*) called from functions that are
run directly by the server. This disables both the default script object and
UseDefaultSource.
- Fixed: rescount-like operations when arguments was specifyed.
- Denied account auto-creation with first character numeric to avoid server
confusion to treat this account as index or a valid name in some operations.
- Fixed: win32 server crash if server name was too long.

06-09-2005, Furio
- Added: SCREENSIZE to access the game window size if the client supports that.
You can access that via SCREENSIZE.X and SCREENSIZE.Y.
- Added: RESENDTOOLTIP. Calling that on the object you need to resend tooltip.
Since clients use a cache for tooltip, if you want to force the cache too use
RESENDTOOLTIP 1.
- Fixed: REMOVEFROMVIEW/TARGET(FGW) not working.

08-09-2005, Vjaka
- Fixed: several errors with sql queries.
- Added: AutoPrivFlags to specify auto PRIV flags for new accounts.
- Added: ARGN1 to f_onaccount_login specifying account type. Most common values
are 3(login), 4(go to game), 5(http), 6(telnet).
- Added: HitsHungerLoss to specify char hits percents lost on starving tick.
- Added: TAG.NOSAVE tag for objects. If set to 1 the object will NOT be saved
when the world save will take place.
- Fixed: NEW* commands on characters not modifying character's ACT.

08-09-2005, Furio
- Fixed: SCREENSIZE.X/.Y not working.
- Added: CLIENTIS3D. Returns 1 if is a client is 3D.
- Removed: Client support for clients older than 1.26.00 (they're awfully old).
- ReDone: Unencrypted client support. UseNoCrypt now is a bool 1 means that
unencrypted client are allowed to login. If ClientVersion in sphere.ini is
setted to some value (e.g. 4.0.0) then only that client version will login
(this is valid for encrypted and unencrypted clients). Note that sometimes
unencrypted clients sometimes are dumb and sphere not recognize them properly
(and thus disconnected), but after restarting the client it's all ok.
- Modified: REPORTEDCLIVER. It contains the version of the unencrypted client
without any trailing letter. To get the complete version (e.g 4.0.11f) use
REPORTEDCLIVER.1.
- Modified: Disabled support for client tooltip cache (it'll be re-enabled after
a re-write).

08-09-2005, Cloud_Br (Script pack)
- Updated: sphere_map_points3.scp
- Updated: sphere_item_profession.scp
- Added: addons/worldfiles.zip. It contains a fully spawned world for Felluca,
Ilshenar and Malas.

09-09-2005, Furio
- Moved: Hardcoded mount/mountid list from exe to scripts.
- Updated: sphere_defs.scp with the mount/mountid list. Read the comments to
know how to edit it.
- Fixed: READLINE returning blank line.
- Fixed: Referring to party outputs a debug message.

09-09-2005, Vjaka
- Fixed: Popup menus not calling SELL, BUY speech triggers on NPCs.
- Added: LBR mounts IDs to the mount defnames.
- Fixed: mounting later npcs since they were treated being brain_human.

10-09-2005, Cloud_Br (Script pack)
- Fixed: some guarded areas on sphere_map2.scp that should be guarded.
- Fixed: names on sphere_map1.scp (Britain being Britain too, so when you
typed .go britain you were going to MAP 1), now all trammel places have
"Trammel <local name>".
- Fixed: some errors on addons/worldfiles.zip.
- Added: new mounts on sphere_chars_new_mounts.scp and their icons.
- Added: new mounts sounds to sphere_defs.scp
- Added: some HTML defs to sphere_defs.scp

10-09-2005, Rattlehead (Script pack)
- Added: new mounts defs to sphere_defs.scp
- Added: new mounts defs to spherechar_mondain_legacy.scp

12-09-2005, Furio
- Added: WOPCOLOR/WOPFONT to set color/font of Word of Powers.
- Added: TAG.OVERRIDE_SKILL applied to a weapon override the SKILL= field.
Attention is a 1 based field so... 1 means Alchemy and so on.
- Modified: now PACKETxx in .ini accept values from 0 to 255.
- Modified: item, with attr not containing 010 or 08000, dropped by player
on sea or black tile will insta-decay. RETURN 1 on DropOn_Ground
avoid that thing.

14-09-2005, Vjaka
- Added: warning msg if chardef does not have any CAN flags specifyed.
- Added: error msg if RESOURCES line contains errors inside.
- Fixed: NPC item equipping not having mt_equip flag.
- Fixed: dialog command TILEPICHUE nor working.

18-09-2005, Cloud_Br (Script pack)
- Fixed: some errors on spherechar_lbr.scp

19-09-2005, Vjaka
- Fixed: wopfont not working.
- Optimized vendor templates storage. Now vendor does not keep all the items to
be sold or bought from players all the time, but generate this list on the
first query and invalidate after some time. It will save your server and save
from tons of objects not actualy in the world.

19-09-2005, Furio
- Fixed: HITPOINTS not working.
- Modified: SYSPAWN/SYSCMD on *Nix build should work now.

20-09-2005, Vjaka
- Added: COMMANDTRIGGER setting. If set, each command the client is entering by
.something will be given to the function first. If it returns 1, the default
action is not taken. This allows overriding default commands.

21-09-2005, Cloud_Br (Script pack)
- Added: addons/Champion_Spawn.zip. A functional Champion Spawn system for Sphere.

21-09-2005, Furio
- Fixed: Spellbook content not correctly sent to newer clients.
- Fixed: SHRINK not working.
- Fixed: carving corpse not working.
- Fixed: using .commands with GM body.
- Modified: tooltip info on spellbooks.
- Modified: Damage on head for newer client now use newer packet.
- Modified: FeatureAOS in sphere.ini. Look in to know how it works.
- Added: support for All Names in 3d clients and newer 2d (ctrl+shift macro).

22-09-2005, Vjaka
- Fixed: Open paperdoll popup menu on self dismounting from horse.
- Modified: Resync executed in a fast mode will not broadcast notes to clients.
- Modified: Low hungry level does not damage in safe zones, and in underground
for NPCs.
- Fixed: ARGO reference when no property was specifyed.
- Fixed: TOPOBJ reference.

22-09-2005, Furio
- Fixed: attack not working with some weapons.
- Fixed: damage packet sent to incorrect clients.
- Fixed: Advanced_LOS not blocking los in some cases.
- Fixed: Spell teleport not using ef_walkcheck routines when enabled.

23-09-2005, Cloud_Br (Script pack)
- Updated: addons/Champion_Spawn.zip (read inside readme for more infos).
- Updated: addons/worldfiles.zip (read inside readme for more infos).

25-09-2005, Furio
- Updated: Moved all OF flags related to magic/magery in "ad hoc" field
called MAGICFLAGS. More info on it in Sphere.ini.
- Added: SEXTANTP. Retrieve the sextant point shown by a sextant in args
and if no args are set it would return the sextantp for the reference.
- Added: support for showing skillcaps in newer clients.
- Added: support for new status gump in newer clients.

25-09-2005, Radiant
- Added @SkillUseQuick char trigger and @UseQuick skill trigger, these are
called when sphere does a quick run of a skill (just difficulty test + skill
gain), in which case it wouldn't call @SkillStart (for example use of tactics,
parrying in combat, arms lore with blacksmithing repair, magic resistance, etc).
ARGN1 = skill being used
ARGN2 = difficulty requested
ARGN3 = result of difficulty calculation (same as in @GetHit)
returning 0 will force skill to fail, returning 1 will force skill to succeed
(both skip gains)
- Fixed: GMs not being able to resurrect in anti-magic areas
- Added: Character flag 020000 (STATF_ArcherCanMove), same as OF_Archery_CanMove
but for specific players. OF_Archery_CanMove overrides this flag for everyone.
- Updated: sphere_defs.scp and sphere_admin.scp for STATF_ArcherCanMove.
- Added: NPCAI flag NPC_AI_ALWAYSINT (0008), always be as smart as possible when
pathfinding.
- Fixed: SERV.NAME not working
- Added: SKILLUSEQUICK on chars, syntax: <SKILLUSEQUICK (skill) (difficulty)>.
Does a quick use of a skill based on (difficulty) and returns 1 if it succeeded.

26-09-2005, Vjaka
- Fixed: exception when adding empty sell/buy template on restock.
- Modified: CommandTrigger now has 2 arguments (in/out): ARGN1 is whatever the
command is accepted (limited by PLEVEL section, etc), and ARGN2 is whatever
the command should be said if not accepted. Also the prefix of the command is
cut up as well.
- Fixed: SERV.MAP if normal point was given in arguments (with Z coord).
- Modified: the sphere window operation on tray dclick. Now it hides if shown
and appears if hidden.

26-09-2005, Furio
- Modified: <STRREV string> to StrReverse(string)
- Added: StrTrim(string) trime whitespaces at start/end of the string.

26-09-2005, Gygrazok (Script pack)
- Added items/sphere_item_eight_age.scp. Item of 8th anniversary of UO.

27-09-2005, Furio
- Added: support in status gump for stat locking.
- Added: STATLOCK[x] working like SKILLLOCK[x] but for stats.

27-09-2005, Cloud_Br (Script pack)
- Updated: sphere_map0.scp and sphere_map3.scp
- Updated: sphere_map_points0.scp and sphere_map_points3.scp
- Updated: addons/Champion_Spawn.zip (read inside readme for more infos).
- Added: addons/Doom_Dungeon.zip. A functional Doom Dungeon system for Sphere
(read inside readme for more infos).

28-09-2005, Vjaka
- Added: ARGN2 to UserSkills trigger. Will be 1 if triggeted from .info command
that is useful if you use custom skill gump and not wish it opening when its not
needed.
- Fixed: ModAr not affecting actual armor.
- Added: ARGN2 (show the message of gain/loss) and ARGO (person killed) to the
@ExpChange trigger.

29-09-2005, Furio
- Updated: Moved LAYER_LIGHT from 9 to 15. Modified all hardcoded things.
- Updated: script pack (sphere_defs.scp, sphere_item_unsorted.scp).
- Fixed: sphere_admin.scp showing incognito name.
- Fixed: elf created always with blond hair.
- Added: RESDISPDNID/RESLEVEL/RESDISPDNHUE for items (it'll work for equippable ones only).

30-09-2005, Vjaka
- Fixed: dupe <amount> limited to the item complexity in containers.
- Fixed: commandtrigger not having proper default object.
- Added: TIMERCALL ini setting to specify amount of minutes for server to call
user function f_onserver_timer.
- Added: BETWEEN min,max,currentvalue,maximalvalue to get the curve value in
this combination.
- Modified: <Rx,y> now supports formulas inside, so -, or eval could be used.

01-10-2005, Cloud_Br (Script pack)
- Updated: addons/Doom_Dungeon.zip (read inside readme for more infos).
- Updated: addons/Champion_Spawn.zip (read inside readme for more infos).
- Updated: addons/worldfiles.zip (read inside readme for more infos).
- Added: addons/Slayer_Weapons.zip (read inside readme for more infos).

02-10-2005, Radiant
- Fixed #013: Webserver attempting to parse images and sending invalid
Content-Type header to clients
- Updated #037: Changed @Kill trigger to be fired on ALL the characters that had
to do with the killing and therefor would gain/lose karma/fame. return 1 stops default
karma/fame changes.

02-10-2005, Handred (Script pack)
- Updated: sphere_types.scp

04-10-2005, Furio
- Fixed #040: An item crafted by a player (skillmenu - makeitem) is created
without decay flag set.
- Updated: Client >= 5.0.0 now use the compressed dialog packet (bandwith saver).
- Updated: Default tooltip for a char (guild title/name).
- Updated: sphere_item_eight_age.scp with some RESDISP tests for two items.
- Added: TEXTENTRYLIMITED/DTEXTENTRYLIMITED (working in only in client >= 5.0.0),
look into sphere_dialog.scp help section.

04-10-2005, Cloud_Br (Script pack)
- Updated: sphere_admin.scp

06-10-2005, Vjaka
- Added: MOUNT command for character to mount it (if possible) by SRC object.
- Fixed #020: Vendor buy menus showing empty list.
- Fixed #022: Fame prefix shown when in polymorph.
- Fixed #006: Item remove not working in DropOn_Ground.
- Fixed #017: Chars with MT_NONMOVER unable to spawn.
- Fixed #051: Extra message when drinking potions too fast, or eating errors.
- Fixed: ISBIT command. Now it is used like all rest functions <isbit value,bit>
without complicated eval plus brackets constructions difficult to reproduce.
- Added: SETBIT value,bit and CLRBIT value,bit commands which returns mask with
specifyed bit set or cleared.
- Added: @ operator (means power of value, fe: 2@3 = 8).
- Added: If SERV.log @text specifyed, this will be shown without script context.
- Added: ALLOWLIGHTOVERRIDE, if set to zero, sector local light will be skipped.

06-10-2005, Furio
- Fixed #009: Client lingering in newer clients.
- Fixed #061: Name not shown on paperdoll.

07-10-2005, Vjaka
- Fixed #057: <dSOMEVAL> gave incorrect values.

07-10-2005, Furio
- Fixed #065: Commands not working with gm body.
- Fixed #064: Commands saying with sysmesage.
- Fixed #055: sphere_backward_compatibility.scp. MUSIC command.
- Fixed #062: sphere_char.scp. CAN flag not specifyed for c_corpser.
- Added: StrIndexOf(string1,string2,[offset]). Search string2 in string1 and
returns -1 (if not found) or a number >= 0 if found (index in string1).
Offset is optional (where to start to search 0-based index).

11-10-2005, Vjaka
- Added: ZeroPoint to configure base of the sextant coordinates.
- Improved: exception debugging and support.
- Fixed: dclick on console not always opened the corresponding file.
- Added: ARGN2 in speech triggers corresponds to the player speech color if
applicable.

11-10-2005, Radiant
- Fixed #070: Container can now be changed in @DropOn_Ground and @DropOn_Item

13-10-2005, Vjaka
- Fixed: ADDCLILOC leading to string corruption.
- Optimized: CALL operator to work faster if arguments are specifyed.
- Fixed #049: isevent/istevent working incorrectly.

18-10-2005, Radiant
- Reverted 0.56b back to 14-10-2005 07:10, 0.57.1 is now a different branch

19-10-2005, Radiant
- Tweaked #121: showing durability in tooltips as hits / maxhits instead of
percentages for armor/clothing.
- Added #038: CTAGLIST and SERV.VARLIST. TAGLIST/CTAGLIST/SERV.VARLIST LOG writes
results to the console.
- Fixed #098: Client not updating on .invis

19-10-2005, Cloud_Br (Script pack)
- Added the minor artifacts, see inside sphere_minor_artifacts.scp for tips.
- Added some missing fields to sphere.ini (PROFILE and EVENTSPET)
- Some updates and fixes on doom script and champions script.

19-10-2005, RanXerox (Script pack)
- Updated: sphere_item_aos_se.scp
- Updated: sphere_item_ml_weapons.scp
- Updated: sphere_item_treasure_maps.scp

19-10-2005, Vjaka
- Added a deadlock detection to some keywords parsing, that will eliminate some
stack overflows.

22-10-2005, Furio
- Fixed #087: Guild related clilocs are bugged.
- Fixed #091: WOPFONT doesnt work.
- Fixed: bug in encryption routines that could lead to a sphere crash during startup

23-10-2005, Furio
- Fixed: Referring to SERV.MEM when memory = 0 causing exceptions.
- Fixed #131: Feature_AOS_Damage + Canharmself cause 2x damage display if damage
is on self.
- Added #125: SERV.CLEARVARS. Clear all vars. Added in default script pack as
plevel 6 command (spheretables.scp).
- Removed: SERV.DELETEFILE / SERV.WRITEFILE / READFILE / FILELINES since they're all
integrated in the FILE obj.

26-10-2005, Cloud_Br (Script pack)
- Updated: sphere_item_building_walls_se.scp

26-10-2005, Furio
- Fixed #135: All stats being 26 when creating char.
- Fixed #149: Trigger @Rename is never called.
- Added: @UserSpecialMove with ARGN1 the special move selected from the fight book.

31-10-2005, Furio
- Fixed #159: Party don't display correct loot info.
- Fixed #171: All NPCs have ISSTUCK 1, even if they are on open, clear ground.
- Fixed #167: Can't see tooltips for locked down items.

04-11-2005, Vjaka
- Fixed #174: NEWDUPE from server object.
- Fixed #161: max* stats affected by mod* even if unsynced.
- Fixed #128: ClientTooltip trigger return 1 causing exceptions.

08-11-2005, Furio
- Fixed #188: <guildstone>.member.X.IsCandidate not working.

11-11-2005, Furio
- Fixed #186: <serv.map(<PLACE>).region.name> giving missing location.
- Added #199: Hiding hierachy (higher plevel will see lower hidden plevel gray).

15-11-2005, Vjaka
- Fixed #208: return 1 on @ReceiveItem not bounced item back if it was still in
dragging layer.
- Fixed #151: trigger command not working for characters.

18-11-2005, Cloud_Br (Script pack)
- Fixed a bug when stealing artifacts that might cause crashes (add-on/Doom_Dungeon.zip).
- Added some missing weapons to sphere_item_ml_weapons.scp
- Added some missing npcs to spherechar_lbr.scp
- Added Succubus to Daemon Slayer list (add-on/Slayer_Weapons.zip).

22-11-2005, Vjaka
- Fixed #112: impossible to access the CHARDEF if the NPC is not in world.
- Fixed #225: CanSee and CanSeeLOS always required for SRC and not accepting
arguments in several cases (actualy CanSee did not accept this at all).

22-11-2005, Torfo
- Fixed #221: Msg/Say parameters have no effect on hearall output.

24-11-2005, Cloud_Br (Script pack)
- Updated add-on/Champion_Spawn.zip:
Changed c_forest_lord to c_etheral_warrior as it should be on Forest Lord Spawn Group.
Changed ID field for Lord Oaks to c_etheral_warrior, to respect the defnames changes.
Barracoon now has the hability to summon ratmans.
Added Rotting Corpse to Unholy terror spawn.
Added Rotting Corpse to Undead slayer weapon list.
Corpses of the minions should now stay on the ground (with a timer of 15 seconds) to
avoid lag.
Optimized spawning of monsters, they won't appear on the same spot anymore and walk a
way after some time, they will appear scatered around the spawn in a maximum distance
of the range of that spawn (this should avoid lag when changing levels).

25-11-2005, Vjaka
- Fixed #233: Setting MAX* was substracting MOD*, so did not work correct way.

28-11-2005, Cloud_Br (Script pack)
- Updated add-on/Doom_Dungeon.zip.
- Updated add-on/Champion_Spawn.zip.

01-12-2005, Vjaka
- Fixed #222: Region triggers required return 0 to allow other same triggers to work.

01-12-2005, Cloud_Br (Script pack)
- Updated add-on/Champion_Spawn.zip:
Fixed some wrong defnames on the monsters list.
Fixed champion appearing as a man and dieing.
- Updated add-on/Slayer_Weapons.zip:
Added Bovine Slayer to slayers list.
- Updated: Talismans to sphere_item_ml_misc.scp.

01-12-2005, Blizzard (Script pack)
- Updated: aquarium fishes to sphere_item_ml_misc.scp.

02-12-2005, Torfo
- Fixed #251: PacketX & unary operators

03-12-2005, Furio
- Fixed #246: Desappearing items on tiles built over water map tiles.
- Fixed #227: Tooltips for locked down items isn't being sent yet.
- Fixed: re-added basic support for speech.mul.

07-12-2005, Torfo
- Fixed #242: Cannot connect with newer clients

08-12-2005, Vjaka
- Fixed #247: Sector local time not changing, light levels not working due that.

09-12-2005, Vjaka
- Fixed #11: DiagonalWalkCheck caused problems with NPC spawning.

10-12-2005, Sir Dwayne (Script Pack)
- Updated: sphere_skillmenu.scp (Silver jewelry)
- Updated: spherechar_human.scp (Female barber)

11-12-2005, RanXerox (Script pack)
- Updated: maps/sphere_map_points2.scp (Rat fort teleporters)
- Updated: sphere_types.scp (Swamp terrain)

11-12-2005, Blizzard (Script Pack)
- Renamed: sphere_item_ml_weapons.scp to sphere_item_provisions_weapons_ml.scp
- Added: sphere_item_provisions_weapons_aos.scp
- Added: sphere_item_provisions_weapons_se.scp
- Updated: sphere_item_aos_se.scp
- Added DUPELIST and DUPEITEMs for all AoS, SE, and ML weapons.
- Added: sphere_item_provisions_armor_aos.scp
- Added: sphere_item_provisions_armor_se.scp
- Updated: sphere_item_provisions_weapons.scp

11-12-2005, Cloud_Br (Script Pack)
- Updated: sphere_minor_artifacts.scp (some missing minor artifacts)
- Added: sphere_item_christimas.scp (Christimas Item ids that come with 5.0.1f patch)

15-12-2005, Introvert (Script Pack)
- Updated: sphere_events_npcs.scp (fixed bugs in e_undead)

20-12-2005, Furio
- Fixed #286: Bug with @ operator (power of).

25-12-2005, Furio
- Fixed: FILE.READLINE returning strings with trailing \n and \r.
- Changed: StrTrim(args) to <STRTRIM args>.
- Fixed #298: Logging out while dragging item.

25-12-2005, Handred
- Fixed #287: Updated sphere_item_professions.scp

26-12-2005, Vjaka
- Fixed #294,#296: @SpellCast did not allow or disable to change words of power.
- Fixed #282: Operator ^= did not resolve.

28-12-2005, Radiant
- Fixed #090, #172, #237: ACTION being changed on UseQuick because of new trigger
- Fixed #136, #154, #291: Partial character updates not working
- Fixed #129: GM body can now also use the normal command prefix, instead of only '='
- Fixed #299: Transfering pets to NPCs

29-12-2005, Furio (Script Pack)
- Updated: sphere_item_provisions_weapons_ml.scp (fixed bug BLACKSMITH
instead of BLACKSMITHING).

31-12-2005, Furio
- Fixed #324: TRYSRC is read as TRYSRV (only in message errors).
- Fixed #326: missing resource in sphere_item_provisions_weapons_ml.scp
- Fixed #315: wrong defnames in sphere_defs.scp
- Fixed #330: updated sphere_item_building_walls_se.scp and sphere_item_magic_necromancer_aos.scp

02-01-2006, Furio
- Fixed #332: support for guild chat speech mode.
- Fixed #336: PETRETRIEVE console error that shows when there's no stabled animals.
- Updated: sphere_defs.scp

03-01-2006, RanXerox (Script pack)
- Updated: sphere_types.scp

04-01-2006, Gygrazok (Script pack)
- Added: items/sphere_item_deco_evilitem.scp

08-01-2006, Shadow Dragon
- Fixed: Pets going logout.

10-01-2006, Furio
- Fixed #361: Creating characters with apostrophes ( ' ) in the name gives a random
name in game.
- Fixed #348: Problems with FILE object.
- Fixed #356: Monsters not playing proper sounds (spherechar.scp and spherechar_evil.scp)
- Fixed #357: Some mappoints fixes (sphere_map_points0.scp and sphere_map_points1.scp)
- Updated: sphere_item_ml_misc.scp

11-11-2006, Radiant
- Ticks will no longer be given to webpages if USEHTTP is disabled in sphere.ini

12-01-2006, Vjaka
- Fixed #94: Stable master restock causing stabled pets to disappear.
- Fixed #212: Vendors do not restock money amount, unable to buy after a while.
- Fixed #343: Container functions like COUNT overrided user functions.
- Updated sphere_spells.scp fixing spell flags for polymorph (#335).

12-01-2006, K. Thorp (Script pack)
- Added: some multis to sphere_item_multis_houses_ships.scp
- Added: deeds to sphere_item_provisions_deed.scp

14-01-2006, Furio:
- Fixed #363: defining new region types. (See knowbugs.txt)
- Updated: sphere_defs.scp, sphere_types.scp, spheretables.scp

14-01-2006, Torfo:
- Fixed #371: Error on Bulletin Board (last letter missing)

15-01-2006, Radiant:
- Updated: You may now call functions on the SERV object. This affects several things,
including the f_onserver functions, the console and packet filtering functions.

17-01-2006, RanXerox (Script pack)
- Updated: sphere_triggers.scp,sphere_item_eight_age.scp,sphere_item_ml_misc.scp
sphere_item_provisions_weapons_ml.scp,sphere_minor_artifacts.scp
sphere_map_points0.scp,sphere_map_points1.scp
sphere_item_provisions_weapons_aos.scp,sphere_item_provisions_weapons_se.scp

20-01-2006, Blizzard (Script Pack)
- Updated: sphere_item_provisions_armor.scp, sphere_item_provisions_armor_se.scp,
sphere_item_provisions_weapons_aos.scp, sphere_item_provisions_weapons_ml.scp,
sphere_item_provisions_weapons_se.scp.

21-01-2006, Radiant
- Updated: 80 character console command limitation to SCRIPT_MAX_LINE_LEN

22-01-2006, Furio
- Fixed #380: IsNearType doesn't works whith custom typedef.
- Fixed #366: Effect of Hallucination.
- Fixed #378: Typo in sphere_admin.scp.
- Fixed: exceptions when using .charlist.
- Fixed: typo in console message.
- Sync (Vjaka): defmessage string allocation, thus binary EXE size reduced by ~200kb.
- Sync (Vjaka): SERV.console CMD to launch commands as you were in server console.
- Sync (ShadowDragon): Items in multis do not send to the client if he is not in
the multi (OSI-compatible lag fight) as OF_OSIMultiSight.
- Updated: now ARGS in f_onchar_create contains account name.
- Updated: sphere_serv_triggers.scp.
- Added: f_onaccount_delete, ARGS contain account name, RETURN 1 block the delete.

23-01-2006, Torfo
- Fixed #264: Problem with 0xBF packet.

23-01-2006, Blizzard (Script Pack)
- Added: sphere_item_provisions_armor_ml.scp, sphere_item_provisions_clothing_ml.scp,
sphere_item_provisions_clothing.scp.
- Updated: sphere_item_provisions_armor.scp, sphere_item_profession_tailor_tanner.scp,
sphere_item_ml.scp.

27-01-2006, Torfo
- Fixed #411: sm_bolts in sphere_item_resources.scp and sphere_item_profession.scp
- Fixed #409: added missing ">" in sphere_item_aos_se.scp
- Fixed #405: added missing MT_FEMALE in def of succubus in spherechar_lbr.scp
- Fixed: seasons will be saved now.
- Fixed #408: <sector.season> doesn't work.

29-01-2006, Furio
- Fixed #410: Promptconsole removes all used ",".
- Fixed: strlen not working correctly with ",".

29-01-2006, RanXerox (Script pack)
- Updated: sphere_book.scp

31-01-2006, Furio
- Fixed #425: Unable to start sphere when editing sphere_msgs.scp.
- Removed: USEGODPORT in sphere.ini (and also the god port)
- Modified: USEHTTP usage. Look into sphere.ini for new options.

02-02-2006, Furio
- Fixed: players being able to track invisible (.invis) GMs.
- Sync (Vjaka): REGION.TYPE returning type from the itemdef of the multi.

10-02-2006, Furio
- Modified: replaced internal routines of TAG/CTAG/VAR/LOCALs, it improves
speed, memory usage and decrease the occurence of leaks/exception.
- Fixed #440: Crash when selling too many items to vendors.

11-02-2006, Furio
- Fixed: new internal routines of TAG/CTAG/VAR/LOCALs in some special case.
- Added: support for OSI AuthID to avoid possible hijack to game server. By
default is disabled, set UseAuthID = 1 in sphere.ini to use it.

15-02-2006, Furio
- Fixed: "Divide by Zero" in CChar::Tick() for "update stats" sections.

19-02-2006, Furio
- Fixed #456: NEWDUPE and DUPE doesn't copy events.
- Added: AOS properties for player characters: RES* (cold,energy,fire,poison) and
LUCK with no built-in functionality.
- Sync (Vjaka): Added #214: ColorNoto* settings for characters color hue change.
- Sync (Vjaka): "NEWLOOT X" character function creating and equiping item X for NPCs
if can give loot, useful to be used in @Death or @DeathCorpse triggers.
- Sync (Vjaka): "NEWGOLD N" function gives amount N of gold to the current char.
- Sync (Vjaka): character function TIMERF N,FuncName to cause a timed execution of a
function FuncName in N secs. Specifying N as -1 will clear all TIMERF list.
These functions are not saved, so do not store hours in the list, the purpose
of this is to decrease overhead due to timered memory items opeations.
- Sync (Shadow Dragon): TAG.NoMoveTill for script purposes. This doesn't allow char
to move if TAG.NoMoveTill > SERV.Time.

20-02-2006, Furio
- Fixed #462: TAG.NAME.HUE on chardef isn't working.
- Fixed: some possible overflow in some spots.
- Touchups for *NIX compilation.

20-02-2006, Cloud_Br (Script pack)
- Changed description of EVENTSPET on sphere.ini
- Add some new points to sphere_map_pointsX.scp
- Add some places with names like on OSI (places that didn't have a respective name
before on default sphere) to sphere_mapX.scp files.

24-02-2006, Vjaka
- Fixed #158: NPC value spontaneously changing when NPC was under reactive armor.
- Fixed #314: Elf's Hair Color in creation is not correct.

25-02-2006, Torfo
- Fixed: possible PLEVEL-hack (thx to SL for reporting).

03-03-2006, Furio
- Fixed #401: Spells (incognito and mark) don't update the client tooltip.
- Fixed #478: Newgold does not update gold amount.

05-03-2006, Furio
- Fixed #483: Typo in sphere.ini.
- Fixed #484: LUCK and RES* properties throws errors when reading.

07-03-2006, Furio
- Added: Tithing points for player characters as TITHING with no built-in
functionality.
- Fixed #492: Undefinied SCROLL_MOTD at player login.

08-03-2006, Furio
- Fixed #502: Divide by Zero Exceptions in CChar::Tick() stat section.
- Fixed #503: Tithing Points showed incorrectly in Paladin book.
- Updated: sphere_item_aos_se.scp, sphere_item_magic_necromancer_aos.scp

10-03-2006, Furio
- Fixed #501: Dropping a stackable item on another one with
special attr (Newbie, Static, Move Never).
- Fixed #509: Cheater message with disconnect.
- Fixed #511: Tooltip Problem with Spawns.
- Fixed #517: Deleting Accounts not loging properly.

15-03-2006, Radiant
- Fixed: WHILE loops ending with weird undefined symbol error.

18-03-2006, Furio
- Fixed #526: "Resync [...]" working incorrectly.
- Fixed #520: Magic Flag IgnoreAr doesn't work.
- Updated: no 0-100 limitations to RES*.
- Updated: sphere_defs.scp

21-03-2006, Furio
- Fixed #292: Textentrylimited crashing clients (thx to Admin Ben)
- Fixed #528: Invis items in pack and/or corpse we see it, but when
we click it, it dissappears.
- Fixed #506: ghost of the npc appears after dying when mounted.
- Updated: sphere_dialog.scp

22-03-2006, MrSugarCube (Script pack)
- Updated: sphere_menu.scp, sphere_item_misc.scp, townmagincia.scp (incorrect
spelling of 'jewelry').
- Updated: sphere_item_provisions_armor_ml.scp (Duplicate DEFNAMEs for 02b74
and 02b79).

23-03-2006, Furio
- Added: <FILE.FILEEXIST arg> returning 1 if arg exist.
- Added: Support for Bushido/Ninjitsu/SpellWeaving spellbooks.
- Updated: sphere_defs.scp (new typedefs), sphere_item_aos_se.scp (spellbooks).

23-03-2006, MrSugarCube
- Fixed: Incorrect spellbook packet being sent to newer clients with certain AOS
features disabled.
- Fixed #181: Woolly sheep having wool resource on corpse after being shorn.
- Fixed: Player adding non-vendable item to vendor stock is deleted - Vendor now
returns the item.
- Fixed #475: Taking item from hidden state does not update other clients.
- Modified: Warning message for non-vendable items will show the UID of the item
and vendor.

23-03-2006, Handred
- Updated: sphere_spawns.scp. Changed all RESOURCES= to ID=, modified also the
WEIGHT= for a better and easier looking to, ie: ID=c_zombie 5.

24-03-2006, MrSugarCube
- Fixed #519: Poison spell and field spell damage reveals caster after every
damage effect.
- Fixed: Setting TARGP only working with invalid locations.
- Modified: @DropOn_Ground and @itemDropon_Ground triggers now have ARGS set
to the location the item will be dropped to, specific points accessible
using ARGV[x]. (readonly)
- Fixed: ARGS not being parsed correctly into ARGV when empty parameters are
given (for example <myfunc 1,,,4,5> was treated as "1",",","4","5" and not
"1","","","4","5").
- Modified: Attacker will not be revealed when a character is hit by a spell
with SPELLFLAG_FIELD set.
- Added: Damage Flag DAM_NOREVEAL (04000). If this flag is applied the attacker
will not be revealed. This is applied by default to poison damage and spell
damage. (Note that for spells the attacker will be revealed regardless if
SPELLFLAG_HARM is set, unless SPELLFLAG_FIELD is also set, so only affects
field spell damage).
- Updated: sphere_defs.scp (Updated DAM_FLAGS section)

26-03-2006, MrSugarCube
- Modified: Vendor boxes will now only accept a maximum of 115 items dropped
inside (as opposed to the 256 item limit of a normal container). A warning
message will be displayed when the buy menu is shown if this limit has been
exceeded.
- Fixed #540: Logged out characters can be targeted with spells (Actually
CANSEE was returning 1 without GM/ALLSHOW priv).

27-03-2006, MrSugarCube
- Fixed #429: Unable to walk on blocking terrain with platform properties
(eg: Palace of Paroxysmus acid).
- Fixed: Walking on stairs in certain areas (such as the ones at 925,641,-80,2
or 7060,376)
- Updated: sphere_map0.scp, sphere_map_points0.scp, sphere_map0_ml.scp,
sphere_map_points0_ml.scp (Moved ML locations to seperate script which can be
uncommented to enabled ML areas).
- Updated: spheretables.scp (Added ML map files to RESOURCES block, to be
uncommented if you wish to use).
- Updated: sphere.ini (Updated MAP0 description to remind users to uncomment ML
map scripts).

28-03-2006, Ellessar (Script Pack)
- Updated: sphere_item_provisions_weapons_se.scp (incorrect spelling for
i_tetsubo SKILLMAKE).

29-03-2006, MrSugarCube
- Fixed: NPCs unable to walk on the same tile as a dead/disconnected/insubstantial
character.

30-03-2006, MrSugarCube
- Fixed #545: TARGET function with no message specified sent a blank sysmessage
to the client. (also affected PROMPTCONSOLE).
- Updated: sphere_msgs.scp - Added missing message definitions to the list
(27 were missing).

30-03-2006, Ellessar (Script Pack)
- Updated: sphere_item_provisions_weapons.scp (SKILL properties corrected for
MaceFighting weapons).

31-03-2006, MrSugarCube (Script Pack)
- Updated: sphere_item_building_floors_se.scp (incorrect axis categories)
- Updated: sphere_item_provisons_deed.scp (incorrect spelling of "Provisions"
for some axis categories)

01-04-2006, MrSugarCube
- Fixed #552: Removing items in SECTOR.ALLITEMS causes infinite loop
(also ALLCHARS/ALLCHARSIDLE/ALLCLIENTS).

03-04-2006, Furio
- Fixed #553: Errors during SERV.MAP parsing.
- Fixed #407: Account creation with bad words.
- Removed: OF_Advanced_Los.
- Added: AdvancedLos in sphere.ini to control Los behaviour of player and npc.

04-04-2006, RanXerox (Script pack)
- Updated: sphere_item_magic_wands.scp (eliminates old ITEMDEF numbers).

04-04-2006, MrSugarCube
- Fixed #556: Exception occuring when failing to bandage another character.
- Fixed #558: DB reference still accessible with MySQL support disabled.

04-04-2006, Ellessar (Script pack)
- Updated: spherechar_lbr.scp (Changed "ICON=i_pet_orc_brute" to "ICON=i_pet_orc"
for character c_orc_brute)

07-04-2006, MrSugarCube
- Fixed #565: Account name "account" not loaded correctly from accounts file.

08-04-2006, Ellessar (Script pack)
- Updated: sphere_item_icons_new.scp (Added missing icons: i_pet_terathanavenger,
i_pet_meereternal, i_pet_meercaptain, i_pet_meermage)
- Updated: spherechar_lbr.scp (Added NPCs: c_mummy, c_terathan_avenger,
c_meer_eternal, c_meer_captain, c_meer_mage)
- Updated: spherechar_se.scp (Fixed incorrect weapon for c_yomotsu_warrior)

09-04-2006, Vjaka
- Fixed #284: Character DISPID limitation changed to 2048 basing on bodyconv.def.
- Fixed #372: Weighted random templates had limitation for 64 members inside.
- Fixed #479: Off-duty vendor going off-duty with active client around.
- Fixed #497: Duplicated resources on inherited NPC.
- Fixed #541: Picking item that is too heavy is causing item to drop.
- Fixed #561: Players are unable to walk through any npc regardless of the stamina.

10-04-2006, Furio
- Added: TERRAIN.Z in SERV.MAP to know at which z is located the map tile.
- Fixed #577: SERV.ITEMDEF not behaving correctly.

10-04-2006, MrSugarCube (Script pack)
- Updated: sphere_map0.scp (Removed REGION_FLAG_UNDERGROUND from
a_lord_britishs_castle_1, fixing lighting around west britain).

10-04-2006, Vjaka
- Fixed #575: Multiple resource lines in a REGIONTYPE not loading correctly.

11-04-2006, Ellessar (Script pack)
- Updated: sphere_backward_compatibility.scp (tweak for addnpc).

13-04-2006, MrSugarCube
- Fixed #576: Added World Statics Save to DEFMESSAGE table.
- Updated: sphere_msgs.scp (Added 'server_worldstaticsave' message)

15-04-2006, MrSugarCube
- Fixed: Players unable to dismount from their rides after attacking
another character unless they retreated or killed the enemy.

16-04-2006, Handred (Script pack)
- Updated: sphere_menu.scp (Added Guild Transfer menu option using
softcoded TRANSFERGUILD function. )
- Updated: sphere_triggers.scp (Added TRANSFERGUILD function. Feel
free to fit it to your needs. )

17-04-2006, MrSugarCube (Script pack)
- Updated: sphere_spells.scp (Added SPELLFLAG_PLAYERONLY to spells
71 and above (potion effects))
- Updated: jobbeggar.scp, jobblacksmith.scp, jobhealer.scp,
jobtavernkeeper.scp, jobvet.scp, jobweaponsmith.scp,
townbritain.scp (Fixed syntax errors where SRC.SEX was being used
incorrectly)

18-04-2006, MrSugarCube
- Fixed: Adding a stack of scrolls to a spellbook consumed the whole
pile instead of just one.

19-04-2006, coruja747 (Script pack)
- Updated: sphere_item_magic_wands (Fixed incorrect spelling of 'daemon'
for i_wand_summon_daemon)

19-04-2006, MrSugarCube
- Fixed: Turning ships to force ship into invalid sailing location.

20-04-2006, Furio
- Fixed #600: Forcont* loops block script execution if no items found.

22-04-2006, MrSugarCube
- Fixed #622: Unable to access specific resources for spells using
RESOURCES.n[.KEY|.VAL]
- Fixed #141: Curse spell having no effect on target.
- Fixed #476: UID.x.KEY not working correctly on region reference (under
@Enter trigger for example).

24-04-2006, MrSugarCube
- Fixed #201: Walking off ship planks moves player to incorrect
height (this is normal for characters with GM mode enabled).

26-04-2006, Ellessar
- Updated: sphere_item_profession_tailor_tanner.scp (Removed custom
@TargOn_Item trigger for i_sewing_kit)

02-05-2006, Gygrazok
- Updated: sphereCrypt.ini (Added encryption keys for 5.0.2 client)

02-05-2006, Furio
- Fixed #643: Functions with similar names sometimes get miscalled (thx to SL Patch).
- Fixed #641: Deleting account when the player is online.
- Fixed #625: Cloth bolts give always 25 i_cloth, while it should give the amount of
i_cloth specified in RESOURCES.
- Updated: sphere_item_profession_tanner.scp (Cloth bolt value).

03-05-2006, MrSugarCube
- Fixed #642: Intrinsic functions not working correctly from SERV
object.
- Fixed #645: Possible to place invalid items on a gameboard, which
in turn crashes clients.
- Fixed: Game board was setup incorrectly for games of Checkers.
- Modified: Game board setup for backgammon game added. (Note: Requires
that backgammon board has MORE1 value of 2)
- Updated: sphere_item_profession_cook_barkeep_baker.scp (i_backgammon_game
MORE1 changed to correct value)

09-05-2006, Torfo
- Fix (temp): TX-Errors are disconnecting player now (just on linux).

15-05-2006, Furio
- Modified: If VENDORMARKUP is not present on the npc or in the region the one from
the chardef will be readed.
- Modified: Changing CLIENT properties will not show anymore annoying sysmessages.

19-05-2006, Shadow Dragon
- Fixed #638 & #639: Items outside of multi not sending when in multi.
- Fixed #655: House building on each other.

21-05-2006, V
- Fixed #611: Vendors buying without buy= assigned to them

23-05-2006, MrSugarCube
- Fixed #675: Stone wall revealing location of higher privileged characters.

28-05-2006, Furio
- Fixed #662: Skill lock tick.
- Fixed #691: serv.REGIONRESOURCE.x.REAP not working
- Modified: FeatureAOS to permit using of basic Aos feature without having tooltips.
Look into sphere.ini for more info.

31-05-2006, MrSugarCube
- Modified: <CANCAST (spell)> now accepts an extra parameter to check the region
flags. If the second parameter is not supplied then this check is enabled by
default, the advantage is that you can now disable the region check when checking
if a character can cast a spell. New usage is: <CANCAST (spell) [checkantimagic]>
- Fixed #702: Items with value=0 can not be crafted (note that without a value set the
QUALITY property will be unavailable, and also no experience will be gained from such
items).

31-05-2006, MrSugarCube (Script pack)
- Fixed #679: sphere_skillmenu.scp (Inscription SKILLMENU now makes use of new
CANCAST syntax, resolving the issue of region flags preventing the crafting of
certain scrolls)

01-06-2006, MrSugarCube
- Fixed #671: CriminalTimer=0 causes errors when setting criminal status.
- Fixed #703: Verbs not executing correctly on the default object in dialogs.

04-06-2006, MrSugarCube
- Fixed #681: Unable to execute and read the return value of scripted functions
on the SERV object.
- Fixed: Server stats not being given when requested by UOGateway.
- Modified: The following multi properties can now be read from their ITEMDEFs:
MULTIREGION, REGIONFLAGS and COMPONENT (COMPONENT usage is same as COMP).

05-06-2006, MrSugarCube
- Fixed: Attempts to use house keys to lock items down in containers.

06-06-2006, Furio
- Added: NAPIERPOW(arg), LOGARITHM(arg[,base]), TAN(arg).

06-06-2006, MrSugarCube
- Fixed: MULTIREGION property didn't show the value exactly as it appears in
scripts (x1,y1,x2+1,y2+1,0 instead of x1,y1,x2,y2)

08-06-2006, MrSugarCube
- Fixed #711: EFFECT_ID property returning the EFFECT value on SPELL block.
- Fixed #413: Spell icons are bounced into backpack with MAGICF_STACKSTATS
enabled.
- Modified: MAGICF_STACKSTATS now allows a character to be affected by
each of the stat spells at the same time (eg. strength+bless+feeblemind).
Note that it does not allow multiple effects from the same spell (so
casting bless several times does not work).
- Updated: Sphere.ini with MAGICF_STACKSTATS description

08-06-2006, Furio
- Fixed #699: Removing an account on Linux cause an exception.

08-06-2006, Ellessar (Script pack)
- Updated: sphere_triggers.scp (Updated SRC.NEWITEM with SERV.NEWITEM and
removed unnecessary SRC references)

08-06-2006, Beyonder (Script pack)
- Updated: sphere_item_building_fence.scp (Changed incorrect item defname
i_gate_wood_2 to i_fence_wood_3 (ITEMDEF 085c))
- Updated: sphere_backward_compatibility.scp (Added i_gate_wood_2 as a
DUPEITEM of i_fence_wood_3 for saves using incorrect defname)

11-06-2006, V
- Fixed: alligator not responding to commands
- Added: Broadcast warning 10 seconds before world save is performed to alert players

12-06-2006, MrSugarCube
- Fixed: ISNUM not working correctly with numbers in hex format.

13-06-2006, MrSugarCube
- Added #722: Support for dialog component 'buttontileart' in newer clients. Syntax
is the same as 'button', but with 4 additional parameters for placing a tilepic
over the gump image with a specified hue (0=normal) and offset (0,0=top left):
"buttontileart x y up down active page id tileid tilehue offsetx offsety"
- Fixed: Remove Trap skill not starting after targeting an object.
- Fixed: Scripted & Targeted skills not starting after targeting an object.
- Fixed: Possible exceptions occuring when a reference does not exist (such as ACCOUNT
.CHAR.x where x was an invalid index)
- Modified: Stat regeneration will now take twice as long instead of halting
completely when a character is hungry.

13-06-2006, MrSugarCube (Script pack)
- Updated: sphere_dialog.scp (Fixed d_hair_dye dialog not dying player's hair and
added buttontileart description to the help section)

14-06-2006, MrSugarCube
- Fixed: Exception when adding a guild member and not provided sufficient arguments.
- Fixed: Inviting someone into a party tells the wrong character they've been added.

15-06-2006, Furio
- Added: Added TAG.OVERRIDE.STATSUM/SKILLSUM/STATCAP[$statid]/SKILLCAP[$skillid] for
players and npc to override SKILLCLASS values.
- Sync (ShadowDragon): TAG.OVERRIDE.REGEN[$statid]/REGENVAL[$statid] to modify regen
rate and regen amount.
- Sync (Vjaka): Added <EXPLODE sep,string> operator which converts string with separators
other than ',' to commas making possible to operate with such string using strarg/streat.
Sample: LOCAL.S=<explode :/- ,my:test/string:2-3> should give result of "my,test,string,2,3".

17-06-2006, MrSugarCube
- Fixed #729: AntiMagic flags blocking spell effects on items even with GM mode enabled.
- Fixed #730: Immunity to spider web traps after taking damage.

17-06-2006, coruja747 (Script pack)
- Updated: sphere_item_provisions_armor_se.scp (Fixed error in t_ninja_belt)

18-06-2006, V (TYVM SL)
- Modified: TimerF is now global and works on any object. It will take optional
arguments to the function call. Entire list is now saved and loaded upon startup.
It no longer uses -1 to erase the TimerF list. Takes a maximum of 1024 characters.
syntax: timerf n, function args

19-06-2006, MrSugarCube
- Fixed #653: TRAIN function causing exception when not all default skills
are defined.
- Fixed #732: Items on buy/sell menus displaying names from muls with
FEATURE_AOS_UPDATE_B disabled on AOS+ clients. Instead a basic tooltip packet
containing only the name of the item will be sent to the client in this case.

19-06-2006, MrSugarCube (Script pack)
- Updated: sphere_item_provisions_weapons_se.scp (Corrected incorrect DUPEITEM
and TDATA properties for i_fukiya)
- Updated: sphere_msgs.scp (Moved 32 hardcoded messages to defmessages and added
1 missing defmessage)

01-07-2006, Furio
- Fixed #740: Strange price on vendors.
- Fixed #752: Resizepic not showing with dorigin.
- Fixed #757: Error on ".serv.account add".

02-07-2006, Nazghul (with thx to Ellessar)
- Fixed #639: OSI Multi Sight removes items already in sight.
- Added: TAG.ALWAYSSEND for items. An item with this TAG will always be send,
no matter whether it is in a multi or not. The TAG works only with
OF_OSIMultiSight on.
- Redone new items sending (should save some unneeded packets)

04-07-2006, MrSugarCube
- Modified: SERV.CLIENT.x reference no longer accepts x if it is out of range
(use SERV.CLIENTS property to check range).
- Modified: SERV.CLIENT.x reference no longer skips clients without characters
(such as HTTP, or telnet connections), which caused strange behaviour.
<SERV.CLIENT.x> will return 0 if the client has no attached character, 1 if
the client has a character attached.

05-07-2006, Nazghul
- Added: A skill trigger ON=@PreStart and a character trigger ON=@SkillPreStart
are now called before ANY hardcoded stuff related to the skill which will start.
- Added: A skill flag SFK_NOMINDIST. With this flag on, you can mine, chop
(distance doesn't have to be >= 1) or fish (distance doesn't have to be >= 2)
right under yourself.
- Modified: Now an axe can be damaged during lumberjacking.
- Fixed: Fishing bug, which allowed fishing through ship floor.
- Fixed: Chopping with t_weapon_fence does not start skill Lumberjacking.

05-07-2006, Nazghul (Script Pack)
- Updated: sphere_defs.scp (added section skill_flags)
- Updated: sphere_msgs.scp (messages fishing_close, lumberjacking_close,
lumberjacking_tool, mining_close, fishing_4)

09-07-2006, MrSugarCube
- Fixed: dtext, dcroppedtext, dhtmlgump, dtextentry and dtextentrylimited in gumps
using a space for the text if no string was provided.
- Fixed #754: GMs losing non-vendable items when dropping them into a vendor box.
- Fixed #720: <dSOMEVAL> returning 0 for values starting with "0.".

10-07-2006, MrSugarCube
- Fixed #760: Exception caused by opening paperdoll when not all default skills
are defined.

11-07-2006 Nazghul
- Fixed #594: Players (only if their client allows) and NPCs were able to go through
non-static walls.
- Added: CAN-Flag mt_passwalls (08); NPC with this flag CAN pass through static
and dynamic walls.

12-07-2006, Furio
- Fixed #690: serv.REGIONTYPE.*.resources is not working.
- Added: <serv.regiontype.*.calcmemberindex [uid]> returning the index of the
resource selected randomly or basing on the skill of the uid passed as argument.

12-07-2006 Nazghul
- Fixed: When logging in with an unencrypted client, you were not able to see
tooltips for objects in line of sight (0 to 18 tiles away from you),
including yourself.

12-07-2006, Nazghul (Script Pack)
- Updated: sphere_defs.scp (updated section can_flags)
- Fixed #761: missing positioning of newly created vendor in i_deed_vendor
(sphere_item_provisions_deed.scp)

13-07-2006, Nazghul
- Added: CURFOLLOWER, MAXFOLLOWER with no built-in functionality. These variables
change values on a status gump.
- Fixed #764: Cannot see items in large multis (OF_OsiMultiSight).
- Sync (Vjaka): ISWEAPON and ISARMOR read-only properties for items.

14-07-2006, Nazghul
- Added: ISWEAPON and ISARMOR are now avaliable through serv.itemdef.x.* too.

16-07-2006, Nazghul
- Added: OF_Command_Sysmsgs into sphere.ini. With this flag on, you will see
sysmessages with current status after typing .allmove, .allshow, .debug,
.detail, .gm, .hearall, .privshow, .invis, .invul

20-07-2006, Nazghul (Script Pack)
- Fixed #776: sphere_map2.scp (Wrong Ilshenar Region description (Wisp Dungeon),
thx Coruja747.

21-07-2006, Furio
- Fixed #780: Unable to read REPLICATE property.
- Changed: TAG.OVERRIDE.STATCAP[$statid]/SKILLCAP[$skillid]/REGEN[$statid]/REGENVAL[$statid]
to TAG.OVERRIDE.STATCAP_$statid/SKILLCAP_$skillid/REGEN_$statid/REGENVAL_$statid.
- Added: -E to command line. Starting Sphere with it will enable the ExceptionDumper
that will generate a .map file on unexpected exceptions. Sending that file through
the bugtracker will help us in the debug process. (thx to Z.)
- Fixed #774: Ghost's speech when in peace mode.

21-07-2006, MrSugarCube
- Fixed: Incorrect name shown when a player declines a party invite.
- Modified: Placing a house over a staff member (Counselor+) no longer blocks
the placement if the character cannot see them.

22-07-2006, MrSugarCube
- Added: SPEEDMODE property for players. Allows setting the speed mode that a
client can use (and affects the movement throttle accordingly). There are
4 different speed modes that affect the client:
0 - Normal speed.
1 - Double speed on foot, normal speed when mounted.
2 - Always walk on foot and when mounted.
3+ - Always run on foot, always walk when mounted.

22-07-2006, coruja747 (Script pack)
- Updated: sphere_map2.scp (Sorcerer Dungeon region definitions incorrect).

23-07-2006, Shadow Dragon
- Added: LOCAL.Arrow storing an UID of used arrow while archery in @Hit.
- Added: Extra combat flag COMBAT_PREHIT to allow pre hit combat style
(first hit is instant)

26-07-2006, coruja747 (Script Pack)
- Updated: sphere_map2.scp (#793, Lake Shire region has not to be guarded)
- Added: GAINRADIUS keyword for skill definitions. Skillgain will only be calculated if
the current skill is less than the actual difficulty + GAINRADIUS to prohibit skillgain
by performing way too easy tasks. If not set it defaults to 100.0 (so pertaining the
old behaviour)

27-07-2006, coruja747 (Script Pack)
- Fixed: #796, sphere_map_points2.scp (Wisp Dungeon, Kirin Passage, Cyclops Dungeon)

28-07-2006, coruja747 (Script Pack)
- Fixed: #800, missing teleports in sphere_map_points0.scp and sphere_map_points1.scp

29-07-2006, Nazghul
- Modified: @Dclick is now called for items which were dclicked by an NPC.
(e.g. when an NPC is going to open a door, @DClick is called for this door)
- Fixed #798: If a wall was built on a spot where a paralyzed player stays,
he was not unparalyzed.

29-07-2006, MrSugarCube
- Fixed: Vendors speak two messages when a player does not have any items to sell to them.

30-07-2006, Shadow Dragon
- Added: New trigger @Criminal called after someone becomes criminal for someone.
[] - criminal, SRC - someone. RETURN 1 - stops hardcoded effect (memory_harmedby and so),
so you can make your own criminal system.

31-07-2006, Kirofus (Script pack)
- Updated: sphere_types.scp (Fixed incorrect terrain definition for t_water)

31-07-2006, MrSugarCube
- Modified: MaxWeight is now sent to the client for display on the status window in
newer clients.

31-07-2006, Nazghul
- Added: CONTP function, which allows you to change the position of an item,
which is inside a container.

01-08-2007, Nazghul
- Added: INI flag EF_New_Walkcheck = 04000 to switch on and off new walkcheck routines
what should prohibit NPC from passing thru walls if not explicitely stated
(CAN-Flag mt_passwalls (08))

02-08-2006, Furio
- Added: STRREGEX(pattern,string) that execute a pattern matching supporting the
known standard. Return: 1 match found, 0 match not found, -1 illegal pattern syntax.

04-08-2006, Nazghul
(most code revised, debugged and (re)designed by Ellessar when I was up to drop
this all in desperation)
- Added: Function AddContextEntry. what takes 2 to 4 arguments separated by a comma.
SRC.AddContextEntry EntryTag,TextID,Flags,Color
EntryTag - the number to return as ARGN by @(item)ContextMenuSelect. Make it unique.
- EntryTags from 0 to 100 are reserved by Sphere for internal use, so do not
use it.
TextID - CLILOCed name of the button. The number from cliloc.[your_localization]
WITHOUT the leading "300" or such! Just type "5194" or "11010"
Flags - 01 - locked (will be grayed out)
- 02 - consecutive entries with this flag set will be summarized under
a golden arrow
- 020 - can be colored
Color (applied only if Flags & 020) - hue

- Added: Trigger @ContextMenuRequest/@itemContextMenuRequest which is fired after
receiving a display Popup-menu client request (single click on an object).

It can be fired two times, each call has a different ARGN.

The first time it is fired before any hardcoded stuff is added to the Popup-menu.
Here, Return 1 denies displaying any hardcoded entries, but if you make a softcoded
entry, it WILL be displayed. It also will prohibit the second call of the trigger.
Both, Return 0 and Return 2 allows hardcoded stuff to be added. If you change ARGN,
the trigger will be called once more (but ARGN != 1).

The second time it is fired after all hardcoded stuff was added (so you can add
your stuff to the bottom of the Popup-menu). Return value has no effect at all.

The first call:
In: ARGN = 1
Out: Return 1 - only your stuff will be added (IF ANY), prohibits the second call
Return 0/2 - your and hardcoded stuff will be added
ARGN (ARGN != 1) - allows the second call

The second call:
In: ARGN = 2
Out: Return 0/1/2 - does nothing
ARGN - does nothing

- Added: Trigger @ContextMenuSelect/@itemContextMenuSelect which is fired after
a client selects something from a Popup-menu. ARGN is a value, which was sent
by the server to the client as the first argument with the AddContextEntry function.

06-08-2006, MrSugarCube
- Modified: SERV.ACCOUNT.x now returns 1 if the account name or index exists, or 0 if not.
- Added: P.STATICS.x.COLOR and P.STATICS.x.Z can be used to find the colour and height
of static items.
- Modified: Setting BONUS_STATS to 0 in SKILL definitions disables using BONUS_x properties
when calculating stat gains for that skill instead of blocking all stat gains for it. If
you want to prevent stat gains, you should either set STAT_x to 0, or set BONUS_x to 0
with BONUS_STATS greater than 0.

07-08-2006, MrSugarCube (Script pack)
- Updated: sphere_msgs.scp (Fixed some 'broken' defmessages with tabs in)

10-08-2006, ShiryuX (Script Pack)
- Fixed: #827 Kirin entered twice in sphere_defs.scp

14-08-2006, Nazghul
- Added: dmgcold, dmgenergy, dmgfire, dmgpoison properties for weapons with no built-in
functionality (yet).
- Fixed: Returned maxweight property different from maxweight property displayed
in status gump.
- Fixed #592: Wrong spellbook packets send by Linux versions
- Updated: sphere.ini - added new experimental flag EF_NewPositionChecks.

16-08-2006, Nazghul
- Added: Experimental flag EF_NewPositionChecks, with this flag on,
the new position-related checks behavior will be used. So far it does something only
with resource gathering related skills (lumberjacking, mining, fishing, eating grass etc.)
and Advanced LOS.
The flag is HIGHLY EXPERIMENTAL!
- Modified: FORPLAYERS now loops through logouted players. If you want to loop only through
online players, use FORCLIENTS.

17-08-2006, MrSugarCube
- Fixed: Retrieving StatLock properties with STATLOCK[statname] and SKILLLOCK[skillname]
- Fixed #835: Setting StatLocks on the status window sets the incorrect StatLock[x] property.
- Modified: Undefined region warnings are no longer reported for locations outside of the
map boundaries.

20-08-2006, Nazghul (Changes only for servers with EF_NewPositionCheck on)
- Fixed #304: NPCs are dumber in pathfinding with EF_DiagonalWalkCheck on
(fixed only with EF_NewPositionCheck and EF_WalkCheck on).
- Fixed #747, #767: Z not updated when you enter a multi, .fix not working inside a multi.
- Fixed #837, #829: NPCs not spawning (or on the wrong place) inside a building.
- Fixed #598: Ladders not updating Z and a player cannot step on some of them.
- Modified GOTO function: NPC will now not stop moving after the first step.

26-08-2006, Nazghul (Changes only for servers with EF_NewPositionCheck on)
- Fixed #744: Line Of Sight check going from out of a house into the house was successful,
but not vice versa.
- Fixed: Item flags and height was always inherited from the parent item
(the item with DUPELIST=), what damaged almost all Line Of Sight checks.

28-08-2006, Nazghul (Changes only for servers with EF_NewPositionCheck on)
- Modified: Now, archery, potion throwing, dragon breathing, stone throwing, magery can be
used through a window.
- Modified: Now, fishing use LOS and prohibits casting through blocking objects.

28-08-2006, Nazghul
- Updated sphere_defs.scp: Added DEFNAME los_flags.
- Updated sphere_msgs.scp: Added message fishing_los.
- Removed: Multithreading support for Linux version due to its unusability on this OS.

30-08-2006, Nazghul
- MODIFIED: RESCOLD, RESENERGY, RESFIRE, RESPOISON now can also be set on NPC
Remember that RES*=100 will give you a 100 percent immunity against the damage inflicted
by TAG.*DAMAGE.
- Added: COMBAT_SPECIALDAMAGE to INI CombatFlags (08). If set, TAG.*DAMAGE (below) will be
used.
- Added: COMBAT_USE_RESISTANCE to INI CombatFlags (010). If set, RES* on characters will
also be weighted against normal damage if the old fashioned damage flags are set.
- Added: TAG.COLDDAMAGE, TAG.ENERGYDAMAGE, TAG.FIREDAMAGE, TAG.POISONDAMAGE for characters
and items. The server will only evaluate the tags on characters, and if ComBatFlag
COMBAT_SPECIALDAMAGE is set. Then any damage done to others (if it's damage type contains
at least one of the physical types OR magic) will be increased by the value of the
appropriate tag, lowered by the RES* percentage of the victim.
Tags on items will not be evaluated by the server - their values can be used to for
example increase the TAGs or the RES* properties on characters on equip of the item.
This way you can use TAG.*DAMAGE on a weapon to increase the wearer's appropriate
damage tag, or on a piece of armor to increase his RES*, or to whatever you want.

31-08-2006, Nazghul
- Added: NPC trigger @PetDesert. Fires when a pet decides to go wild.
Default object is the pet, SRC the master. RETURN 1 changes the pet's mind.

31-08-2006, MrSugarCube
- Fixed: P.REGION reference not working correctly in areas defined via ROOMDEFs.
- Added: P.ROOM can be used to access the ROOM properties of a point, just like
you can with P.REGION.
- Modified: P.REGION and P.ROOM now return 0 if a region or room doesn't exist at
the point, and 1 if one does.
- Added: Support for the new BandageSelf and BandageTarget macros found in the
latest clients (5.0.4). Using the macro will act as if the client has just
targeted something with the bandage (and so @[item]TargOn_Item will be called).

01-09-2006, MrSugarCube
- Fixed #849: Enabling precasting does not freeze characters when casting.
- Fixed #849: With precasting enabled, skill is gained before the spell is
completely cast at a target.
- Fixed #849: Harmful area effect spells don't affect the caster when
MAGICF_CANHARMSELF is enabled.
- Fixed #849: TELE and POLY functions not working correctly with precasting
enabled.
- Fixed #849: Casting from spellbook not working correctly with both
FEATURE_AOS_UPDATE_B and MAGICF_PRECAST settings enabled.
- Fixed: Exception caused by spell effects on items with no SRC present.

02-09-2006, Nazghul
- Added: TAG.OVERRIDE.MOVERATE for NPC to speed up or slow down single NPC

05-09-2006, Nazghul
- Added: Option flag OF_Buffs. When on, Sphere will automatically add and remove buff and
debuff icons to the affected players.
- Updated: sphere.ini - added new optional flag OF_Buffs
- Added: Functions ADDBUFF, REMOVEBUFF for adding and removing buff/debuff icons.
syntax: ADDBUFF IconId ClilocOne ClilocTwo Seconds Text1 Text2(optional) Text3(optional)
The text fields are supposed to hold max. 3 characters each (numbers) and will
be cut off if larger.
REMOVEBUFF IconId
These functions only work with client 5.0.3 or above.

06-09-2006, Nazghul (script pack)
- Updated: sphere_defs.scp (added defnames for buff icons and clilocs)
- Fixed: bug with i_multi_tower_wizard - the door was placed BELOW the floor,
so unuseable with new LOS checks

07-09-2006, Nazghul
- Updated: sphere.ini - added new debug flags DEBUGF_SCRIPTS, DEBUGF_LOS.

10-09-2006, ShiryuX (Script Pack)
- Updated: sphere_defs.scp - added a defname for rideable Polar Bear

11-09-2006, Nazghul
- Fixed #852: Trigger @SKILLSUCCESS did not fire with fighting skills

12-09-2006, MrSugarCube
- Added: FORINSTANCES to loop through all instances of a given BaseID. Usage
is "FORINSTANCES id". If an ID is not supplied then the BaseID of the default
object will be used. Works for both items and characters.

12-09-2006, Nazghul
- Added: A new item property IsCont, which returns 1 if an item is a container and 0 if
it is not.
- Updated: sphere.ini - added a new debug flag DEBUGF_WALK.

15-09-2006, Nazghul
- Added: INI Flag OF_NoPrefix (0x4000) to get rid of the "A" and "An" prefixes what ere
only an annoyance for not english language shards
- Changed: Key links will only be blanked if they are pointing to an invalid item UID now.
Before everything what was neither container nor multi was considered "invalid", so keys
with the UID of a door, or themselves could turn blank.
- Added #848: Character trigger @SpellSelect. Doing pretty much the same as the spell trigger
@select and has the same arguments/parameters
- Fixed #778: Wrong spellbook recognition with more than one spellbook std., necro, ...)
in pack.
- Updated: sphere.ini - Removed experimental flag EF_New_Walkcheck.

16-09-2006, Nazghul
- Added: OF_DyeType flag to sphere.ini. If set players are allowed to use i_dye on every
t_dye_vat instead of only i_dye_tub. Making it switcheable for all those who have concerns
about exploitability (even as I do not see any risk) - we all remember the times when
injection users colored whole shards pink.

17-09-2006, MrSugarCube
- Fixed: Using Bandage macro with a target prompt already present calling @TargOn_Cancel
on the bandages.
- Fixed #863: Changing RESFIRE/RESENERGY/RESPOISON/RESCOLD properties does not update the
client.
- Fixed: Unable to gain magery skill with precasting enabled.
- Fixed: Various object references not accessible from the guildstone object.
- Fixed #865: GUILD.MEMBER.x.ISMEMBER property not working correctly.

20-09-2006, Nazghul
- Fixed #853: Update & DClick stopped display of weather effects

21-09-2006, Nazghul
- added TAG.OVERRIDE.AMMOTYPE and TAG.OVERRIDE.AMMOANIM for bows and xbows to - yes, OVERRIDE the
TDATA3 and TDATA4 values on a per-item-base

21-09-2006, MrSugarCube
- Fixed #875: Exception caused by setting MASTERUID when no current guild/town master
exists.
- Modified: Setting MASTERUID to the same uid as the current guild/town master no longer
causes an error.
- Fixed: Calling the TRAIN function on an NPC in combat would cause an error.
- Modified #869: The TRAIN function now works on all NPC brains between 2 and 9.

21-09-2006, Nazghul
- changed GAINRADIUS so that it no longer defaults to anything - if not set on a skill
it's just transparent (as if never invented)

22-09-2006, Nazghul
- Fixed #846: Bad character DispID displayed if there was serv.chardef called no NPC
in the world with this ID.

24-09-2006, Nazghul
- Added: Function CONTCONSUME <arg1> <arg2>, which consumes <arg2> amount of an item with id <arg1>
from a referenced container and its subcontainers. Function does nothing on chars (use consume)
and on non-container items.
Example: findlayer.29.contconsume i_gold 100000
- Added: Item trigger @Buy and character trigger @itemBuy, which are called before item is sold
by a vendor. The trigger is called only with EF_New_Triggers on.
ACT/DEFAULT is the item, SRC is the player, ARGN is the item amount, ARGO is the vendor.
Return 1 prevents the player from buying the item.
- Added: Item trigger @Sell and character trigger @itemSell, which are called before item is bought
by a vendor. The trigger is called only with EF_New_Triggers on.
ACT/DEFAULT is the item, SRC is the player, ARGN is the item amount, ARGO is the vendor.
Return 1 prevents the player from selling the item.
- Fixed: Serv.itemdef.xxx.skill not always returning the skill
- Fixed: A copy & paste error in TAG.OVERRIDE.AMMO* what prevented the animation stuff to run.

25-09-2006, Nazghul
- Added: EF_DamageTool (0x2000) to Sphere.ini. Only if set tools/weapons will be damaged while
lumberjacking/mining (what includes firing @Damage on them)
- Fixed: NPCs spawning with incorrect Z position.

26-09-2006, Nazghul
- Modified: @(item)ContextMenuRequest and @(item)ContextMenuSelect now will not be called with
EF_Minimize_Triggers on.

27-09-2006, Nazghul
- Added: TDATA3 and TDATA4 of a container type item are now holding min and max coordinates of
the "area were items may be placed", relatively to the open container gump.
TDATA3 is (MinX * 0x10000) + MinY, TDATA4 is (MaxX * 0x10000) + MaxY
Be very careful with these settings - if they are set to illegal values (i.e., outside of the
visible gump) Sphere will happily accept them, but your users will not be able to pick items
placed there out of the container, because the client will only display then if they have the
container gump as a background!
If TDATA4 is not set (or set to 0), default values will apply, along with the console warning
"unknown gump id".

28-09-2006, Nazghul
- Added: MOREM value (0..127) on digestible food will override the amount of "food units"
what will be added to the characters FOOD property when eating this. Obviously, items
with different MOREM will not stack. Because on=@SUCCESS on cooking will not give you
a reference to the newly created item but only to the raw one, MOREM will be transferred
from the raw food (what you may alter in on=@success)

29-09-2006, Nazghul
- Added: 3 defmessages, thus making the headline for the "c" console command configurable.

01-10-2006, Nazghul
- Added: Intrinsic function IsObscene what tests whether the passed argument is a forbidden
word (list of these words are in your spheretables.scp under the section OBSCENE).
- Fixed: Obscene not matching obscened words inside a string.
- Fixed #889: Fame.* and Karma.* always returning 0.
- Updated: spheretables.scp - added KARMA and FAME sections. Now you can change, add or remove
keys which are used behind Karma. and Fame. . First line declares steps, other lines their
names.
IT IS HIGHLY RECOMMENDED TO UPDATE YOUR SPHERETABLES.SCP!!!

02-10-2006, Nazghul (Script Pack)
- Fixed #867: sphere_minor_artifacts.scp, i_orcish_visage
- Updated: Flags notification on server startup

02-10-2006, Nazghul
- Fixed #898: Some stairs unwalkable with EF_NewPositionChecks, EF_WalkCheck and
EF_DiagonalWalkCheck on.

05-10-2006, Nazghul
- Added: INI flag OF_OSIDamageMod (0x04)
Modifying weapon damage OSI style, according to this formulas (originally provided by ClouD_Br):
Tactics Damage Bonus% = Tactics � 1.6 (Add 6.25% if Tactics >= 100)
Anatomy Damage Bonus% = (Anatomy � 2) + 5
Lumberjack Damage Bonus% = Lumberjack � 2 (Add 10% if Lumberjacking >= 100)
Strength Damage Bonus% = Strength * 0.3 (Add 5% if Strength >= 100)
Final Damage Bonus% = Tactics Bonus + Anatomy Bonus + Lumber Bonus + Strangth Bonus + Damage Increase Items*
Final Damage = Base Damage + (Base Damage * Final Damage Bonus%)
* Damage Increase is capped at 100%.

05-10-2006, Nazghul
- Fixed #036: Fixed TRY and TRYSRV not working with locals (local and arg*). TRYSRC and TRYP
do not work, since it makes no sense to use it on local variables. (Thx to Ellessar who
finally worked out how this SHOULD work, so we found the bug deeply buried under tons of
old code)

06-10-2006, Nazghul
- Added: Function ISNEARTYPETOP(.P) which uses new checks for resource gathering (item which
you want to find must be at the top, if at the top there are 2 items, then the success
depends on the priority (dynamic->multi->static->terrain) of those items). Syntax is the
same with ISNEARTYPE(.P). NOTE: This function is called from hardcode if EF_NewPositionChecks
are on.
- Fixed #668: Delete packets of items which cannot be seen were sent to the client.
- Modified #632: Now, IsPlayer can be used on every game object.
- Modified: sphere.ini - added an NPC AI flag NPC_AI_INTFOOD which enables smarter and more
trustworthy food finding.

08-10-2006, Furio
- Modified: TRIGGER command. It now supports calling a trigger with arguments, the syntax is:
TRIGGER $trigger_name[,$trigger_arg_type,...] where $trigger_arg_type can be:
- TAT_AS_ARGN (1): uses arguments as ARGN. Example: TRIGGER @MyTest,<def.TAT_AS_ARGN>,1,2,3
will call @MyTest with ARGN1=1 ARGN2=2 ARGN3=3.
- TAT_AS_ARGS (2): uses arguments as ARGS. Example: TRIGGER @MyTest,<def.TAT_AS_ARGS>,hi you 2,yo !
will call @MyTest with ARGS=hi you 2,yo !.
- TAT_AS_ARGO (3): uses arguments as ARGN. Example: TRIGGER @MyTest,<def.TAT_AS_ARGO>,01
will call @MyTest with ARGO.UID=01 (only if object with such uid exist).
- Updated: sphere_defs.scp (with new definitions for the TRIGGER command).
- Fixed #880: Explode function not working as it should.

09-10-2006, Nazghul
- fixed problems with spellbooks obviously triggered by new Gcc compiler for Linux with a weird
workaround.

10-10-2006, Nazghul
- Fixed #900: Added INI flag COMBAT_DCLICKSELF_UNMOUNT to unmount horse when dclicking self
while in warmode.

11-10-2006, Nazghul (Script Pack)
- Updated: sphere_msgs.scp - more defmessages to customize text output.
- Updated (#905): sphere_item_provisions_potions.scp - Shrink potion did not behave as expected.

13-10-2006, Nazghul
- Added: Intrinsic functions SIN() and COS(). Attention: Without FLOAT math they will obviously
only return 0 and 1 :)

16-10-2006, Nazghul
- Added: Support for floats (local variables FLOAT.younameit, which have size of double, and
can hold precise numbers). Usage of these variables is the same like LOCAL.younameit. As
EVAL only uses integer arithmetic, with FLOAT math you have to use <FLOATVAL ()>
(New code was done mainly by Ellessar and Decrythe, I just "glued" it into Sphere :) )
- Changed: Return values for @SPELLSELECT trigger. Touchup for @SELECT with spells. Different
server behaviour can be achieved with the following RETURN values in trigger scripts:
@SELECT
RETURN 0 - proceed without mana, spellbook, and reagent check as if these checks were
successful
RETURN 1 - Abort processing (so aborting the spell)
RETURN 2 - proceed as normal
RETURN 6 - like RETURN 0 (for compatibility with @SPELLSELECT)
@SPELLSELECT
RETURN 0 - proceed as normal
RETURN 1 - abort processing (so aborting the spell)
RETURN 2 - proceed as normal
RETURN 6 - proceed without mana, spellbook, and reagent check as if these checks were
successful
@SPELLSELECT will be called after @SELECT - what means, if you leave @SELECT with RETURN 0 or
RETURN 1, @SPELLSELECT will NOT be called!

16-10-2006, Furio
- Added: DAM.HI/LO and ARMOR.HI/LO

17-10-2006, Nazghul
- Added: Defmessage if skillgain is aborted due to GAINRADIUS not met; message will only be displayed
if TAG.NOSKILLMSG=1 on character
- Fixed: Problems with long passwords and MD5 hash on.

18-10-2006, Nazghul
- Added INI flag OF_DrinkIsFood (0x10000). If set, T_DRINK will increase FOOD lvl. like T_FOOD

19-10-2006, Nazghul
- Added: Dynamic property "height" for characters.

20-10-2006, Nazghul
- Updated: sphere_defs.scp - added defname charheight.

21-10-2006, Nazghul
- Added: New "m" paramter for TARGET function. Now you can use TARGETM and TARGETFM for targeting
a place for your multi (you will see your multi in the "ghost mode"). TARGETM takes as an argument
ONLY ID of the multi, TARGETFM takes 2 arguments - function_to_call,ID_ot_the_multi.

21-10-2006, Nazghul (Changes only for servers with EF_NewPositionCheck on and AdvancedLOS on)
- Modified: CanSeeLOS now uses height of a character for its checks. Height is read in this order
and first correct entry is used:
1. Dynamic height property of an object
2. Height property under CHARDEF/ITEMDEF (can be inherited)
3. Defname in format "height_dispid", while dispid is a hex number in Sphere format (0a3)
4. Defname in format "height_dispid", while dispid is a dec number
5. Universal height - "15"
If a character is mounted, its height is raised by 4. CanSeeLOS reduce height of an unmounted
character by 1 (pretending eyes height).
NOTE: This formula is used when you are doing .show height, or <height> in scripts.

23-10-2006, Nazghul
- Fixed: #789 ModAR on characters only worked with damage of type GENERAL.

23-10-2006, MrSugarCube
- Fixed: Webpage requests always displaying the "Internal Server Error" page.

24-10-2006, Nazghul
- Added: Trigger @(item)Buy now has local.totalcost, which holds the cost of the whole purchase
and ARGN2, which holds price of this amount of items (price * amount).
- Fixed: Trigger @(item)Buy returning bad amount in ARGN1.
- Added: Local variables LOCAL.CREATEOBJECT1 and LOCAL.CREATEOBJECT2 to @SUCCESS trigger of spells.
These variables are _unset_ when the trigger is called. But they can be _set_ with field- and
summon spells to change what these spells will create.
- Summon spells (summon creature, bladeSpirit, Vortex, summon daemon, summon *elemental) take only
the first one. If set with LOCAL.CREATEOBJECT1 = <eval c_orc> the spell will summon an orc. This
way one can add more random daemons to the summon daemon spell, or change the spawned creature
due to magery or whatever.
- field spells (s_wall_of_stone, s_fire_field etc) take both variables, as usually the items for
the field in west-east direction are different from those in north-south direction. If necessary
they can of course be the same (s_fire_field looks impressive with i_fire_columns :) ), but BOTH
have to be set (otherwise the unset will be replaced by the spell's default item for this dir).
Example:
[SPELL s_fire_field]
...
on=@SUCCESS
IF <magery> >= 99.9
LOCAL.CREATEOBJECT1 = <eval i_fire_column>
LOCAL.CREATEOBJECT2 = <eval i_fire_column>
ENDIF

24-10-2006, Pilz-e (Script pack)
- Updated: sphere_map0_ml.scp (Corrected P properties for ML locations)

25-10-2006, Nazghul (Changes only with EF_NewPositionCheck, EF_WalkCheck and MountHeight on)
- Modified. You will not be able to go into a building if there is not enough space for you.
- Modified: You will not be able to mount a rideable if there is not enough space for you + ride.
- Modified: You will not be able to summon an NPC if there is not enough space for it.
- Modified: You will not be able to teleport (gate, recall) yourself to a spot where is not enough
space for you.

25-10-2006, Nazghul
- Updated: sphere_msgs.scp - added a new defmessage msg_summon_ceiling and modified
the msg_mounted_ceiling defmessage.

25-10-2006, Nazghul
- Changed: NPC_AI flags in sphere.ini. Started splitting them up to make it easier to track
errors related to them. The respective INI section now reads:
// NPC AI settings
// NPC_AI_PATH 0001 NPC pathfinding
// NPC_AI_FOOD 0002 NPC food search (objects + grass)
// NPC_AI_EXTRA 0004 NPC magics, etc
// NPC_AI_ALWAYSINT 0008 Always be as smart as possible with pathfinding
// NPC_AI_INTFOOD 0010 NPC food search (more intelligent and trusworthy)
// NPC_AI_COMBAT 0040 Look for friends in combat
// NPC_AI_VEND_TIME 0080 vendors closing their shops at nighttime
// NPC_AI_LOOTING 0100 loot corpses an the way
// NPC_AI_MOVEOBSTACLES 0200 if moveable items block my way, try to move them
//NPCAI=0

27-10-2006, Nazghul
- Fixed: Fishing not displaying an animation right after start.
- Fixed: Resource gathering with EF_NewPositionChecks on did not work on tiles with Z < 0.
- Added: Some more defmessages (also to sphere_msgs.scp), this time title-related

28-10-2006, Furio
- Fixed #809: Wrong cheater message.
- Added #913: TAG.OVERRIDE.MAXITEMS/MAXWEIGHT on bank to override global settings.
- Added: TAG.PARTY_AUTODECLINEINVITE. If set on char it makes the char autodecline every invite.
- Modified: After an party invite you must wait a bit before inviting someone else.

29-10-2006, Nazghul
- Added: Spell flag "SPELLFLAG_NOUNPARALYZE", if the flag is turned on, victim won't be
unparalyzed.
- Added: Damage flag "DAM_NOUNPARALYZE", if the flag is turned on, victim won't be unparalyzed.
- Updated: sphere_spells.scp (added spellflag_nounparalyze to the paralyze field spell)
and sphere_defs.scp
- Updated: sphereCrypt.ini

31-10-2006, Nazghul
- Added: FEVAL and FHVAL which allow you to convert your float variable to a standard decimal or
hexadecimal number. Numbers behind a decimal point are cut out.
The syntax is: <feval <float.yourvar>> or <fhval <floatl.yourvar>>.
- Fixed: Addspell not working if used like <findid.i_spellbook.addspell 5>. Now, this syntax
should return 1 if the spell passed as an argument is in the spellbook.

02-11-2006, Nazghul
- Fixed: CanSeeLOS working through a "black hole" in terrain.
- Fixed: Walls with the impassable flag off blocking movement.
- Modified: IsArmor and IsWeapon now accept UID or ItemId as an argument.

02-11-2006, MrSugarCube
- Fixed: Double "You have the key for this" message when attempting to use a lockpick or cast
magic unlock on something you already have a key for.

03-11-2006, Furio
- Added: DB.ESCAPEDATA $field returning $field escaped using the charset of the connected db.

03-11-2006, Nazghul
- Added: Character trigger ON=@JAILED
ARGN1 = 1 -> Char is up to be jailed, 0 -> char is up to be forgiven
ARGN2 = Jail cell (0 if none special)
RETURN 0 -> proceed as normal
RETURN 1 -> stop the procedure without changing current status
- Added: Character property IsVerticalSpace, which returns 0 if there is not enough space for
you and your mount (if you are mounted). Function takes position as an optional argument.

05-11-2006, MrSugarcube
- Modified: SERV.BLOCKIP now accepts a second argument specifying the time to block the IP for
in tenths of a second (-1 for permanent).
- Added: f_onserver_blockip, called when an IP is blocked from the server. ARGS contain the IP
being blocked and ARGN1 holds the amount of time the IP will be blocked for (writable).

05-11-2006, MrSugarCube (Script pack)
- Updated: sphere_serv_triggers.scp (Added f_onserver_blockip definition)

10-11-2006, Nazghul
- Added: REFx as a local reference object, where x is a number between 1 and 65535. It can be
used like an OBJ, but will be removed after leaving a function (like a LOCAL).

15-11-2006, Nazghul
- Fixed #933: i_rune_paralyze is not removed.
- Fixed #934: NPCAI_Extra and heavy weapons.

16-11-2006, Admin BladeCraft (Script pack)
- Updated: sphere_serv_triggers.scp (Added f_onserver_blockip under [PLEVEL 7] block)

20-11-2006, MrSugarCube
- Fixed #940: Undefined keyword errors when using functions via [guildstone.]MEMBER.x.KEY.

23-11-2006, MrSugarCube
- Added: Support for ConnectUO status request packet.

23-11-2006, Furio
- Added: ALLOWBUYSELLAGENT in sphere.ini to allow rapid buy/sell.

24-11-2006, MrSugarCube
- Fixed: Exceptions caused by not definined FAME.*/KARMA.* ranges.
- Fixed: Exception caused by using a spyglass from a ship.
- Modified: Walking off a ship plank no longer moves characters to adjacent ships.

25-11-2006, MrSugarCube
- Fixed: Stamina not being sent to other party members, and stat bars for other party members
not always showing the correct mana/stamina levels.

26-11-2006, MrSugarCube
- Fixed #949: Possibility of taking items from inside containers within the bank.
- Fixed #947: ISARMOR causing errors when no arguments given.
- Fixed #960: .Extract and .UnExtract always using map 0.
- Modified #946: Items can no longer be moved from the trade window due to client limitations.

26-11-2006, MrSugarCube (Script pack)
- Updated: sphere_msgs.scp (Added "msg_trade_cantmove" defmessage)

27-11-2006, Vjaka
- Added: ATTACKER keyword to access last attackers of a character. Usage:
<attacker> returns amount of attackers
<attacker.x> returns UID of the attacker (or 0 if there is no attacker)
<attacker.x.dam> returns total damage done by the attacker
The list is being cleared upon death after @DeathCorpse trigger.
- Removed: OF_Multithreaded option flag, it actually did not work at all.
- Removed: EF_Scripts_Parse_Verbs - now it is integrated into the parser and is used when needed.
- Modified: The way the scripts are being parsed, now they are not read from the disk on each
operation, and are actually re-read only when you are doing a manual resync.
- Added: BETWEEN2 as opposite of BETWEEN, which selected min<-cur->max to select towards
minimum (max<-cur->min).

28-11-2006, Furio
- Fixed #951: FILE.WRITECHR not working as it should.
- Modified: Added error feedback for FOR* cycles.

28-11-2006, MrSugarCube
- Fixed #932: Removing items with a Z greater than 25 not updating view for players.

29-11-2006, Vjaka
- Modified: The exception handling routine to get more information about the place which causes
the exception.

30-11-2006, MrSugarCube
- Fixed #804: Multiple stackable items being created in a TEMPLATE not having the correct
amounts.
- Fixed #664: Automatic loading of backup saves not working.
- Fixed: REPORTEDCLIVER always returning 0.0.0 and CLIENTIS3D always returning 0.
- Fixed: GUILDTITLE property on guild members not working.
- Fixed: KARMA.* ranges not accepting negative values.
- Modified #494: RESURRECT function now accepts a parameter specifying whether or not to
ignore anti-magic fields (i.e. "RESURRECT 1" to ignore anti-magic field). Note that
specifying 1 will also cause @[Spell]Effect triggers to not fire for the resurrection
spell.
- Modified: Adding/Accepting an offline player into a guild now shows a more appropriate
message to the client.

01-12-2006, MrSugarCube
- Fixed: Corpses for creatures with higher RESLEVEL than the client's RESDISP not showing
the body and hue specified in the creature's CHARDEF.

02-12-2006, Nazghul
- Added: CanSeeLOSFlag which accepts flags for LOS check as the first argument and an object
or a position as the second argument. For flags and their explanation see sphere_defs.scp.

05-12-2006, Vjaka
- Fixed: Ships falling apart after rotation.
- Fixed #955: Some dialogs/sdialogs causing exceptions after they're opened.

06-12-2006, Nazghul
- Modified: Now only ATTACKER.* works (not ATTACKERFUBAR), now only ATTACKER.*/ATTACKER.*.UID
returns the UID of an attacker, ATTACKER.*.DAM returns damage done by the attacker * and
ATTACKER.*.ELAPSED returns the time in seconds since the last hit of the attacker *.
- Modified: ATTACKERs are now also saved if they deal no damage.

09-12-2006, Nazghul
- Fixed #965: Fishing with certain flags on not working.
- Fixed: Error messages about undefined item 00.

09-12-2006, Furio
- Added: Encryption keys for client 5.0.7.0.

09-12-2006, MrSugarCube
- Fixed: <REPORTEDCLIVER.> not showing the ".x" in client "5.0.6.5" and above.

10-12-2006, Vjaka
- Added: Now keyword MAX can be used instead of number in ATTACKER in order to access the one
who have dealt most damage.
- Removed: EF_Scripts_Ret_Strings has proven to be stable and correct during years, so it is
now a default behavior of Sphere.

16-12-2006, Furio
- Added: argument CLEAR to TIMERF. Now using x.TIMER CLEAR will delete all the timerf running on x.

16-12-2006, MrSugarCube
- Fixed #979: PRIVSHOW feedback showing incorrect ON/OFF message.
- Fixed #977: +=/-= operators not working with REFx, and exception caused when TRYSRC is
supplied with an invalid verb.
- Fixed #936: REFx interfering with functions beginning with REF (such as REFUSECANDIDATE
on guildstones)
- Fixed: REFx allowing x to be out of range (should only allow 1 to 65535).
- Modified: <REFx> now returns the UID of the object stored in the REF like other object
references.
- Modified: REFx no longer ignores attempts at being set to invalid UIDs - now in this case
the REF will be cleared.

16-12-2006, ShiryuX (Script pack)
- Updated: sphere_defs.scp (Added missing MT_MALE definition)

18-12-2006, MrSugarCube
- Fixed #985: Clients on the "Status..." window not showing on seperate lines.
- Fixed #978: Setting LevelMode to unexpected values causing server freeze when calculating
experience.

19-12-2006, coruja747 (Script pack)
- Updated: sphere_admin.scp (Fixed IP Address and Location properties not greyed out for
insubstantial characters)
- Updated: spherechar.scp and spherechar_evil.scp (Corrected Lava Lizard definition and
moved it to spherechar.scp)

19-12-2006, _Epila_ (Script pack)
- Updated: sphere_menu.scp (Removed [COMMENT MENU MENU_ADMIN] as it's no longer used)

20-12-2006, MrSugarCube
- Modified: Tooltips that have been queued long enough for their object to no longer be on
the client's screen are no longer sent.

20-12-2006, MrSugarCube (Script pack)
- Updated #988: sphere_msgs.scp (Added 3 "msg_serv_shutdown*" defmessages)

20-12-2006, Nazghul
- Fixed #972: NPCs walking on water with EF_WalkCheck on.
- Fixed #982: Teleport allowed to water with EF_WalkCheck on.

21-12-2006, MrSugarCube
- Fixed #971: Clock overflow that causes the game to freeze.
- Fixed: FRUIT property of crops not returning the correct value.

22-12-2006, Nazghul
- Fixed: HEIGHT returning wrong value on DUPEd items.

22-12-2006, Vjaka
- Fixed: HITS setting for items when MAXHITS was not specified, so you can act via HITS for
items as well for saving with no need to differ HITS and HITPOINTS.
- Fixed: client problems with quick mounting horse while running causing no future updates
being interpreted by client till .fix/.resend was done.
- Fixed: inject ,snoop command still having some cases to access items in undesired containers.
- Fixed #819: If we use rand(X), where X > 32767, we always get result of rand(131072).

22-12-2006, Furio
- Fixed #816: Reading non-string data from sql is autoeval'd.

23-12-2006, Vjaka
- Added: Region tag RestockVendors (in ticks) to alter time in which the vendors will auto restock.
Default value is 10*60*10 (10 minutes).

24-12-2006, MrSugarCube
- Fixed #1000: TAG.NAME.PREFIX not overriding the Lord/Lady title in the profile and paperdoll
menus, and TAG.NAME.SUFFIX not showing at all.
- Fixed: Sphere crashing when a player opens a container with 810+ items inside.

29-12-2006, MrSugarCube
- Fixed #973: Ship hatch contents being deleted upon turning the ship.
- Fixed #973: Ship planks becoming permanently unlocked when opened.
- Fixed #973: Fixed spam caused when attempting to attack an opponent outside of a ship.
- Fixed: MULTICREATE function not working without an SRC present.
- Fixed: Setting the ACCOUNT property of an NPC now properly sets it up as a player character
without it being deleted by garbage collection.
- Modified #995: Logged out players are now moved along with moving ships.
- Modified #920: GMPAGE function can now be used with the arguments "ADD <Message>" to add <Message>
to the page queue. This function should be called on a logged in player (eg: "GMPAGE ADD This is a
page").
- Added #973: Combat flag COMBAT_ALLOWHITFROMSHIP. Removes the combat restriction that prevents
characters attacking from ships.
- Added: TILLER, HATCH and PLANK.x references for ships. PLANKS property can be used to determine
how many planks are present on a ship.

29-12-2006, MrSugarCube (Script pack)
- Updated: sphere_msgs.scp (Added combat_outsideship to defmessages)

30-12-2006, _Epila_ (Script pack)
- Updated: sphere_map_points3.scp (Added missing Doom dungeon teleporters)

02-01-2007, MrSugarCube
- Fixed: Loginserver not sending server IPs correctly.
- Fixed: Response not being sent when a client sends a ping packet.
- Fixed: Hallucination ignoring RESLEVEL settings on the random bodies it selects.
- Modified: Trade window contents are no longer included in searches of a character's inventory. This
affects CONSUME, *COUNT, FIND* and FORCONT* functions.

02-01-2007, MrSugarCube (Script pack)
- Updated: spherechar.scp (Replaced c_sea_monster definition to add protection against crashing newer
clients)

03-01-2007, MrSugarCube
- Fixed: MapChange packet not sending the correct map id for Trammel (Map 1)
- Modified: MAPx in sphere.ini now accepts a 5th parameter, for specifying the map id that should be
given to the client (0=felucca, 1=trammel, 2=ilshenar, etc).
- Added: *Experimental* flag "EF_Mapdiff_Support" added to sphere.ini. Enables using mapdif and stadif
files to patch terrain and statics.

04-01-2007, MrSugarCube
- Fixed: Buying from vendors allowing players to carry more weight than they should. Excess items are
now dropped to the ground.
- Fixed: Selling to off-duty vendors showing a warning message about an illegal "buy packet" instead
of "sell packet". Also added more detail to buy/sell packet cheater warnings.
- Modified: Resync messages are now always visible on the console.

05-01-2007, MrSugarCube
- Fixed #1011: Trade title on the paperdoll written incorrectly.

05-01-2007, Nazghul
- Fixed: Sphere now adds and removes the hiding/stealth buff icon automatically

06-01-2007, MrSugarCube
- Fixed: SERV.RESYNC command being executed from scripts causing the server to freeze. Note that using
SERV.RESYNC from scripts will now cause the resync pause to be delayed until after the script has
completed execution.
- Modified: EFFECT property of crafting skills can now be used to define the percentage of resources
that are lost when failing to craft an item. A few examples of how you can use this:
"EFFECT=x" - Always lose x% of resources on fail
"EFFECT=x,y" - Lose between x% and y% of resources on fail
"EFFECT=x,y,z" - Lose between x% and z% of resources on fail (weighted by y)
If EFFECT is not set then resource loss will be as normal -> 0-50% resources lost.
- Added: TAG.OVERRIDE.GUARDS on regions to specify different guards per region.
- Added: Arguments for @CallGuards trigger:
ARGN1 = Guard ID that will be created. (writable)
ARGN2 = Force spawning a new guard. (writable)
ARGO = An already spawned guard that will be used, unless ARGN2 has been set to 1.

06-01-2007, MrSugarCube (Script pack)
- Updated: sphere_skills.scp (Removed EFFECT property from Alchemy and updated [COMMENT SKILL x] block)

07-01-2007, MrSugarCube
- Fixed #1007: War/Peace button on paperdoll not correct when logging in with war mode.

08-01-2007, MrSugarCube
- Fixed #1004: Target cursor appearing when calling functions starting with "SET" or "X".
- Added #1013: SYSMESSAGELOC, for sending localized messages to clients. SMSGL can also be used as a shortcut.
Syntax is: "SYSMESSAGELOC color,clilocid[,arguments]"
All arguments must be separated by a comma ",". Specify -1 for color if you do not wish to override it.
Some examples of this being used (latest clilocs) are:
"SYSMESSAGELOC -1,502771" - Displays "You cannot reach that."
"SYSMESSAGELOC 2,1042758,MrSugarCube" - Displays "You are now loyal to MrSugarCube." in blue
"SYSMESSAGELOC -1,1062695,MrSugarCube,4,5" - Displays "MrSugarCube rolls the dice and gets a 4 and
a 5!"
- Modified #1013: '@color,font,unicode' in messages is now '@color,font,mode'. You can specify 1 for mode if
you wish to use unicode (like before), or specify 2 if you wish to use a localized message (useful for
overriding messages in sphere_msgs.scp). The above localization examples used with this method would be:
"SYSMESSAGE @,,2 502771"
"SYSMESSAGE @2,,2 1042758,MrSugarCube"
"SYSMESSAGE @,,2 1062695,MrSugarCube,4,5"

09-01-2007, Furio
- Added: MD5HASH returning the md5 hash of the argument.

11-01-2007, MrSugarCube
- Fixed: ATTACKER.x not working correctly.
- Fixed: Possible exception with handling mail message packet.
- Modified: Rewritten EF_Mapdiff_Support handling to perform much faster. This is done at the cost of some
additional memory usage but it can now cope with populated worlds.
- Modified: Profiler now includes time spent loading map blocks.

11-01-2007, MrSugarCube (Script pack)
- Updated: sphere_spells.scp (Corrected FLAGS property of paralyze field spell)

12-01-2007, Shadow Dragon
- Added: MulDiv script function. Usage "MulDiv number,multiplier,divider". Returns result.

12-01-2007, Vjaka
- Greatly increased speed of loading large scripts (especially annoying on resync).
- Fixed parsing script files when latest useful script line not ended by carriage return.

15-01-2007, MrSugarCube
- Fixed #1027: SDIALOG claiming to be an undefined keyword when the specified dialog is already showing.

16-01-2007, Nazghul
- Added: Character trigger @charAttack, @charClick, @charClienttooltip, @charDClick, which work like
@itemXXX triggers, but for NPCs.
- Added: An item flag CAN_I_DCIGNORELOS and a character flag mt_nodclicklos. With these flags on, LOS checks
on a dclicked item won't be performed.
- Added: An item flag CAN_I_DCIGNOREDIST and a character flag mt_nodclickdist. With these flags on, distance
checks on a dclicked item won't be performed.

16-01-2007, MrSugarCube
- Added #1029: @Cancel trigger to MENUs and SKILLMENUs.
- Modified: Items displayed on MENUs and SKILLMENUs can now be coloured. This can be done by prefixing the
item description with "@color" (in the same way that sysmessages can be coloured). For example,
"ON=i_sword_viking @2 This is a viking sword" will display a blue sword on the menu.
- Modified: Cancelling a PROMPTCONSOLE prompt no longer prevents the callback function from being called.

16-01-2007, SaCi (Script pack)
- Updated: sphere_dialog.scp (Updated descriptions in [COMMENT DIALOG HELP_SECTION])

17-01-2007, MrSugarCube
- Added: OPENPAPERDOLL character function. Without arguments it will display the current character's
paperdoll to SRC. With the UID of a character given it will display the specified character's paperdoll to
the current client.

20-01-2007, Ellessar
- Fixed: Problems with stairs which have odd height (1,3,5,...).
- Fixed #1037: Buffs needed FEATURE_AOS_UPDATE_B to work.

24-01-2007, MrSugarCube
- Fixed: Tillerman speech on the 3D client not shown in the correct colour.

25-01-2007, Ellessar
- Fixed #1028: Problems with terrain height.
- Rewritten the whole NPC_AI_PATH, now it should be faster, more reliable and less buggy.

28-01-2007, Ellessar
- Fixed: Pathfinding called on every NPC step.
- Fixed #987: ResMake returning wrong values if the item doesn't exist in the world.
- Fixed #1010: After casting a wall in a guard zone you were flagged as a criminal, also with the spellflag_harm
flag off.

28-01-2007, MrSugarCube
- Fixed: GAINRADIUS on skill definitions defaulting to random values.

29-01-2007, Ellessar
- Optimized: MapCaching (using STL functions), which should result in less bugs and better performance.
- Fixed: Using .tele over water tiles was allowed.

29-01-2007, Furio
- Modified: Is now possible to always use ARGO.verb directly.
- Added: In packetfilter functions ARGO is the CClient connected now (e.g. it allows SENDPACKET through
ARGO.SENDPACKET syntax at any time)

31-01-2007, MrSugarCube
- Fixed #771: Unicode characters being stripped from speech when keywords from Speech.mul are used.
- Added: Encryption keys for client 5.0.8.x to sphereCrypt.ini

01-02-2007, MrSugarCube
- Fixed #755: GetResourceValue error being shown for items with valid resources after being shown for the
first time.
- Modified: Changed the "GetResourceValue reentrant item=xxx" error to make more sense.

02-02-2007, MrSugarCube
- Fixed #496: Musicianship skill triggering skill gain twice on success.

03-02-2007, MrSugarCube
- Fixed #510: Notoriety status on tooltips not shown correctly when moving around.

05-02-2007, Ellessar
- Added: Keyword GetRefType, which returns flag of the referenced type. The list of flags is in sphere_defs.scp.
- Updated: sphere_defs.scp - added ref_types defnames

06-02-2007, Nazghul
- fixed #1047: NPC AI_CAN_LOOT missed a "not" so only animals looted :).
Domestic animals will no more poop dung if frozen, stone, insubstantial or in warmode

07-02-2007, Nazghul
- Fixed #1049: t_fire, t_campfire, t_spell are no longer dispellable if they have attr_move_never
- Added: more defmessages (update sphere_msgs.scp!)

07-02-2007, Vjaka
- Modified console output in linux build. By default it assumes that it is not colored,
launch with argument -c (./spheresvr -c) in order to get colored output. It screwed some consoles.

08-02-2007, Nazghul
- Added: Skill flags SKF_NOANIM (don't show hardcoded anim for this skill) and SKF_NOSFX (don't play
hardcoded sound for this skill). After setting this you can set anim/sfx yourself in @start
or alike.

08-02-2007, Ellessar
- Fixed #1050: Problems with underground caves.

09-02-2007, MrSugarCube
- Fixed: ConnectUO Status requests sometimes reporting an encryption error.

11-02-2007, Fisicka (Script pack)
- Fixed #1051: Bug in sphere_map_points0.scp and sphere_map_points1.scp

11-02-2007, MrSugarCube
- Fixed #1037: ADDBUFF and REMOVEBUFF requiring FEATURE_AOS_UPDATE_B enabled to work.
- Fixed #1053: @color in [SKILL]MENUs displaying the wrong colour.

12-02-2007, MrSugarCube
- Fixed #1058: Exception on linux build caused by items decaying without decay flag.

13-02-2007, Nazghul
- Fixed #1059: Now NPC will be stuck with the lightsource they already have equipped.

15-02-2007, Nazghul
- Added: First version of support for TNG's webscript reader. Use console command
"tngstrip" to create a file what contains the information TNG needs from all
your scripts (thus completely useless for script thieves). The file will be
placed at the location defined with "StripPath=" in sphere.ini and is named
"tngstrip.scp. Can be delivered either by a dedicated web server or the built-in
of sphere itself.

15-02-2007, Babidi (Script pack)
- Modified: sphere_dialog.scp - line 217, the highest skill is now SKILL_SPELLWEAVING.

16-02-2007, Nazghul
- Added: TAG.OVERRIDE.AMMOANIMHUE for bow and crossboy-type weapons to locally
override the color of the effect what will be used for displaying the shot.

18-02-2007, MrSugarCube
- Fixed #1069: Stable masters giving food to invisible characters.

20-02-2007, Nazghul
- Added SPELLFLAG_NO_CASTANIM (0x80000) to suppress the usual cast anim.
This way a custom (perhaps race-, class-, magery-, experience-related) anim
can be played @START/@SPELLCAST

21-02-2007, MrSugarCube
- Fixed #1071: Undefined Symbol error caused when a function returns a string.
- Fixed #1075: The last line in script files being ignored.
- Fixed #1076: ALLSHOW switching off too late upon login.
- Added: Skill flag SKF_CRAFT. Skills with this flag set will function
correctly with the MAKEITEM command.

21-02-2007, MrSugarCube (Script pack)
- Updated: sphere_defs.scp (Added SKF_CRAFT definition)
- Updated: sphere_map_points0.scp and sphere_map_points1.scp
(Removed duplicate teleporters)

22-02-2007, MrSugarCube
- Fixed #1078: Exception when walking in the top left corner of maps.
- Added #1079: ARGO in f_onchar_create, f_onchar_delete and f_onaccount_login
is now the the client that is performing the action (note that at the time
these functions are called, there is no character attached to the client so
character properties are not accessible).

22-02-2007, Nazghul
- Added: Character trigger @statchange (argn1: the stat, argn2: new value).

25-02-2007, Ellessar
- Added: TAG.DEATHFLAGS which changes some death related behavior. The list of
flags is in sphere_defs.scp and their names are pretty self-explaining.
- Fixed #1081: SERV.WRITELINE not adding a new line on Windows.

25-02-2007, Ellessar (Script pack)
- Updated: sphere_defs.scp (Added death_flags defname)

25-02-2007, Nazghul
- Added: TAG.OVERRIDE.MAXWEIGHT and TAG.OVERRIDE.MAXITEMS now are applying
to all containers if set. If not, maximum weight is still unlimited, while
max. item count is still default.

26-02-2007, Ellessar
- Modified: Region trigger @Step will now work only with EF_New_Triggers
on and EF_Minimize_Triggers off.

27-02-2007, Ellessar
- Added: sphere.ini settings EventsPlayer, EventsRegion. These events are
applied on all players/regions in the world.
- Updated: sphere.ini

01-03-2007, Furio
- Added: LASTEVENT keyword on clients, returning the time of last packet
receive (like serv.time).
- Modified: OF_OSIDamageMod and OF_Archery_CanMove are now CombatFlags
(look in sphere.ini)
- Updated: sphere.ini

01-03-2007, MrSugarCube
- Fixed #1092: Dead characters not showing on the status page.
- Fixed #1090: MOUNTHEIGHT checks preventing characters teleporting to valid
locations if they are stuck under a low ceiling.
- Fixed #1085: MAXBASESKILL in sphere.ini applying to skills that players are
unable to see in their skill menu. An INITHIDDENSKILLS setting has been added
to sphere.ini so that this behaviour can be toggled.
- Fixed #1084: Vendor's constantly restocking goods instantly after selling them.
- Fixed: Players able to create characters with skill in undefined skills.

01-03-2007, MrSugarCube (Script pack)
- Updated: sphere_skills.scp (Missing skill cap for Animal Lore in SKILLCLASS 0)

02-03-2007, Ellessar
- Fixed #1093: serv.restock not working. Now it updates all vendor boxes and
world gem bits.
- Fixed: NPCs sometimes not spawning with EF_NewPositionChecks on.
- Modified: Trigger @CallGuards now have a reference "REF1", which refers to
the target of the guard.
- Modified: NPCs now won't 'talk and follow' you, if your distance from their
spawn bit is greater than their homedist.

02-03-2007, Vjaka
- Fixed: red NPCs spawning in cities from spawns at the edges of the town.
- Modified: now clients which spawns too many exceptions are disconnected.
- Added: GOLD property for character. It counts all gold coins on character
and return them. Or, if used with argument, sets a new amount of gold, adding
gold coins to reach the new sum. The most common usage would be similar to
GOLD += 5000 and so on.
- Fixed: NPCs not being able to stumble upon hidden player character.

05-03-2007, Furio
- Fixed #1098: Explosion potion activate with decay timer also if not activated.

06-03-2007, Ellessar
- Added: ATTACKER.LAST, which works like ATTACKER.MAX, but returns the char which
hit the victim for the last time.

10-03-2007, Ellessar
- Added: Experimental flag EF_AllowTelnetPacketFilter, which allows telnet
connections to fire a PACKETx function.
- Updated: sphere.ini

12-03-2007, MrSugarCube
- Fixed #1062: "RETURN x" not always halting script execution or even returning
the correct value.
- Fixed: Exceptions that are sometimes caused when attempting to use/take an item
that cannot be reached.

13-03-2007, Nazghul
- Added: keyword VISUALRANGE, parameter 1..18 to limit the visualrange of a client.
After changing the visual range you should update the character in question once.

13-03-2007, Ellessar
- Fixed #1106: PACKETx sometimes caused errors in console.

16-03-2007, MrSugarCube
- Fixed #1113: Exception caused when an online player character is deleted.
- Fixed: ATTACKER.LAST only working when the last attack was within the last second.

17-03-2007, Beyonder (Script pack)
- Updated: sphere_item_treasure_maps.scp (Updated to use 0.56b features)

17-03-2007, Ellessar
- Added: Function SKILLTEST, which tests values of skills sent as arguments
on the default character. Usage: <skilltest carpentry 68.9>
- Fixed: SKILLMAKE replacing types with item names.

17-03-2007, Furio
- Fixed #1117: Unable to access subcontainers on the ground.

17-03-2007, MrSugarCube
- Fixed #1118: Ship functions being reported as invalid commands.

18-03-2007, Ellessar
- Added: ++/-- operators, which are in C languages.
- Fixed: RESENERGY is saved only if RESPOISON doesn't equal 0.
- Fixed: Possibility of double definition of events (sphere.ini + events +e...)

24-03-2007, Furio
- Updated: sphereCrypt.ini with 5.0.9.0 keys.
- Removed: MEMORY_GUMPRECORD to track open dialogs. It now uses an internal system.
- Updated: sphere_defs.scp
- Added: ISDIALOGOPEN $dialogId. It returns the number of the opened $dialogId
on the client.
- Fixed #1127: Items of the hatch can't be moved.
- Fixed #1129: GumpPicTiled don't work with dynamic origin.

24-03-2007, ShiryuX (Script pack)
- Updated: sphere_dialog.scp (Reference at top)

24-03-2007, RanXerox (Script pack)
- Updated: sphere_map_points0_ml.scp (Updated teleports)

26-03-2007, Nazghul
- Added: Teleport effect and sound config keywords for Sphere.ini.
Setting it to 0 disables the effect. Defaults are
TeleportEffectNPC=0372a
TeleportEffectPlayers=0372a
TeleportEffectStaff=03709
TeleportSoundNPC=01fe
TeleportSoundPlayers=01fe
TeleportSoundStaff=01f3

27-03-2007, Vjaka
- Fixed: Allowed to cast spells without reagents.

29-03-2007, MrSugarCube
- Fixed #1122: Exception when fighting with -100 dexterity.
- Fixed #1137: Containers closing when targeting them with .x/set.

04-03-2007, MrSugarCube
- Fixed #1126: Creatures with neutral karma not spawning in guard zones.

04-03-2007, Furio
- Added: PARTY.ISSAMEPARTYOF $uid, checking if the current party is the
same of the char with $uid.

06-04-2007, Nazghul
- Added: More defmessages
- Updated: sphere_msgs.scp

14-04-2007, Sir Dwayne (Script pack)
- Fixed: Various flaws in npc scripts and sphere_item_unsorted.

21-04-2007, coruja747 (Script pack)
- Updated: sphere_map2.scp (Corrected a_shrine_virtues area definition)

27-04-2007, Ellessar
- Added: Character trigger @TradeAccepted (+@charTradeAccepted), which is called
after both trade sides tick Accept Trade button. Default, ARGO - the first
trader, SRC - the second one, ARGN1 - the number of items the first trader gets,
ARGN2 - the number of items the second trader gets, REF1...REF<argn1> -
references to items the first trader gets. Return 1 prevents the trade.
- Fixed: CTAGs deleted before calling @LogOut

30-04-2007, MrSugarCube
- Modified #1162: A comma ',' can be used under the NOTOTITLES section to
optionally specify seperate titles for female characters.
- Modified: EF_MapDiff_Support has been removed, and map diffs are now enabled
via the USEMAPDIFFS setting in sphere.ini.

02-05-2007, MrSugarCube
- Fixed: Exception when using ACCOUNT.CHAR.x.KEY when the index 'x' does not exist.

03-05-2007, MrSugarCube
- Fixed: Server IPs on the server list being sent incorrectly to older clients.

05-05-2007, MrSugarCube
- Added: Experimental flag EF_UsePingServer. This will enable a server for
receiving pings from clients viewing the server list. Uses UDP port 12000.

06-05-2007, Ellessar
- Added: Missing character trigger @SpellFail (called before @Fail in a
SPELL section)

06-05-2007, MrSugarCube
- Fixed #1169: Exception caused by the count parameter being negative in the
STRSUB function.

08-05-2007, Ellessar
- Fixed: POW (@) does not work when using inside 'floatval'.

10-05-2007, MrSugarCube
- Fixed #1176: RANGE property on items returning 0 when the minimum range is 0,
when in this case it should return the maximum range.
- Fixed #1178: Automatic loading of backup saves not unloading all of the data
from the previous save.

17-05-2007, Sir Dwayne (Script pack)
- Updated: sphere_item_building_fence.scp, sphere_item_building_stairs.scp,
sphere_item_building_walls.scp (Reordering of some fences, stairs and walls)

17-05-2007, MrSugarCube
- Fixed: SPELLFLAG_NOUNPARALYZE doing the opposite of its description.
- Fixed #1181: Casting field spells on players not giving criminal status even
when SPELLFLAG_HARM is set.
- Fixed #1182: Crash when opening the .edit menu on a player with too many
equipped items.

17-05-2007, Furio
- Added: DSPEECH prop to players. Its purpose is to intercept player speech
like SpeechSelf, but it allows multiple speech block (DSPEECH +spk_lol add spk_lol,
DSPEECH -spk_lol removes it). Return 1 on the speech block interrupt execution and
prevent the player from speaking, Return 4 blocks the execution while allowing the
player to speech.
- Added: ISDSPEECH prop to players. Its purpose is to chech if a speech block is in
DSPEECH in a similar way of ISEVENT.

18-05-2007, MrSugarCube
- Modified #1155: The COMPONENT property of multi definitions can now be given
the ID of any scripted item.

20-05-2007, Furio
- Fixed: Trade windows not bouncing correctly some of the items.

20-05-2007, MrSugarCube
- Fixed: Sphere running slowly, due to new threading not ticking as much as
old threading.

22-05-2007, ShadowDragon
- Added: Support for Int and Color options to CHARDEF.

22-05-2007, Camelotten (Script pack)
- Fixed: jobvet.scp - an excessive '<' in "<SRC.SEX <Mi'Lord/Mi'Lady>".

26-05-2007, MrSugarCube
- Fixed #1194: Polymorph becoming a permanent effect during worldsaves.

27-05-2007, Nazghul
- Added: MODAR on weapons should modify the DAM effect of a weapon

28-05-2007, Furio
- Fixed #1201: DB.EXECUTE executing commands also when not connected.

29-05-2007, MrSugarCube
- Fixed #1203: Multis not being visible from a distance.

31-05-2007, Nazghul
- Fixed #1206: using character function ".gold" with negative numbers crashed
the server.

02-06-2007, Furio
- Fixed #1208: If modstat is negative and > ostat, all skills affected by
that stat become 65535.
- Fixed #1186: Starvation incorrectly damages affected player's equipment

02-06-2007, Almost all the dev team
- Fixed #1188: Incorrect save output.
- Fixed #1191: Sphere closing when using crafting skills (related to #1188).

02-06-2007, MrSugarCube
- Fixed: Unable to gain musicianship past 30%.

06-06-2007, Furio (Script Pack)
- Fixed #1213: "admin" in console (sphere_admin.scp)

08-06-2007, MrSugarCube
- Fixed #1211: FORCONTID and FORCONTTYPE not working.
- Fixed #1212: Reactive Armor causing a server crash when damaging self.

11-06-2007, MrSugarCube
- Fixed: Vendor menus on clients later than 4.0.0 not showing correctly for
renamed items when ACCOUNT.RESDISP is not correctly set to AOS+.

14-06-2007, Fire-Dragon-DoL
- Fixed #1220: typos in sphere_guild_functions.scp

26-06-2007, Nazghul
- Added: Character trigger @SkillChange. Fires whenever the skill raises due
to a gain. ARGN1 is the skill number (e.g. 43 for wrestling), ARGN2 is the
skill value AFTER the change happens. RETURN 1 (or 2, or 666) means that the
skill will NOT change.

29-06-2007, Torfo
- Added: ADDMD5. If md5 is enabled in the sphere.ini you can use ADDMD5 to
bypass the hashing algorithm, if MD5 isn't enabled it's the same as ADD.
Usage: "ACCOUNT ADDMD5 name hash"

06-07-2007, Nazghul
- Fixed: RETURN 1 in region triggers @exit, @enter did not tell the client that
the movement was stopped what led to some weird rubberband effects.
(thx. to MrSugarCube for help)
- Added: Character triggers @RegionEnter, @RegionLeave. ARGO is the region in
question, RETURN 1 works like in region triggers @exit, @enter.

12-07-2007, Nazghul
- Fixed: #1222 MAGICF_IGNOREAR rendered armor useless even on non magic damage
- some cleanups regarding NPC accepting/rejecting items
- Added: Hungry NPC try to pick ripe crops if available
- Added: ACTP character property (like ACTDIFF, ACTARG etc.) to work with for
example ACTION 102
- Added: Poisoned Food (MOREz = poison strength [0..100]) will poison whoever
eats it; NPC might refuse eating poisoned food depending on their TasteID skill

15-07-2007, Ellessar
- Modified: Now you can get AREADEF regions from inside a multi with the help
of an additional "region" keyword (e.g. region.region.name).

17-07-2007, MrSugarCube
- Fixed: Multis from newer expansions not loading correctly.

17-07-2007, Admin BladeCraft (Script pack)
- Updated #1236: sphere_item_magic_weapon.scp, sphere_template.scp,
sphere_backward_compatibility.scp (Changed misspelled defname
i_axe_war_VANQUISIHNG to i_axe_war_VANQ)
- Updated #1237: sphere_defs.scp (Fixed broken random templates)

18-07-2007, Nazghul
- Changed Ping Attack detection so that it only issues a warning if the "attack"
comes from LocalAddress and/or 127.0.0.1

19-07-2007, MrSugarCube
- Added: Support for packet changes in client 6.0.1.7. With clients running
on slower connections there may still be issues as Sphere cannot identify
the 4th digit of the client version until after the client has logged in.
If you want to override all 6.0.1.* clients to use the 6.0.1.7 packet
changes (and thus correct the issue with slower connections, but at the
same time remove support for 6.0.1.0-6 clients), find the following line
in sphereCrypt.ini:
0600010 02F2BA7ED 0A2817E7F ENC_TFISH // 6.00.10
and change it to:
0600018 02F2BA7ED 0A2817E7F ENC_TFISH // 6.00.18
- Added: FIXWEIGHT function for characters, which acts the same as FIXWEIGHT
does on containers (recalculates the total weight of the items in their
possession).

29-07-2007, Nazghul
- Just a fix in writing: Item tag.override_SKILL can also be written as
tag.override.skill (as the other OVERRIDE tags)

04-08-2007, Ellessar
- Fixed #1239: Lumberjacking caused Sphere to crash, when failed.
- Fixed: ISNEARTYPETOP did not work as intented (also changes some hardcoded
gathering related behavior.)
- Modified #1238: Sphere now tells you that you do not use SERV.MAP correctly
and does not throw an exception.
- Fixed #1197: RANGE property was not inherited through ID property.

09-08-2007, MrSugarCube
- Fixed #1153: House placement checking a larger area than the multi region
specifies.
- Fixed: Guards being attacked and calling new guards instead of fighting
back properly.
- Fixed: Incorrect client version detection for client 6.0.1.10.

10-08-2007, MrSugarCube
- Fixed #753: Crafting skills no longer consume items that match the one
you're attempting to create (unless the resources property specifically
states that the item can be crafted from itself).
- Fixed #1138: Scripts could be loaded multiple times if the file extension
was not provided.

10-08-2007, MrSugarCube
- Added: Support for AOS Custom Housing through a new item type 't_multi_custom'.
> See the sphere_item_multis_foundations.scp and add-on/House_Placement
scripts for examples of it's use.
> Custom houses (t_multi_custom) will be saved to a new save file named
spheremultis.scp.
> Note that Sphere will require access to doors.txt, misc.txt, floors.txt,
teleprts.txt, roof.txt, and walls.txt from the UO folder as these provide
lists of valid items. Also, all these items should exist in scripts for them
to be added to a building - note that the default script pack is currently
missing several sets of floors and walls.
> New functions and properties have been added that can be used with items of
the type t_multi_custom. These are:
-- References --
"DESIGNER" The player currently designing the building.
-- Properties --
"COMPONENTS" (r) The number of components in the building design.
"FIXTURES" (r) The number of fixtures in the building design (doors
and teleporters/t_door and t_telepad).
"DESIGN.x.KEY" (r) Accesses component x in the building design and
returns the given property. Possible properties are:
ID: The ID of the component.
DX: The x offset of the component.
DY: The y offset of the component.
DZ: The z offset of the component.
D: The x,y,z offset of the component.
FIXTURE: Returns 1 if the component is a fixture.
"DESIGNER" (r) The uid of the player designing the building (or 0).
"EDITAREA" (r) The editable range of coordinates when in design
mode (TopLeftX,TopLeftY,BottomRightX,BottomRightY).
"REVISION" (r) The revision number of the building design.
-- Functions --
"ADDITEM id,x,y,z" Adds an item to the building design (see COMMIT).
"ADDMULTI id,x,y,z" Adds a multi to the building design (see COMMIT).
"CLEAR" Wipes the building of all components (see COMMIT).
"COMMIT" Commits changes made to the building design.
"CUSTOMIZE [uid]" Enters the given player (or SRC) into design mode.
"ENDCUSTOMIZE" Forces the player to exit design mode.
"REMOVEITEM id,x,y,z" Removes an item from the building design (see
COMMIT). If the given id is 0 then any items found
at the location will be removed.
"RESET" Resets the building to it's default state (see
COMMIT).
"RESYNC [uid]" Resends the building structure to the given player
(or SRC)
> Players also have some new house design-related properties and triggers.
These are:
-- References --
"HOUSEDESIGN" The building this player is currently designing.
-- Properties --
"HOUSEDESIGN"(r) The uid of the building this player is designing (or
0).
-- Triggers --
@HouseDesignCommit Called on a character when they commit a new design.
ARGN1: Number of components in the old design.
ARGN2: Number of components in the new design.
ARGN3: The revision number of the new design.
ARGO: The building being designed.
LOCAL.FIXTURES.OLD: Number of fixtures in the
old design.
LOCAL.FIXTURES.NEW: Number of fixtures in the
new design.
RETURN 1: Block the commit.
@HouseDesignExit Called on a character when they exit design mode.
ARGN1: Is set to 1 if the character being forced
out of house design mode (ie. they're
logging out).
ARGO: The building being designed.
RETURN 1: Keeps the client in design mode (if ARGN1
was 0).

10-08-2007, MrSugarCube (Script pack)
- Updated: sphere_defs.scp (Updated type defnames)
- Updated: sphere_item_building_walls.scp (Split i_wall_stone_4's DUPELIST into
different defnames for different wall heights)
- Updated: sphere_item_ground_tiles.scp (Added a few missing water tiles and split the
waterfall DUPELIST into different defnames for different waterfall heights)
- Updated: sphere_item_profession_alchemist_mage.scp (Set the types of i_rune_alchem_*
items to t_telepad)
- Added: sphere_item_multis_foundations.scp (Added foundation multi definitions)
- Added: sphere_item_multis_stairs.scp (Added stair multi definitions)
- Added: sphere_item_building_roofs_aos.scp (Added AOS roof definitions)
- Added: sphere_item_building_roofs_ml.scp (Added ML roof definitions)
- Added: sphere_item_building_stairs_ml.scp (Added ML stair definitions)
- Added: add-on/House_Placement.zip (Added a sample script that allows custom houses
to be design by players)

14-08-2007, Nazghul
- Modified: sphere_defs.scp, added DEATHFLAG_HASCORPSE (010) to deathflags. If set on
a character like water elemental it will leave a corpse. Caveat: If DEATHFLAG_NOCORPSE
and DEATHFLAG_HASCORPSE are set, the NOCORPSE takes precedence!

17-08-2007, Nazghul
- Added: Item CAN flag CAN_I_BLOCKLOS (see sphere_defs.scp). Works only if
INI option AdvancedLOS is != 0.

18-08-2007, Nazghul
- Added: Spellflags TARG_NO_PLAYER and TARG_NO_NPC
- Updated: sphere_msgs.scp and sphere_defs.scp

19-08-2007, MrSugarCube
- Fixed #1242: TAT_AS_ARGO Triggers not working with hexadecimal uids.
- Fixed #1243: MODAR on weapons not showing the correct minimum damage on the
status window and tooltips.
- Fixed #1244: TAGAT.x.KEY and TAGAT.x.VAL returning the opposite properties.

21-08-2007, MrSugarCube
- Fixed #1246: Exception caused by using EQUIPWEAPON function on a character
with no backpack.
- Fixed #1247: NPCs not moving closer to their targets when they're using a
bow with a shorter range than the ini's archery range settings.

25-08-2007, Beyonder (Script pack)
- Fixed #815: sphere_item_resources.scp (i_blood_2 not decaying: Changed the
definition so that i_blood_2 now has a weight)

30-08-2007, MrSugarCube
- Fixed #1248: Incorrect container weight shown on tooltips.

04-09-2007, coruja747 (Script pack)
- Updated #1251: sphere_map_points2.scp (Missing teleports in Wisp Dungeon)

05-09-2007, Furio
- Fixed #1254: Console error when guild member delete char.
- Fixed: Login relay problems from localhost.
- Added #1260: "Setup_Start acct" with IP on the same LOG line.
- Added #1261: Incognito names in kill logs.
- Added: CLEARCTAGS (working like cleartags for ctags).

06-09-2007, MrSugarCube
- Fixed: "GetMapBlock failed at x" errors when logging in or placing a multi
over the edge of the map.

07-09-2007, Ellessar
- Fixed #1252: FloatVal not behaving correctly with negative numbers.
- Updated: sphere_msgs.scp (added login_lastlogged key)

08-09-2007, MrSugarCube
- Fixed: Character creation allowed whilst another character is still idling
in the world.

11-09-2007, MrSugarCube
- Fixed #1256: Ship plank exit allowing players to pass over blocked paths,
such as walls or fences.
- Modified: Added more "Bad Login x" codes along with expanded descriptions
to assist in identifying login issues.

16-09-2007, coruja747 (Script pack)
- Fixed #1258: ctags will be cleared when leaving admin menu

16-09-2007, nazghul
- Fixed #1257: Custom damage type didn´t work with COMBAT_USE_RESISTANCE

22-09-2007, nazghul
- Added: TAG.OVERRIDE.RANGE on items and/or characters overriding the RANGE
property of the itemdef/chardef.

30-09-2007, nazghul
- Fixed: not-working tag override of SkillPracticeMax what may have caused
problems with Linux builds. Now TAG.OVERRIDE.PRACTICEMAX.SKILL_#
(with "#" == "40" for swordsmanship, "42" for fencing, etc.) on a training
dummy can override the INI default upto what skill value one can practice
with it.

02-10-2007, coruja747 (Script pack)
- Updated #1224: sphere_admin.scp (Added char updates when modifying flags)

03-10-2007, MrSugarCube
- Fixed #1269: Fixed house design commit issues on alternate maps.
- Fixed #1270: Fixed ISEVENT not working on regions.

04-10-2007, MrSugarCube
- Fixed: House components being affected by OF_OSIMultiSight.
- Fixed: DESIGN.x.KEY not working on custom housing.

06-10-2007, Fire-Dragon-Dol (Script pack)
- Updated #1274: sphere_map2.scp (Removed reference to non-existant resource)

15-10-2007, MrSugarCube
- Added #1283: FEATURE_ML_NINTHAGE feature flag in sphere.ini. Setting this
enables the crystal and shadow components in custom houses.
- Fixed #1281: Unable to disembark ships on west-facing planks.
- Fixed #1278: Unable to craft crafting tools.

17-10-2007, Nazghul
- Changed: Behaviour of TAG.OVERRIDE.RANGE. Now the largest TAG value (on weapon
and/or char) takes precedence over the other.

18-10-2007, Nazghul
- Added: TAG.OVERRIDE.TRAINSKILLMAX and TAG.OVERRIDE.TRAINSKILLMAXPERCENT
overriding the respective defaults from Sphere.INI based on an individual
trainer (NPC).

19-10-2007, MrSugarCube
- Fixed #1293: Checkbox positions in dialogs not working with dorigin.
- Fixed #1292: House designer not working with RESDISP less than 3, a minimum
client version of 4.0.0 is still required though.
- Fixed #511: Character spawn tooltip modified to avoid bad token ID messages
with characters using random names (#NAMES_xxx).
- Fixed: Quest and Guild buttons on the paperdoll not working with RESDISP less
than 3.

20-10-2007, MrSugarCube
- Fixed #1295: Radio positions in dialogs not working with dorigin.
- Modified: MAXCHARSPERACCOUNT limit has been raised to 7. Note that the client
must support extra character slot(s) for them to be visible at the character
selection menu, older clients can only display 5 or 6.
- Added: MAXCHARS property to accounts. Setting it to 0 will link it to
MAXCHARSPERACCOUNT in the ini (default behaviour).

21-10-2007, MrSugarCube
- Fixed #1297: No resources lost when failing to craft.

26-10-2007, MrSugarCube
- Fixed #1304: Being able to light kindling whilst it is being dragged.
- Fixed #1300: Polymorphing whilst incognito'ed not updating the character's
name correctly with creatures using random names (#NAMES_xxx).
- Fixed: Various means of removing game board pieces from their game boards.
- Modified #1303: ISTEVENT now works on items, exactly the same as it does with
characters.

30-10-2007, MrSugarCube
- Fixed #1306: NPCs accepting every item given to them.
- Fixed #1298: Infinite loop caused by combat between two characters with the
statf_reactive flag set and the reflected damage being greater than the
original damage.

30-10-2007, Furio
- Fixed #1307: MySQL client running out of memory.

24-11-2007, Furio
- Fixed #1294: Error with the third parameter of "spelleffect". Now the third
parameter refer to the current source if is -1.
- Fixed #1318: Owned NPC's names and NPC's vendors commands.
- Fixed #1330: Problems with client and accounts with 16 characters.
- Fixed #1345: Clear Party TAG's.
- Added: Support for login protocol in 6.0.5.0+ clients.
- Added #1329: Max dist to park boats (see sphere.ini MaxShipPlankTeleport).
- Added #1296: "trigger" function returning the values returned by @CustomTrigger.

25-11-2007, MrSugarCube
- Fixed #1284: Multi regions being overlapped by area regions when map files are
resynced.
- Fixed: Mount items are now adjusted using the RES* settings on the ride
itself, to display themselves appropriately to lower RESDISP clients.

25-11-2007, Elric (Script pack)
- Updated: sphere_item_aos_se.scp (Removed duplicate item definitions)
- Updated: sphere_item_building_walls_se.scp (Removed duplicate item
definitions)
- Updated: sphere_item_misc_se.scp (Removed duplicate item definitions)
- Updated: sphere_item_ml_floor_wall.scp (Removed duplicate item definition)
- Updated: sphere_item_provisions_armor_ml.scp (Corrected Vulture Helm item
definition)
- Updated: sphere_item_unsorted.scp (Removed duplicate item definitions)

27-11-2007, MrSugarCube
- Fixed #1323: Criminal status for attacking dead players.
- Fixed #1250: Exception with region triggers.
- Fixed #1017: Magery skill being used for all spells. Now the first skill listed
in the spell's SKILLREQ line will be the action used when casting. Note that
unexpected things will happen if you've set this to be a non-magic skill (for
example, Begging), so make sure the SKF_MAGIC flag is set on such skills.

14-12-2007, coruja747 (Script pack)
- Updated: sphere_item_building_walls_se.scp (Missing item 02753)
- Updated: sphere_item_deco_evilitem.scp (Incorrect dupeitem on itemdef 02a59)
- Updated: sphere_item_christimas.scp (Incorrect RESDISPx settings on i_Sleigh)
- Updated: sphere_map_points2.scp (Inaccessible teleports on Exodus Dungeon)

21-12-2007, MrSugarCube
- Modified: Ships now move 2 spaces at a time instead of 1. This reduces a lot
of lag caused by ship movement and also fixes overhead messages disappearing
whilst the ship is in motion.
- Added: SHIPSPEED property to ship ITEMDEFs. This controls how often and how far
the ship will move. SHIPSPEED.PERIOD and SHIPSPEED.TILES can be used to return
the separate values. Usage:
"SHIPSPEED=5,3" Ship will move 3 tiles every half a second.
"SHIPSPEED=1,5" Ship will move 5 tiles every tenth of a second.
"SHIPSPEED=20,2" Ship will move 2 tiles every 2 seconds.
Note 1: If there is less space available than specified by SHIPSPEED.TILES,
the ship will still move as far as possible before stopping (so if a ship is
set to move 10 tiles and is heading towards a coast that is 16 tiles away, the
ship will move 10 tiles, then 6 tiles, and then stop.
Note 2: TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can also
be set on the ships themselves to override their speed on an individual basis.

22-12-2007, Nazghul
- Added: Triggers @NPCAction and @NPCSpecialAction
@NPCSpecialAction
If the NPC has a lot of spare time (i.e., nothing else to do) it
looks for some special action. For example, giant spiders lay webs,
and fire elems leave fire patches. This trigger fires on ANY type
of creature. If you return 1, it will not do it's special action,
on return 0 it will (what, as said above, will only be true with
giant spiders and fire elems; you can script other NPC special
events yourself).

@NPCAction
AI-related trigger. If the situation is so the NPC will do something
due to it's AI - things like animals pooping the ground, vendors
going off/on duty, (un)equipping a lightsource when it's dark,
(un)equipping a weapon when fighting, stabler feeding animals or
giving players food for their animals etc. - (once hardcoded behaviour
was planned also for beggars who should sleep at night, for thieves,
undead mages, healers, and more, but never realized. Now you can script
this yourself) this trigger will be fired. On RETURN 0
the NPC will continue with what it wants to do, RETURN 1 will abort it.

Both triggers will fire only if EF_NPCAct_Triggers is SET and
EF_Minimize_Triggers is NOT SET in the sphere.INI. SO if you don't
change your INI, everything will stay as it was before.

22-12-2007, MrSugarCube
- Fixed #1341: Arguments not being parsed correctly for commands entered
on the console.
- Fixed #1331: Script verbs not being parsed correctly when there is a
space in them (ie. TAG.xxx_<EVAL yyy> = zzz).

04-01-2008, Nazghul
- Added: Triggers @Mount and @Dismount, both are character trigger, firing
when a character tries to mount/dismout it's ride (and will be able to).
@DISMOUNT
ARGO is the UID of the (still disconnected!) pet.
RETURN 1 stops the dismount process.
@MOUNT
ARGO is the UID of the NPC bound to be ridden.
RETURN 1 stops the mounting process.

19-01-2008, MrSugarCube
- Fixed #1351: Gaining tactics when fighting players in no-pvp regions.
- Fixed #1337: Foundations of custom housing deletable by players.
- Fixed #1132: Maps other than #0 not showing up when logging in.
- Added #1003: ACTPRV property to characters. This is used in some skills,
for example with magery to hold the source of the spell (character, wand,
scroll, etc).
- Fixed: CALL not working with object references. (eg. "CALL src.myfunction")
- Fixed: ++/-- in scripts being parsed as +=1 when not being used as operators.

19-01-2008, MrSugarCube (Script pack)
- Updated #1360: sphere_admin.scp (Fixed blank client list when using .admin twice)
- Updated: sphere_backward_compatibility.scp (Added NpcCast function, which can be
used to make a character start casting a spell)

19-01-2008, Furio
- Fixed #1324: Undefined Symbols on attacker when accessing a bad attacker #
- Fixed: isneartype not searching through all statics.
- Updated: sphere.ini with missing values.
- Added #1358: now serv.newitem has a 4th argument if set to 1 trigger @Equip will
be called upon item equipping.
- Added: SERV.MAPLIST.$mapid.$prop to cycle through maps to get props. The list of
properties that can be accessed (read only) are:
BOUND.X = maximum x for the map
BOUND.Y = maximum y for the map
CENTER.X = x coord of map center
CENTER.Y = y coord of map center
SECTOR.SIZE = size of sectors
SECTOR.ROWS = qty of sector rows for the map
SECTOR.COLS = qty of sector columns for the map
SECTOR.QTY = total number of sectors for the map
- Added: FeatureKR and Kr reslevel (6). Guess what they do (it's a wip).
- Added: EF_UseNetworkMulti (00800000) to experimental flags. Tired of crashing due
too many items/npcs, try it. Don't change it while the server is running.
(Thx to Z. for the windows version)

21-01-2008, MrSugarCube
- Fixed #1311: NPC Pathfinding failing when EF_DiagonalWalkCheck is enabled.
- Added #738: Combat flag COMBAT_STAYINRANGE. Causes out-of-range attacks to fail
at the end of the swing instead of waiting until the target is in range.
- Added: WEATHER property to sectors, sets or gets the current weather.

22-01-2008, MrSugarCube (Script pack)
- Updated #1107: sphere_genericstone_functions.scp (added function to control or
override ally status between guilds (f_stonesys_internal_isalliedwith), see
comments for details)

24-01-2008, MrSugarCube
- Fixed #1363: Players unable to pick up single items from heavy stacks.

31-01-2008, Nazghul
- Fixed #989: Fame-titles will not be shown on NPC anymore if INI option NPCNoFameTitle
is set.

31-01-2008, MrSugarCube
- Fixed #1372: EF_NewPositionChecks causing fishing to fail from boats when
AdvancedLos is disabled.
- Fixed: ADVANCEDLOS_PLAYER enabling AdvancedLos for all characters including
NPCs (ADVANCEDLOS_NPC being ignored).

02-02-2008, Furio
- Added DIALOGLIST keyword. DIALOGLIST.COUNT gives the number of open gump dialogs,
DIALOGLIST.$x.ID ($x = a number between 0 and DIALOGLIST.COUNT-1) the ID of the
respective gump dialog, and DIALOGLIST.$x.COUNT the number of active instances of
this dialog. So to close a specified gump, DIALOGCLOSE <DIALOGLIST.$n.ID> should do.
- Added KRTOOLBARSTATUS (prop/verb) and @UserKRToolbar (ARGN1 type, ARGN2 arg) to
interact with the hotbar in the KR client.

03-02-2008, Shadow Dragon
- added @KarmaChange, @FameChange. Called when Karma/Fame adjusting.
ARGN1 = Karma/Fame modifier, it's writable.
return 0 will use Argn1 value in adjusting.
return 1 will break adjusting.
return 2 will ignore Argn1 and continue default adjusting.
Both triggers work only when EF_Minimize_Triggers isn't set.

07-02-2008, MrSugarCube
- Fixed #718: Ships unable to travel over static water tiles.
- Fixed #1378: Armour rating being factored in twice during damage calculations.

11-02-2008, MrSugarCube
- Fixed #1406: Newly created characters not starting with the MALE_DEFAULT / FEMALE_DEFAULT
newbie templates.
- Fixed: Exception caused by using ARGO.Verb when argo is not set.
- Modified: "Vendor uid=xxx selling unmovable item" message no longer shown when
listing the items that a player can sell to a vendor.

27-04-2008, MrSugarCube
- Fixed #1404: Restoring custom house design without first making a backup allowing players
to remove the entire house foundation.
- Fixed #1398: Lightning spells causing @EnvironChange to be called on nearby characters.
- Fixed #1381: Maps with non-matching courses plotted can be stacked.
- Modified #1389: Character list to show filled character slots that are over the account's
limit (eg. account containing 7 characters shows all 7 even when the limit is 5 ,assuming
the client is capable of displaying all 7).

27-04-2008, coruja747 (Script pack)
- Updated #1402: sphere_item_building_walls_se.scp (Fixed empty dupelist property)

27-04-2008, Mordaunt (Script pack)
- Updated: sphere_item_multis_foundations.scp (Added the remaining house foundation sizes)

28-04-2008, MrSugarCube
- Fixed #1394: Advanced pathfinding (NPC_AI_PATH) allowing NPCs to make invalid movements
(for example walking whilst paralyzed). Some other adjustments have also been made,
allowing NPCs to properly assess characters that may be blocking the way (to walk around
them), negotiate corners with EF_DiagonalWalkCheck enabled, and attempt to compensate
when new obstacles block a previously valid path.
- Fixed #1390: Locals not working in SKILLMENUs.

28-04-2008, coruja747 (Script pack)
- Updated #1392: spherechar_new_mounts.scp, spherechar_mondains_legacy.scp (Updated
RESDISPDNHUE property on rides)

02-05-2008, MrSugarCube
- Fixed #1348: Problem where <SERV.ResourceType.Id> returns 1 when the id is a different
resource type (e.g. <SERV.TEMPLATE.i_dagger> (dagger being an item not a template)).

15-05-2008, Shadow Dragon
- Added LAYER_AUCTION that can contain container on character for script purposes, like
auction system.

19-05-2008, Shadow Dragon
- Modified: GOLD property adds new gold stacks to bankbox.

21-05-2008, Nazghul
- Added: Combat flags to Sphere.ini to allow stacking armor and aimed hits. Example of usage
is in scripts/AddOns.
Aimed hits are controlled by tags on the "hitter": TAG.HITPREFERENCE holds the targetted
zone: 1=head, 2=neck/throat, 3=back, 4=chest, 5=arms, 6=hands, 7=legs, 8=feet (if the value
is out of this range it will be changed by %9; "0" means: no preference set);
TAG.HITPREFERENCE_CHANCE (0..1000) is the chance to really hit the desired area;
TAG.HITPREFERENCE.BONUS is the percent the damage is raised when hit where desired,
TAG.HITPREFERENCE.PENALTY is the percent the damage is lowered if the area was missed.
The last two values are defaulting to "30".
The system is perhaps useful to script a system where a player can look for weak armored
bodyparts of his opponent and try to hit him there; could be essential if armor stacking
is used.

23-05-2008, MrSugarCube
- Fixed #1418: Tracking being used to reveal the location of invisible staff members.
- Fixed #1417: Unable to access account properties using [SERV.]ACCOUNT.x.KEY where account
x begins with a number.
- Fixed: Characters "drifting to shore" when logging in on a ship.
- Fixed: Variety of exceptions caused when items are being set to type t_eq_memory_obj after
after creation.
- Modified: RESTOCK function on vendors now accepts a parameter to specify whether or not
new stock should be spawned immediately (0=empty existing stock (default), 1=empty stock
and spawn next set).

26-05-2008, MrSugarCube
- Fixed: Code not being skipped properly when incorrect loop syntax is used.
- Modified: @UserVirtue trigger now has 2 arguments:
ARGO = The character whose virtue button has been pressed
ARGN1 = The button ID pressed (1=virtue button (on paperdoll), 105-112=icons within the
menu)
Note: Clients only specify the character they're viewing (ARGO) when pressing the
paperdoll button (ARGN1=1)
- Added: @UserVirtueInvoke trigger, called when a virtue is invoked through client macros.
ARGN1 = The virtue ID (1=Honor, 2=Sacrifice, 3=Valor)

27-05-2008, MrSugarCube
- Modified: ARGN2 in @SkillChange trigger is now writeable.

27-05-2008, MrSugarCube (Script pack)
- Updated: sphere_msgs.scp (Added 2 more "tracking_*" defmessages)

25-06-2008, MrSugarCube
- Modified: Installing Sphere as a Windows service (using "-k install" with NTService=1) will
now configure the service with an automatic restart configuration.

02-07-2008, MrSugarCube
- Fixed #1439: NPC_AI_MOVEOBSTACLES allowing NPCs to move items whilst paralyzed.
- Added #850: @SpellSuccess trigger, fires on the caster just before the @Success trigger is
fired on spell blocks.

04-07-2008, MrSugarCube
- Fixed #1177: Client command parsing using brackets as argument separators.
- Fixed #1097: Possible infinite loop involving circular ownership (e.g. two characters set as
owners of each other).

04-07-2008, MrSugarCube (Script pack)
- Updated #1443: sphere_guild_dlg_charlist.scp, sphere_guild_promptconsole.scp,
sphere_town_dlg_charlist.scp, sphere_town_promptconsole.scp (Fixed guild and town stones
using TITLE property instead of GUILDTITLE)

04-07-2008, Nazghul
- Added: skilltitles "Elder" and "Legendary"

05-07-2008, MrSugarCube (Script pack)
- Updated #1130: sphere_msgs.scp (Removed tracking_dis* defmessages and replaced them with
simpler tracking_result* defmessages)

06-07-2008, Nazghul
- Added: SPELLFLAG_NOPRECAST what disbles PRECASTING on a per-spell-base.
Only valid if PRECAST is activated by Sphere.ini

08-07-2008, MrSugarCube
- Fixed #1446: GM/MT_FLY enabled characters walking through stairs when EF_WalkCheck is not
enabled. [Note: Due to potentially negative side-effects of this fix a temporary EF flag
(EF_NoWalkingThroughStairsFix) has been added to sphere.ini which disables the fix just in
case something bad happens (if no issues are reported that are caused by this fix then you
can expect it to disappear very soon)]

10-07-2008, MrSugarCube
- Fixed ##3: Unstackable items becoming stacked after being bought off a player-owned vendor,
when the buyer cannot carry the items.
- Fixed ##2: NPC_AI_FOOD causing NPCs to get stuck whilst they attempt to eat grass from a
tile where grass has already been eaten from recently.

13-07-2008, Beyonder
- Fixed ##1: Sphere crashes with Experimental Flag UseNetworkMulti.
- Added: LOCAL.FIELDWIDTH and LOCAL.FIELDGAUGE to @SpellSuccess and @Success
triggers.
LOCAL.FIELDWIDTH sets the width of the field from character point of view.
LOCAL.FIELDGAUGE sets the thickness of the field.
- Fixed #1449: Damage spells backfire when selecting summon while casting.

15-07-2008, Beyonder
- Added: Extra local arguments to @SkillStart and @Start (skill section) triggers for crafting
skills:
LOCAL.CRAFTITEMDEF - the UID of defname of the item we are currently crafting. Readable/Writable.
Accepts ONLY UIDs of ITEMDEFs, for example:
if (<LOCAL.CRAFTITEMDEF> == <DEF.i_katana>)
LOCAL.CRAFTITEMDEF = <DEF.i_sword_long>
endif
LOCAL.CRAFTSTROKECNT - amount of strokes character makes while creating the item. Each stroke
has DELAY specified in SKILL section. Readable/Writable.
LOCAL.CRAFTAMOUNT - amount of items that will be created. Only usable for REPLICATable items,
otherwise will make no effect. Readable/Writable.
- Modified: @Destroy on items and characters is triggered before deletion, not after. This way
all of the item/character properties are fully accessible.
"return 1" forbids deletion. WARNING! putting return 1 in this trigger means it won't be deleted
in any possible way! Use it with caution.

15-07-2008, MrSugarCube
- Fixed: World saves being aborted when they are taking a long time to complete.

20-07-2008, MrSugarCube
- Fixed #1459: Weather effects not being updated when walking in/outdoors.
- Fixed #1458: ARGV[x] not being updated when ARGS is set to a new value.

20-07-2008, Coruja (Script pack)
- Updated #1457: sphere_items_multis_houses_ships.scp (Corrected sign height and door type for the
stone and marble shops)
- Updated #1456: spherechar_new_mounts.scp (Added FOODTYPE for c_giant_beetle)

24-07-2008, Coruja (Script pack)
- Updated #1465: sphere_spells.scp (Wrong spellflag for MARK spell)

02-08-2008, MrSugarCube
- Fixed #1475: Undefined keyword error when using 'REGION.ALLCLIENTS' in a region with no clients.

08-08-2008, MrSugarCube
- Fixed #1479: Custom layer values not being restored correctly when loading from world save.
- Fixed #1470: Entering house customization with open dialogs causing the sphere to lose track of
which dialogs are still open on the client.
- Fixed #1468: Exiting house customization mode sending characters to the house sign's height
instead of ground level.

09-08-2008, MrSugarCube
- Fixed #1476: Players under the incognito spell being unable to read other players' profile
scrolls.
- Fixed #1033: Mass Curse spell not affecting character stats.
- Modified #963: ARGN1 in @[item]DropOn_Ground can now be used to read/write the decay time (in
tenths of a second) that will be set on the dropped item.

10-08-2008, Coruja (Script pack)
- Updated #1486: sphere_map_points4.scp (Added teleports for Yomotsu Mines and Fan Dancer's Dojo)
- Updated #1485: sphere_map3.scp (Added missing Malas locations)
- Updated #1480: sphere_map_points0.scp, sphere_map_points1.scp (Incorrect teleports for Ice
Dungeon)

11-08-2008, MrSugarCube
- Fixed #1483: Issues with trying to load scripts from directories outside of where the Sphere
executable is located.

12-08-2008, MrSugarCube
- Fixed #1489: Longer ships being able to manoeuvre themselves into invalid positions.

13-08-2008, MrSugarCube
- Fixed #1490: Formatting error when showing murderer/criminal title on the paperdoll.

14-08-2008, MrSugarCube
- Fixed #1484: Client showing the wrong season and light level upon login.

16-08-2008, Nazghul
- Added: Character Trigger @UserQuestArrowClick what fires if the user clicks on the quest arrow.
No RETURN value checks, ARGN1 is the mouse button used (0=left, 1=right). Trigger works only
with EF_MinimizeTriggers disabled.

22-08-2008, MrSugarCube
- Fixed #1496: Female NotoTitles not always being shown on the paperdoll.

25-08-2008, MrSugarCube
- Fixed: @Dismount trigger being fired multiple times under certain circumstances.

26-08-2008, Shadow Dragon
- Fixed: Skills doesn't gain when lower than 1.8
- Added: New trigger @AfterClick and @ItemAfterClick. LOCAL.ClickMsgText will contain text, that
will be shown after click on object, LOCAL.ClickMsgHue will contain color of the message. Both
locals are writable. RETURN 1 - will cancel showing text. Requires EF_New_Triggers to be
enabled.
- Fixed: Mounts removing when world save (error: Ridden NPC without a mount item).

31-08-2008, MrSugarCube
- Added #1507: REVERT function to custom housing (t_multi_custom), calling this will clear any
uncommitted changes that have been made to the building design.

03-09-2008, Nazghul
- Added #1504: Optional second parameter "amount" to MAKEITEM. Please understand that the
"additional" items crafted will neither fire any trigger, nor give experience or skill. So,
from that point of view there's no difference between "MAKEITEM i_dagger" and "MAKEITEM i_dagger,10"
(except for the number of daggers created). If the resources you have are insufficiant for
the amount, it will be shortened respectively.

08-09-2008, MrSugarCube
- Fixed #1514: Players and NPCs unable to cast spells.
- Fixed #1508: Dropped items stacking regardless of their difference in height.

09-09-2008, MrSugarCube
- Fixed #1516: NPCs unable to use pathfinding when trying to follow or walk up to another character.

13-09-2008, MrSugarCube
- Added: BASECOMPONENT property to multis. Usage is similar to COMPONENT except it returns
information for the components specified in the mul files, and when accessing
individual components (BASECOMPONENT.n.[ID/DX/DY/DZ/D] there is an additional "VISIBLE"
property which returns 0 if the component is invisible (usually applies to doors and signs).

16-09-2008, Nazghul
- Added: Override Tags for item/action related sound.
TAG.OVERRIDE.DOORSOUND_CLOSE / TAG.OVERRIDE.DOORSOUND_OPEN
(what it does should be obvious)
TAG.OVERRIDE.PORTCULISSOUND - holds an sfx number played when
opening/closing a portculis
TAG.OVERRIDE.DROPSOUND - sfx an items makes when dropped. Att:
system default sounds sometimes change due to the amount dropped
(gold, ingots), or on what surface/item the item is dropped. All
this will be overridden!
TAG.OVERRIDE.SOUND_HIT - on weapons holds the sound when it hits,
regardless of WHAT it hits!
TAG.OVERRIDE.SOUND_MISS - on weapons, sound they make when missing

all TAGs need to hold a number (defname MAY be possible -> test!),
what also can be "0" (zero) with the meaning: don't play any sound.

17-09-2008, Nazghul
- Added: Trigger @PICKUP_STACK what fires only if an item was picked up from a pile.
ARGO is the remaining part of the stack. (There's a char trigger itemPICKUP_STACK
also)

18-09-2008, Nazghul
- Added: TAG.OVERRIDE.RUNNINGPENALTY and TAG.OVERRIDE.STAMINALOSSATWEIGHT to
override the respective INI settings on a per character base

28-09-2008, Shadow Dragon
- Fixed: Sphere crashing when injection tries to add one item to another non-container item
(errors in injection script and so).

26-10-2008, MrSugarCube
- Fixed #1540: Server crash when invalid parameters are passed into RTIME.FORMAT.
- Fixed #1539: Infinite loop caused by "back" options on SKILLMENUs leading to a server crash.
- Fixed #1538: Possibility of quickly gaining arms lore skill through repairing, by repeatedly
attempting to repair an item that cannot be repaired.
- Fixed #1518: Possibility of world save notification not being broadcasted.
- Fixed #1510: IsNum not working with negative numbers.
- Fixed #1158: Possibility of the statf_fly flag not being removed from players who have been stood
still for some time.
- Fixed: "You can't think of a way to use that item." when failing to repair an item.
- Modified: EVENTSPLAYER, EVENTSPET and EVENTSREGION settings now accept a comma-delimited list of
events.

26-10-2008, MrSugarCube (Script pack)
- Updated #1535: sphere_defs.scp (Corrected sounds for snd_rune_beetle through to snd_hiryu)

02-11-2008, MrSugarCube
- Added #1499: CanUndressPets setting to sphere.ini. Setting this to 1 will enable players to
take equipment from their pets' paperdolls.

29-11-2008, MrSugarCube
- Fixed #1553: Repairing an item does not update its tooltip.
- Modified: IsNearType (including IsNearType.P) now accepts a third parameter, which when set to 1
will cause the function to include multi components in the search.
- Added: New mt_mount flag (00400) which will allow character bodies to become capable of mounting
rides. Note that this flag is not required for the bodies that could already mount rides prior
to this flag's existence (c_man/c_woman/c_man_gm/c_elf_man/c_elf_woman). Also be aware that not
all character bodies are intended to be used for mounting rides and won't have proper riding
animations.

29-11-2008, MrSugarCube (Script pack)
- Updated: sphere_defs.scp (Added mt_mount to the can_flags defname section)

05-12-2008, MrSugarCube
- Fixed: Server crash caused by exceedingly large dialogs being sent to clients.

06-12-2008, jeem (Script pack)
- Updated #1555: sphere_guild_dlg_charlist.scp, sphere_town_dlg_charlist.scp (Fixed script error
when showing guild member titles)

07-12-2008, MrSugarCube
- Added #1086: Skill degradation for skills that have been set to decrease. @SkillChange trigger
is called for decaying skills just as it does when they gain (compare <ARGN2> to <<ARGN1>> to
determine if the skill is being increased or lowered).
- Added: Experimental flag EF_UseNetworkMultiVersionMod. This modifies the behaviour of the
EF_UseNetworkMulti flag (don't forget to set this too) so that clients older than 4.0.0 will
be unaffected and continue to use the original networking code as if the EF_UseNetworkMulti
flag was never set.

03-01-2009, Dwayne1988 (Script pack)
- Updated: spherechar_human.scp, spherechar_evil.scp (Axis Tags were messed up, came after
@NPCRESTOCK _and_ had a leading TAB so Axis won't find them)

24-01-2009, MrSugarCube
- Fixed #1572: Exception on Linux builds when mounting a horse.
- Fixed #1569: @UserWarmode trigger not being fired.
- Fixed #1568: Default webpage paths in Sphere.ini not valid for Linux.
- Fixed #1532: Added log message to indicate the account name being referred to when an account
is already in use, blocked, or cannot log in due to CLIENTMAX setting.

28-01-2009, Shadow Dragon
- Added: SERV.RTicks for reading purposes. Returns real system time in ticks as unsigned value (0..4294967295).
- Added: UVAL, which works like EVAL, but for unsigned values.

01-02-2009, Shadow Dragon
- Added: Basic LIST support.
LIST.xxx to show elements in list. Also, can be used like LIST.xxx=value to clear list and add a value
LIST.xxx.ADD to add new element to list, can be number or string
LIST.xxx.CLEAR to clear list
LIST.xxx.index to read/write value on element in list
LIST.xxx.COUNT to get count of elements in list
LIST.xxx.index.REMOVE to remove element at specified index in list
LIST.xxx.index.INSERT to insert element at specified index in list
LIST.xxx.FINDELEM search_value returns index of first found element in list. Search starting from begin
LIST.xxx.index.FINDELEM search_value returns index of first found element in list. Search starting from index
SERV.PRINTLISTS to print all lists and their elements
SERV.CLEARLISTS to clear all lists. If used with mask parameter, then clear all lists, which name countains specified mask
- Added: SERV.Map.x.AllSectors some_verb_to_use
If used not in this syntax, then gives old error about MAP is readonly.

08-02-2009, MrSugarCube
- Fixed #1517: Unable to cast polymorph spell.
- Fixed: Possible infinite loop when creating fight memories in scripts.

09-02-2009, Coruja (Script pack)
- Updated #1576: sphere_item_profession.scp, sphere_item_deco_dungeons_traps_dead.scp (Corrected
portrait DUPELISTs)

15-02-2009, MrSugarCube
- Modified #1545: JOINASMEMBER function no longer requires that the new member be online.
- Fixed: Unable to connect to local server with an encrypted client when it decides to reuse its
login server connection instead of open a new one.

21-02-2009, MrSugarCube
- Fixed #1571: Creating a player with a hyphen or period in its name causing a random name to be
generated.
- Fixed #1548: Armor MODAR being factored in twice when calculating total armour value, and sometimes
character MODAR being factored in twice when calculating damage.
- Fixed: Messages such as "You can't reach anything in your state." and "You can't think of a way to
use that item." being sent to players as they try to free themselves from spider webs.
- Added #1564: PetsInheritNotoriety setting to sphere.ini. This can be used to specify which
notoriety flags a pet will inherit from its master (so if for example a pet has an evil owner
and the NotoEvil flag is set then the pet will also show as evil regardless of its real notoriety).

22-02-2009, MrSugarCube
- Fixed #1575: Improved handling of unicode speech in Linux build.
- Fixed #1537: TEST in skillmenus not being parsed in the same way as TESTIF.

26-02-2009, MrSugarCube
- Modified #1560: Separated PROMPTCONSOLE from the targeting system. Targeting no longer interferes
with prompts and vice-versa.

14-03-2009, MrSugarCube
- Fixed #1585: Multiple arguments not being passed into commands when using the syntax
[SERV.]ACCOUNT <name> <command> <args>

20-03-2009, MrSugarCube
- Fixed #1586: Exception in Linux build when using the ADDCLILOC function with DEBUGF_SCRIPTS enabled.
- Fixed: Exception when passing an invalid object uid into the NEWDUPE function.

21-03-2009, MrSugarCube
- Fixed: Crashes with EF_Unicode enabled on Linux builds.
- Fixed: SuppressCapitals causing speech to be blanked out.

22-03-2009, MrSugarCube
- Fixed #1557: Sphere only sending partial webpages to certain browsers such as FireFox.
- Fixed: Sphere only sending partial webpages to all browsers when EF_UseNetworkMulti is used.
- Modified: EF_UseNetworkMultiVersionMod now also disables the effects of EF_UseNetworkMulti for HTTP
clients.

29-03-2009, MrSugarCube
- Fixed #1589: TWOHANDS returning 1 with items that are equipped in the second hand but aren't
two-handed, such as shields and lanterns.

04-04-2009, MrSugarCube
- Fixed #1588: Possibility of overflow when applying markups to vendor prices (note that prices are
limited to a maximum of 2,147,483,647gp inclusive of markup).

10-04-2009, MrSugarCube
- Fixed: Server crash caused by deeply nested SKILLMENUs.
- Modified: Menu options are no longer hidden from SKILLMENUs when Sphere is unable to fully search
within them.

13-04-2009, MrSugarCube
- Added: SERV.RTICKS.FROMTIME year,month,day,hour,minute,second. Returns the timestamp for the given
date.
- Added: SERV.RTICKS.FORMAT timestamp[,format]. Converts the given timestamp into a formatted date
string (similar to SERV.RTIME.FORMAT).

14-04-2009, MrSugarCube (Script pack)
- Updated #1497: sphere_item_multis_houses_ships.scp (Fixed ship masts not blocking line of sight)

19-04-2009, MrSugarCube
- Fixed #1586: Possible exception when checking line of sight near multis when AdvancedLos is enabled.
- Fixed #1495: Ghosts able to teleport through walls when resurrecting. Line of sight is now required
for a ghost to resurrect with their corpse.
- Fixed: Exception when EF_NewPositionChecks is enabled and there are statics placed on the map which
don't have scripts.

19-04-2009, MrSugarCube (Script pack)
- Updated #1469: sphere_item_ground_tiles.scp (Corrected height of i_waterfall_low)

25-04-2009, MrSugarCube
- Modified: Jailing players (".JAIL cell#" command) now remembers the cell number that was specified,
stored in Tag.JailCell on the account and used when returning players to jail.
- Modified: Jailed players are no longer blocked from being teleported within the jail region.

25-04-2009, MrSugarCube (Script pack)
- Updated: sphere_map0.scp (Renamed individual jail AREADEFs to jail cell ROOMDEFs)

02-05-2009, MrSugarCube
- Fixed #1581: Characters unable to see objects that are in the corners of their visual range.

03-05-2009, MrSugarCube
- Fixed #1526: No decay timer set on lights after they become unlit.

04-05-2009, MrSugarCube
- Fixed: Objects on the corners of .EXTRACT, .NUKE, .NUKECHAR areas not being affected by the command.

05-05-2009, MrSugarCube
- Fixed #1451: Missing mana checks, skill checks and @Select triggers not being fired before casting,
when precasting is enabled.
- Modified: Separated the movement behaviour of the MAGICF_PRECAST flag into a new MAGIC_FREEZEONCAST
flag. Enable MAGICF_PRECAST to enable casting before targeting, and enable MAGICF_FREEZEONCAST to
prevent characters from moving whilst casting (enable both to retain the previous behaviour of
MAGICF_PRECAST). Also added SPELLFLAG_NOFREEZEONCAST to disable the effects of MAGICF_FREEZEONCAST
for individual spells.

06-05-2009, MrSugarCube
- Added #1599: SpellTimeout setting to Sphere.ini. If set to a value greater than zero then when
casting a spell the player is given this many seconds to choose a target before the spell is
automatically cancelled.

16-05-2009, MrSugarCube
- Modified #1610: Cure spell just sends the packet needed to update the health bar rather than sending
a full refresh of the entire screen.
- Added #1609: MAGICF_SUMMONWALKCHECK flag to ensure that summoned creatures can only be successfully
summoned on tiles that are walkable for them (i.e. a sea creature can only be summoned on water).

16-05-2009, MrSugarCube (Script pack)
- Updated: sphere_msgs.scp (Added msg_summon_invalidtarg defmessage)

18-05-2009, MrSugarCube
- Added #1466: MAGICF_NOFIELDSOVERWALLS flag to enable additional checks when casting field spells to
prevent them from passing through blocking objects (CAN_I_BLOCK and/or CAN_I_DOOR).

20-05-2009, MrSugarCube
- Added #1604: PROMPTCONSOLEU function. This is an alternative to the PROMPTCONSOLE which enables the
client to respond with unicode text.
- Added: SYSMESSAGELOCEX, an extended version of SYSMESSAGELOC which can be used for sending localized
messages to clients with a non-localized string attached to the start or end of the message. SMSGLEX
can also be used as a shortcut.
Syntax is: "SYSMESSAGELOCEX color,clilocid,flags,affix[,arguments]"
All arguments must be separated by a comma ",". Specify -1 for color if you do not wish to override
it. Known possible values for flags are:
0x00 = Append text to message
0x01 = Prepend text to message
0x02 = Forces message to show as a system message
A couple of examples of this being used (latest clilocs) are:
"SYSMESSAGELOCEX -1,1008078,01,MrSugarCube" - Displays "MrSugarCube : Attempting to heal you."
"SYSMESSAGELOCEX -1,3002003,00,Smoking is bad for your health" - Displays "Note to self: Smoking is bad for your health"
For overriding messages in sphere_msgs.scp (or other message functions such as SAY and MESSAGE) the
syntax "@hue,font,3 clilocid,flags,affix[,arguments]" can be used, for example:
"SAY @022,,3 1008097,01,MrSugarCube" - Object says "MrSugarCube : poisoned you!" in red

30-05-2009, Nazghul
- Fixed: @GetHit always gave damagetype type (argn2) 0C02 (physical | slash | pierce). Now the type is set
to dam_physical, dam_slash or dam_pierce is added depending on weapon type (wrestling and mace weapons
don't set extra flags).
- Added: TAG.OVERRIDE.DAMAGETYPE for weapon type items. Holds a numerical value and overrides the
type specific damage type.

20-06-2009, MrSugarCube
- Fixed #1617: Dispel and Mass Dispel spells sending an unnecessary full client update to all players
touched by the spell.

21-06-2009, MrSugarCube
- Added #1627: PlayerEvil setting to Sphere.ini. Similar to the PlayerNeutral setting, this
will control the karma level at which a player will be considered evil.

25-07-2009, MrSugarCube
- Added: Support for packet changes found in client 6.0.14.2.

02-08-2009, MrSugarCube
- Fixed #1636: Exception caused when an online player character is deleted.
- Fixed #1639: Tooltips not being sent for objects on the edge of the client's screen.

29-08-2009, MrSugarCube
- Fixed: Unable to drop 'new' spell scrolls (necro+) into spellbooks even when MOREZ has
been correctly set on the book.
- Fixed: Incorrect character race being sent to clients.

30-08-2009, MrSugarCube
- Fixed #1625: Extremely high vendor prices on Linux build.
- Fixed: Archery buttes not checking for OVERRIDE.AMMOTYPE and OVERRIDE.ANIM* tags on the
character's weapon.
- Modified #1642: Reduced delay between asynchronous database query callbacks.
- Added: Skill flag SKF_RANGED. Combine this with the SKF_FIGHT flag to create ranged
(i.e. archery) combat skills.

30-08-2009, MrSugarCube (Script pack)
- Updated: sphere_defs.scp (Added SKF_RANGED definition)

07-09-2009, MrSugarCube
- Added: Console command "d ui" to generate a file named "unscripted_items.scp" that
contains *basic* definitions for items in tiledata.mul that have no corresponding
Sphere script.

12-09-2009, MrSugarCube
- Fixed #1623: RESTEST requiring 1 of an item when checking for a quantity of 0. This also
affects other resource-list-based functions and properties such as CONSUME, FOODTYPE,
RESOURCES, SKILLMAKE, SKILLTEST, etc.
- Fixed #1655: Setting RAINCHANCE and COLDCHANCE to zero does did not disable rain or snow.
- Modified: When loading a WORLD* block from a save Sphere can resolve defnames to find the
object being loaded (like the ones in sphere_backward_compatibility.scp, for example).

12-09-2009, Coruja (Script pack)
- Updated #1645: sphere_template_vend.scp, sphere_item_resources.scp, spherechar_human.scp,
sphere_item_provisions_potions.scp, sphere_backward_compatibility.scp (Corrected spelling
of the wyrm heart defname (i_reag_worm_heart->i_reag_wyrm_heart))
- Updated #1654: sphere_defs.scp (Adjusted height of the Meer characters)

13-09-2009, MrSugarCube
- Fixed #1595: @Destroy trigger not being fired for items inside removed containers. When
returning 1 in @Destroy on an item inside a container about to be deleted, the item will
be dropped to the ground (unless the item has already been moved elsewhere).
- Fixed #1656: Exception when players trade and item 01e5e has not been set as a container
type.
</spherescript>

[[Category: Articles]]

Special Items

2009-08-30T02:04:30Z

MrSugarCube: Corrected description of BODY property.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PIN]]''.n'' [[PIN]] ''x, y'' || RW || Gets the position of the ''nth'' pin (zero-based), or adds a pin to the map at the specified location.
|}

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

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

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

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

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

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

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

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

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

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

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

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

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

====Character Members====

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

====Item Members====

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

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

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

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

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

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[PRICE]] || RW || Gets or sets the price of the item.
|-
| [[QUALITY]] || RW || Gets or sets the quality of the item.
|}

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

AQUERY

2009-08-01T16:10:51Z

MrSugarCube: Created page with '__FORCETOC__ ==Description== This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to complete like the [[Q...'

__FORCETOC__

==Description==
This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to complete like the [[QUERY]] function). Once the query has been executed, a specified callback function will run.

Unlike the [[QUERY]] function, results are not stored in the [[ROW]] object. Instead they are passed in to the callback function as [[LOCAL]]s. The following table shows the differences between accessing the results for the two functions:

{| border="1" cellspacing="4" cellpadding="4"
| [[QUERY]] || [[AQUERY]]
|-
| [[ROW]].NUMROWS || LOCAL.NUMROWS
|-
| [[ROW]].NUMCOLS || LOCAL.NUMCOLS
|-
| [[ROW]].''row_index''.''col_index'' || LOCAL.''row_index''.''col_index''
|-
| [[ROW]].''row_index''.''col_name'' || LOCAL.''row_index''.''col_name''
|}

'''''Note 1''''': An open database connection is required for this function to work correctly. See the [[CONNECT]] function for information regarding the opening of a database connection.

'''''Note 2''''': The [[AQUERY]] and [[QUERY]] functions are intended to run SQL commands that return results (such as SELECT). For commands that do not return results consider using the [[AEXECUTE]] and [[EXECUTE]] functions.

Valid for the following objects:
* [[Database]]

==Syntax==
<tt>AQUERY ''function'', ''command''</tt>

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''Type''' || '''Description'''
|-
| ''function'' || string || A script function to call when the command has been executed.
{| cellspacing="4" cellpadding="4"
| '''Argument''' || '''Description'''
|-
| ''ARGN1'' || The type of command (0 = [[AEXECUTE]], 1 = [[AQUERY]])
|-
| ''ARGN2'' || 0 = Command failed, 1 = Command succeeded.
|-
| ''ARGS'' || The command that was executed.
|}
|-
| ''command'' || string || The SQL command to execute.
|}

==Return Values==
This function returns one of two values when executed. See the table below for the meanings of the return values:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || Command has not been successfully queued.
|-
| 1 || Command has been successfully queued.
|}

==Examples==

<spherescript>
//
// Queues an SQL query.
//
[FUNCTION f_aquery]
SERV.LOG Selecting some values in the background.
IF (<DB.AQUERY f_aquery_callback, SELECT 10 AS test1, 20 AS test2, 30 AS test3> == 0)
SERV.LOG Failed to queue command.
ELSE
SERV.LOG Command queued.
ENDIF
RETURN

//
// This function will be called when the query has been executed.
//
[FUNCTION f_aquery_callback]
IF (<ARGN2> == 0)
SERV.LOG The command failed to execute. (<ARGS>)
ELSE
SERV.LOG The command succeeded, <dLOCAL.NUMROWS> row(s) of data returned. (<ARGS>)
FOR 0 <EVAL <LOCAL.NUMROWS> - 1>
SERV.LOG #<EVAL <LOCAL._FOR> + 1>. <LOCAL.<dLOCAL._FOR>.test1>, <LOCAL.<dLOCAL._FOR>.test2>, <LOCAL.<dLOCAL._FOR>.test3>
ENDFOR
ENDIF
RETURN
</spherescript>

AEXECUTE

2009-08-01T15:45:08Z

MrSugarCube:

__FORCETOC__

==Description==
This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to complete like the [[EXECUTE]] function). Once the query has been executed, a specified callback function will run.

'''''Note 1''''': An open database connection is required for this function to work correctly. See the [[CONNECT]] function for information regarding the opening of a database connection.

'''''Note 2''''': The [[AEXECUTE]] and [[EXECUTE]] functions are intended to run SQL commands that do not return any results (such as DELETE or UPDATE). For commands that return results (that you want to then read back) see the [[AQUERY]] and [[QUERY]] functions.

Valid for the following objects:
* [[Database]]

==Syntax==
<tt>AEXECUTE ''function'', ''command''</tt>

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''Type''' || '''Description'''
|-
| ''function'' || string || A script function to call when the command has been executed.
{| cellspacing="4" cellpadding="4"
| '''Argument''' || '''Description'''
|-
| ''ARGN1'' || The type of command (0 = [[AEXECUTE]], 1 = [[AQUERY]])
|-
| ''ARGN2'' || 0 = Command failed, 1 = Command succeeded.
|-
| ''ARGS'' || The command that was executed.
|}
|-
| ''command'' || string || The SQL command to execute.
|}

==Return Values==
This function returns one of two values when executed. See the table below for the meanings of the return values:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || Command has not been successfully queued.
|-
| 1 || Command has been successfully queued.
|}

==Examples==

<spherescript>
//
// Queues up an SQL command.
//
[FUNCTION f_execute]
SERV.LOG Deleting all rows from table 'tbl_name'.
IF (<DB.AEXECUTE f_execute_callback, DELETE FROM tbl_name> == 0)
SERV.LOG Failed to queue command.
ELSE
SERV.LOG Command queued.
ENDIF
RETURN

//
// This function will be called when the query has been executed.
//
[FUNCTION f_execute_callback]
IF (<ARGN2> == 0)
SERV.LOG The command failed to execute. (<ARGS>)
ELSE
SERV.LOG The command succeeded. (<ARGS>)
ENDIF
RETURN
</spherescript>

AEXECUTE

2009-08-01T15:44:48Z

MrSugarCube: Created page with ''''''wip''''' __FORCETOC__ ==Description== This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to comple...'

'''''wip'''''

__FORCETOC__

==Description==
This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to complete like the [[EXECUTE]] function). Once the query has been executed, a specified callback function will run.

'''''Note 1''''': An open database connection is required for this function to work correctly. See the [[CONNECT]] function for information regarding the opening of a database connection.

'''''Note 2''''': The [[AEXECUTE]] and [[EXECUTE]] functions are intended to run SQL commands that do not return any results (such as DELETE or UPDATE). For commands that return results (that you want to then read back) see the [[AQUERY]] and [[QUERY]] functions.

Valid for the following objects:
* [[Database]]

==Syntax==
<tt>AEXECUTE ''function'', ''command''</tt>

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''Type''' || '''Description'''
|-
| ''function'' || string || A script function to call when the command has been executed.
{| cellspacing="4" cellpadding="4"
| '''Argument''' || '''Description'''
|-
| ''ARGN1'' || The type of command (0 = [[AEXECUTE]], 1 = [[AQUERY]])
|-
| ''ARGN2'' || 0 = Command failed, 1 = Command succeeded.
|-
| ''ARGS'' || The command that was executed.
|}
|-
| ''command'' || string || The SQL command to execute.
|}

==Return Values==
This function returns one of two values when executed. See the table below for the meanings of the return values:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || Command has not been successfully queued.
|-
| 1 || Command has been successfully queued.
|}

==Examples==

<spherescript>
//
// Queues up an SQL command.
//
[FUNCTION f_execute]
SERV.LOG Deleting all rows from table 'tbl_name'.
IF (<DB.AEXECUTE f_execute_callback, DELETE FROM tbl_name> == 0)
SERV.LOG Failed to queue command.
ELSE
SERV.LOG Command queued.
ENDIF
RETURN

//
// This function will be called when the query has been executed.
//
[FUNCTION f_execute_callback]
IF (<ARGN2> == 0)
SERV.LOG The command failed to execute. (<ARGS>)
ELSE
SERV.LOG The command succeeded. (<ARGS>)
ENDIF
RETURN
</spherescript>

Category:Statements

2009-07-11T12:22:12Z

MrSugarCube:

{| border="1" cellspacing="4" cellpadding="4"
| '''Statement''' || '''End Statement''' || '''Description'''
|-
| [[BEGIN]] || END || Groups a set of lines together, for use with [[DORAND]] and [[DOSWITCH]] statements.
|-
| [[DORAND]] ''line_count'' || ENDDO || Executes a random line of code within the block.
|-
| [[DOSWITCH]] ''line_number'' || ENDDO || Executes the specified line of code within the block.
|-
| [[FOR]] ''start end'' || ENDFOR || Loops through the block of code
|-
| [[FORCHARLAYER]] ''layer_id'' || ENDFOR || Loops through all items that a character has equipped on a specified layer.
|-
| [[FORCHARMEMORYTYPE]] ''memory_flags'' || ENDFOR || Loops through all memory items on a character that have one of the specified flags.
|-
| [[FORCHARS]] ''distance'' || ENDFOR || Loops through all characters within ''distance'' tiles.
|-
| [[FORCLIENTS]] ''distance'' || ENDFOR || Loops through all connected clients within ''distance'' tiles.
|-
| [[FORCONT]] ''container_uid, max_subcontainers'' || ENDFOR || Loops through all items inside a container.
|-
| [[FORCONTID]] ''item_id, max_subcontainers'''' || ENDFOR || Loops through all items inside a container with a specified [[BASEID]]
|-
| [[FORCONTTYPE]] ''type, max_subcontainers'' || ENDFOR || Loops through all items inside a container with a specified [[TYPE]]
|-
| [[FORINSTANCES]] ''defname'' || ENDFOR || Loops through all instances of characters or items with the specified [[BASEID]]
|-
| [[FORITEMS]] ''distance'' || ENDFOR || Loops through all items within ''distance'' tiles.
|-
| [[FOROBJS]] ''distance'' || ENDFOR || Loops through all items and players within ''distance'' tiles.
|-
| [[FORPLAYERS]] ''distance'' || ENDFOR || Loops through all players (online and offline) within ''distance'' tiles.
|-
| [[IF]] ''condition'' [[IF|ELIF]] ''condition'' [[IF|ELSEIF]] ''condition'' || ENDIF || Executes the block of code if ''condition'' is true.
|-
| [[WHILE]] ''condition'' || ENDWHILE || Loops through the block of code whilst ''condition'' is true.
|}

[[Category: Reference Compendium]]
[[Category: Scripts]]

Error Codes

2009-06-25T21:10:29Z

MrSugarCube: Created page with '__FORCETOC__ ==Exit Codes== When Sphere closes, an 'exit code' will normally be shown in the console to describe why it is being shut down. In general, an exit code less than 0 i...'

__FORCETOC__
==Exit Codes==
When Sphere closes, an 'exit code' will normally be shown in the console to describe why it is being shut down. In general, an exit code less than 0 is considered to be an error code, and values above 0 are normal shutdown codes. In most cases, a more descriptive error will be shown in the console and/or log file to help better diagnose the reason behind error codes.

The following table lists all of the current codes and their meanings.

{| border="1" cellpadding="3"
| '''Code''' || '''Description'''
|-
| -10 || Unexpected error occurred
|-
| -9 || Failed to bind server port
|-
| -8 || Failed to load world save(s)
|-
| -3 || Failed to load server settings (script, ini, mul files)
|-
| -1 || Shutdown via commandline (/?, /T and /Q switches)
|-
| 1 || X in console ''or'' SIGHUP signal, terminal closed (Linux Only)
|-
| 2 || SHUTDOWN command
|-
| 4 || Service shutdown ''(Windows Only)''
|-
| 5 || Console window closed ''(Windows Only)''
|-
| 6 || SIGABRT signal, process aborted ''(Linux Only)''
|}

==Garbage Collection==
The purpose of garbage collection is to validate all of the server objects and free up unused UIDs. Garbage collection is initiated:
* After the world save is loaded at startup.
* Before a world save begins, if the [[FORCEGARBAGECOLLECT]] setting is enabled in Sphere.ini.
* After the [[IMPORT]] or [[RESTORE]] functions have been used on the [[Server|server]] object.
* When the 'G' command is entered via the Sphere console
* When the [[GARBAGE]] function is used on the [[Server|server]] object.

When garbage collection encounters a problem with an object it may attempt to automatically correct the error, otherwise the object will be removed. When an object is removed by garbage collection there will normally be an error shown in the console describing the item that was removed along with the reason. The following table lists all of the garbage collection codes along with their description:

{| border="1" cellpadding="3"
| '''Code''' || '''Description'''
|-
| 1102 || Disconnected character not acting as such.
|-
| 1103 || NPC with STATF_Ridden does not have the correct action set.
|-
| 1104 || Ridden NPC without a mount item.
|-
| 1105 || Ridden NPC with a mount item that is not linked to them.
|-
| 1106 || Disconneced NPC neither dead or ridden.
|-
| 1107 || Ingame character that is neither a player or an NPC.
|-
| 1108 || Character not on a valid position.
|-
| 1203 || NPC with STATF_Ridden does not have the correct action set.
|-
| 1204 || Ridden NPC without a mount item.
|-
| 1205 || Ingame character that is neither a player or an NPC.
|-
| 2102 || Item without an ITEMDEF.
|-
| 2103 || Item ITEMDEF with an ID of 0.
|-
| 2104 || Disconnected item.
|-
| 2105 || Item not on a valid position.
|-
| 2106 || Item flagged as being in a container but it isn't.
|-
| 2202 || Item flagged as equipped but it isn't.
|-
| 2205 || Item's LINK property is set to itself or a UID that doesn't exist.
|-
| 2206 || GM Robe or Deathshroud not on a character.
|-
| 2207 || Deathshroud not on a dead character.
|-
| 2208 || GM Robe on a character without privileges.
|-
| 2220 || Trade window memory not equipped in the correct layer, or not equipped to a player.
|-
| 2221 || Client linger memory not equipped in the correct layer, or not equipped to a player.
|-
| 2222 || Memory not equipped or is not a real memory.
|-
| 2226 || Mount memory not equipped in the correct layer.
|-
| 2227 || Hair or beard item is not equipped, not in a corpse, and not in a vendor box.
|-
| 2228 || Hair or beard item is equipped, but not in the correct layer.
|-
| 2229 || Game piece not in a container.
|-
| 2230 || Item equipped in layer_none but it isn't a trade window.
|-
| 2231 || Item equipped in layer_special but it isn't a memory or script type.
|-
| 2233 || Item equipped in layer_horse but it isn't a mount memory.
|-
| 2234 || Item equipped in the client linger layer but it isn't a client linger memory.
|-
| 2235 || Item equipped in the murder memory layer but it isn't a murder memory.
|-
| 2236 || Item flagged as decay but without timer set.
|-
| 3101 || Object is totally lost, no parent exists.
|-
| 3102 || Object was deleted or UID is incorrect.
|-
| 3201 || More than one object with the same UID.
|-
| 4222 || Memory item is not equipped, not in the memory layer, or without colour
|-
| 4223 || Memory not on a character.
|-
| 4224 || Guild/town memory does not link to the character's town/guild.
|-
| 4225 || Guild/town memory linked to a stone, but the character is not a member.
|-
| 7101 || Object's UID does not match up with server's UID table.
|-
| 7102 || Object does not exist.
|-
| FFFF || Bad memory allocation (unknown error occured).
|}

Main Page

2009-06-25T21:10:15Z

MrSugarCube:

Welcome to the retake of Taran's famous "[http://www.cs.rit.edu/~djr7581/ Sphere Scripting for Dummies tutorials]" and information. His tutorial was made for Sphere 55i, but now that Sphere 56b is about to be released we have decided to rewrite his tutorials and update the information to reflect the latest changes and additions.

'''Where should I start?'''

If you want to learn to script for Sphere 56b you should start by first reading the [[#Setting Up Sphere|Setting Up Sphere]] section. It will teach you how to set up a basic empty world to start your path. After that you should try reading the [[#Tutorials|Tutorials]], go slow, don't try to go through everything in one day as it takes time to read and fully understand everything.

'''I learned how to script! And now?'''

If you have finished the 10 chapters then we encourage you to read the tutortials and other articles below. They may not be as important as the others but they are still quite useful and contain lots of useful information. Try making your own scripts and share with others at the [http://www.sphereserver.net/index.php SphereServer Forums]. You can also ask for help if you can't resolve something by yourself. Remember to use the [[#Reference Compendium|Reference Compendium]] below as it is really useful.

'''I want to contribute!'''

Maintaining the information on this site involves a huge amount of work and not many of us have the time to do it. If you wish to help out then please feel free to do so! All you need to do to get started is [[Special:UserLogin|create an account]] if you haven't done so already. You can then edit any page by using the "Edit" link in the rop right corner. Before you go do this, you may want to start by reading the [[Contribution Guide]].

'''Special thanks to:'''

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

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

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

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

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

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

----

==Setting up Sphere==

* [[Where to get Sphere]]
* [[Installing Sphere]]
* [[Configuring Sphere.ini]]

==Tutorials==

Here are the chapters of Taran's original compendium, updated for Sphere56b:

* [[Chapter 1]] ''(Numbers, DEFNAME, ITEMDEF, CHARDEF)''
* [[Chapter 2]] ''(Sphere files explained)''
* [[Chapter 3]] ''(Scripting NPC's and items, Cool commands)''
* [[Chapter 4]] ''(Objects, operators, speech)''
* [[Chapter 5]] ''(Tags, Vars, Locals, Functions)''
* [[Chapter 6]] ''(LINKs, TIMERs, TARGETs)''
* [[Chapter 7]] ''(Loops and powerful functions)''
* [[Chapter 8]] ''(SKILLMENUs, MENUs, Gumps)''
* [[Chapter 9]] ''(Events)''
* [[Chapter 10]] ''(String Handling)''

In addition to these there are some more advanced tutorials that have been contributed by other members. Once you have read the above 10 tutorials you may wish to read these to learn more:

* [[Common Mistakes|Common Mistakes Explained]] ''(A revision of Maximus's tutorial on the forums, and continuation of Taran's Misconceptions tutorial)''
* [[Internet and Sphere]] ''(And how to make the right use of them)''
* [[Languages Tutorial]] ''(How to script your own language system)''
* [[Making your own Skills]] ''(How to make and customize your skill)''
* [[Mul Patching Tutorial|Nazghul's Mul Patching Tutorial]] [http://sorea.profitux.cz/patching/ external link] ''(A document about mul patching and customizing your server)''
* [[Overriding Hardcoded Commands]] ''(How to override hardcoded commands and functions)''
* [[Scheduled Reboot]] ''(How to schedule system reboots)''
* [[Using MySQL]] ''(How to use MySQL)''

==Reference Compendium==

* [[:Category:Definitions|Definitions]]
** [[CHARDEF|Characters]]
** [[DIALOG|Dialogs]]
** [[EVENTS|Events]]
** [[ITEMDEF|Items]]
** [[MENU|Menus]]
** [[REGIONRESOURCE|Region Resources]]
** [[REGIONTYPE|Region Types]]
** [[AREADEF|Regions]]
** [[ROOMDEF|Rooms]]
** [[SKILLCLASS|Skill Classes]]
** [[SKILLMENU|Skill Menus]]
** [[SKILL|Skills]]
** [[SPELL|Spells]]
** [[TYPEDEF|Types]]
* [[:Category:Objects|Objects]]
** [[Accounts]]
** [[Characters]]
** [[Database]]
** [[Files]]
** [[GM Pages]]
** [[Items]]
*** [[Special Items]]
** [[Map Points]]
** [[Parties]]
** [[Regions]]
** [[Rooms]]
** [[Sectors]]
** [[Server]]
* [[:Category:Scripts|Scripts]]
** [[:Category:Functions|Functions and Triggers]]
** [[:Category:Variables|General Functions, Properties and References]]
** [[Intrinsic Functions]]
** [[:Category:Statements|Statements]]

==Other Articles==

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

==External Links==

* [http://www.sphereserver.net/ Official SphereServer Website]
* [http://prerelease.sphereserver.net/ Official Sphere 56b Downloads]
* [http://scriptsharing.dv-team.de/ ScriptSharing]
* [http://spherewiki.99k.org/index.php/Portada SphereWiki (Español/Spanish)]
* [http://www.cs.rit.edu/~djr7581/ Taran's Scripting for Dummies (Sphere 55i)]
* [http://scriptsharing.dv-team.de/docs/packet_doc.html UO Packet Guide]

[[Category: Navigation]]

Items

2009-06-25T19:21:53Z

MrSugarCube: CONTP is not a reference to another object but an item property (see Properties and Functions section)

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[CONT]] || RW || Gets or sets the [[Characters|character]] or [[Special Items#Containers|container item]] that the object is inside.
|-
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to.
|-
| [[REGION]] || R || Gets the [[Regions|region]] that the object is in.
|-
| [[ROOM]] || R || Gets the [[Rooms|room]] that the object is in.
|-
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the object is at.
|-
| [[SECTOR]] || R || Gets the [[Sectors|sector]] that the object is in.
|-
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the item.
|-
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[ITEMDEF]] that defines the item.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ADDCIRCLE]] ''spell_circle'' || W || Adds all of the spells in the given circle to the spellbook.
|-
| [[ADDSPELL]] ''spell_id'' || RW || Gets whether or not a spell exists in the spellbook, or adds a spell to the spellbook.
|-
| [[AMOUNT]] || RW || Gets the amount of this items this item represent (e.g. a pile of gold).
|-
| [[ATTR]] || RW || Gets or sets the item's attribute flags.
|-
| [[BOUNCE]] || W || Moves the item to SRC's backpack.
|-
| [[CANSEE]] || R || Returns 1 if SRC can see the item.
|-
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the item.
|-
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the item, with flags to modify what tests take place.
|-
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the item that start with the given prefix.
|-
| [[COLOR]] || RW || Gets or sets the object's hue.
|-
| [[CONSUME]] ''amount'' || W || Deducts an amount from the item, deleting it at 0.
|-
| [[CONTCONSUME]] ''resource_list'' || W || Deletes items from inside the container.
|-
| [[CONTGRID]] || RW || If in a container, gets or sets the grid number that the item occupies (in KR's grid view)
|-
| [[CONTP]] || RW || Gets or sets the position of the item within its container.
|-
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the item.
|-
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.
|-
| [[DECAY]] ''time'' || W || Sets the decay timer for the item.
|-
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.
|-
| [[DISPID]] || RW || Gets or sets the ID that the item will appear as to players.
|-
| [[DISPIDDEC]] || RW || Same as [[DISPID]], except it returns the ID as a decimal number.
|-
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.
|-
| [[DMGCOLD]] || RW || Gets or sets the amount of cold damage the weapon will give.
|-
| [[DMGENERGY]] || RW || Gets or sets the amount of energy damage the weapon will give.
|-
| [[DMGFIRE]] || RW || Gets or sets the amount of fire damage the weapon will give.
|-
| [[DMGPOISON]] || RW || Gets or sets the amount of poison damage the weapon will give.
|-
| [[DROP]] || W || Drops the item to the ground.
|-
| [[DUPE]] || W || Clones the item.
|-
| [[EDIT]] || W || Displays an editing dialog for the item to SRC.
|-
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.
|-
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.
|-
| [[EQUIP]] || W || Equips the item to SRC.
|-
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.
|-
| [[FIX]] || W || Re-aligns the item's Z level to ground level.
|-
| [[FLIP]] || W || Rotates the item.
|-
| [[FRUIT]] || RW || Gets or sets the fruit that will be produced by the crops.
|-
| [[HEIGHT]] || R || Gets the height of the item.
|-
| [[HITS]] || RW || Gets or sets the number of hitpoints the item has.
|-
| [[HITPOINTS]] || RW || Gets or sets the number of hitpoints the item has.
|-
| [[ID]] || RW || Gets or sets the ID of the item.
|-
| [[INFO]] || W || Displays an information dialog about the item to SRC.
|-
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.
|-
| [[ISCHAR]] || R || Returns 1 if the object is a character.
|-
| [[ISCONT]] || R || Returns 1 if the object is a container.
|-
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.
|-
| [[ISITEM]] || R || Returns 1 if the object is an item.
|-
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.
|-
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.
|-
| [[ISPLAYER]] || R || Returns 1 if the object is a player.
|-
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.
|-
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.
|-
| [[LAYER]] || RW || Gets or sets the layer that the item occupies when equipped.
|-
| [[MAP]] || RW || Gets or sets the map that this object is located.
|-
| [[MAXHITS]] || RW || Gets or sets the maximum number of hitpoints the item can have.
|-
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.
|-
| [[MESSAGE]] ''message'' || W || Displays a message above this item to SRC.
|-
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this item to SRC.
|-
| [[MODAR]] || RW || Gets or sets a modifier for the item's armour rating.
|-
| [[MORE1]] || RW || Gets or sets the MORE1 value for the item.
|-
| [[MORE1H]] || RW || Gets or sets the upper 4 bytes of the item's MORE1 value.
|-
| [[MORE1L]] || RW || Gets or sets the lower 4 bytes of the item's MORE1 value.
|-
| [[MORE2]] || RW || Gets or sets the MORE2 value for the item.
|-
| [[MORE2H]] || RW || Gets or sets the upper 4 bytes of the item's MORE2 value.
|-
| [[MORE2L]] || RW || Gets or sets the lower 4 bytes of the item's MORE2 value.
|-
| [[MOREM]] || RW || Gets or sets the MOREM value for the item.
|-
| [[MOREX]] || RW || Gets or sets the MOREX value for the item.
|-
| [[MOREY]] || RW || Gets or sets the MOREY value for the item.
|-
| [[MOREZ]] || RW || Gets or sets the MOREZ value for the item.
|-
| [[MOREP]] || RW || Gets or sets the MOREP value for the item.
|-
| [[MOVE]] ''direction, amount'' [[MOVE]] ''x y'' || W || Moves the object relative to its current position.
|-
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the object to a random location near another object within a certain distance.
|-
| [[MOVETO]] ''location'' || W || Moves the object to a specific location.
|-
| [[NAME]] || RW || Gets or sets the object's name.
|-
| [[NUDGEDOWN]] ''amount'' || W || Decreases the object's Z level.
|-
| [[NUDGEUP]] ''amount'' || W || Increases the object's Z level.
|-
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.
|-
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.
|-
| [[REMOVE]] || W || Deletes the object.
|-
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.
|-
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.
|-
| [[SAY]] ''message'' || W || Makes the object speak a message.
|-
| [[SAYU]] ''message'' || W || Makes the object speak a UTF-8 message
|-
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the object speak a UNICODE message.
|-
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.
|-
| [[SERIAL]] || R || Gets the item's unique ID in the world.
|-
| [[SEXTANTP]] ''location'' || R || Converts the item's location or a specified location into sextant coordinates.
|-
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this object.
|-
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the item to be affected by a spell.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.
|-
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.
|-
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.
|-
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.
|-
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.
|-
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.
|-
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.
|-
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.
|-
| [[TIMERF]] CLEAR || W || Clears all scheduled functions from the object.
|-
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.
|-
| [[TYPE]] || RW || Gets or sets the item type.
|-
| [[UID]] || R || Gets the item's unique ID in the world.
|-
| [[UNEQUIP]] || W || Unequips the item and places it in SRC's backpack.
|-
| [[UPDATE]] || W || Updates the state of the item to nearby clients.
|-
| [[UPDATEX]] || W || Updates the state of the item to nearby clients, removing it from their view first to ensure a full refresh.
|-
| [[USE]] ''check_los'' || W || Uses the item, as if SRC had double clicked it.
|-
| [[USEITEM]] || W || Double clicks the item, with SRC as the source of the event, without checking for line of sight.
|-
| [[WEIGHT]] || R || Gets the weight of the item.
|-
| [[Z]] || R || Gets the Z position of the item.
|}

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

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

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

Regions

2009-06-25T19:21:51Z

MrSugarCube: Corrected description of the region's TYPE property.

__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.
|-
| [[@Step]] || Fires whenever a character takes a step within the region.
|}

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

WhoIsWho

2009-06-20T12:46:48Z

MrSugarCube: Created page with 'Just to give you an impression about who is who of the contributors of this website, here's a small image gallery. <tt>All pictures were taken from public sources. So if <br /...'

Just to give you an impression about who is who of the contributors of this website, here's a small image gallery.

<tt>All pictures were taken from public sources. So if 
you find your picture here accidentally and want it removed, 
just drop me a mail to nazghul AT dv-team DOT de. 

The same applies if you would be kind enough to provide a 
photography of yourself to this page - just drop it into a 
mail at the same mail address as above. </tt>

{| cellpadding="5"
| http://www.lostland.de/swiki/bladecraft.jpg
[http://www.sphereserver.net/index.php?showuser=30593 Admin BladeCraft]
| http://www.lostland.de/swiki/cloudBR.jpg
[http://www.sphereserver.net/index.php?showuser=24106 ClouD_BR]
| http://www.lostland.de/swiki/furio.jpg
[http://www.sphereserver.net/index.php?showuser=23903 Furio]
| http://www.lostland.de/swiki/Jdog.jpg
[http://www.sphereserver.net/index.php?showuser=9131 Jdog]
|-
| http://www.lostland.de/swiki/maximus.jpg
[http://www.sphereserver.net/index.php?showuser=5247 Maximus]
| http://www.lostland.de/swiki/pyromapes.jpg
[http://www.sphereserver.net/index.php?showuser=6022 Pyromapes]
| http://www.lostland.de/swiki/rattle.jpg
[http://www.sphereserver.net/index.php?showuser=25714 Rattlehead]
| http://www.lostland.de/swiki/saciBR.jpg
[http://www.sphereserver.net/index.php?showuser=29706 SaCi_BR]
|}

ROOMDEF

2009-06-20T12:21:39Z

MrSugarCube:

__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.
|-
| [[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.
|-
| [[UNDERGROUND]] || RW || Gets or sets whether or not the room is considered to be underground.
|}

==Examples==

<spherescript>
//
// A House in Minoc, from the default script pack.
//
[ROOMDEF a_house_1]
EVENTS=r_default,r_default_rock,r_default_water,r_default_tree,r_default_grass
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]
EVENTS=r_default,r_default_rock,r_default_water,r_default_tree,r_default_grass
NAME=Secret Cave
GROUP=Hidden Valley
P=1653,2967,0,0
RECT=1648,2957,1658,2977,0
</spherescript>

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

AREADEF

2009-06-20T12:21:37Z

MrSugarCube:

__FORCETOC__
Areas in the world, such as dungeons and cities are defined by regions. Regions are constructed from one or more "rectangles" on the map.

The basic syntax for definining a region is as follows:

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

==Properties==
Within the region 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 region.
|-
| [[ARENA]] || RW || Gets or sets whether or not the region is considered to be an arena.
|-
| [[BUILDABLE]] || RW || Gets or sets whether or not players can place buildings and ships in the region.
|-
| [[EVENTS (Property)|EVENTS]] ''regiontype_defname'' || W || Adds a region event to the region.
|-
| [[FLAGS]] || RW || Gets or sets the region's attributes.
|-
| [[GATE]] || RW || Gets or sets whether or not casting the gate travel spell is allowed in the region.
|-
| [[GROUP]] || RW || Gets or sets a group name for the region.
|-
| [[GUARDED]] || RW || Gets or sets whether or not guards can be called within the region.
|-
| [[MAGIC]] || RW || Gets or sets whether or not there is an anti-magic field in the region.
|-
| [[MARK]] || RW || Gets or sets whether or not casting the mark spell is allowed in the region.
|-
| [[NAME]] || RW || Gets or sets the name of the region.
|-
| [[NOBUILD]] || RW || Gets or sets whether or not players can place buildings in the region.
|-
| [[NODECAY]] || RW || Gets or sets whether or not items will decay in the region.
|-
| [[NOPVP]] || RW || Gets or sets whether or not PvP combat is allowed in the region.
|-
| [[P]] || RW || Gets or sets the location of the region (used when using the [[GO]] command).
|-
| [[RECALL]] || RW || Gets or sets whether or not casting the recall spell is allowed in the region.
|-
| [[RECALLIN]] || RW || Gets or sets whether or not it is possible to use the recall spell to enter the region.
|-
| [[RECALLOUT]] || RW || Gets or sets whether players can recall out of the region.
|-
| [[RECT]] ''left, top, right, bottom, map'' || W || Adds a rectangle to the region definition.
|-
| [[RESOURCES]] ''regiontype_defname'' || W || Adds a region event to the region.
|-
| [[SAFE]] || RW || Gets or sets whether or not the region is a safe zone.
|-
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.
|-
| [[UNDERGROUND]] || RW || Gets or sets whether or not the region is considered to be underground.
|}

==Examples==

<spherescript>
//
// The world region from the default script pack.
//
[AREADEF a_world]
EVENTS=r_default,r_default_rock,r_default_water,r_default_tree,r_default_grass
NAME=Felucca
GROUP=ALLMAP
P=1323,1624,55,0
RECT=0,0,7168,4096,0
</spherescript>

<spherescript>
//
// Lord British's Castle from the default script pack.
//
[AREADEF a_lord_britishs_castle_1]
EVENTS=r_default,r_default_rock,r_default_water,r_default_tree,r_default_grass
NAME=Lord British's Castle
GROUP=Britain
FLAGS=0648e
P=1392,1625,30,0
RECT=1294,1679,1411,1697,0
RECT=1295,1559,1313,1577,0
RECT=1392,1559,1410,1577,0
RECT=1302,1577,1410,1680,0
RECT=1313,1563,1392,1577,0
EVENTS=r_brit_castle
TAG.GUARDOWNER=Lord British's Personal
</spherescript>

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

Category:Triggers

2009-06-20T12:18:30Z

MrSugarCube: Created page with ' ==Characters== Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples. {| border="1" ce...'

==Characters==
Here is a list of all [[Characters|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.
|-
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.
|-
| [[@HouseDesignExit]] || Fires when the character exits house design mode.
|-
| [[@Hunger]] || Fires when the character's food level decreases.
|-
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.
|-
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.
|-
| [[@ItemClick]] || Fires when the character single-clicks an item.
|-
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.
|-
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.
|-
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.
|-
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.
|-
| [[@ItemDamage]] || Fires when the character damages an item.
|-
| [[@ItemDClick]] || Fires when the character double-clicks an item.
|-
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.
|-
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.
|-
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.
|-
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.
|-
| [[@ItemEquip]] || Fires when the character equips an item.
|-
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.
|-
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.
|-
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.
|-
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.
|-
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.
|-
| [[@ItemSell]] || Fires when the character sells an item to a vendor.
|-
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.
|-
| [[@ItemStep]] || Fires when the character steps on an item.
|-
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.
|-
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.
|-
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.
|-
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.
|-
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.
|-
| [[@ItemUnEquip]] || Fires when the character unequips an item.
|-
| [[@Jailed]] || Fires when the character is sent to jail.
|-
| [[@KarmaChange]] || Fires when the character's karma changes.
|-
| [[@Kill]] || Fires when the character kills another character.
|-
| [[@Login]] || Fires when the character logs in.
|-
| [[@Logout]] || Fires when the character logs out.
|-
| [[@Mount]] || Fires when the character mounts a ride.
|-
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.
|-
| [[@MurderMark]] || Fires when the character is about to gain a kill.
|-
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.
|-
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.
|-
| [[@NPCActFollow]] || Fires when the NPC follows another character.
|-
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.
|-
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.
|-
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.
|-
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.
|-
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.
|-
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].
|-
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.
|-
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.
|-
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.
|-
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.
|-
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).
|-
| [[@PersonalSpace]] || Fires when the character is stepped on.
|-
| [[@PetDesert]] || Fires when the character deserts its owner.
|-
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.
|-
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.
|-
| [[@UserBugReport]] || Fires when the player submits a bug report.
|-
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.
|-
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)
|-
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini
|-
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.
|-
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.
|-
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.
|-
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.
|-
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.
|-
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.
|-
| [[@UserSpecialMove]] || Fires when the player uses a special move.
|-
| [[@UserStats]] || Fires when the player opens the status window.
|-
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.
|-
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.
|-
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.
|}

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

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

==Region Resources==
Here is a list of all [[REGIONRESOURCE|region resource]] triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@ResourceTest]] || Fires when the resource is being considered for spawning.
|-
| [[@ResourceFound]] || Fires when the resource is spawned.
|}

==Regions==
Here is a list of all [[Regions|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.
|-
| [[@Step]] || Fires whenever a character takes a step within the region.
|}

==Skills==
The following table lists all of the triggers that can be placed under a skill definition. All of the triggers here have an equivalent @Skill trigger on the [[Characters|character]] object.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@Abort]] || Fires when a character aborts an attempt at using the skill.
|-
| [[@Fail]] || Fires when a character fails an attempt at using the skill.
|-
| [[@Gain]] || Fires when a character is given the chance to gain in the skill.
|-
| [[@PreStart]] || Fires when a character starts to use the skill, before any hardcoded behaviour takes place.
|-
| [[@Select]] || Fires when a character selects the skill from their skill menu.
|-
| [[@Start]] || Fires when a character starts to use the skill.
|-
| [[@Success]] || Fires when a character succeeds an attempt at using the skill.
|-
| [[@UseQuick]] || Fires when a character quickly uses the skill, without changing their [[ACTION]].
|}

==Spells==
The following table lists all of the triggers that can be placed under a spell definition. All of the triggers here have an equivalent @Spell trigger on the [[Characters|character]] object.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@Effect]] || Fires when a character or item is hit by the spell.
|-
| [[@Fail (Spell Trigger)|@Fail]] || Fires when a character fails to cast the spell.
|-
| [[@Select (Spell Trigger)|@Select]] || Fires when a character selects to cast the spell, or when Sphere checks if a character is capable of casting it.
|-
| [[@Start (Spell Trigger)|@Start]] || Fires when a character starts to cast the spell.
|-
| [[@Success (Spell Trigger)|@Success]] || Fires when a character successfully casts the spell.
|}

[[Category: Reference Compendium]]
[[Category: Functions]]

REGIONRESOURCE

2009-06-20T12:15:44Z

MrSugarCube:

__FORCETOC__
A region resource block defines a resource that can be found in a region.

==Properties==
The following properties are available when defining a region resource:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[AMOUNT]] || RW || Gets or sets the initial amount of the resource available when it spawns. Accepts multiple values to build a weighted range of difficulty values.
|-
| [[DEFNAME]] || W || Gets or sets the resource defname.
|-
| [[REAP]] || RW || Gets or sets the [[BASEID]] of the resource item.
|-
| [[REAPAMOUNT]] || RW || Gets or sets the amount of the resource that can be gathered in one use of a skill. Accepts multiple values to adjust based on skill level.
|-
| [[REGEN]] || RW || Gets or sets the length of time it takes for the resource to decay, in seconds.
|-
| [[SKILL (Region Resource Property)|SKILL]] || RW || Gets or sets the difficulty of gathering the resource. Accepts multiple values to build a weighted range of difficulty values.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@ResourceTest]] || Fires when the resource is being considered for spawning.
|-
| [[@ResourceFound]] || Fires when the resource is spawned.
|}

==Examples==
<spherescript>
//
// Fish resource from default script pack.
//
[REGIONRESOURCE mr_fish1]
SKILL=1.0,100.0 // requires between 1% and 100% skill to gather
AMOUNT=9,30 // between 9 and 30 fish available
REAP=i_fish_big_1 // the resource item
REGEN=60*60*10 // decays after 10 hours
</spherescript>

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

Characters

2009-06-20T12:14:01Z

MrSugarCube:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MediaWiki:Sidebar

2009-06-20T12:06:00Z

MrSugarCube:

Server

2009-06-20T12:04:48Z

MrSugarCube:

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ACCOUNT]]''.n'' || R || Gets the nth [[Accounts|account]] on the server. (zero-based)
|-
| [[ACCOUNT]]''.name'' || R || Gets the [[Accounts|account]] with the specified name.
|-
| [[AREA]]''.defname'' || R || Gets the [[Regions|region]] with the specified defname.
|-
| [[CHARDEF (Reference)|CHARDEF]]''.defname'' || R || Gets the [[CHARDEF|character definition]] for ''defname''.
|-
| [[CLIENT]]''.n'' || R || Gets the nth [[Characters#Clients|client]] on the server. '''Note:''' The nth client may not be an ingame player character, <CLIENT.n> first as it returns 1 for ingame clients and 0 for non-player clients.
|-
| [[GMPAGE]]''.n'' || R || Gets the nth [[GM Pages|GM page]] on the server.
|-
| [[GUILDSTONES]]''.n'' || R || Gets the nth [[Special Items#Guild.2FTown_Stones|guild stone]] on the server. (zero-based)
|-
| [[ITEMDEF (Reference)|ITEMDEF]]''.defname'' || R || Gets the [[ITEMDEF|item definition]] for ''defname''.
|-
| [[LASTNEWCHAR]] || R || Gets the last [[Characters|character]] created on the server.
|-
| [[LASTNEWITEM]] || R || Gets the last [[Items|item]] created on the server.
|-
| [[MAP]]''(x, y, map)'' [[MAP]]''(x, y, z, map)'' || R || Gets the [[Map Points|map point]] for a specified location.
|-
| [[REGIONRESOURCE (Reference)|REGIONRESOURCE]]''.defname'' || R || Gets the [[REGIONRESOURCE|region resource definition]] for ''defname''.
|-
| [[REGIONTYPE (Reference)|REGIONTYPE]]''.defname'' || R || Gets the [[REGIONTYPE|region type definition]] for ''defname''.
|-
| [[ROOM (Reference)|ROOM]]''.defname'' || R || Gets the [[Rooms|room]] with the specified defname.
|-
| [[SKILL (Reference)|SKILL]]''.defname'' || R || Gets the [[SKILL|skill definition]] for ''defname''.
|-
| [[SKILLCLASS (Reference)|SKILLCLASS]]''.defname'' || R || Gets the [[SKILLCLASS|skillclass]] for ''defname''.
|-
| [[SPELL (Reference)|SPELL]]''.defname'' || R || Gets the [[SPELL|spell definition]] for ''defname''.
|-
| [[SPELL (Reference)|SPELL]]''-n'' || R || Gets the nth [[SPELL|spell definition]], ordered by skill requirements (1-based, ascending).
|-
| [[TOWNSTONES]]''.n'' || R || Gets the nth [[Special Items#Guild.2FTown_Stones|town stone]] on the server. (zero-based)
|}

==Properties and Functions==
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. Settings from Sphere.ini can also be accessed from the server object, but they are not listed in this table.

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

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

Regions

2009-06-20T11:59:37Z

MrSugarCube:

__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 [[TYPE]] 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.
|-
| [[@Step]] || Fires whenever a character takes a step within the region.
|}

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

Items

2009-06-20T11:58:31Z

MrSugarCube:

Characters

2009-06-20T11:53:39Z

MrSugarCube:

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

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

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

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@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.
|-
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.
|-
| [[@HouseDesignExit]] || Fires when the character exits house design mode.
|-
| [[@Hunger]] || Fires when the character's food level decreases.
|-
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.
|-
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.
|-
| [[@ItemClick]] || Fires when the character single-clicks an item.
|-
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.
|-
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.
|-
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.
|-
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.
|-
| [[@ItemDamage]] || Fires when the character damages an item.
|-
| [[@ItemDClick]] || Fires when the character double-clicks an item.
|-
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.
|-
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.
|-
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.
|-
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.
|-
| [[@ItemEquip]] || Fires when the character equips an item.
|-
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.
|-
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.
|-
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.
|-
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.
|-
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.
|-
| [[@ItemSell]] || Fires when the character sells an item to a vendor.
|-
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.
|-
| [[@ItemStep]] || Fires when the character steps on an item.
|-
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.
|-
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.
|-
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.
|-
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.
|-
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.
|-
| [[@ItemUnEquip]] || Fires when the character unequips an item.
|-
| [[@Jailed]] || Fires when the character is sent to jail.
|-
| [[@KarmaChange]] || Fires when the character's karma changes.
|-
| [[@Kill]] || Fires when the character kills another character.
|-
| [[@Login]] || Fires when the character logs in.
|-
| [[@Logout]] || Fires when the character logs out.
|-
| [[@Mount]] || Fires when the character mounts a ride.
|-
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.
|-
| [[@MurderMark]] || Fires when the character is about to gain a kill.
|-
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.
|-
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.
|-
| [[@NPCActFollow]] || Fires when the NPC follows another character.
|-
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.
|-
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.
|-
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.
|-
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.
|-
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.
|-
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].
|-
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.
|-
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.
|-
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.
|-
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.
|-
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).
|-
| [[@PersonalSpace]] || Fires when the character is stepped on.
|-
| [[@PetDesert]] || Fires when the character deserts its owner.
|-
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.
|-
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|-
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.
|-
| [[@UserBugReport]] || Fires when the player submits a bug report.
|-
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.
|-
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)
|-
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini
|-
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.
|-
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.
|-
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.
|-
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.
|-
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.
|-
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.
|-
| [[@UserSpecialMove]] || Fires when the player uses a special move.
|-
| [[@UserStats]] || Fires when the player opens the status window.
|-
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.
|-
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.
|-
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.
|}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TYPEDEF

2009-06-20T11:49:17Z

MrSugarCube:

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

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

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

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

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

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

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

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

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