Graal Bible - User contributions [en]

Server options

2012-04-22T01:21:44Z

Fowlplay4: /* Showimg/Ani Filter */

[[Category:Administration]]
The '''server options''' are a collection of key=value configuration options that allow you to customize the non-[[GScript|script]]able behaviour of an individual [[Playerworld]].

== Usage ==

Options are usually set only by high [[Playerworld]] staff, preferably only the [[Playerworld]] owner, as they are very powerful and can be abused easily.

When you omit an option, its value will not be changed if the option has been used before. Therefore, it is more secure to change only the value and not whole option, should you need to change something.

Lines beginning with # are not parsed, and can be used for comments.

== Known Server Options ==

Please add new options if you discover them.

=== Start location ===
startlevel=level name
startx=number
starty=number

This sets the originating location for all [[Player]]s which do not have location statistics of their own saved [[Local|locally]].

=== Unstick me location ===
unstickmelevel=level name
unstickmex=number
unstickmey=number

These define the position that a [[Player]] is warped to after using the [[Unstick me]] command.

=== Unstick Time ===
unstickmetime=number

This option sets the amount of time a player has to be idle before they can use the unstick me command.

=== Protected Weapons ===
protectedweapons=list of comma seperated weapon names

[[NPC weapon]]s that cannot be deleted by the [[Player]]. This differs from weapons with asterisk prefixed name which cannot be deleted with the Del key, but still can be deleted on the [[Clientside]] using the [[Old GScript:destroy|destroy]] command. `Protected' weapons can (unless *ified) be deleted with Del, but the NPC server will not remove them from the player's weapon list and thus the [[Serverside]] part will remain and the player obtains them again on the next connect.

=== Jail Levels ===
jaillevels=level names comma separated

Non-[[Playerworld staff|staff]] players in these levels will not be able to leave them. A [[Serverside]] [[Old GScript:setlevel2|setlevel2]] or warping with [[RC]] is neccessary. Also, they can send [[PM]]s only to RC clients and not regular [[Client]]s.
, ,

=== Explosion Restriction ===
noexplosions=true/false

Disables the result of [[Old GScript:putexplosion|putexplosion]], and `explosive' [[NPC weapons]].

=== Statistic Restriction ===
setbodyallowed=true/false
setheadallowed=true/false
setbomyallowed=true/false
setswordallowed=true/false
setshieldallowed=true/false

Whether the chat commands to change the player's [[Appearance commands|appearance]] are enabled. Defaults to true.

=== Gralat Loss Options ===
mindeathgralats=number
maxdeathgralats=number

Defines the amount of [[Gralat]]s that the player drops on death.

=== Staff Gralat Restriction ===
normaladminscanchangegralats=true/false

Whether normal [[RC]]s can change the gralat count of a player. `Normal' used to be defined as `below [[Adminlevel]] 4', but nowadays is probably regulated by certain high-level [[Admin right]]s.

=== Local 'Staff Guilds' ===
staffguilds=comma seperated list of guild names

Matches to these [[Guild]] names appear in the `Staff' section of the playerlist.

=== `Bush' Items ===
bushitems=true/false

Selects whether [[Bush]]es contain [[Item]]s. May not work on a [[GMap]].

=== `Baddy' Items ===
baddyitems=true/false

Selects whether [[Baddy|baddies]] drop [[Item]]s once killed.

=== `Healing' Swords ===
healswords=true/false

Selects whether is possible to have a negative [[Sword]] power and thus add [[Heart]]s to those hit by the sword.

=== Non-script timeouts ===
respawntime=number
horselifetime=number
baddyrespawntime=number

Timeout in seconds for respawn times for [[Bush]]es, [[Horse]]s and [[Baddy|Baddies]]

=== Server Scripting Flags ===
dontaddserverflags=true/false

Selects whether [[GScript|scripts]] can add new [[Server flag]]s or only modify existing ones.

=== Server Maps ===
bigmap=maptext,mapimage,defaultx,defaulty
minimap=maptext,mapimage,defaultx,defaulty

Default serverwide [[Map]]s. Syntax resembles [[Old GScript:setmap|setmap]] and [[Old GScript:setminimap|setminimap]] [[GScript]] commands.

=== Warping (All Players) ===
warptoforall=true/false
warptoforlowadmins=true/false

Whether all [[Player]]s can use the [[Warpto]] command, and whether [[Global]] [[Admin level]] 1 allows warpto.

=== Warping Activation ===
warpto=false/true
ignorewarpto=true/false

Allows or disallows the default [[Warpto]] command for all [[staff]], including [[Global]]s. This is normally enabled.

Note that warpto=false will show a "(warping is disabled)" error message to [[Player]], whereas ignorewarpto=true will treat [[Warpto]] commands as just normal chat text and display no error message.

The latter is good for replacing the default [[Warpto]] command with a scripted version.

=== Ghost Mode ===
ghostmodeenabled=true/false
ghostmodefornotstaff=true/false

Selects whether all [[Player]]s appear as [[Ghost]], or only non-[[Playerworld staff|staff]] players, or nobody.

=== Playerlist Icons ===
playerlisticons=comma seperated list of statusses

Possible status list, [[Player]]s can select one of them in the [[Players list]]. There must be a [[Downloadable]] file plisticonNAME.png available in a folder specified as `file' in [[Folder configuration]].

=== Profile Variables ===
profilevars=comma seperated list of profile variables

Selects what is to be displayed in a [[Player]]'s profile. The default variables are: playerkills, playerdeaths, playerfullhearts, playerrating, playerap, playerrupees, playerswordpower, canspin, largely modelled after [[Old GScript]]. Custom string variables can be added in the format `name=stringname'. If name is not specified, stringname is used.

=== Trial Account Limits ===
limitfreeplayers2=true/false

Selects whether to disable adding of [[Bomb]]s, [[Arrow]]s, and [[Explosion]]s for [[Trial account]]s.

=== AP System Activation ===
apsystem=true/false

Whether the [[AP]] system is enabled. If yes, there are some restrictions for [[Player]]s with low AP regarding hearts.

=== Starting AP ===
startap=number

How much [[AP]] [[Player]]s are given upon first login to this [[Playerworld]].

=== Global Guilds Activation ===
globalguilds=true/false

Allows or disallows [[Guild]] from the [[Global]] database. This is normally enabled.

allowedglobalguilds=guild,guild,guild

This option limits what guilds can be used from the [[Global Guilds]] database. (Note: globalguilds= needs to be set to false so other guilds besides the allowed can not be used.

=== AP Timeouts ===
aptime0=number
aptime1=number
aptime2=number
aptime3=number
aptime4=number

Time (in seconds) it takes to recharge one point of [[AP]] when the AP is currently below 20, 40, 60, 80 and 100 respectively. The defaults are 30, 90, 300, 600 and 1200.

=== Heart/Sword Limits ===
heartlimit=number
swordlimit=number

The maximum amount of fullhearts and swordpower that is allowed.

=== 'putnpc' Scripting Command ===
putnpcenabled=true/false

Whether the [[Old GScript:putnpc|putnpc]] command is enabled. (Mostly [[Deprecated]])

=== Language Selection ===
translatedlanguages=comma seperated list of language domains, like de,...

The languages of which a [[Translation system|translation]] file shall be loaded by the server. If a file exists, signs and _() text will be replaced with values from the translation file for this language. See [[Creation/Dev/Releases/Client/5.006#Translation_System|Graal v5 release notes]] for more.

=== Server Language ===
serverlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English.

=== Default Language ===
defaultlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English. Players see text in this language if their language is not in ''translatedlanguages''.

=== NPC-Server 'Sleep' ===
sleepwhennoplayers=true/false

Whether the [[NPC Server]] must execute [[GScript|scripts]] even when no [[Player]] is around.

=== Tilesets ===
newtilesets=true/false
newtilesetlevels=comma seperated list of levels

Whether all [[level]]s will use the new [[tileset]] layout, or a match list of levels that shall. This will influence collision behavior (onwall script function, serverside [[Creation/Dev/Script/Client/TProjectile|projectile]] hit detection, etc.) on server-side only.

You can specify just the start of the level name if you want to include a lot of levels at once (newtilesetlevels=myquest will switch on new tileset onwall behavior on server-side for myquest1.nw, myquest2.nw etc.).

=== Staff ===
staff=comma separated list of account names or community names

The [[Account]]s in this list will count as [[Playerworld staff]] as if their admin level was > 0. Their [[PM|mass messages]] override the option to ignore mass messages, their [[Admin rights]] will be applied, and if their [[IP address range]] matches their actual IP address, they may log in to [[RC]]. The ip-range will automatically be set to match their current ip / computer id once they login for the first time.

=== GMAP List ===
gmaps=comma seperated list of gmap files, without .gmap extension

The server will attempt to load these as [[GMap]]s. As this line might get rather crowded, it is possible to have multiple gmaps= lines.

=== Weapon Order ===
weaponorder=comma seperated list of weapon names

Specifies the order in which the [[NPC weapon]] [[GScript|scripts]] will be sent to the [[Clientside|client]] upon connection. This can be used to ensure that the inventory script that disables the [[Q menu]] will be sent first, for example. First, all weapons in this list will be sent in order, then all unlisted weapons.

=== NPC-Control Rights ===
npcrights=true/false

Whether [[NC rights]] are active. For security reasons, it is strongly recommended to set this to true.

=== Kill Count ===
dontchangekills=true/false

Selects whether the variables 'playerkills' and 'playerdeaths' can be changed [[serverside]] via [[GScript]].

=== NPC-Server Nickname ===
nickname=string

The [[NPC Server]] will use this as its [[Nick name]], with (Server) appended. Ignores all [[Guild]] tags.

=== Speedhack Tolerance ===
speedhacktolerance=number

This gives the percentage of data packages that [[Clientside|clients]] may send above the expected over without being logged as [[Trainer users]]. On [[Graal Kingdoms]], the rather conservative setting of 90 is used. If you set this too low, your server will crash.

=== Idle Disconnect ===
disconnectifnotmoved=true/false

Selects whether [[Idle]] [[Player]]s are automatically disconnected. (Possibly deprecated).

=== Save Levels ===
savelevels=true/false

Setting this to true allows changes to the [[Tile]]s of [[Level]]s to be saved to the actual level files from [[GScript|scripting]] commands, so it is possible to persistently change the levels.

savelevelsmessage=true/false

Specifies if saving of levels should be reported on the RC chat (by default enabled).

=== Only Staff ===
onlystaff=false

=== Log script function calls ===
scriptlogfunctions=write player.nick,write player.guild,call sendtonc,call sendtorc

This lets the npcserver log script activity into logs/scriptfunctionslog.txt. You
can get a list of available functons / actions by typing ''/listscriptlogfunctions''
on RC chat. Currently only important or exploitable things can be logged. Keep care
to delete the logs from time to time.

=== Log script errors to file ===
logscripterrorstofile=true/false

When enabled, all script errors (e.g. missing server-side script functions) will be logged into logs/scripterrors.txt instead of RC chat.

=== Level Auto-Save ===
levelsautosave=true/false
Whether or not updateboard2 changes are saved to the level file automatically (by default true). Works only if 'savelevels' is enabled as well.

=== Sending Player Attributes ===
sendtoallattr=comma seperated list of attribute numbers
Specifies which player attributes (#P/player.attr[]) are to be sent to all players on the server (instead of only to people who see you).
*Set the server options sendtoallattr=1,2,3 for sending attributes 1, 2 and 3 to all players.
*When #P1/attr[1] is changing then it is also invoking the event onPlayerChanges(player,id) like when the head is changing.

=== Optimized NPC Storage ===
newnpcstorage=true/false
Whether or not to use the optimized storage for NPCs placed via putnpc2.
If this option is set, NPCs with this.savelocally = true; will use the optimized NPC storage. This is recommended for NPCs that do not need to be loaded when the server is started up or do not need to be sitting in memory all of the time.

=== DBNPCs Protection ===
protectdbnpcs=true/false
Whether or not NPCs displayed in the NPC list in RC should be protected from being destroy()ed. Default is "true". This option has been added because they were previously not protected and some servers might prefer to be able to destroy them by script. This option doesn't affect NPCs created with the script command putnpc2() which are are still destroy()able.

=== Send NPC output to RCs ===
sendechotorc=true/false
Sends output of NPCs (echo() command) to everyone instead of only to people with NPC rights.

=== SQLite Databases ===
database=dbname,dbfile[,dbname2,dbfile2[,etc.]]
Allows several SQLite database files to be opened or closed with specified names and filenames for use the the requestsql2 function.
Source: http://forums.graalonline.com/forums/showpost.php?p=1557272&postcount=17

=== Player Syncing ===
syncdistancex=number
syncdistancey=number
syncbydistanceinside=true/false
Define the radius (in tiles) at which players are synced to the screen. This is used for GMAPs to reduce players from being drawn outside of the specified radius. By default, it is being drawn at 192x192.

=== Default Logging ===
disablegralatlog=true/false
Toggles whether or not the default gralat log will be used when a player picks up a gralat on the server.

=== Player Z Axis ===
lockplayerz=true/false
Disables player's z-axis on the server. Locks player.z to undefined and does not allow any type of alteration. Any value of z outside of |-50, 170| is considered undefined.

=== Hideplayer ===
nohidewithoutbush=true/false
Script command hideplayer(float) will no longer be working unless the player is under a bush.

=== Player Triggers ===
sendplayertriggers=true/false
Prevents triggeraction from triggering other players. By default on server triggers and mouse clicks, they are being processed by the server first, otherwise being processed by the player.

=== Item Drops ===
bushitemtypes=list
deathitemtypes=list
Examples for list are (greenrupee,bluerupee,goldrupee,darts,bombs,heart,etc).
These will define which items will be dropped from the specified event.
itemdropevents=true/false
When itemdropevents is enabled, each time an item is dropped (like heart, goldrupee, etc) it will send the event to Control-NPC as onItemDrop(level,x,y,itemname).

=== Item Spawn Percentages ===
spawnrategreenrupee=number
spawnratebluerupee=number
spawnrategoldrupee=number
spawnrateheart=number
spawnratebombs=number
spawnratedarts=number
spawnrate...=number
The value of these options are from 0 to 100, being a percentage at which the specified item will drop from a bush or death.

=== Horses ===
puthorseenabled=true/false
This option allows or pevents script command puthorse() from being executed on the server.

=== RC Mass PM ===
rcofftagoverridesignore=true/false
this option allows or prevents RC-Masses to override "ignore masses" when the Admin sending the Mass from RC is off-Staff Tag

=== Putbomb Filter ===
putbombenabled=true/false
bomballowedtypes=all or comma separated text of bomb power (e.g. 1,2,3)
bombfilterlog=true/false - logs to logs/bombfilter.txt

=== Showimg/Ani Filter ===
showimgstypes=all or ani,img,text
showimgsallowedganis=all or comma separated ganis (e.g. idle,walk,sit)
showimgsallowedimages=all or comma separated images (e.g. block.png,block2.png)
showimgsfilterlog=true - logs to logs/showimgsfilter.txt

Server options

2012-04-22T01:21:33Z

Fowlplay4:

[[Category:Administration]]
The '''server options''' are a collection of key=value configuration options that allow you to customize the non-[[GScript|script]]able behaviour of an individual [[Playerworld]].

== Usage ==

Options are usually set only by high [[Playerworld]] staff, preferably only the [[Playerworld]] owner, as they are very powerful and can be abused easily.

When you omit an option, its value will not be changed if the option has been used before. Therefore, it is more secure to change only the value and not whole option, should you need to change something.

Lines beginning with # are not parsed, and can be used for comments.

== Known Server Options ==

Please add new options if you discover them.

=== Start location ===
startlevel=level name
startx=number
starty=number

This sets the originating location for all [[Player]]s which do not have location statistics of their own saved [[Local|locally]].

=== Unstick me location ===
unstickmelevel=level name
unstickmex=number
unstickmey=number

These define the position that a [[Player]] is warped to after using the [[Unstick me]] command.

=== Unstick Time ===
unstickmetime=number

This option sets the amount of time a player has to be idle before they can use the unstick me command.

=== Protected Weapons ===
protectedweapons=list of comma seperated weapon names

[[NPC weapon]]s that cannot be deleted by the [[Player]]. This differs from weapons with asterisk prefixed name which cannot be deleted with the Del key, but still can be deleted on the [[Clientside]] using the [[Old GScript:destroy|destroy]] command. `Protected' weapons can (unless *ified) be deleted with Del, but the NPC server will not remove them from the player's weapon list and thus the [[Serverside]] part will remain and the player obtains them again on the next connect.

=== Jail Levels ===
jaillevels=level names comma separated

Non-[[Playerworld staff|staff]] players in these levels will not be able to leave them. A [[Serverside]] [[Old GScript:setlevel2|setlevel2]] or warping with [[RC]] is neccessary. Also, they can send [[PM]]s only to RC clients and not regular [[Client]]s.
, ,

=== Explosion Restriction ===
noexplosions=true/false

Disables the result of [[Old GScript:putexplosion|putexplosion]], and `explosive' [[NPC weapons]].

=== Statistic Restriction ===
setbodyallowed=true/false
setheadallowed=true/false
setbomyallowed=true/false
setswordallowed=true/false
setshieldallowed=true/false

Whether the chat commands to change the player's [[Appearance commands|appearance]] are enabled. Defaults to true.

=== Gralat Loss Options ===
mindeathgralats=number
maxdeathgralats=number

Defines the amount of [[Gralat]]s that the player drops on death.

=== Staff Gralat Restriction ===
normaladminscanchangegralats=true/false

Whether normal [[RC]]s can change the gralat count of a player. `Normal' used to be defined as `below [[Adminlevel]] 4', but nowadays is probably regulated by certain high-level [[Admin right]]s.

=== Local 'Staff Guilds' ===
staffguilds=comma seperated list of guild names

Matches to these [[Guild]] names appear in the `Staff' section of the playerlist.

=== `Bush' Items ===
bushitems=true/false

Selects whether [[Bush]]es contain [[Item]]s. May not work on a [[GMap]].

=== `Baddy' Items ===
baddyitems=true/false

Selects whether [[Baddy|baddies]] drop [[Item]]s once killed.

=== `Healing' Swords ===
healswords=true/false

Selects whether is possible to have a negative [[Sword]] power and thus add [[Heart]]s to those hit by the sword.

=== Non-script timeouts ===
respawntime=number
horselifetime=number
baddyrespawntime=number

Timeout in seconds for respawn times for [[Bush]]es, [[Horse]]s and [[Baddy|Baddies]]

=== Server Scripting Flags ===
dontaddserverflags=true/false

Selects whether [[GScript|scripts]] can add new [[Server flag]]s or only modify existing ones.

=== Server Maps ===
bigmap=maptext,mapimage,defaultx,defaulty
minimap=maptext,mapimage,defaultx,defaulty

Default serverwide [[Map]]s. Syntax resembles [[Old GScript:setmap|setmap]] and [[Old GScript:setminimap|setminimap]] [[GScript]] commands.

=== Warping (All Players) ===
warptoforall=true/false
warptoforlowadmins=true/false

Whether all [[Player]]s can use the [[Warpto]] command, and whether [[Global]] [[Admin level]] 1 allows warpto.

=== Warping Activation ===
warpto=false/true
ignorewarpto=true/false

Allows or disallows the default [[Warpto]] command for all [[staff]], including [[Global]]s. This is normally enabled.

Note that warpto=false will show a "(warping is disabled)" error message to [[Player]], whereas ignorewarpto=true will treat [[Warpto]] commands as just normal chat text and display no error message.

The latter is good for replacing the default [[Warpto]] command with a scripted version.

=== Ghost Mode ===
ghostmodeenabled=true/false
ghostmodefornotstaff=true/false

Selects whether all [[Player]]s appear as [[Ghost]], or only non-[[Playerworld staff|staff]] players, or nobody.

=== Playerlist Icons ===
playerlisticons=comma seperated list of statusses

Possible status list, [[Player]]s can select one of them in the [[Players list]]. There must be a [[Downloadable]] file plisticonNAME.png available in a folder specified as `file' in [[Folder configuration]].

=== Profile Variables ===
profilevars=comma seperated list of profile variables

Selects what is to be displayed in a [[Player]]'s profile. The default variables are: playerkills, playerdeaths, playerfullhearts, playerrating, playerap, playerrupees, playerswordpower, canspin, largely modelled after [[Old GScript]]. Custom string variables can be added in the format `name=stringname'. If name is not specified, stringname is used.

=== Trial Account Limits ===
limitfreeplayers2=true/false

Selects whether to disable adding of [[Bomb]]s, [[Arrow]]s, and [[Explosion]]s for [[Trial account]]s.

=== AP System Activation ===
apsystem=true/false

Whether the [[AP]] system is enabled. If yes, there are some restrictions for [[Player]]s with low AP regarding hearts.

=== Starting AP ===
startap=number

How much [[AP]] [[Player]]s are given upon first login to this [[Playerworld]].

=== Global Guilds Activation ===
globalguilds=true/false

Allows or disallows [[Guild]] from the [[Global]] database. This is normally enabled.

allowedglobalguilds=guild,guild,guild

This option limits what guilds can be used from the [[Global Guilds]] database. (Note: globalguilds= needs to be set to false so other guilds besides the allowed can not be used.

=== AP Timeouts ===
aptime0=number
aptime1=number
aptime2=number
aptime3=number
aptime4=number

Time (in seconds) it takes to recharge one point of [[AP]] when the AP is currently below 20, 40, 60, 80 and 100 respectively. The defaults are 30, 90, 300, 600 and 1200.

=== Heart/Sword Limits ===
heartlimit=number
swordlimit=number

The maximum amount of fullhearts and swordpower that is allowed.

=== 'putnpc' Scripting Command ===
putnpcenabled=true/false

Whether the [[Old GScript:putnpc|putnpc]] command is enabled. (Mostly [[Deprecated]])

=== Language Selection ===
translatedlanguages=comma seperated list of language domains, like de,...

The languages of which a [[Translation system|translation]] file shall be loaded by the server. If a file exists, signs and _() text will be replaced with values from the translation file for this language. See [[Creation/Dev/Releases/Client/5.006#Translation_System|Graal v5 release notes]] for more.

=== Server Language ===
serverlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English.

=== Default Language ===
defaultlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English. Players see text in this language if their language is not in ''translatedlanguages''.

=== NPC-Server 'Sleep' ===
sleepwhennoplayers=true/false

Whether the [[NPC Server]] must execute [[GScript|scripts]] even when no [[Player]] is around.

=== Tilesets ===
newtilesets=true/false
newtilesetlevels=comma seperated list of levels

Whether all [[level]]s will use the new [[tileset]] layout, or a match list of levels that shall. This will influence collision behavior (onwall script function, serverside [[Creation/Dev/Script/Client/TProjectile|projectile]] hit detection, etc.) on server-side only.

You can specify just the start of the level name if you want to include a lot of levels at once (newtilesetlevels=myquest will switch on new tileset onwall behavior on server-side for myquest1.nw, myquest2.nw etc.).

=== Staff ===
staff=comma separated list of account names or community names

The [[Account]]s in this list will count as [[Playerworld staff]] as if their admin level was > 0. Their [[PM|mass messages]] override the option to ignore mass messages, their [[Admin rights]] will be applied, and if their [[IP address range]] matches their actual IP address, they may log in to [[RC]]. The ip-range will automatically be set to match their current ip / computer id once they login for the first time.

=== GMAP List ===
gmaps=comma seperated list of gmap files, without .gmap extension

The server will attempt to load these as [[GMap]]s. As this line might get rather crowded, it is possible to have multiple gmaps= lines.

=== Weapon Order ===
weaponorder=comma seperated list of weapon names

Specifies the order in which the [[NPC weapon]] [[GScript|scripts]] will be sent to the [[Clientside|client]] upon connection. This can be used to ensure that the inventory script that disables the [[Q menu]] will be sent first, for example. First, all weapons in this list will be sent in order, then all unlisted weapons.

=== NPC-Control Rights ===
npcrights=true/false

Whether [[NC rights]] are active. For security reasons, it is strongly recommended to set this to true.

=== Kill Count ===
dontchangekills=true/false

Selects whether the variables 'playerkills' and 'playerdeaths' can be changed [[serverside]] via [[GScript]].

=== NPC-Server Nickname ===
nickname=string

The [[NPC Server]] will use this as its [[Nick name]], with (Server) appended. Ignores all [[Guild]] tags.

=== Speedhack Tolerance ===
speedhacktolerance=number

This gives the percentage of data packages that [[Clientside|clients]] may send above the expected over without being logged as [[Trainer users]]. On [[Graal Kingdoms]], the rather conservative setting of 90 is used. If you set this too low, your server will crash.

=== Idle Disconnect ===
disconnectifnotmoved=true/false

Selects whether [[Idle]] [[Player]]s are automatically disconnected. (Possibly deprecated).

=== Save Levels ===
savelevels=true/false

Setting this to true allows changes to the [[Tile]]s of [[Level]]s to be saved to the actual level files from [[GScript|scripting]] commands, so it is possible to persistently change the levels.

savelevelsmessage=true/false

Specifies if saving of levels should be reported on the RC chat (by default enabled).

=== Only Staff ===
onlystaff=false

=== Log script function calls ===
scriptlogfunctions=write player.nick,write player.guild,call sendtonc,call sendtorc

This lets the npcserver log script activity into logs/scriptfunctionslog.txt. You
can get a list of available functons / actions by typing ''/listscriptlogfunctions''
on RC chat. Currently only important or exploitable things can be logged. Keep care
to delete the logs from time to time.

=== Log script errors to file ===
logscripterrorstofile=true/false

When enabled, all script errors (e.g. missing server-side script functions) will be logged into logs/scripterrors.txt instead of RC chat.

=== Level Auto-Save ===
levelsautosave=true/false
Whether or not updateboard2 changes are saved to the level file automatically (by default true). Works only if 'savelevels' is enabled as well.

=== Sending Player Attributes ===
sendtoallattr=comma seperated list of attribute numbers
Specifies which player attributes (#P/player.attr[]) are to be sent to all players on the server (instead of only to people who see you).
*Set the server options sendtoallattr=1,2,3 for sending attributes 1, 2 and 3 to all players.
*When #P1/attr[1] is changing then it is also invoking the event onPlayerChanges(player,id) like when the head is changing.

=== Optimized NPC Storage ===
newnpcstorage=true/false
Whether or not to use the optimized storage for NPCs placed via putnpc2.
If this option is set, NPCs with this.savelocally = true; will use the optimized NPC storage. This is recommended for NPCs that do not need to be loaded when the server is started up or do not need to be sitting in memory all of the time.

=== DBNPCs Protection ===
protectdbnpcs=true/false
Whether or not NPCs displayed in the NPC list in RC should be protected from being destroy()ed. Default is "true". This option has been added because they were previously not protected and some servers might prefer to be able to destroy them by script. This option doesn't affect NPCs created with the script command putnpc2() which are are still destroy()able.

=== Send NPC output to RCs ===
sendechotorc=true/false
Sends output of NPCs (echo() command) to everyone instead of only to people with NPC rights.

=== SQLite Databases ===
database=dbname,dbfile[,dbname2,dbfile2[,etc.]]
Allows several SQLite database files to be opened or closed with specified names and filenames for use the the requestsql2 function.
Source: http://forums.graalonline.com/forums/showpost.php?p=1557272&postcount=17

=== Player Syncing ===
syncdistancex=number
syncdistancey=number
syncbydistanceinside=true/false
Define the radius (in tiles) at which players are synced to the screen. This is used for GMAPs to reduce players from being drawn outside of the specified radius. By default, it is being drawn at 192x192.

=== Default Logging ===
disablegralatlog=true/false
Toggles whether or not the default gralat log will be used when a player picks up a gralat on the server.

=== Player Z Axis ===
lockplayerz=true/false
Disables player's z-axis on the server. Locks player.z to undefined and does not allow any type of alteration. Any value of z outside of |-50, 170| is considered undefined.

=== Hideplayer ===
nohidewithoutbush=true/false
Script command hideplayer(float) will no longer be working unless the player is under a bush.

=== Player Triggers ===
sendplayertriggers=true/false
Prevents triggeraction from triggering other players. By default on server triggers and mouse clicks, they are being processed by the server first, otherwise being processed by the player.

=== Item Drops ===
bushitemtypes=list
deathitemtypes=list
Examples for list are (greenrupee,bluerupee,goldrupee,darts,bombs,heart,etc).
These will define which items will be dropped from the specified event.
itemdropevents=true/false
When itemdropevents is enabled, each time an item is dropped (like heart, goldrupee, etc) it will send the event to Control-NPC as onItemDrop(level,x,y,itemname).

=== Item Spawn Percentages ===
spawnrategreenrupee=number
spawnratebluerupee=number
spawnrategoldrupee=number
spawnrateheart=number
spawnratebombs=number
spawnratedarts=number
spawnrate...=number
The value of these options are from 0 to 100, being a percentage at which the specified item will drop from a bush or death.

=== Horses ===
puthorseenabled=true/false
This option allows or pevents script command puthorse() from being executed on the server.

=== RC Mass PM ===
rcofftagoverridesignore=true/false
this option allows or prevents RC-Masses to override "ignore masses" when the Admin sending the Mass from RC is off-Staff Tag

=== Putbomb Filter ===
putbombenabled=true/false
bomballowedtypes=all or comma separated text of bomb power (e.g. 1,2,3)
bombfilterlog=true/false - logs to logs/bombfilter.txt

=== Showimg/Ani Filter ===
showimgstypes=all or ani,img
showimgsallowedganis=all or comma separated ganis (e.g. idle,walk,sit)
showimgsallowedimages=all or comma separated images (e.g. block.png,block2.png)
showimgsfilterlog=true - logs to logs/showimgsfilter.txt

Particle Engine

2011-07-06T03:03:26Z

Fowlplay4: /* Reference */

[[Category:Scripting Reference]]
==Introduction==

The particle engine in Graal v4 is an extension of the SHOWIMG feature. With the command "showimg" scripts can display graphics, text, polygons and even animations on the screen. That command is mainly meant for client-side effects, but can also partially used on the serverside, and they can also be made visible on other player's screens. Graphics or texts displayed using this command will be called SHOWIMGs in this paper.

Each SHOWIMG can be used as emitter for particles. That way all kind of scripts can use the new particle engine - just display a SHOWIMG and set the attributes of the SHOWIMG so that the particle emitter is activated and is emitting particles. A particle can be seen as an independent graphic object that is put at the position of the emitter once it is emitted, then travelling over the screen, and disappearing once its lifetime is over or it is outside the allowed screen bounds. Actually a particle is itself a SHOWIMG and can so be used for any kind of graphical effect, and can theoretically even be used as emitter for other particles.

The reason for using a particle engine is speed: theoretically all graphical effects could be done by using scripts which call commands to display graphics or text. But often such effects contain several hundreds or even thousands of graphics, which must be moved and animated several times each second. If there are many objects using scripted particle effects that can slow down the game quite a lot. That's why it is possible in Graal v4 to use a built-in particle engine with many possible options to influence the look and behaviour of the particles so that most graphics effects can be displayed using that engine.

==Create a SHOWIMG==

To use the particle engine, you first need a SHOWIMG as emitter:

with (findimg(200)) {
x = player.x;
y = player.y;
}

The function findimg(index) is searching for an existing SHOWIMG with the index of 200 and then using that for setting the other attributes, otherwise it is automatically creating a new SHOWIMG with index 200 for the current object (npc, or player if its a weapon/gui-script). Afterwards it is setting the position of the SHOWIMG to position of the player.

==Configure emitter and particle==

Once the SHOWIMG is setup, you need to configure the emitter and the default attributes of the particle that should be emitted:

with (findimg(200)) {
x = player.x;
y = player.y;
emitter.attribute = value;
emitter.particle.attribute = value;
}

Possible attribute names are
(you can run "Graal4.exe -listscriptfunctions" to get the latest list of script functions):

TParticleEmitter (TGraalVar):
attachposition - boolean - says if the particle is moved with the emitter (true), or can fly freely (false)
autorotation - boolean - for making the particle heading into the direction it flies (rotation=angle)
checkbelowterrain - boolean - destroys the particles if they are below the terrain height (or zero on flat maps)
clippingbox - {xd1,yd1,zd1, xd2,yd2,zd2} - defines a box, if particles leave this box then they are destroyed
cliptoscreen - boolean - automatically resizes the clipping box to the visible area
continueafterdestroy - boolean
delaymin - float - minimum delay till the next automatic emission (>= 0.05 seconds)
delaymax - float - maximum delay till the next automatic emission
emissionoffset - {xd,yd,zd} - by default {0,0,0}, says at which position the particles should be emitted, relative to the current emitter position
emitautomatically - boolean - enables or disabled the automatic emission of particles after delaymin/delaymax time
firstinfront - boolean - says if the first emitted particle should be displayed in front (true by default)
maxparticles - integer - can be used to limit the total particle count
nrofparticles - integer - specifies how many particles are emitted at once
particle - object (read only) - defines the default attributes of the next emitted particle
wraptoclippingbox - boolean - if a particle leaves on one side, it appears on the other side (use with "cliptoscreen" option)
dropemitter - TParticleEmitter - works exactly like the emitter itself and are used for emitting particles once a particle drops on the ground (rain drops) or the lifetime is over (for fireworks)
dropwateremitter - TParticleEmitter - see dropemitter

TParticle (TGraalVar):
angle - float - the movement angle of the particle (horizontally on the (x,y) plane)
lifetime - float - in seconds, the particle will be destroyed when the lifetime is over
movementvector - string - says in which direction the particles moves, this is a combination of angle and zangle
speed - float - tiles per second
spin - float - automatic rotation of the particle (radiants each second)
zangle - float - the vertical movement angle - says if the particles goes up or down

Particle attributes that are the same like for a SHOWIMG:
alpha - float - transparency
ani - string - a gani file (use "projectile.actor" for changing the attributes)
blue - float - blue color value (0-1)
code - string - the old representation as 'font@style@text'
dimension - integer - polygon dimension (2 or 3)
dir - integer - animation direction
emitter - object (read only) - for specifying the attributes of a sub-emitter
font - string - text font name
green - float - green color value (0-1)
image - string - image filename
layer - integer - 4 or higher for particle which move in screen coordinates, below 4 for level coordinates
mode - integer - the image drawing mode (0 - add, 1 - transparent, 2 - subtract, 3 - daynight)
playerlook - boolean - if the animation should take it's head, body, sword, shield and attr[] from the owner (playerlook), set this to false if you want to set the images yourself by changing showimg.actor.head etc.
polygon - object - array of coordinates for displaying a 2 or 3 dimensional polygon
red - float - red color value (0-1)
rotation - float - defines in which direction the particle graphics is facing
stretchx - float - horizontal particle graphics stretch factor (default 1)
stretchy - float - vertical particle graphics stretch factor (default 1)
style - string - text style (e.g. "b" for bold text)
text - string - a text that should be displayed on the SHOWIMG position
zoom - float - zoom factor of the particle graphics or text

==Add particle modifiers==

Once you have setup the SHOWIMG and specified the attributes of the emitter and default particle, you can also specify particle modifiers so that the particles are not always flying into the same direction and look the same. There are 3 different functions, for modifying the default particle addemitmodifier(), for modifying all existing particles addglobalmodifier(), and for modifying the attributes for each particle individually addlocalmodifier(). The local modifiers are the most often used modifier.
Parameters are:
modifier type - once,impulse or range - modifies the particle one time, periodically or only in the given time range
rangemin - seconds, minimum delay until first modification or start of modification range (if modifier is "range")
rangemax - seconds, maximum delay until first modification or end of modification range (if modifier is "range")
variable - x,y,z,movex,movey,movez,angle,zangle,speed,rotation,spin,stretchx,stretchy,red,green,blue,alpha or zoom
variable modification type - replace,add or multiply (if modifier type is "range" then only "replace" and "add" are valid)
valuemin - range start of the random value or first value to set/add (if modifier is "range")
valuemax - range end of the random value or last value to set/add (if modifier is "range")

Those 3 functions addemitmodifier(), addglobalmodifier() and addlocalmodifier() are returning a modifier object which can be used to attach more variable modifications to the same impulse:

with (addlocalmodifier("impulse",1,2,"angle","replace",0,pi)) {
addmod("zoom","add",0.1,0.2);
}

This example is modifying the angle each 1-2 seconds, and at the same time it is zooming the particle so that it grows bigger. If you don't need to have the two modifiers act at the same moment, then you could have called addlocalmodifier("impulse",1,2,"zoom","add",0.1,0.2) which looks quite the same, but is not guaranteed to happen at the same moment like the first modifier. Most of the time you don't need the addmod-function though.

==Manually emitting particles==

If you have done the things mentioned in the previous steps, then the particle emitter is automatically emitting particles after the time specified with delaymin and delaymax. If you don't want that particles are automatically emitted, then set emitautomatically to false and call emitter.emit() directly.

==Controlling the particle emitter==

You can modify the particle emitter at any time by using the "with (findimg(index))" construct again as mentioned in "Create a SHOWIMG" chapter. To change the position where the particles are emitted you can just change the position of the SHOWIMG, e.g. moving it to the player position so that the particles are always emitted where the player stands.

It can also be interesting to watch the number of particles that the emitter has emitted, you can read the variables "currentparticlecount" and "emittedparticles" for that:

TParticleEmitter (TGraalVar):
currentparticlecount - integer (read only) - for watching how many particles exist
emittedparticles - integer (read only) - for seeing how many particles have been emitted in total

==Reference==

emitter
attachposition - Tells whether or not x/y position of particles is relative to the position of the emitter. Also tells if particles should move when the emitter is moved.
autorotation - Must be ture for making the particle heading into the direction it flies (rotation=angle)
checkbelowterrain - If true, the particle will be destroyed if it falls below the terrain height (0 for flat GMaps)
clippingbox - Format of {x1,y1,z1,x2,y2,z2}, particles that leave this box will be destroyed
cliptoscreen - boolean - automatically resizes the clipping box to the visible area
continueafterdestroy - boolean
currentparticlecount - Current number of particles that exist
delaymin - Minimum time before another particle is emitted
delaymax - Maximum time before another particle is emitted
emissionoffset - How far away from the emitter (or the level if attachposition=false) to emit particles. Format: {x,y,z}
emittedparticles - Total number of particles that have been emitted
firstinfront - Tells whether particles drawn after the first particle should draw on top or below the first
maxparticles - Maximum number of particles that can exist at once
nrofparticles - Number of particles to release at once
isfrozen - Boolean, stops all particles if true
wraptoclippingbox - boolean - if a particle leaves on one side, it appears on the other side (use with "cliptoscreen" option)
dropemitter - TParticleEmitter - works exactly like the emitter itself and are used for emitting particles once a particle drops on the ground (rain drops) or the lifetime is over (for fireworks)
dropwateremitter - TParticleEmitter - see dropemitter

particle
lifetime - Time (in seconds) before a particle is destroyed
image - Image to use for the particle
mode - Drawing mode of the image. (0 = add, 1 = replace, 2 = subtract, 3 = daynight) See changeimgmode
alpha - Alpha transparency of a particle (0 = invisible, 1 = opaque)
zoom - Zoomfactor of a particle
angle - Movement angle for the particle (for x/y)
zangle - Up/down movement angle for the particle
speed - How many tiles or pixels the particle should move (depends on if its in a level or on the GUI)
rotation - Angle for rotating the image (set autorotation=true to automatically set rotation=angle)
spin - How much the image should be rotated each second, can be postive and negative
stretchx - How much to stretch the particle image horizontally
stretchy - How much to stretch the particle image vertically
red, green, blue - Used to change color of particle
dimension - Polygon dimension (2 or 3)
movementvector - Format is {float,float,float}, a combination of x, y and z

Emitter functions:
addlocalmodifier("string",float,float,"string","string",float,float)
Parameters:
First - Tells when to do an action
once - Do it once
range - Do the action during the range of time param2-param3
impulse - Do it randomly
Second - Tells the minimum time to wait before doing an action (except for 'range')
Third - Tells the maximum time to wait before doing an action (except for 'range')
Fourth - Tells what action to perform
Everything under "particle" except for the following can be changed: image , text, ani, font, movementvector, style
x - x position of the particle
y - y position of the particle
z - z position of the particle
movex - How far the particle should move horizontally in its lifetime
movey - How far the particle should move vertically in its lifetime
movez - How far the particle should move above the ground in its lifetime
Fifth - Tells what to do with parameters 6 and 7
add - Add the amount (use negatives to subtract)
replace - Set a new amount
multiply - Multiply the amount (use negatives to divide)
Sixth - Minimum amount
Seventh - Maximum amount
addglobalmodifier() - Same as addlocalmodifier, except it affects all particles at once
addemitmodifier() - Same as addlocalmodifier, except it only affects emitter.particle
addmod() - Used in conjunction with addlocalmodifier, same parameters except no parameters 1-3
emit() - Do one emission
removemodifiers() - Remove modifiers set
removeparticles() - Remove particles

==Examples==

<pre>
with (findimg(200)) {
emitter.nrofparticles = 1;
emitter.particle.image = "block.png";
}
</pre>
 
<pre>
with (findimg(200)) {
// Chimney

// Emitter attributes
layer = 2;
emitter.delaymin = 0.1;
emitter.delaymax = 0.2;
emitter.nrofparticles = 1;

// Basic particle attributes
emitter.particle.lifetime = 3;
emitter.particle.image = "g4_particle_smoke.png";
emitter.particle.mode = 1; // alpha transparent
emitter.particle.alpha = 0.8;
emitter.particle.zoom = 1;

// Movement
emitter.particle.angle = pi / 2;
emitter.particle.speed = 8;
emitter.addglobalmodifier("impulse", 0.2, 0.2, "spin", "multiply", 0.9, 0.9);
emitter.addlocalmodifier("once", 0, 0, "angle", "add", -0.2, 0.2);
emitter.addlocalmodifier("once", 0, 0, "rotation", "replace", 0, 2*pi);
emitter.addlocalmodifier("range", 1, 3, "alpha", "replace", 0.8, 0);
emitter.addlocalmodifier("range", 0, 3, "zoom", "add", 0.25, 0.25);
emitter.addlocalmodifier("range", 0, 0.5, "speed", "replace", 12, 4);
emitter.addlocalmodifier("range", 0.5, 3, "speed", "replace", 4, 1.5);
emitter.addlocalmodifier("once", 0, 0, "spin", "replace", 2, 4);
}
</pre>

==Useful articles==
[[Creation/Dev/Script/Client/TParticleEmitter]]

[[Creation/Dev/Script/Client/TParticle]]

[[Creation/Dev/Releases/Client/4.03]]

Particle Engine

2011-07-06T03:03:04Z

Fowlplay4: /* Configure emitter and particle */

Creation/Dev/Script/Client/TServerPlayer

2011-04-24T20:14:03Z

Fowlplay4: /* Variables */

[[Category:Scripting Reference]]
{{Script Object}}
Inherits [[Creation/Dev/Script/Client/TGaniObject|TGaniObject]].

=Variables=
{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Type'''
| '''Description'''
|-
| account
| string (read only)
|
|-
| ap
| integer
|
|-
| attached
| boolean (read only)
|
|-
| bombs
| integer
|
|-
| chat
| string
|
|-
| chatoffset
| string
| set to {deltax,deltay} if you want to change the position of chat and emoticons for bigger characters; chat only uses deltay
|-
| communityname
| string (read only)
|
|-
| darts
| integer
|
|-
| fullhearts
| integer (read only)
|
|-
| glovepower
| integer
|
|-
| gralats
| integer
|
|-
| guild
| string (read only)
|
|-
| headimg
| string
|
|-
| headset
| integer
|
|-
| hearts
| float (read only)
|
|-
| horseimg
| string (read only)
|
|-
| hp
| float (read only)
|
|-
| id
| integer (read only)
|
|-
| isadmin
| boolean (read only)
|
|-
| ischannel
| boolean (read only)
|
|-
| ischannelopen
| boolean (read only)
|
|-
| ischanneluser
| boolean (read only)
|
|-
| isexternal
| boolean (read only)
|
|-
| isfemale
| boolean (read only)
|
|-
| isignoring
| boolean (read only)
|
|-
| isloggedin
| boolean (read only)
|
|-
| ismale
| boolean (read only)
|
|-
| ismuted
| boolean (read only)
|
|-
| ismuting
| boolean (read only)
|
|-
| language
| string (read only)
|
|-
| languagedomain
| string (read only)
|
|-
| maxhp
| integer (read only)
|
|-
| messagebubble
| integer (read only)
|
|-
| mp
| integer
|
|-
| nick
| string
|
|-
| platform
| string (read only)
|
|-
| rupees
| integer
| Use ''gralats'' instead
|-
| shieldimg
| string
|
|-
| shieldpower
| integer (read only)
|
|-
| swordimg
| string
|
|-
| swordpower
| integer (read only)
|
|-
| x
| float
|
|-
| y
| float
|
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Return Type'''
| '''Description'''
|-
| isguildpm()
| boolean
|
|-
| ismasspm()
| boolean
|
|-
| pmswaiting()
| boolean
|
|-
| openexternalhistory()
| boolean
| Open's PM History between you and the player.
|-
| openexternalpm(bool)
| boolean
| as parameter specify 'true' if it should display the pm sent by the player, otherwise always open a blank PM window.
|-
| showprofile()
|
| Open's the player's profile.
|}

Creation/Dev/Script/Client/TServerPlayer

2011-04-24T20:11:29Z

Fowlplay4: /* Functions */

[[Category:Scripting Reference]]
{{Script Object}}
Inherits [[Creation/Dev/Script/Client/TGaniObject|TGaniObject]].

=Variables=
{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Type'''
| '''Description'''
|-
| account
| string (read only)
|
|-
| ap
| integer
|
|-
| attached
| boolean (read only)
|
|-
| bombs
| integer
|
|-
| chat
| string
|
|-
| darts
| integer
|
|-
| fullhearts
| integer (read only)
|
|-
| glovepower
| integer
|
|-
| gralats
| integer
|
|-
| guild
| string (read only)
|
|-
| headimg
| string
|
|-
| headset
| integer
|
|-
| hearts
| float (read only)
|
|-
| horseimg
| string (read only)
|
|-
| hp
| float (read only)
|
|-
| id
| integer (read only)
|
|-
| isadmin
| boolean (read only)
|
|-
| ischannel
| boolean (read only)
|
|-
| ischannelopen
| boolean (read only)
|
|-
| ischanneluser
| boolean (read only)
|
|-
| isexternal
| boolean (read only)
|
|-
| isfemale
| boolean (read only)
|
|-
| isignoring
| boolean (read only)
|
|-
| isloggedin
| boolean (read only)
|
|-
| ismale
| boolean (read only)
|
|-
| ismuted
| boolean (read only)
|
|-
| ismuting
| boolean (read only)
|
|-
| language
| string (read only)
|
|-
| languagedomain
| string (read only)
|
|-
| maxhp
| integer (read only)
|
|-
| messagebubble
| integer (read only)
|
|-
| mp
| integer
|
|-
| nick
| string
|
|-
| platform
| string (read only)
|
|-
| rupees
| integer
| Use ''gralats'' instead
|-
| shieldimg
| string
|
|-
| shieldpower
| integer (read only)
|
|-
| swordimg
| string
|
|-
| swordpower
| integer (read only)
|
|-
| x
| float
|
|-
| y
| float
|
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Return Type'''
| '''Description'''
|-
| isguildpm()
| boolean
|
|-
| ismasspm()
| boolean
|
|-
| pmswaiting()
| boolean
|
|-
| openexternalhistory()
| boolean
| Open's PM History between you and the player.
|-
| openexternalpm(bool)
| boolean
| as parameter specify 'true' if it should display the pm sent by the player, otherwise always open a blank PM window.
|-
| showprofile()
|
| Open's the player's profile.
|}

Creation/Dev/Terrain Generator

2011-04-15T21:06:39Z

Fowlplay4:

[[Category:Graal Kingdoms Development]][[Category:Scripting Reference]][[Category:Levels]]
The terrain generator tool can be used to generate
maps for Graal which use 3D terrain.

[[Image:Terrain Generator.png|320px]]
==Usage==
Start TerrainGenerator.exe and click on 'Generate World' to see a map generated using fractal algorithms. To make an island click on the 'Islands' preset button first. For a more detailed view click on 'Show level details'. You can also directly edit the terrain by clicking on the grid and moving the mouse up/down.

If you need additional help try reading the following guide [http://forums.graalonline.com/forums/showpost.php?p=1643518&postcount=3 How To Generate and Use a Terrain Map Offline].

==Random seeds==
For finding the best map you will need to click several times on the 'Generate World' button. Once you have found a good one, you can write down the random seed that is displayed in the upper right corner of the window. Using that number you can always generate the map again - click on 'random', then enter the number.

==Export==
Click on the save button (disc-icon) to save the generated world as .gmap file. If you enable 'Generate Graal levels' then the terrain generator will also generate all the needed level files and save them in the same folder.

==Enable the map in Graal==
For offline tests, add the gmap name into a file loadgmaps.txt, and put that text file into the Graal folder. Next time you are starting Graal it will automatically load the gmap if it is in the current folder or in the Graal folders. To see nice tiles you must add a tile definition: add a line
<pre>
picso.png,LEVELSTART,5,0,0
</pre>
to levels/tiledefs/tiledefsoffline.txt. LEVELSTART is the first part of the map name, e.g. 'myworld' in 'myworld.gmap'.

==Using it online==
Upload the gmap, and add a line
gmaps=LEVELSTART
to the serveroptions. You can put several maps into the same line, separate their names with commas. You can also add several gmaps= lines. Afterwards upload the sublevels. Now you should be able to enter the map. To set the good tiles you need to call the 'addtiledef' command in a weapon script. Add a weapon called '-Initialization' (the minus for not displaying it in the weapon list), set the script to this:

<pre>
//#CLIENTSIDE
function onCreated() {
addtiledef("picso.png", "LEVELSTART", 5);
loadmap("GMAPNAME");
}
</pre>

The 'loadmap' command is not really necessary, but can speed up the entering of maps because the map is preloaded. To add that weapon script to each player, add following script to the 'Control-NPC' of your server:

<pre>
function onActionPlayerOnline() {
addweapon("-Initialization");
}
</pre>

==Using different graphics==
If you want to replace picso.png with new tiles then just change the tiledefsoffline.txt file (for offline testing) and the '-Initialization' weapon to use your new tiles instead of 'picso.png'. Don't forget to upload the tiles to the server. Do '/find filename' on RC to see if the folder configuration is
correct and people can download the file.

Creation/Dev/Tileset

2011-04-09T23:47:35Z

2011-04-09T19:42:01Z

Fowlplay4: /* Example */

{{Template:Script_Object}}

Inherits from [[Creation/Dev/Script/Client/TGraalVar|TGraalVar]].

=Description=

[[Image:Guicontrol_panel.png]]

GuiControl is the base GUI control, therefore general functions listed here are available to all GUI controls. Most of the time it is used as container for positioning groups of other controls. It can either have a border (border=1..5) or just be plain transparent, and just display its child controls.

=Variables=

{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Type'''
| '''Description'''
|-
| active
| boolean
| whether the control can be used (e.g. a button can be clicked only if active)
|-
| awake
| boolean (read only)
|
|-
| canmove
| boolean
| allows the control to be moved by the mouse
|-
| canresize
| boolean
| allows the control to be resized by dragging the corner or side with the mouse
|-
| controls
| object (read only; see ''addControl()'')
| array of [[Creation/Dev/Script/Client/GuiControl|GuiControl]] (subcontrols)
|-
| cursor
| int
| cursor when the mouse is hovered over the control - options are default, hand/pointer, text, crosshair, column-reisze, row-resize, wait, progress, and help (some are not available based on platform)
|-
| editing
| boolean
|
|-
| extent
| string
| Can be used instead of width and height. Used like this: "123 456", where 123 is width and 456 is height. There is some syntactic sugar that allows you to treat it like an array, but it is not a good idea to do this because it does not work when you try to assign to e.g extent[0]. See 'width' and 'height' instead for this.
|-
| flickering
| boolean
| Allows the control to periodically show/hide itself.
|-
| flickertime
| integer
| The time between the show and hides in flickering.
|-
| height
| integer
| can be used instead of extent
|-
| hint
| string
| tooltip text displayed when you hover the mouse over the control
|-
| horizsizing
| string
| specifies the horizontal resizing behaviour when the parent control is resized: right, width, left, center or relative
|-
| layer
| integer (read only)
| image layer the control is on
|-
| minextent
| string
| minimum size as a string like "200 300", though there is some support for arrays which is not complete (e.g. you cannot set minextent[0])
|-
| minsize
| string
| the same as "minextent"
|-
| parent
| object (read only)
| the parent [[Creation/Dev/Script/Client/GuiControl|GuiControl]]
|-
| position
| string
| Can be used instead of x and y. Used like this: "123 456", where 123 is x and 456 is y. There is some syntactic sugar that allows you to treat it like an array, which does not work when you try to assign to e.g position[0]. See 'x' and 'y' instead for this.
|-
| profile
| object
| controls the way the profile looks and acts - see [[Creation/Dev/Script/Client/GuiControlProfile|GuiControlProfile]]
|-
| resizeheight
| boolean
|
|-
| resizewidth
| boolean
|
|-
| scrolllinex
| integer
| lines to scroll vertically
|-
| scrollliney
| integer
| lines to scroll horizontally
|-
| showhint
| boolean
| whether to show the hint or not
|-
| useownprofile
| boolean
| allows you to set custom variables for the profile without modifying the profile at every instance it is used, set it to true before changing things
|-
| vertsizing
| string
| specifies the vertical resizing behaviour when the parent control is resized: bottom, height, top, center or relative
|-
| visible
| boolean
| whether the control can be seen or is hidden
|-
| width
| integer
| can be used instead of extent
|-
| x
| integer
| can be used instead of position
|-
| y
| integer
| can be used instead of position
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Return Type'''
| '''Description'''
|-
| addcontrol(obj)
|
| adds the control inside another control
|-
| bringtofront()
|
| bring the control to the front
|-
| clearControls()
|
| removes all controls inside the control at once
|-
| destroy()
|
|
|-
| getparent()
| object
| returns parent object
|-
| globaltolocalcoord({x,y})
| {x,y}
| converts global screen coordinates to a position relative to the controls origin (0,0), can be used to know where exactly the user has clicked inside a control
|-
| hide()
|
| Hide the control
|-
| isfirstresponder()
| boolean
| Returns whether or not this control is the first responder
|-
| localtoglobalcoord({x,y})
| {x,y}
| converts a position relative to the controls origin (0,0) to global screen coordinates, can be used to know where on the screen a control is displayed in case it is a child of another control (e.g. GuiWindowCtrl or GuiScrollCtrl)
|-
| makefirstresponder(bool)
|
| makes the control the first responder for key input
|-
| pushtoback()
|
| pushes the control to the back
|-
| resize(int x, int y, int width, int height)
|
| resizes the control to the specified dimensions
|-
| show()
|
| shows the control
|-
| showtop()
|
| calls show(), tabfirst() and bringtofront()
|-
| tabfirst()
| object
| when tab is pressed, the control is selected first, similar to web forms
|}

=Events=

onAdd() - is invoked when the control is added to another control (addcontrol function)

onRemove() - is invoked when the control is removed from its parent

onShow() - is invoked when the control is shown or gets awakened while being 'visible'

onHide() - is invoked when the control is made hidden

onWake() - is invoked when the control is awakened and becomes visible on the screen

onSleep() - is invoked for windows when a dialog window is removed from the screen

onMove(newx,newy) - is invoked when the control is moved

onResize(newwidth,newheight) - is invoked when the control is resized

onAction() - is invoked when a button control is pressed, you press the enter-key in a text edit control, or move a slider control,

onDialogPush() - is invoked when a dialog control is placed on the screen (using pushDialog(control))

onDialogPop() - is invoked when a dialog control is removed from the screen again (using popDialog())

onKeyDown(keycode,keystring,scancode) - a key has been pressed while the control had the input focus (makeFirstResponder())

onKeyUp(keycode,keystring,scancode) - the key has been released

onMouseYawPitch(xaxis,yaxis) - mouse event in Graal3D when the mouse has been turned off

onMouseDown(keymodifier,mousescreenx,mousescreeny,clickcount) - the left mouse button has been pressed inside this control

onMouseUp(keymodifier,mousescreenx,mousescreeny) - the left mouse button has been released

onMouseEnter(keymodifier,mousescreenx,mousescreeny) - the mouse moved inside this control

onMouseLeave(keymodifier,mousescreenx,mousescreeny) - the mouse left the control

onMouseDragged(keymodifier,mousescreenx,mousescreeny) - the mouse is moved while the left mouse button is pressed

onMouseMove(keymodifier,mousescreenx,mousescreeny) - the mouse has been moved

onRightMouseDown(keymodifier,mousescreenx,mousescreeny,clickcount) - the right mouse button has been pressed

onRightMouseUp(keymodifier,mousescreenx,mousescreeny) - the right mouse button has been released

onRightMouseDragged(keymodifier,mousescreenx,mousescreeny) - the mouse has been moved while the right mouse button is pressed

onMouseWheelUp(keymodifier) - the mouse wheel has been scrolled up

onMouseWheelDown(keymodifier) - the mouse wheel has been scrolled down

=Example=

new GuiControl("Test_Back") {
useownprofile = true;
profile.border = 3;
x = 10;
y = 10;
width = 160;
height = 80;
}

 

{{:Creation/Dev/Script/Client}}

2006-11-20T04:59:47Z

Fowlplay4: /* '''Excalibur's Scripting Guide''' */

== '''Excalibur's Scripting Guide''' ==
I'm hoping this allows people to learn how to script a bit easier, I believe all staff should know some scripting basics, and I find other GS2 guides hard to follow. This should help you get started out. I'm afraid it isn't complete and there are a few typos in it. I'm working on it.

Starting:

Level NPCs:

A level NPC is an npc that functions in a specific level. These are the most common on most servers. They are also a very important part of developement.

A script:
<pre>
//this is a note
/*

this is also a note, these help make scripts more clear
this type of note can go on as longe as it's inclosed
*/
//#CLIENTSIDE
//This tells the computer that the following
//script will be on the players client,
//as opposed to the server, this is very important.
function onPlayerTouchsMe()
//this checks if the player has touched the NPC
{ // starting bracket
this.chat = "Hey!"; //displays a message above the NPC
}//closing bracket
</pre>
The above script checks to see if the event, playertouchsme is true, then acts on what is in the bracket. It is important to include this clientside, because too many serverside scripts can cause problems for an NPC server, however they are more secure. If you wanted to do the last script serverside, you would omit the //#CLIENTSIDE , and add the shape to the NPC:
<pre>
function onCreated()
{
setshape(1,32,32);
setimg("block.png");
//img can also be done in the box above the script
}
function onPlayertouchsme()
{
this.chat = "You made a serverside script!";
}
</pre>
This takes a bit longer than clientside commands, and it takes up serverside script time, however, for secure actions, it may be necessary.
A secure script example:
<pre>
function onCreated()
{
this.account="Excaliber7388";
setshape(1,32,32);
this.chat="Excaliber's Chest";
}
function onPlayertouchsme()
{
if(player.account==this.account)
{
this.chat="This is a secure message!";
}
}
</pre>
First, I would like to quickly point out the 'if' statement. Some guides go into this a lot, but it's actually quite simple. The if statement is a very important part of scripting. It's what allows the NPC to make choices. The code withing the brackets of an if statement will only execute if the statement is true. Also, there is a catchall statement you can use, else. If the if statement is not true, the else will exectue it's script, other wise it is ignored.
Example:
<pre>
//#CLIENTSIDE
function onCreated()
{
this.a=1;
}
if(this.a==1)
//always use '==' for comparasons, NEVER just '=' as '=' is for assignments
{
this.b=2;
}
else if(this.a==2) //will only execute if first is false, AND this.a==2
{
this.b=3;
}
else //catch all if above 2 statements are false
{
this.b=4;
}
</pre>
Now, in the above example, this.b will always be 2, however, it's the format that's important.
<pre>
if(statement)
else if(statement)
else if(statement //may be used many times
else //catch all
</pre>
Now, back to serverside and clientside scripts:
By putting the checks on serverside, you disable a hackers ability to send an action from their client. So, this script is much more secure, and can only be accessed by the specified account (Excaliber7388 in this case). Most playerworlds and classic servers do these checks serverside as well, but we also apply a different method, to avoid having too much serverside script time:
<pre>
function onCreated()
{
this.account="Excaliber7388";
setshape 1,32,32;
this.chat="Excaliber's Chest";
}
function onActiontouched()
{
if(player.account==this.account)
{
this.chat="Yup, this is still secure, yay!";
}
}
//#CLIENTSIDE
function onPlayertouchsme()
{
triggeraction(x,y,"Touched","Touched");//no params needed
}
</pre>
This script will take up more time, but the playertouchsme check is clientside. Would this help much? Probably not, in fact, sending the action in this case would probably create more lag than having the script serverside. However, if a large portion of the script is serverside, and can be moved to clientside without risking security, it may be a good idea.
Serverisde timeouts=bad idea.
You shouldn't send to many actions to serverside, especially if you do so quickly. You should always limit the serverside timeouts, and the amount of time between actions to the server from client should be spaced out. Also, you should never have a timeout shorter than .05 on serverside, though it is possible, please do not do it. Many playerworlds have expierenced problems from serverside timeouts which can lead to NPC server crashing or lagging.

Here are two examples of serverside scripts, the first is [b]VERY[/b] bad, the second is more productive:
<pre>
function onCreated()
{
setshape 1,32,32;
}
function onActiontime()
{
for(server.i=0;server.i<5;server.i++)
//WHY use server for this???
//for loops, use this. it works only for this NPC
{
sleep(.01);
//WAY to short of a sleep time for the server
}
server.time+=.1;
}
//#CLIENTSIDE
function onCreated()
{
settimer(.05); //minimum clientside timeout
}
function onTimeout()
{
trigegraction(x,y,"time","time");
settimer(.05);
//Will cause a loop through the timeout, sending action
//to serverside TOO quickly, AND while the server is
//still working on the last action. This WILL cause the
//server to crash.
}
</pre>
If you put the above script on a server, say goodbye to your NPC server, because it will crach pretty quickly!
A better version:
<pre>function onCreated()
{
setshape 1,32,32;
//setshape is needed for all level NPCs triggeractions
//this sets it to a square of tiles 32x32 pixels.
}
function onActiontime()
{
server.time++;
//no need for incredible accuracy
}
//#CLIENTSIDE
function onCreated()
{
settimer(1);
}
function onTimeout()
{
triggeraction(x,y,"time","time");
settimer(1);
}
</pre>
This will execute the script less often, however, it still is an unlimited loop. Don't have too many of these NPCs, or you could have problems!

Now, you may have noticed this line in the bad script:
<pre>
for(server.i=0;server.i<5;server.i++)
</pre>
This is a 'for' loop. There are many types of loops, however the for loop isn't the easiest to learn first. Therefore, I will show you the 'while loop' first.
The while loop executes whatever is held within it's brackets as long as the statement within it is true. The while loop is just like an if statement, but you cannot use else with a with statement.
format:
<pre>
while(statments)
{
//commands
}
//if statment is still true, it will loop
</pre>
here's a script example:
<pre>
//#CLIENTSIDE
function onCreated()
{
this.size=10;
}
while(this.size<=20) //while this.size is less than or equal to 20
{
this.chat="The fish was " @this.size@ " centimeters long!";
//as the story is retold....
sleep(.5);
this.size=this.size+1;
//increment the size
}
</pre>
The above script will run through the loop until this.size is equal or greater than 20.
Some important things to know:
<pre>
if(a==b) means if a is equal to b
if(a<b) means if a is less than b
if(a>b) means if a is greater than b
if(a<=b) means if a is less than or equal to be
if(a>=b) means if a is greater than or equal to be
a++ is the same as a=a+1
a-- is the same as a=a-1
a+=b means a=a+b
a-=b means a=a-b
a*=b means a=a*b (multiplied by b)
a/=b means a=a/b
++a is just like a, but it will add to a before anything else in the line,
this is not important to know now
--a just like ++a, but with subtraction
a%b Modulus, basically, its a/b and th remainder is the output
for example 10%3=1
</pre>
These may be helpfull in loops, or in any other rational expressions you may use. (Well, it's important for all scripting!)
Now, recall this line:
<pre>
this.chat="The fish was " @this.size@ " centimeters long!";
</pre>
The output for this is: The fish was (size here) centimeters long!
The script NEEDS to know where a variable is, so if you want to put it in between a string you surround it with the '@' symbol. Or if it's at the end, you only put the '@' at the beggining of the variable. The variable and the '@' do NOT go in the quotes. Example:
<pre>
//#CLIENTSIDE
function onPlayertouchsme()
{
this.chat="Well hi there, " @player.account@ " I like your sword, " @player.swordimg;
}
</pre>
This would display the player's account, and sword image.

Now, back to the 'for' loop.
This a very interesting loop it's format is as follows:
<pre>
for(command;expression;command)
{
}
</pre>
Here's an example:
<pre>
//#CLIENTSIDE
function onPlayertouchsme()
{
for(this.i=0;this.i<10;this.i++)
{
this.chat="Loops: " @this.i;
sleep(.5);
}
}
</pre>
This loop would be activated when the player touchs it.
It would go through 10 loops, displaying the count, and taking .5 seconds for each loop (due to the sleep() command)
Now remember this while loop?
<pre>
function onCreated()
{
this.size=10;
}
while(this.size<=20)
{
this.chat="The fish was " @this.size@ " centimeters long!";
//as the story is retold....
sleep(.5);
this.size=this.size+1;
//increment the size
}
</pre>
There's an easier way of doing it with a for loop, in fact all loops done with while can be replaced by for.
<pre>
for(this.size=10;this.size<=20;this.size++)
{
this.chat="The fish was " @this.size@ " centimeters long!";
sleep(.5);
}
</pre>
See? Much shorter and easier to use!
Once you know the format of a for loop, you can make longer and more complex loops as well, and they'll take less time to script, which is always a bonus.

Some more detail on actions:
An action is an effective way to use a portion of script more than once, have one script act on another script, more script to serverside from clientside (and the other way) and more.
So how do you use them? Here's the format:
<pre>
triggeraction(x,y,"params[0]","params[1]");
</pre>
You must have two parameters, but you can have as many as you want a quick example:
<pre>
function onCreated()
{
setshape 1,32,32;
}
function onActiontrigger()
{
player.chat="Account: " @params[1]@ " Sword " @params[2]@ " head: " @params[3];
}
//#CLIENTSIDE
function onPlayerchats()
{
if(player.chat=="Who am I?") //amnesia? multiple identities?
{
triggeraction(x,y,"trigger",player.account,player.swordimg,player.headimg);
}
}
</pre>
See? You can make more than one parameter.
Now, there are a few differences between a level NPC with a triggeraction, and a weapon with a triggeraction. Weapons need their location (serverside or clientside) as the first parameter, params[0] is the one after it. Here, you can have just one parameter, and the x and y is always 0 (because the npc server is at 0,0), and you need to include the name of the weapon in the action.
here's an example:
<pre>
//weapon script with a triggeraction
//Weapon name: Fire Ball
function onActionserverside()
{
if(params[0]=="mp")
{
playermp-=10
}
}
//#CLIENTSIDE
function onWeaponfired()
{
if(playermp>=10)
{
shootfireball(playerdir);
triggeraction(0,0,"serverside","Fireball","mp");
}
else
{
player.chat="Not enough mp!";
}
}
</pre>
This nifty little weapon will cost 10 mp per use, and fires a fireball in the direction the player is facing. Hopefully, you can learn to make many weapons of your own!
Triggeractions can be used in shops as well (and these are the scripts people ask for the most).
<pre>
//a shop script, yay!
function onCreated()
{
setshape 1,32,32;
}
function onActionbuy()
{
if(playerrupees>=100)
{
addweapon Fire Ball;
playerrupees-=100;
}
}
//#CLIENTSIDE
function onPlayerchats()
{
if(player.chat=="buy fire ball")
{
triggeraction(x,y,"buy","buy");
//the level npc triggeraction type
}
}
</pre>
There, now you can make a little shop that sells a Fire Ball weapon. Have fun with it, search the commands, there's plenty of easy weapons you can make, and the weapon script is easy to follow and modify as well. Hopefully, you know enough about parameters to make more than one weapon for sale in the same NPC, just make the weapon name part of the action, then check for that parameter before they can buy.
Now there are other types of loops. One I commonly see is a timeout loop. You should understand why. Back with GS1, it was a bit easier to tell what was happening in the script. In GS1 the script for function onTimeout() would be displayed as if(timeout). It was a bit easier to tell that when a timeout was done, it set a flag that if(timeout) would check. function onTimeout does the same thing, however, for new users this may be harder to tell. here's an example of an NPC that uses a timeout loop:
<pre>
//#CLIENTSIDE
function onCreated()
{
settimer(1);
}
function onTimeout()
{
player.chat="Counter: " @this.time;
this.time++;
settimer(1);
//after 1 second, the timeout loop will restart
}
</pre>
This would cause the player to count up every second.
You may have noticed that the variables often start of with client. or this. There are actually a few prefixes, each does a different thing:
<pre>
client. variable is saved to the client, it can be modified on the clientside or serverside, and read from either.
clientr. variables can be rad from server or clientside, but only written from serverside. This is more secure, but only if you use it right.
server. variables are saved to the server, can only be written on the serverside, read on either side
serverr. more secure version of server. read only on clientside
this. is a variable that only functions in the NPC it is in. This prevents NPCs from morifying each others variables
temp. only exists in between the brackets of a function
</pre>
To use scripts effectivly, you should know how to use each of these.
I will add more over time.

Some important commands can be found here:
page:http://wiki.graal.net/index.php/Creation/Dev/Script/Starting_Guide#Introduction
Which is also helpful for learning how to script. Enjoy!