SphereWiki - User contributions [en]

@Hit

2014-09-13T17:48:36Z

Wuffel: /* Arguments */

{{Languages|@Hit}}

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

Fires on:
* [[Characters]]

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being dealt.
|-
| LOCAL.ARROW || I || UID of the arrow used (Archery only)
|-
| LOCAL.ARROWHANDLED || IO || if set to !=0, you can do whatever you want with local.arrow
|}

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

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

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

@HitMiss

2014-09-13T17:48:16Z

Wuffel: /* Arguments */

==Description==
This trigger fires when a character is about to miss a combat swing.

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]] who was missed.
|}

==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'''
|-
| LOCAL.ARROWHANDLED || IO || if set to !=0, you can do whatever you want with local.arrow
|}

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

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

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

@Hit

2014-09-13T17:33:52Z

Wuffel:

{{Languages|@Hit}}

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

Fires on:
* [[Characters]]

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

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

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being dealt.
|-
| LOCAL.ARROW || I || UID of the arrow used (Archery only)
|-
| LOCAL.ARROWHANDLED || IO || if set to !=0, no hardcoded action will be done to the local.arrow
|}

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

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

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

Chapter 7

2014-04-08T19:54:06Z

Wuffel: /* NEWDUPE */

{{Languages|Chapter_7}}

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

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

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

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

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

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

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

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

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

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

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

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

Then, in another script, we would execute this command: SRC.RECURSE_HELLO 35

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

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

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

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

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

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

==FOR==

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

Usage:

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

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

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

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

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

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

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

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

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

'''Result:''' 
On your screen you would see:

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

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

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

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

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

One example of a function using FORCHARS

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A basic example of a function using FORITEMS:

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

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

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

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

For example:

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

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

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

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

==TRY==

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

For example, we may have the following script:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==SERV==

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

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

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

Pretty simple, right?

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

Here's an example:

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

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

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

That's not too complex, is it?

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

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

And when you look at console it shows something like:

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

Easy and useful.

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

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

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

The KEY can be a number of things:

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

===NEWDUPE===
When you use the .DUPE command you can create a 'clone' of a targeted item. The NEWDUPE function allows this functionality to be reproduced within scripts.

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

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

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

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

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

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

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

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

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

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

Easy, uh?

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

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

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

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

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

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

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

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

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

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

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

[[Category:Tutorials]]

TARGETF

2014-04-05T14:33:04Z

Wuffel:

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

ex. targetf f_hello or targetf f_hello 1,2

In targetf:

SRC= player using the function

ARGO= target's UID

Remember that using ARGO doesn't work directly like SRC. I.e. src.name but you have to use it via UID as uid.<argo>.name.

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

CHARDEF

2014-04-05T14:32:12Z

Wuffel:

{{Languages|CHARDEF}}

__FORCETOC__

A CHARDEF block defines the basic properties of a [[Characters|character]].

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''
|-
| [[ANIM]] || RW || ?? || Gets or sets a mask of animations that the character supports. The default value is 0ffffff.
|-
| [[ARMOR]] || RW || ?? || Gets or sets the character's base defense without armour.
|-
| [[AVERSIONS]] || RW || ?? || Gets or sets a list of things that the character does not like.
|-
| [[BASEID]] || R || ?? || Gets the defname of the character if set, otherwise the ID.
|-
| [[BLOODCOLOR]] || RW || ?? || Gets or sets the character's blood colour (a value of -1 prevents the creature from bleeding at all.)
|-
| [[CAN]] || RW || ?? || Gets or sets attributes for the character. See can_flags in sphere_defs.scp.
|-
| [[COLOR]] || RW || ?? || Gets or sets the character colour.
|-
| [[DAM]] ''min,max'' || RW || ?? || Gets or sets the base damage that the character will deal without a weapon.
|-
| [[DAM]].LO || R || ?? || Gets the minimum base damage the character will deal without a weapon.
|-
| [[DAM]].HI || R || ?? || Gets the maximum base damage the character will deal without a weapon.
|-
| [[DEFNAME]] || RW || ?? || Gets or sets defname of the character.
|-
| [[DESIRES]] || RW || ?? || Gets or sets a list of things that the character likes.
|-
| [[DEX]] || RW || ?? || Gets or sets the dexterity that is set when a character polymorphs into this character.
|-
| [[DISPID]] || R || ?? || Gets the ID that the character displays as.
|-
| [[FOODTYPE]] || RW || ?? || Gets or sets a list of things that the character can eat.
|-
| [[HEIGHT]] || RW || ?? || Gets or sets the height of the character.
|-
| [[HIREDAYWAGE]] || RW || ?? || Gets or sets how much gold is needed to hire the character for one day.
|-
| [[ICON]] || RW || ?? || Gets or sets the item that can be used to represent the character in figurine form.
|-
| [[ID]] || RW || ?? || Gets or sets the ID of the character to inherit property values from.
|-
| [[INSTANCES]] || R || ?? || Returns the number of this character that exist in the world.
|-
| [[INT]] || RW || ?? || Gets or sets the intelligence that is set when a character polymorphs into this character.
|-
| [[JOB]] || R || ?? || Gets the character's job title.
|-
| [[MAXFOOD]] || R || ?? || Gets the maximum food level that the character can have.
|-
| [[MOVERATE]] || RW || Y || Gets or sets the percent movement rate of the character. The higher it is, the slower the NPC will be. If undefined, the default is 100.
|-
| [[NAME]] || RW || ?? || Gets or sets the name of the character.
|-
| [[RANGE]] ''min, max'' || RW || Y || Gets or sets the attack range of the character.
|-
| [[RANGEH]] || R || ?? || Gets the maximum attack range of the character.
|-
| [[RANGEL]] || R || ?? || Gets the minimum attack range of the character.
|-
| [[RESDISPDNHUE]] || RW || ?? || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the character.
|-
| [[RESDISPNID]] || RW || ?? || Gets or sets the character ID to display as to clients who don't have a high enough [[RESDISP]] to see the character.
|-
| [[RESLEVEL]] || RW || ?? || Gets or sets the minimum [[RESDISP]] required for a client to see the character.
|-
| [[RESOURCES]] || RW || ?? || Gets or sets the resources that the character is made of.
|-
| [[RESOURCES]]''.COUNT'' || R || ?? || Gets the number of different resources that the character is made of.
|-
| [[RESOURCES]]''.n.KEY'' || R || ?? || Gets the [[BASEID]] of the nth resource that the character is made of. (zero-based)
|-
| [[RESOURCES]]''.n.VAL'' || R || ?? || Gets the amount of the nth resource that the character is made of. (zero-based)
|-
| [[SOUND]] || RW || ?? || Gets or sets the generic sound that the character makes.
|-
| [[STR]] || RW || ?? || Gets or sets the strength that is set when a character polymorphs into this character.
|-
| [[TAG]]''.name'' || RW || ?? || Gets or sets the value of a TAG.
|-
| [[THROWDAM]] ''min,max'' || RW || y || Gets or sets a range of damage used for thrown objects.
|-
| [[THROWDAM]] ''dam'' || RW || y || Gets or sets the constant damage used for thrown objects.
|-
| [[THROWOBJ]] ''id'' || RW || y || Gets or sets the ID of an object to be thrown by NPCs.
|-
| [[THROWRANGE]] ''min,max'' || RW || y || Gets or sets the range that an object can be thrown at.
|-
| [[THROWRANGE]] ''max'' || RW || y || Gets or sets the range that an object can be thrown at with a default min of 2.
|-
| [[TSPEECH]] ''speech_defname'' || RW || ?? || Gets a list of speech handlers for the character, or adds a speech handler to the character.
|-
| [[TEVENTS]] ''event_defname'' || RW || ?? || Gets a list of event handlers for the character, or adds an event handler to the character.
|}

'''&dagger;''' Some properties can be overridden on a individual character basis. For example, you can set TAG.OVERRIDE.MOVERATE on a specific NPC to speed up or slow down the speed at which that one NPC will move.

==INI Overrides==

{| border="1" cellspacing="4" cellpadding="4"
! '''Name''' !! '''Description'''
|-
| TAG.OVERRIDE.RUNNINGPENALTY || This special tag overrides the INI setting of the same name on a per character basis.
|-
| TAG.OVERRIDE.STAMINALOSSATWEIGHT || This special tag overrides the INI setting of the same name on a per character basis.
|}
==Others==
{| border="1" cellspacing="4" cellpadding="4"
! '''Name''' !! '''Description'''
|-
| TAG.NoMoveTill|| doesn't allow char to move if TAG.NoMoveTill > SERV.Time
|-
|}

==Examples==

This first example shows a "base" CHARDEF... these are identified by the fact that the CHARDEF keyword is followed by a number:

<spherescript>[CHARDEF 01] // This is a "base" chardef for character animation 01 (from the mul/uop files)
// This is the start of the "base" properties.
// Values set in the base properties cannot have a range (you cannot use {1 10})
DEFNAME=c_ogre // The DEFNAME is a friendly name to reference this CHARDEF
NAME=ogre // This is the creature's name as seen in-game
ICON=i_pet_ogre // If the creature is shrunk, this is the item that will result
SOUND=snd_monster_ogre1 // This is the start of the sound entries for this creature
CAN=MT_WALK|MT_USEHANDS|MT_EQUIP // These flags are defined in the can_flags area of sphere_defs.scp
DAM=18,22 // This is the range of damage they creature will cause when not using a weapon
ARMOR=30 // ARMOR is the physical damage resistance *before* additional armor is equipped
DESIRES=r_forests,t_gold,t_coin,t_gem,t_arock
AVERSIONS=t_trap,r_civilization
FOODTYPE=35 t_meat_raw // This is the maximum amount (and types) of food the creature eats
RESOURCES=2 i_ribs_raw // If this creature's corpse is carved, these resources will be created
BLOODCOLOR=colors_blood // This is the color of this creatures blood
MOVERATE=100
TAG.Barding.Diff=48.8 // When a TAG is added to the "base properties", all existing creatures are affected
TAG.SlayerGroup=OGRE,REPOND
TEVENTS=e_carnivores2 // EVENTS are collections of triggers used by CHARDEFs. Each TEVENT must be on its own line.
CATEGORY=Monsters // CATEGORY, SUBSECTION, and DESCRIPTION are used by the GM tool "Axis"
SUBSECTION=Giants
DESCRIPTION=Ogre

// This is the end of the "base" properties, and the start of the "triggers".
// You can override *most* base properties in a trigger if necessary.

ON=@Create // This is the @Create trigger
NAME=#NAMES_OGRE // #NAMES_OGRE is an array of names defined in sphere_names.scp
TITLE=the ogre
NPC=brain_monster // The available "brains" are defined in sphere_defs.scp
FAME={1500 1999} // The { } marks are used to set a range of possible values
KARMA={-1500 -1999}
STR={165 195}
MAXHITS={100 120} // If MAXHITS is not set, the default value is the same as STR
DEX={45 65}
MAXSTAM={45 65} // If MAXSTAM is not set, the default value is the same as DEX
INT={45 70}
MAXMANA={45 70} // If MAXMANA is not set, the default value is the same as INT
MAGICRESISTANCE={55.0 70.0}
PARRYING={60.0 70.0}
TACTICS={60.0 70.0}
WRESTLING={70.0 80.0}
MODAR={0 5} // Setting MODAR in @Create lets us add o-5 more ARMOR to this creature
RESCOLD={15 25}
RESENERGY={15 25}
RESFIRE={15 25}
RESPOISON={15 25}
ON=@NPCRestock
ITEM=loot_ogre // This references a TEMPLATE in the sphere_templates_loot.scp file
</spherescript>

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

@StatChange

2014-04-03T12:07:24Z

Wuffel: /* Return Values */

==Description==
This trigger fires when a character's strength, dexterity, intelligence, food, maxhits, maxmana or maxstam is changed.

Fires on:
* [[Characters]]

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|-
| [[SRC]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|}

==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 || In || The stat being changed.
{| cellpadding="4"
| '''Value''' || '''Stat'''
|-
| 0 || Strength
|-
| 1 || Intelligence
|-
| 2 || Dexterity
|-
| 3 || Food
|-
| 4 || MaxHits
|-
| 5 || MaxMana
|-
| 6 || MaxStam
|-
| 7 || Maxfood
|-
| 8 || Modstr
|-
| 9 || Modint
|-
| 10 || Moddex
|-
|}
|-
| ARGN2 || In || The current stat value.
|-
| ARGN3 || I/O || The new stat value.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character's stat from being changed, even if argn3 has been changed.
|}

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

@Success

2014-03-30T15:45:04Z

Wuffel: /* Return Values */

==Description==
This trigger fires when an attempt to use skill has succeeded.

Fires on:
* [[SKILL|Skills]]

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] succeeding the skill attempt.
|-
| [[SRC]] || The [[Characters|character]] succeeding the skill attempt.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The skill number that has succeeded.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Aborts the skill attempt.
|-
| 0 || Aborts the skill, but grants Skillgain.
|-
| 2 || Aborts the skill, but grants Skillgain.
|-
|}

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

TYPEDEF

2014-03-26T22:08:23Z

Wuffel: /* Built-in Types */

{{Languages|TYPEDEF}}

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

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

==Built-in Types==

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

{| border="1"
! DEFNAME !! Number !! Description
|-
| t_normal || 0 || No built-in behavior.
|-
| t_container and t_container_locked || 1 and 2 || These types are used for containers. They leverage the following properties:
* MORE1 = "ID" from the key that can unlock this item (If the MORE1 of the key matches the MORE1 of the container then they are linked)
* MORE2 = The lock complexity (how hard it is to pick the lock)
* MOREX = The trap type (not used yet?)
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
* LINK = UID of a secondary key?
|-
| t_door or t_door_locked || 3 or 4 || This type is used for both unlocked and locked doors. They leverage the following properties:
* MORE1 = UID of this door's key (if it has one)
* TDATA1 = ID for the sound it makes when double clicked
|-
| t_key || 5 || This type is used for keys. It leverages the following properties:
* MORE1 = "ID" of the item(s) this key can unlock (if the MORE1 of the key matches the MORE1 of the container/door then they are linked)
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.
|-
| t_light_lit || 6 || This type is used for light sources that can be turned on or off. It leverages the following properties:
* MOREY = Number of charges before the item is consumed
* MOREZ = Type of light pattern it will cast
|-
| t_light_out || 7 || This type is used for light sources that can be turned on or off. It leverages the following properties:
* MOREY = Number of charges before the item is consumed
* MOREZ = Type of light pattern it will cast
|-
| t_food || 8 || This type is used for edible food. It leverages the following properties:
* MORE2 = The ID of the creature that this came from
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the food
'''Note:''' The following properties may also exist depending on your server version:
* MOREX = The ID of a spell effect that will be gained when eaten
* MOREY = The strength of the spell effect
|-
| t_food_raw || 9 || This type is used for ''raw'' food. It leverages the following properties:
* MORE1 = ID of the item it makes when cooked (the default is i_unused and if defined, it will override TDATA1)
* MORE2 = The ID of the creature that this came from
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the food
* TDATA1 = The item ID this cooks into
'''Note:''' The following properties may also exist depending on your server version:
* MOREX = The ID of a spell effect that will be gained when eaten
* MOREY = The strength of the spell effect
* TDATA2 = The creature ID type that the food came from
* TDATA3 = The amount of skill required to cook it (did this ever work?)
|-
| t_armor || 10 || This type is used for armor. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)
* MOREY = There are two possible effects of setting MOREY:
*# If MOREX is set, then MOREY is the power/effect of that spell
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.
|-
| t_weapon_mace_smith || 11 || This type is used for macefighting weapons that can also be used by blacksmiths to forge items. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_mace_sharp || 12 || This type is used for macefighting weapons that have sharp cutting edges. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_sword || 13 || This type is used for swordsmanship weapons. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_fence || 14 || This type is used for fencing weapons. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses
|-
| t_weapon_bow || 15 || This type is used for archery weapons (bow or crossbow). It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic
* TDATA1 = The sound effect the weapon makes when it shoots
* TDATA2 = The required strength to wield the weapon
* TDATA3 = ID of arrow item that will be fired (and must therefore be on the player's person)
* TDATA4 = ID of the arrow animation (for bows it is usually i_arrow_x, for crossbows, i_xbow_x)
The following overrides can be set on a per item basis:
* TAG.OVERRIDE.DAMAGETYPE = to override the types of damage this weapon does
* TAG.OVERRIDE.SOUND_HIT = to override the sound this weapon makes when it hits
* TAG.OVERRIDE.SOUND_MISS = to override the sound this weapon makes when it misses
* AMMOANIMRENDER = to override the rendermode of the ANIM this item uses (yes, no TAGs)
* AMMOTYPE = to override the type of ammo (TDATA3) this item uses (yes, no TAGs)
* AMMOANIM = to override the ammo animation (TDATA4) this item uses (yes, no TAGs)
* AMMOANIMHUE = to override the color of the ammo animation this item uses (yes, no TAGs)
|-
| t_wand || 16 || This type is used for magic wands. It leverages the following properties:
* MORE1L = the current amount of hitpoints the item has
* MORE1H = the maximum hitpoints for the item
* MORE2 = the number of remaining charges (if magical)
* MOREX = the spell type (if magical)
* MOREY = the spell strength (0-1000)
* MOREZ = the poison skill applied (0-100)
* TDATA2 = Required Strength to equip the wand
* TDATA3 = ID of the light pattern
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object).
|-
| t_telepad || 17 || This type is used for teleport pads. It leverages the following properties:
* MOREP = Coordinates of the point to which you will teleport when you step on the item
* MORE1 = If set to 1, the teleport pad will only work for players (and their pets)
* MORE2 = If set to 1, the teleport animation and sound will not be shown to anyone witnessing the teleport
|-
| t_switch || 18 || This type is used for switches. The way these things work is, when used, they trigger @DCLICK on the LINK object. It leverages the following properties:
* LINK = UID of item to trigger
* MORE1 = The item ID of the next state of the switch
* MOREX = A flag to indicate if this is activated by stepping on it
|-
| t_book || 19 || This type is used for books of static or dynamic text. It leverages the following properties:
* MORE1L = This can be set to an ID of a book (some default book text is included in the sphere_books.scp file)
* MORE1H = Some flags that determine book behavior:
** 0c00: Scripted book
** 0800: Editable book
** 08000: ? time stamp ?
* AUTHOR = The ID of the character that wrote the book
* BODY.# = The text for each page of the book (starting with page 0)
'''Note:''' we need more information on those flags...
|-
| t_rune || 20 || This type is used for recall runes. It leverages the following properties:
* MORE1 = The number of uses left before it wears out
* MOREP = The coordinates of the marked location
|-
| t_booze || 21 || This type is used for alcohol (it causes a drunk effect when double clicked.) It leverages the following properties:
* TDATA1 = A flag that indicates whether the container is empty or not.
|-
| t_potion || 22 || This type is used for potions. It leverages the following properties:
* MORE1 = The potion spell effect that will result when the potion is double clicked
* MORE2 = The strength of the potion (This has a different effect defending on the spell, usually between 0 and 1000)
* MOREX = The countdown to explosion (for purple potions)
* TDATA1 = A flag that indicates whether the container is empty or not
|-
| t_fire || 23 || This type is used for fires (and ovens?). These items can be used to cook food, and they can burn you if stepped on. It leverages the following properties:
* TIMER = time until it decays?
* MORE1 (or MORE2?) = Amount of damage it will cause when stepped on or dclicked
* MOREZ = Type of light pattern it will cast
|-
| t_clock || 24 || This type is used to tell time (game time, not real time) when double clicked. The result comes out something like "half past eleven o'clock at night". From what I can tell there are no MORE or TDATA modifiers that affect the result.
|-
| t_trap and t_trap_active || 25 and 26 || These types are used for traps that are triggered when walked on. They leverage the following properties:
* MORE1 = ID of the animation
* MORE2 = The damage the trap will cause
* MOREX = The length of time the animation will run
* MOREY = The length of time the activated trap will idle until reset
* MOREZ = A flag that indicates if the trap must idle before changing from active to inactive.
|-
| t_musical || 27 || This type is used for musical instruments. It leverages the following properties:
* TDATA1 = The sound ID to be played if successful
* TDATA2 = The sound ID to be played if not successful
|-
| t_spell || 28 || This type is used for magic spell effects. It leverages the following properties:
* MORE1L = The polymorph effect on STR
* MORE1H = The polymorph effect on DEX
* MORE2 = The number of charges left
* MOREX = The spell effect that will result when the item is stepped on
* MOREY = The strength of the spell (This has a different effect defending on the spell, usually between 0 and 1000)
* MOREZ = Type of light pattern it will cast
|-
| t_gem || 29 || This type is used for gems, and from what I can tell there is no built-in behavior for it.
|-
| t_water || 30 || This type is used for water, which means it can be fished in or used to clean used bandages.
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce (is this true?)
|-
| t_clothing || 31 || This type is used for all cloth based equip-able items. It is essentially identical to t_armor and t_armor_leather. It leverages the following properties:
* MORE1L = Max hitpoints
* MORE1H = Current hitpoints
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)
* MOREY = There are two possible effects of setting MOREY:
*# If MOREX is set, then MOREY is the power/effect of that spell
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.
|-
| t_scroll || 32 || This type is used for scrolls. It leverages the following properties:
* MOREX = ID of the spell to cast when double-clicked
* MOREY = Power of the spell (equivalent to the EFFECT setting of the spell itself?)
|-
| t_carpentry || 33 || This type is used by carpenters to craft items, and from what I can tell there is no built-in behavior for it.
|-
| t_spawn_char || 34 || This type is used to spawn NPCs. Once it spawns its first creature, it will turn red and change its appearance to the ICON of the creature (or appear as a wisp if the spawn is set to use a template.) It leverages the following properties:
* AMOUNT = The maximum amount of NPCs the spawner should create
* MORE1 = The creature ID or spawn template ID for what you want to spawn
* MORE2 = The current number of creatures spawned from this point
* MOREX = The minimum time between spawns (in minutes)
* MOREY = The maximum time between spawns (in minutes)
* MOREZ = The maximum distance away from the spawn to create the spawned NPC (this is also the maximum wander distance for the NPC)
'''Note:''' The spawn is considered active if the TIMER has a positive value, and when the timer reaches zero, it is automatically restarted using a random number between MOREX and MOREY.
|-
| t_game_piece || 35 || This type is used for game board pieces (checkers, chess, etc). They cannot be removed from the game, and they have no tile image outside of the game board gump. It leverages the following properties:
* TDATA1 = The starting x position for this piece
* TDATA2 = The starting y position for this piece
|-
| t_portculis || 36 || This type is used for portcullis doors that raise and lower when double clicked. It leverages the following properties:
* MORE1 = The z height at the lowest setting
* MORE2 = The z height at the highest setting
|-
| t_figurine || 37 || This type is used for shrunk NPCs (essentially magic figurines), that turn into a "pet" creature when double clicked. It leverages the following properties:
* MORE1 = The creature ID that will spawn when the item is double clicked.
* MORE2 = The UID of the off-line creature (in "stable master" inventory)
* TDATA2 = The required strength to mount the creature (presumably only if it is possible to mount it)
* TDATA3 = The base creature ID.
|-
| t_shrine || 38 || This type is used for shrines. They will resurrect a ghost when double-clicked by a ghost.
|-
| t_moongate || 39 || This type is used for moongates. When stepped on they teleport the player to another location. It leverages the following properties:
* MOREP = The coordinates that the moongate leads to
* MORE1 = If set to 1, the smoke and sound is supressed
* MORE2 = If set to 1, NPCs (and pets?) cannot use it
|-
| t_chair || 40 || This type is used for any sort of a chair item and it's only purpose is to trigger a sitting animation.
|-
| t_forge || 41 || This type is used by blacksmiths to smelt ore....
|-
| t_ore || 42 || This type is harvested by miners, and converted by blacksmiths (using a forge) into something else. It leverages the following properties:
* TDATA1 = ID of item created when the ore is smelted (usually ingots)
|-
| t_log || 43 || This type is a raw material resource usually harvested from trees.
|-
| t_tree || 44 || This type is chopped by lumberjacks to get logs. It leverages the following properties:
* FRUIT = ID of item gathered if double-clicked (usually logs)
|-
| t_rock || 45 || This type can be mined for ore.
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce (is this true?)
|-
| t_carpentry_chop || 46 || A carpentry tool that can be used to craft carpentry objects as well as used to "chop" trees (like a saw?)
|-
| || ||
t_multi 47 // = multi part object like house or ship. MORE1 is the UID of the player that created/owns the multi
t_reagent 48 // = alchemy when clicked ?
t_ship 49 // = this is a ship multi. MORE2 contains the speed, anchor flag, direction of movement, and facing direction in each byte respectively
t_ship_plank 50 // TDATA1 is the itemID of the next open/closed state.
t_ship_side 51 // = should extend to make a plank TDATA1 is the itemID of the next open/closed state.
t_ship_side_locked 52 // TDATA1 is the itemID of the next open/closed state.
t_ship_tiller 53 // = tiller man on the ship.
t_eq_trade_window 54 // = container for the trade window.
t_fish 55 // = fish can be cut up.
|-
| t_sign_gump || 56 || This type is used for simple signs (and things like grave stones). It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_stone_guild || 57 || This type is used for guild stones. It leverages the following properties:
* MORE1 = The alignment of the guild (chaos, neutral, order)
* MORE2 = The amount of gold in the guild account
|-
| || ||
t_anim_active 58 // = active anium that will recycle when done.
t_sand 59 // = sand on the beach
t_cloth 60 // = bolt or folded cloth
t_hair 61 //
t_beard 62 // = just for grouping purposes.
|-
| t_ingot || 63 || This type is used for ingots (when a blacksmith smelts ore, it turns into ingots. It leverages the following properties:
* TDATA1 = The skill required to smelt this
* TDATA2 = The skill required to get the maximum yield when smelting
|-
| t_coin || 64 || This types is used for coins, gold or otherwise.
|-
| t_crops || 65 || This type is used to grow plants that likely bear fruit. Double clicking a t_crop item will harvest the fruit if it is ripe. It leverages the following properties:
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)
* TDATA1 = Is the ID of the first stage of the crop (the sprout), it is the ID that the crop will be reset to regrow from (0=nothing, which means this plant will not regrow once harvested)
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant (0 means the plant is not mature)
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.
|-
| t_drink || 66 || This type is used for non-alcoholic drinks. It leverages the following properties:
* TATA1 = A flag that indicates whether the container is empty or not.
'''Note:''' There is an INI flag OF_DrinkIsFood (0x10000) that, if set, will increase FOOD level when the drink is consumed (like T_FOOD does)
|-
| || ||
t_anvil 67 // = for repair.
t_port_locked 68 // = this portcullis must be triggered.
t_spawn_item 69 // = spawn other items.
t_telescope 70 // = big telescope pic.
|-
| t_bed || 71 || This type is used to indicate the item is a bed. I am not sure how it is used exactly, but it leverages the following properties:
* TDATA1 = The direction it occupies
|-
| t_gold || 72 || This type is used to indicate the object is a gold coin and can be used to purchase stuff.
|-
| t_map || 73 || This type is used for cartography maps. It has the following properties:
* MORE1L = The top coordinate
* MORE1H = The left coordinate
* MORE2L = The bottom coordinate
* MORE2H = The right coordinate
* MOREZ = A flag that indicates whether the map has pins or not
* MOREX and MOREY = The coordinates of the pin (I think)
|-
| t_eq_memory_obj || 74 || This type is used for character memories, and it really depends on the type of memory to know what each property really means, but here is a relatively good guide:
* MORE1L = The action type this is a memory for
* MORE1H = The skill involved
* MORE2 = The start time of the memory
* MOREP = The map coordinates at which the memory occurred.
|-
| || ||
t_weapon_mace_staff 75 // = staff type of mace. or just other type of mace.
|-
| t_eq_horse || 76 || This type is used for equipped horse object. Essentially it represents a riding horse to the client. It leverages the following properties:
* MORE1 = The creature ID
* MORE2 = The UID of the offline creature (in "stable master" inventory)
* TDATA2 = The required strength to mount it
* TDATA3 = The base creature ID
|-
| t_comm_crystal || 77 || This type is used for communication crystals.
|-
| t_game_board || 78 || This type is used as a container for game pieces (t_game_piece). It leverages the following properties:
* MORE1 = The type of pieces to use (0=chess, 1=checkers, 2=none... presumably this is hard-coded)
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_trash_can || 79 || This type is used as a trash can container, and it deletes any object placed into it. It leverages the following properties:
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_cannon_muzzle || 80 || This type is used for the business end of the cannon.
|-
| t_cannon || 81 || This type is used for the cannon control. It leverages the following properties:
* MORE2 = A mask of what is currently loaded in it. (0 = none, 1=powder, 2=shot)
|-
| t_cannon_ball || 82 || This is ammo for a t_cannon.
|-
| || ||
t_armor_leather 83 // = non metallic armor (t_clothing)
|-
| t_seed || 84 || This type is used for seeds. A seed can be created by using a dagger on a fruit (assuming the fruit is setup to have a seed.) A seed can be planted by double clicking it and targeting the ground (specifically t_dirt items). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that will grow the fruit that this seed comes from
|-
| || ||
t_junk 85 // = never used
t_crystal_ball 86 //
t_swamp 87 // = swamp (smelly)
|-
| t_message || 88 || This type is used for bulletin board messages. It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| || ||
t_reagent_raw 89 // = freshly grown reagents...not processed yet.
t_eq_client_linger 90 // = change player to npc for a while.
t_snow 91 // = snow
|-
| t_it_stone || 92 || This type is an "item stone" that is used to generate items when the object is double clicked. It has the following properties:
* MORE1 = The item or template ID to generate
* MORE2 = The price (or Plotflags to set?)
* MOREX = The regen time (0 = instant)
* MOREY = The total amount to deliver (0 = infinite, 0xFFFF = none left)
|-
| || ||
t_unused_93 93
|-
| t_explosion || 94 || This type is used for explosion animations. It leverages the following properties:
* MOREX = The damage that the explosion will cause
* MOREY = The type of damage (fire, magic, etc)
* MOREZ = The distance range for the damage
|-
| t_eq_npc_script || 95 || This type is used to script NPC actions (in the form of a book). The sphere_defs.scp file says "get rid of this in favor of waiting on m_events" but it may still exist... if so, it leverages the following properties:
* MORE1 = The same as for other books
* MORE2L = The current script page
* MORE2H = The current offset
* MOREZ = The priority for this script (as a percent, this is the chance they want to "do" this task)
|-
| || ||
t_web 96 // = walk on this and transform into some other object. MORE1 is the amount of hits the web can take.
t_grass 97 // = can be eaten by grazing animals
t_arock 98 // = a rock or boulder. can be thrown by giants.
t_tracker 99 // = points to a linked object.
|-
| t_sound || 100 || This type is used to play sounds. It uses the following properties:
* MORE1 = The sound ID
* MORE2 = A flag to indicate repetition
|-
| t_stone_town || 101 || This type is used for town stones. It leverages the following properties:
* MORE1 = The alignment of the town (chaos, neutral, order)
* MORE2 = The amount of gold in the town bank account
|-
| || ||
t_weapon_mace_crook 102 //
t_weapon_mace_pick 103 //
t_leather 104 // = leather or skins of some sort.(not wearable)
t_ship_other 105 // = some other part of a ship.
|-
| t_bboard || 106 || This type is a bulleting board container that holds t_message items. It leverages the following properties:
* TDATA2 = The gumpID of the container
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| t_spellbook || 107 || This type is used for the Magery spellbook. It leverages the following properties:
* MORE1 = A bit mask of available spells in circles 0-4, so to add all those spells: set MORE1=0fffffff
* MORE2 = A bit mask of available spells in circles 5-8, so to add all those spells: set MORE2=0fffffff
'''Note:''' In older sphere versions, MOREX, MOREY, and MOREZ could be set to add additional spells (necro, etc), but recently these concepts may have been removed... same with these TDATA settings:
* TDATA2 = Required Strength to equip the book
* TDATA3 = Type of light pattern it will cast
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)
|-
| t_corpse || 108 || This type is a container used for all dead corpses. It leverages the following properties:
* MORE1 = The time of death
* MORE2 = The UID of the individual character that landed the killing blow
* MOREX & MOREY = Combined, these make up a single DWORD which specifies what type of creature this was
* MOREZ = The direction it is facing
* TDATA2 = The gumpID of the container
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
There are two special TAGs for corpses:
* TAG.BLOOD = This is the number of times you can carve the corpse and cause blood to come out (default 5)
* TAG.MAXBLOOD = Not certain about this one, but it is likely related... perhaps it is set on the CHARDEF?
|-
| || ||
t_track_item 109 // - track a id or type of item.
t_track_char 110 // = track a char or range of char id's
t_weapon_arrow 111 //
t_weapon_bolt 112 //
t_eq_vendor_box 113 // = an equipped vendor box
|-
| t_eq_bank_box || 114 || This type is a container that is used for the character bank. It leverages the following properties:
* MORE1 = The amount of gold in the account (is this still true?)
* MORE2 = The amount to restock to (for NPCs vendors who can buy stuff from players?)
* MOREP = The location in the world (x, y, and z) where the bank box was opened
* TDATA2 = The gumpID for the bank box container
* TDATA3 = The minimum gump size
* TDATA4 = the maximum gump size
|-
| t_deed || 115 || This type is used to create something else when double clicked. It is perhaps the best solution for a player to place a ''multi'' part item like a house. When double clicked, it will prompt for a target location. It leverages the following properties:
* MORE1 = The ID of the item that will be created at the target location
* MORE2 = The previous key ID (ideally this is set when a house or ship are re-deeded so that all the existing keys will still work)
|-
| t_loom || 116 || This type of device is used by weavers who turn wool or thread into bolts of cloth. It leverages the following properties:
* MORE1 = The ID of the currently loaded resource (wool or cotton/flax) that is being woven
* MORE2 = The amount of resources currently in the loom
|-
| t_bee_hive || 117 || This type is used for beehives. It leverages the following properties:
* MORE1 = The amount of honey which has accumulated in the hive
|-
| t_archery_butte || 118 || This type is used for practice archery targets. When double clicked, the target will first check if you have an archery weapon equipped and if so, it will return some ammo. It leverages the following properties:
* MORE1 = The ID for the type of ammo currently stuck in the target
* MORE2 = The amount of items stuck in the target
|-
| || ||
t_eq_murder_count 119 // = my murder count flag. MORE1 contains the amount of time before it expires.
t_eq_stuck 120 // we are stuck in a web
t_trap_inactive 121 // = a safe trap.
//t_unused_122 122
t_bandage 123 // = can be used for healing.
t_campfire 124 // = this is a fire but a small one.
t_map_blank 125
t_spy_glass 126
t_sextant 127
t_scroll_blank 128
|-
| t_fruit || 129 || This type is used for fruit. When double clicked, fruit will be eaten. Fruit can be grown from crops (t_crop). It leverages the following properties:
* TDATA1 = The ID of a t_crop item that this fruit comes from (If not set, this fruit may not have a seed, use zero to be certain)
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)
* MOREZ = Is the poison level of the fruit
|-
| || ||
t_water_wash 130 // water that will not contain fish. (for washing or drinking) TDATA1 is a flag that indicates whether the container is empty or not
t_weapon_axe 131 // not the same as a sword. but uses swordsmanship skill
|-
| t_weapon_xbow || 132 || This type is used for crossbow weapons. It is essentially identical to t_weapon_bow.
|-
| || ||
t_spellicon 133
t_door_open 134
t_meat_raw 135 // just a meaty part of a corpse. (uncooked meat)
t_garbage 136
|-
| t_keyring || 137 || This type is a container used to store keys. It leverages the following properties:
* TDATA2 = The gumpID
* TDATA3 = The minimum gump size
* TDATA4 = The maximum gump size
|-
| || ||
t_table 138 // doesn't really do anything.
t_floor 139
t_roof 140
t_feather 141 // a birds feather
t_wool 142 // wool cut from a sheep.
t_fur 143
t_blood 144 // blood of some creature
|-
| t_foliage || 145 || This type is very similar to t_crops, the difference being the foliage does not disappear when the fruit is harvested. It leverages the following properties:
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)
* TDATA1 = Is the ID of the first stage of the crop (the sprout)
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.
|-
| || ||
t_grain 146
t_scissors 147
t_thread 148
t_yarn 149
t_spinwheel 150
t_bandage_blood 151 // = can't be used for healing.
t_fish_pole 152
t_shaft 153 // bolt or arrow.
t_lockpick 154
t_kindling 155
t_train_dummy 156
t_train_pickpocket 157
t_bedroll 158
t_bellows 159
|-
| t_hide || 160 ||Made into leather.
* TDATA1 = Hold ID or DEFNAME of custom cut leather (or any item).
|-
| || ||
t_cloth_bolt 161
t_board 162 // = logs are plained into decent lumber
t_pitcher 163 // TDATA1 is a flag that indicates whether the container is empty or not.
t_pitcher_empty 164 // TDATA1 is a flag that indicates whether the container is empty or not.
t_dye_vat 165
t_dye 166
t_potion_empty 167 // empty bottle.
t_mortar 168
t_hair_dye 169
t_sewing_kit 170
t_tinker_tools 171
t_wall 172 // wall of a structure.
t_window 173 // window for a structure. MOREZ is the light pattern
t_cotton 174 // cotton from the plant
t_bone 175
|-
| t_eq_script || 176 || This type can have tags and can be equipped. Possibly used for memory objects that leverage @Equip and @UnEquip triggers.
|-
| || ||
t_ship_hold 177 // ships hold. TDATA2 is the gumpID, TDATA3 is the minimum gump size, TDATA4 is the maximum gump size
t_ship_hold_lock 178
t_lava 179
|-
| t_shield || 180 || This type is used to indicate the object is an equipable shield. It has the following properties:
* MORE1L = The current amount of hitpoints the item has
* MORE1H = The maximum hitpoints for the item
* MORE2 = The number of remaining charges (if magical)
* MOREX = The spell type (if magical)
* MOREY = The spell strength (0-1000)
|-
| t_jewelry || 181 || This type is used for equpable jewelry. It leverages the following properties:
* MORE1L = The current amount of hitpoints the item has
* MORE1H = The maximum hitpoints for the item
* MORE2 = The number of remaining charges (if magical)
* MOREX = The spell type (if magical)
* MOREY = The spell strength (0-1000)
* TDATA2 = Required Strength to equip the item
* TDATA3 = Light pattern
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)
|-
| t_dirt || 182 || This type is used to represent a patch of dirt where something can be planted.
|-
| t_script || 183 || This type can have tags, but can NOT be equipped.
|-
| || ||
t_spellbook_necro 184 // AOS Necromancy spellbook (should have MOREZ=100 by default)
t_spellbook_pala 185 // AOS Paladin spellbook (should have MOREZ=200 by default)
t_spellbook_extra 186 // some spellbook for script purposes (MOREZ=basic offset)
t_spellbook_bushido 187 // SE Bushido spellbook (should have MOREZ=400 by default)
t_spellbook_ninjitsu 188 // SE Ninjitsu spellbook (should have MOREZ=500 by default)
t_spellbook_arcanist 189 // ML Spellweaver spellbook (should have MOREZ=600 by default)
t_multi_custom 190 // Customisable multi
t_spellbook_mystic 191 // SA Mysticism spellbook (should have MOREZ=677 by default)
t_hoverover 192 // Hover-over item (CAN_C_HOVER can hover over blocking items)
t_spellbook_bard 193 // SA Bard spellbook (should have MOREZ=700 by default)
|}

==Scripted TYPEDEFs==

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

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

<tt>
[TYPEDEF ''defname''] 
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>

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

SKILL

2014-03-26T01:18:35Z

Wuffel: /* Properties */

{{Languages|SKILL}}

__FORCETOC__
A skill block defines the basic properties and behaviours of a skill.

==Properties==
The following properties are available when defining a skill:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[ADV_RATE]] || RW || Gets or sets the skill's advance rate. Accepts multiple values to adjust based on skill level.
|-
| [[BONUS_DEX]] || RW || Gets or sets a multiplier for how much dexterity affects a character's non-real skill amount, and affects stat gain.
|-
| [[BONUS_INT]] || RW || Gets or sets a multiplier for how much intelligence affects a character's non-real skill amount, and affects stat gain.
|-
| [[BONUS_STATS]] || RW || Gets or sets a modifier for gaining stats when using the skill.
|-
| [[BONUS_STR]] || RW || Gets or sets a multiplier for how much strength affects a character's non-real skill amount, and affects stat gain.
|-
| [[DELAY]] || RW || Gets or sets how long it takes to attempt to complete the skill, in tenths of a second. Accepts multiple values to adjust based on skill level.
|-
| [[EFFECT]] || RW || Gets or sets a value which effects skills in different ways. (Crafting = Resource Loss % on Fail, Healing = Amount Healed). Accepts multiple values to adjust based on skill level.
|-
| [[FLAGS]] || RW || Gets or sets skill attributes. The available flags are defined in the sphere_defs.scp file:
{|
| SKF_SCRIPTED || 0001 || fully scripted, no hardcoded behaviour
|-
| SKF_FIGHT || 0002 || considered a fight skill, maintains fight active
|-
| SKF_MAGIC || 0004 || considered a magic skill
|-
| SKF_CRAFT || 0008 || considered a crafting skill, compatible with MAKEITEM function
|-
| SKF_IMMOBILE || 0010 || skilluser can not move while skilluse
|-
| SKF_SELECTABLE || 0020 || from skill list. ATTENTION: This does ''not'' place the button next to the skill in the client's skill list! For this you have to edit skills.mul or script the trigger.
|-
| SKF_NOMINDIST || 0040 || you can mine, fish, chop, hack on the same point you are standing on
|-
| SKF_NOANIM || 0080 || don't show hard-coded animation for this skill
|-
| SKF_NOSFX || 0100 || don't play hard-coded sound for this skill
|-
| SKF_RANGED || 0200 || considered a ranged skill (combine with SKF_FIGHT)
|}
|-
| [[GAINRADIUS]] || RW || Gets or sets a difficulty "radius" that prevents characters from gaining skill when performing "easy" actions. Skillgain will only be calculated if the current skill is less than the actual difficulty + GAINRADIUS. If skillgain is aborted due to GAINRADIUS not met, a message will only be displayed if TAG.NOSKILLMSG=1 on character.
|-
| [[GROUP]] || RW || Get or sets the skill's group flags.
|-
| [[KEY]] || RW || Gets or sets the skill's defname.
|-
| [[NAME]] || RW || Gets or sets the name of the skill.
|-
| [[STAT_DEX]] || RW || Gets or sets the maximum dexterity a character can gain up to when using this skill.
|-
| [[STAT_INT]] || RW || Gets or sets the maximum intelligence a character can gain up to when using this skill.
|-
| [[STAT_STR]] || RW || Gets or sets the maximum strength a character can gain up to when using this skill.
|-
| [[PROMPT_MSG]] || RW || Gets or sets the message shown when the character selects the skill, and also forces characters to select a target when non-empty.
|-
| [[TITLE]] || RW || Gets or sets the professional title for the skill.
|-
| [[VALUES]] || RW || Gets or sets a modifier for the value of items that are created using the skill. Accepts multiple values to adjust based on skill level.
|}

==Triggers==
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]].
|-
| [[@Wait]] || This is called whenever Sphere wants to check if a character must wait before starting a skill. Normally this will be when a skill is selected from the skill menu (before [[@Select]]), but also when snooping a container or using a musical instrument.
|}

==Examples==

<spherescript>
//
// Alchemy skill from the default script pack.
//
[SKILL 0]
DEFNAME=SKILL_ALCHEMY
KEY=Alchemy
TITLE=Alchemist
DELAY=3.0,1.0
ADV_RATE=10.0,200.0,800.0
VALUES=1,20,100

BONUS_STATS=10
BONUS_STR=0
BONUS_DEX=20
BONUS_INT=80

STAT_STR=5
STAT_INT=75
STAT_DEX=40

ON=@Fail
SRC.SYSMESSAGE You toss the failed mixture from the mortar, unable to create a potion from it.

ON=@Abort
SRC.SYSMESSAGE You fail to complete the potion.
</spherescript>

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

@StatChange

2014-03-25T19:25:27Z

Wuffel: /* Arguments */

==Description==
This trigger fires when a character's strength, dexterity, intelligence, food, maxhits, maxmana or maxstam is changed.

Fires on:
* [[Characters]]

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|-
| [[SRC]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|}

==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 || In || The stat being changed.
{| cellpadding="4"
| '''Value''' || '''Stat'''
|-
| 0 || Strength
|-
| 1 || Intelligence
|-
| 2 || Dexterity
|-
| 3 || Food
|-
| 4 || MaxHits
|-
| 5 || MaxMana
|-
| 6 || MaxStam
|-
| 7 || Maxfood
|-
| 8 || Modstr
|-
| 9 || Modint
|-
| 10 || Moddex
|-
|}
|-
| ARGN2 || In || The current stat value.
|-
| ARGN3 || I/O || The new stat value.
|}

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

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

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

@StatChange

2014-03-25T18:59:34Z

Wuffel: /* Arguments */

==Description==
This trigger fires when a character's strength, dexterity, intelligence, food, maxhits, maxmana or maxstam is changed.

Fires on:
* [[Characters]]

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|-
| [[SRC]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|}

==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 || In || The stat being changed.
{| cellpadding="4"
| '''Value''' || '''Stat'''
|-
| 0 || Strength
|-
| 1 || Intelligence
|-
| 2 || Dexterity
|-
| 3 || Food
|-
| 4 || Hits
|-
| 5 || Mana
|-
| 6 || Stam
|-
| 7 || Maxfood
|-
| 8 || Modstr
|-
| 9 || Modint
|-
| 10 || Moddex
|-
|}
|-
| ARGN2 || In || The current stat value.
|-
| ARGN3 || I/O || The new stat value.
|}

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

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

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

@StatChange

2014-03-25T18:38:03Z

Wuffel:

==Description==
This trigger fires when a character's strength, dexterity, intelligence, food, maxhits, maxmana or maxstam is changed.

Fires on:
* [[Characters]]

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|-
| [[SRC]] || The [[Characters|character]] whose strength, dexterity or intelligence is being changed.
|}

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

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I/O || The stat being changed.
{| cellpadding="4"
| '''Value''' || '''Stat'''
|-
| 0 || Strength
|-
| 1 || Intelligence
|-
| 2 || Dexterity
|-
| 3 || Food
|-
| 4 || Hits
|-
| 5 || Mana
|-
| 6 || Stam
|-
| 7 || Maxfood
|-
| 8 || Modstr
|-
| 9 || Modint
|-
| 10 || Moddex
|-
|}
|-
| ARGN2 || I/O || The current stat value.
|-
| ARGN3 || I/O || The new stat value.
|}

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

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

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