SphereWiki - User contributions [en]

Special Items

2024-10-20T13:07:28Z

ShiryuX:

{{Languages|Special_Items}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

====Character Members====

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

====Item Members====

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

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

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

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

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

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

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

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

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

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

Main Page

2020-04-12T23:56:39Z

ShiryuX: Included reference compedium in the new style

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

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

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

==Other Articles==

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

==Credits==

'''Special thanks to:'''

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

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

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

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

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

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

==External Links==

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

[[Category: Navigation]]

Main Page

2020-04-10T22:09:52Z

ShiryuX: New design of the head section.

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

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

==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]]
* [[Category: Triggers|'''Triggers''']]
** [[:Category:Triggers|Triggers]]

==Other Articles==

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

==Credits==

'''Special thanks to:'''

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

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

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

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

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

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

==External Links==

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

[[Category: Navigation]]

Installing Sphere

2010-07-18T22:43:00Z

ShiryuX: /* Windows */ - Updated MySQL Library link.

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

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

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

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

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

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

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

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

<tt>useradd -d /home/sphere sphere<br />
mkdir /home/sphere<br />
chown sphere /home/sphere<br />
chmod 700 /home/sphere<br /></tt>

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

<tt>/home/sphere --- spheresvr<br />
              |  sphere.ini<br />
              |  sphereCrypt.ini<br />
          |-------------------- accounts/<br />
          |-------------------- logs/<br />
          |-------------------- muls/<br />
          |-------------------- save/<br />
          |-------------------- scripts/<br /></tt>

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

<tt>cd ~sphere<br />
chown -R sphere *<br />
find . -type d | xargs chmod 0700<br />
find . -type f | xargs chmod 0600<br />
chmod 4700 spheresvr<br /></tt>

'''4)''' Still as root do a

<tt>ldd spheresvr<br /></tt>

the output should be something like this:

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

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

<tt>ldconfig<br /></tt>

===Test the Installation===
It does not matter if you start your test as user root or user sphere. Setting the permissions of the spheresvr executable to 4700 forces it to always be started as it's owner, sphere. So start it:

<tt>cd ~sphere<br />
./spheresvr<br /></tt>

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

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

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

Finally your Sphere will tell you something like:

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

You are now in the sphere console and can issue the common commands (type '?' to get a list). So create an account, activate it, edit the login.cfg on your windows box with the client installation to point to the address of the Linux box, and be the first to log in.

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

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

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

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

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

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

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

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

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

Compiled on:

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

With:

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

Linked Against:

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

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

[[Category: Setting Up Sphere]]