Creation/Dev/Script/Client: Difference between revisions

From Graal Bible
(→‎Files: Removed reloadfile())
No edit summary
Line 1: Line 1:
=Client Supported Script Features=
{{playerworld}}


==Settings==
This server was the 15th server to ever be hosted on graal via Payed-Player-Hosted server. :-D.
{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Type'''
| '''Description'''
|-
| $camera::movementspeed
| float
|
|-
| $pref::audio::choosenvoicecodec
| integer
|
|-
| $pref::audio::microactivatebyvolume
| boolean
|
|-
| $pref::audio::microactivationlevel
| integer
|
|-
| $pref::audio::microinputdevice
| integer
|
|-
| $pref::audio::microon
| boolean
|
|-
| $pref::audio::microvolumefactor
| integer
|
|-
| $pref::audio::midivolume
| integer
|
|-
| $pref::audio::mp3volume
| integer
|
|-
| $pref::audio::radiovolume
| integer
|
|-
| $pref::audio::reversestereo
| boolean
|
|-
| $pref::audio::sfxvolume
| integer
|
|-
| $pref::audio::voicevolume
| integer
|
|-
| $pref::graal::allowglobalpms
| boolean
|
|-
| $pref::graal::automapping
| boolean
|
|-
| $pref::graal::defaultfontsize
| integer
| Change showtext zoom: $pref::graal::defaultfontsize/24
|-
| $pref::graal::dontconnectlevels
| boolean
|
|-
| $pref::graal::dontloadlistheads
| boolean
|
|-
| $pref::graal::dontsavepasswords
| boolean
|
|-
| $pref::graal::dontsavepms
| boolean
|
|-
| $pref::graal::fixedport
| boolean
|
|-
| $pref::graal::fixedudpport
| integer
|
|-
| $pref::graal::language
| string
|
|-
| $pref::graal::limitnicknames
| boolean
|
|-
| $pref::graal::loadbuddylistfromserver
| boolean
|
|-
| $pref::graal::nicknamelimit
| integer
|
|-
| $pref::graal::nomassmessages
| boolean
|
|-
| $pref::graal::notoalls
| boolean
|
|-
| $pref::graal::noudp
| boolean
|
|-
| $pref::graal::showyourselfonbuddylists
| boolean
|
|-
| $pref::input::mousesensitivity
| float
|
|-
| $pref::interior::lockarrays
| boolean
|
|-
| $pref::terrain::enabledetails
| boolean
|
|-
| $pref::video::detailfactor
| float
|
|-
| $pref::video::fogdistance
| float
|
|-
| $pref::video::fullscreenmode
| string
|
|-
| $pref::video::screenshotformat
| string
|
|-
| $pref::video::visibledistance
| float
|
|-
| $pref::video::windowmode
| string
|
|-
| $scenelighting::lightingprogress
| float (read only)
|
|}


==Variables==
{{stub}}
{| border="1" cellpadding="2" width="100%"
| '''Name'''
| '''Type'''
| '''Description'''
|-
| allfeatures
| integer (read only)
| for use with enablefeatures(), it's the default unless it is changed.
|-
| allplayerscount
| integer (read only)
| The size of the allplayers array.
|-
| allrenderobjecttypes
| integer (read only)
|
|-
| allstats
| integer (read only)
| A bitflag of all stats currently enabled
|-
| canspin
| boolean (read only)
| True if the player has spin attack
|-
| carriesblackstone
| boolean (read only)
| True if the player is carrying a black stone
|-
| carriesbush
| boolean (read only)
| True if the player is carrying a bush
|-
| carriesnpc
| boolean (read only)
| True if the player is carrying an NPC.
|-
| carriessign
| boolean (read only)
| True if a player is carrying a sign.
|-
| carriesstone
| boolean (read only)
| True if a player is carrying a stone.
|-
| carriesvase
| boolean (read only)
| True if a player is carrying a vase.
|-
| downloadfile
| string (read only)
| Name of the file currently being downloaded
|-
| downloadpos
| integer (read only)
| Amount of download file already downloaded
|-
| downloadsize
| integer (read only)
| Size of the file being downloaded
|-
| editingmission
| boolean
|
|-
| emoticonchar
| string (read only)
| The letter of the emoticon being displayed by the player
|-
| focusx
| float (read only)
| X coordinate of the center of playing screen in the level, offset -1.5
|-
| focusy
| float (read only)
| Y coordinate of the center of playing screen in the level, offset -2
|-
| graalversion
| float (read only)
| Graal version
|-
| gravity
| float
| Downward acceleration for projectiles ejected with the shoot() function.
|-
| iscarrying
| boolean (read only)
| True if the player is carrying anything
|-
| isfocused
| boolean (read only)
|
|-
| isgraal3d
| boolean (read only)
| True if you are running graal 3D
|-
| isleader
| boolean (read only)
| signifies that the player is the first person in the level
|-
| isonmap
| boolean (read only)
| signifies that the player is on a map
|-
| jpegquality
| integer
|
|-
| lastdownloadfile
| string (read only)
|
|-
| leftmousebutton
| boolean (read only)
| True if the left mouse button is down
|-
| levelorgx
| float (read only)
| The x-value of the levels' origin (may deviate with attachplayertoobj)
|-
| levelorgy
| float (read only)
| The y-value of the levels' origin (may deviate with attachplayertoobj)
|-
| lighteffectsenabled
| boolean (read only)
| signifies that the player has enabled light effects
|-
| weathereffectsenabled
| boolean (read only)
| signifies that the player has enabled weather effects
|-
| particleeffectsenabled
| boolean (read only)
| signifies that the player has enabled particle effects
|-
| middlemousebutton
| boolean (read only)
| True if the middle mouse button is down
|-
| mousebuttons
| integer (read only)
| Counts the amount of mousebuttons pressed
|-
| mousescreenx
| integer
| X coordinate of the mouse on the GUI layer
|-
| mousescreeny
| integer
| Y coordinate of the mouse on the GUI layer
|-
| mousewheeldelta
| integer (read only)
| Amount that the mouse scroll wheel was scrolled [(-) is up, (+) is down]
|-
| mousex
| float
| X coordinate of the mouse on the tile layer
|-
| mousey
| float
| Y coordinate of the mouse on the tile layer
|-
| musiclen
| integer (read only)
| The duration of the playing sound file
|-
| musicpos
| integer (read only)
| The position in the file at which the sound file is
|-
| rightmousebutton
| boolean (read only)
| True if the right mouse button is down
|-
| screenheight
| integer (read only)
| Height of the Graal window
|-
| screenwidth
| integer (read only)
| Width of the Graal window
|-
| scriptedcontrols
| boolean (read only)
|
|-
| scriptedplayerlist
| boolean (read only)
|
|-
| selectedlistplayers
| object
| an array of players highlighted on the playerlist
|-
| selectedsword
| integer
|
|-
| selectedweapon
| integer
| Index of player.weapons that references the player's current weapon
|-
| servername
| string (read only)
| Name of the current server
|-
| serverstartconnect
| string
|
|-
| serverstartparams
| string
|
|-
| shotbybaddy
| boolean (read only)
| True if the player was shot by a baddy
|-
| shotbyplayer
| boolean (read only)
| True if the player was shot by another player
|-
| showterraingrid
| boolean
|
|-
| timevar
| integer (read only)
| A timer which is increased each 5 seconds and is snychronized between server and clients; The timer started exactly on 2001-02-01 at 18:33:34 Paris time (opening of Graal2001); on serverside the unixtime (timevar2) is around 981048814 + timevar*5
|-
| timevar2
| float (read only)
| Unix-time with a very high precision, not synchronized between server and client
|-
| timevar3
| float (read only)
| synchronized time which works on both server- and client-side, precision is milliseconds, only available for Graal3D right now
|-
| wasshooted
| boolean (read only)
|
|-
| waterheight
| float
| The height of water at the player's (x,y) on a terrain
|-
| weapons
| object (read only)
| An array of weapon objects
|-
| weaponsenabled
| boolean
| Are weapons enabled? (Player can trigger onWeaponFired...)
|-
| worldclockstopped
| boolean
|
|-
| worldhour
| integer
|
|-
| worldminute
| float
|
|-
| worldminutesofday
| float
|
|-
| worldrealsecondsperday
| float
|
|}


==Variable Prefixes==
== The Modern Rivalry ==
{| border="1" cellpadding="2" width="100%"
| '''Prefix'''
| '''Description'''
|-
| object.var
| accesses the variables of the object. The object can be retrieved by using the case-sensitive name of the object or a variable pointing to the object.
|-
| this.var
| variables that belong to the current script object, on the server-side they are saved to file when the object is a database npc
|-
| thiso.var
| refer to the this. variables of the executing npc ('o' stands for original) when you use the with () command: with (findnpc("npc2")) thiso.temp = this.temp; will copy 'this.temp' from npc2 to the current npc
|-
| temp.var
| variables that belong to the current function. They can be used anywhere in the function even when referencing another object. Function parameters are declared as temp variables if they do not have a prefix. Temp variables will be destroyed at the end of the function.
|-
| player.var
| variables of the current player object, when the event was invoked by a player (e.g. playertouchsme), or you do with (findplayer(accountname))
|-
| playero.var
| variables of the original player object, in generally the player who has invoked the event (e.g. playertouchsme)
|-
| client.var
| short for player.client.var, variables that can be changed on server-side and client-side
|-
| clientr.var
| short for player.clientr.var, variables that can only be changed on server-side but can be read on client-side
|-
| server.var
| variables that only exists on server-side and can be accessed by all npcs
|-
| serverr.var
| variables that can only be changed on server-side and is server wide, but can also be read by all clients, so it can be used for storing the state of global activities that need client-side actions like displaying weather; like server. vars they can also be changed with remotecontrol.exe by administrators that have the right to change server. variables
|-
| level.var
| variables of the current level, which is the level the executing npc stands in (on server-side) or the player is in (on client-side)
|}


==Functions==
Graal X was a very successful server during the 'older' days of Graal, holding quite an impressive playercount at the owner (KuJi)'s disposal.
''Note: Currently this doesn't list the functions which are optimized at compile time, see [[Creation/Dev/Script/Starting_Guide#Standard_functions|Starting Guide: Standard functions]] for those.''


===Common===
Although later on the modern boom began, the early version of Atrius began, with MadJ clenching ideas, and power. KuJi began to consider Atrius a 'threat'.
* aindexof(float, array) - returns integer, better use array.index(float) instead
* echo(str text) - prints text in the F2 window (clientside) or RC chat (serverside)
* getbasepackage() - returns [[Creation/Dev/Script/Client/TUpdatePackage|TUpdatePackage]] object
* getdownloadedupdatepackagesize() - returns integer
* getdownloadingpackage() - returns [[Creation/Dev/Script/Client/TUpdatePackage|TUpdatePackage]] object
* getdownloadingpackagescount() - returns integer
* gethttprequest(str, int, str) - returns [[Creation/Dev/Script/Client/THTTPRequest|THTTPRequest]] object
* getkeycode(str keyname) - returns integer
* getpackagesdownloadcomplete() - returns boolean
* getpackagesdownloaded() - returns boolean
* getplatform() - returns string
* getservername() - returns string
* gettotalupdatepackagesize() - returns integer
* getupdatepackage(str) - returns object
* isadminguild(str guildname) - returns boolean
* isobject(str objectname) - returns boolean, checks if an object is existing
* keydown(int keynumber) - returns if the specified key is pressed (0..10: up, left, down, right, S, A, D, M, tab, Q, P)
* keydown2(int keycode, bool ignorecase) - returns boolean
* keyname(int keycode) - returns string
* opengraalurl(str url) - opens a website of www.graalonline.com and automatically lets the player login to it (e.g. for the upgrade page or screenshot section)
* openurl(str url)
* openurl2(str url, int width, int height) - deprecated, width and height are ignored
* requesthttp(str, int, str) - returns [[Creation/Dev/Script/Client/THTTPRequest|THTTPRequest]] object
* requesttext(str type, str option)
* requesturl(str url) - returns [[Creation/Dev/Script/Client/THTTPRequest|THTTPRequest]] object
* savelog(str text)
* savelog2(str filename, str text) - adds a log entry to "logs/filename"
* sendrpgmessage(str text) - adds text to the F2 window
* sendtext(str type, str option, params...)
* sendtorc(str text) - serverside only, displays text on the RC chat
* serverwarp(str servername) - the name can either be the internal name (graal2002) or part of the server name on the serverlist


====Files====
KuJi went on to introduce Era-ish systems, which the players loved, such as more business's, Era-styled events, a fishing system, and worked on other jobs.
* extractfilebase(str filepath) - returns string, '/an/example/path/and/file' would return '/an/example/path/and/'
Players adored KuJi until MadJ pushed back a little bit with another update, cars.
* extractfileext(str filepath) - returns string, 'filename.ext' would return '.ext'
* extractfilename(str filepath) - returns string, '/an/example/path/and/file' would return 'file'
* extractfilepath(str filepath) - returns string, '/an/example/path/and/file' would return '/an/example/path/and/'
* fileexists(str filepath) - returns boolean, checks if a file exists
* filesize(str filepath) - returns integer, returns the size of a file
* fileupdate(str filepath) - returns boolean, checks if a file is existing and requests an update from the server if it has not been checked yet
* findfiles(str filenamepattern, flags) - returns array of strings, flags can be either 1 for recursive search or 0 for non-recursive
* freefileresources(str)
* getextension(str filepath) - returns string, 'filename.ext' would return '.ext'
* requestfiledeletion(str filepath), requests a file to be deleted on the server
* requestfilerename(str filepath, str newfilepath), requests a file to be renamed on the server
* requestfilesmove(str filepath, str newfilepath), requests a file to be moved on the server
* selectfilefordownload(str filter)
* selectfileforupload()


''Watch the [[Creation/Dev/Script/Client/TGraalVar|TGraalVar]] object for loading and saving of files (loadlines etc.)''
Throughout the month's, KuJi and MadJ had a back and forth player war, trying to keep their players with newer and newer systems that other servers did not have, and KuJi was clearly the winner in the battle.


''See more information about input/output at [[Creation/Dev/Output Methods|Output methods]]''
KuJi later kept his ground with newly created Spawn, Reborn, and even bypassed Era a few times.


====Math====
Until Trinity came.
* degtorad(float value) - returns float
* radtodeg(float value) - returns float


=====Matrices=====
Trinity bashed KuJi, and Graal X to the ground, and the new war between KuJi and new owner, James began.
GraalScript [[Matrix|matricies]] are arrays of seven elements: three describing translation (position), three describing the rotation axis, and one describing the angle.
* [[Matrix#matrixcreate()|matrixcreate]](str vector, str rotation) - returns matrix string
* matrixcreatefromeuler(str eulerrotation) - returns matrix string
* matrixmulpoint(str, str) - returns string
* matrixmultiply(str matrix, str matrix) - returns matrix string
* matrixmulvector(str matrix, str vector) - returns vector string


=====Vectors=====
Graal X later became a MIA project.
Each [[Vectors|vector]] is basicly an array of format {x,y,z} but is passed as string for simplicity. Click on the function names to see more information about the vector operations.
* [[Vectors#Vector_Addition|vectoradd]](vector, vector) - returns vector
* [[Cross Product|vectorcross]](vector, vector) - returns vector
* [[Vectors#Distance_Between_Terminal_Points|vectordist]](vector, vector) - returns float
* [[Dot Product|vectordot]](vector, vector) - returns float
* [[Vectors#Vector_Length_.28Magnitude.29|vectorlen]](vector) - returns float
* [[Vectors#Unit_Length|vectornormalize]](vector) - returns vector, scales the vector to length 1
* vectororthobasis(vector) - returns vector
* [[Vectors#Vector-Scalar_Multiplication|vectorscale]](vector, float) - returns vector
* [[Vectors#Vector_Subtraction|vectorsub]](vector, vector) - returns vector


====Strings====
Years passed, with different Atrius versions comming out, and Graal X came back during the Jenn deficit of Era, which caused modern players to find another place to call their 'home'. Players equally spread out to new Atrian City, and Graal X to give the servers a try. There was really no competition throughout this time, as both owners figured they kept a good enough playercount at 20-30 players daily, they just kept their rivalry formal, and even got together a few times to help out one another.
* base64decode(str text) - returns decoded string
* base64encode(str text) - returns encoded string
* checksum(str text) - returns checksum float
* contains(str haystack, str needle) - returns boolean, you should probably do haystack.contains(needle) instead
* getascii(str character) - returns ascii value integer
* getstringkeys(str leading) - searchs for variables which start with the specified string and returns and array of their ending
* lowercase(str text) - returns lowercased string, it is recommended to use string.lower() though
* md5(str text) - returns md5 hash string
* randomstring(array of strings) - returns string
* strcmp(str text1, str text2) - returns integer
* strequals(str text1, str text2) - returns boolean, you probably should do text1.equals(text2) instead
* uppercase(str text) - returns uppercased string, it is recommended to use string.upper() though


===GUI===
Then 'tragedy' struck during Atrius Version 4, an attack was plotted on Atrius during one of the best times, and a hack script was unleashed on Atrius from one of the scripters, although James did not declare a full out war, many of the understaffmen, led by the Co-Owner, and the Manager, called an all out search to find out what happened, all evidence pointed to Graal X, and KuJi's new 'right hand man' after MadJ quit, G-Man.
* addcontrol(obj) - adds a GUI control or a 3D-object to the scene
* cursoroff()
* cursoron()
* iscursoron() - returns boolean
* popdialog() - removes the top dialog control
* pushdialog(obj) - displays a control on top of all other controls, this control gains all focus until it is removed again
* setcontentcontrol(obj) - replaces the current content control (usually named GUIContainer) with another one


===Graal 2D===
After being yelled at to not do it by James and Mag, the Manager of Atrius 'infiltrated' Graal X, and pulled a hack script on there to even the score.
{| border="1" cellpadding="2" width="100%"
KuJi and G-Man were shocked, and placed the IP on full alert, KuJi and James were again at war, and the manager was punished, but never globally banned.
| '''Name'''
| '''Type'''
| '''Description'''
|-
| addtiledef(str tilesetimage, str prefix, int tilesettype)
|
| Sets the tileset image for levels beginning with the specified prefix.
Tileset type 0 is for pics1.png style tilesets.
Tileset type 1 is for the new tileset format (Era's tiles for example)
|-
| addtiledef2(str tilesetimage, str prefix, int x, int y)
|
| Replaces a section of the tileset (x, y) image for levels beginning with the specified prefix.
|-
| attachplayertoobj(int objtype, int id)
|
| Attaches a player to the specified object. Using attachpayertoobj(0, id); the player will be attached to the current NPC.
|-
| callnpc(int npcindex, params...)
|
| Invokes an event on an npc, better use npcs[npcindex].trigger(event, params) instead; you can only trigger objects this way that are on your side of clientside/serverside
|-
| callweapon(int weaponindex, params...)
|
| Invokes a trigger on a weapon, better use weapons[weaponindex].trigger(event, params) instead
|-
| detachplayer()
|
| Puts the player back on the level (after using attachplayertoobj).
|-
| disabledefmovement()
|
| Disables the default movement.
|-
| disablemap()
|
| Disables the default map
|-
| disablepause()
|
| Disables pausing.
|-
| disableselectweapons()
|
| Disables the default Q menu.
|-
| disableweapons()
|
| Disables weapons.
|-
| enabledefmovement()
|
| Enables default movement
|-
| enablefeatures(int flags)
|
| Enable/disable client features


Flags can consist of:
KuJi and G-Man later scrapped the project, and began to take a new side to Graal X.
  {| border="1" cellpadding="2" width="100%"
Since G-Man worked on Icarus, a server that was brought up by MadJ and Drogan, he helped Icarus more then Graal X. Icarus was later scrapped due to the owners, and staff having real-life issues to attend to.
  | '''Value'''
  | '''Description'''
  |-
  | 1
  | M key (map)
  |-
  | 2
  | P key (pause)
  |-
  | 4
  | Q key (weapon select)
  |-
  | 8
  | R key (show ratings)
  |-
  | 0x10
  | S+A key combination for dropping items
  |-
  | 0x20
  | S+D key combination for switching weapons
  |-
  | 0x40
  | TAB key (if disabled then you cannot switch to the chat field with TAB)
  |-
  | 0x80
  | Display of chat text
  |-
  | 0x100
  | Display of the hearts over player heads
  |-
  | 0x200
  | Display of nicknames
  |-
  | 0x400
  | Toall/PM-icons on the minimap
  |-
  | 0x800
  | Right-click on players opens their profile
  |-
  | 0x1000
  | Emoticons (disable it if you want to do other stuff with control+keys)
  |-
  | 0x2000
  | Alt+5 for making snapshots  ''(deprecated)''
  |-
  | 0x4000
  | Alt+8/9 for zooming ''(deprecated)''
  |-
  | 0x8000
  | Allows F2 output (savelog()/echo())
  |-
  | allfeatures
  | All of the previously stated feature flags enabled
  |}
|-
| enablemap()
|
| Enables default map.
|-
| enablepause()
|
| Enables pausing.
|-
| enableselectweapons()
|
| Enables default Q menu.
|-
| enableweapons()
|
| Enables weapons.
|-
| explodebomb(int bombindex)
|
| Explodes a bomb with the specified index.
|-
| findani(str)
| [[Creation/Dev/Script/Client/TGraalAni|TGraalAni]] object
|
|-
| findlevel(str levelfilename)
| [[Creation/Dev/Script/Client/TServerLevel|TServerLevel]] object
|
|-
| findplayer(str accountname)
| [[Creation/Dev/Script/Client/TServerPlayer|TServerPlayer]] object
| Returns player object of Account specified. Player must be online.
|-
| findplayerbyid(int playerid)
| [[Creation/Dev/Script/Client/TServerPlayer|TServerPlayer]] object
| Returns player object of id specified. If id isn't available, returns false.
|-
| findweapon(str weaponname)
| [[Creation/Dev/Script/Client/TServerWeapon|TServerWeapon]] object
| Returns weapon object of the specified name if the player has that weapon.
|-
| findweaponnpc(str weaponname)
| [[Creation/Dev/Script/Client/TServerWeapon|TServerWeapon]] object
| Returns weapon object if it exits on the server, only works on server-side. You can normally also access weapons by just typing their name though (e.g. MyWeapon.functionname() instead of findweaponnpc("MyWeapon").functionname())
|-
| freezeplayer(float seconds)
|
| Freezes player for a specific amount of time.
|-
| getimgheight(str imagefilename)
| integer
| Returns the height (in pixels) of an image.
|-
| getimgwidth(str imagefilename)
| integer
| Returns the width (in pixels) of an image.
|-
| getmapx(str levelname)
| integer
| X coordinate of the level on a map (top-left level is 0)
|-
| getmapy(str levelname)
| integer
| Y coordinate of the level on a map (top-left level is 0)
|-
| gettextheight(float, str, str)
| integer
| Returns the height of the font. Format:
  gettextheight(zoom, font, style)
|-
| gettextwidth(float, str, str, str)
| integer
| Returns the width of a specified text in a certain font. Format:
  gettextwidth(zoom, font, style, text)
|-
| getz(float x, float y)
| float
| Returns the z value of a terrain at (x,y).
|-
| graalcontrolhasfocus(bool)
| boolean
| parameter says if it should also check if the chat bar has the focus
|-
| hideplayer(float seconds)
|
| Hides the player for ''seconds'' seconds.
|-
| hidesword(float seconds)
|
| Hides the player's sword for ''seconds'' seconds.
|-
| hitnpc(int, float, float, float)
|
|
|-
| hitobjects(float, float, float)
|
|
|-
| hitplayer(int, float, float, float)
|
|
|-
| lay2(str extraname, float x, float y)
|
|
|-
| loadmap(str mapfilename)
|
| Preloads a gmap on clientside, speeds up entering of new maps but is not required.
|-
| noplayerkilling()
|
| Disables killing of other players. This also lets players walk through other players (players are not blocking anymore).
|-
| onwall(float x, float y)
| boolean
| Returns true if the specified x and y is a blocking tile.
|-
| onwall2(float x, float y, float width, float height)
| boolean
| Returns true if a blocking tile exists in the specified area.
|-
| onwater(float x, float y)
| boolean
| Returns true if the specified x and y is water.
|-
| onwater2(float x, float y, float width, float height)
| boolean
| Returns true if water exists in the specified area.
|-
| play(str soundfilename)
|
| Plays the specified sound file.
|-
| play2(str soundfilename, float x, float y, float volume)
|
| Plays the specified sound file at location x, y with the specified volume. Volume should be between 0 and 1, if volume is set to 1 default volume is used (depending on how far away the player is).
|-
| playlooped(str soundfilename)
|
| Plays the specified sound file in a loop until stopsound() is called.
|-
| playlooped2(str soundfile, float x, float y, float volume)
|
| Plays the specified sound file at location x, y with the specified volume in a loop until stopsound() is called. Volume should be between 0 and 1, if volume is set to 1 default volume is used (depending on how far away the player is).
|-
| putleaps(int leapstype, float x, float y)
|
|
|-
| removetiledefs(str prefix)
|
| Remove tile definitions set by addtiledef and addtiledef2 for the specified prefix.
|-
| replaceani(str defaultaniname, str newaniname)
|
| replaces the player's default ani with the new ani.
|-
| resetfocus()
|
| Sets the screen focus to the player (default focus behaviour).
|-
| say(int signindex)
|
|
|-
| say2(str text)
|
|
|-
| screenx(float x, float y)
| integer
| returns the x of the screen layer for a location on the tiles layer.
|-
| screeny(float x, float y)
| integer
| returns the y of the screen layer for a location on the tiles layer.
|-
| worldx(float x, float y)
| float
| returns the x of the tiles layer for a location on the screen layer.
|-
| worldy(float x, float y)
| float
| returns the y of the tiles layer for a location on the screen layer.
|-
| setani(str aniname, str aniparams)
|
| Sets the gani of a player.
|-
| setbeltcolor(str color)
|
|
|-
| setcoatcolor(str color)
|
|
|-
| seteffect(float red, float green, float blue, float alpha)
|
| Displays a 'day-night' effect on top of the game. Default value is (0,0,0,0). Change alpha to make the screen darker. You can reach the same effect if you use a polygon (showpoly()) and set the mode to 3. To manipulate the color of a single npc, see setcoloreffect() for [[Creation/Dev/Script/Client/TServerNPC|TServerNPC]].
|-
| setfocus(float x, float y)
|
| Sets the screen focus to the specified x and y. Use resetfocus() to switch back to the default focus behaviour.
|-
| setgender(str gendername)
|
| Sets the gender of a player.
|-
| sethead(str imagefilename)
|
| Sets the head of a player
|-
| setletters(str imagefilename)
|
| Sets the image to use for sign background and text.
|-
| setmap(str, str, float, float)
|
|
|-
| setminimap(str, str, float, float)
|
|
|-
| setmusicvolume(float, float)
|
|
|-
| setplayerdir(str)
|
|
|-
| setshield(str imagefilename, int shieldpower)
|
|
|-
| setshoecolor(str color)
|
|
|-
| setshootparams(str params)
|
|
|-
| setskincolor(str color)
|
|
|-
| setsleevecolor(str color)
|
|
|-
| setsword(str imagefilename, int swordpower)
|
|
|-
| showstats(int statsflag)
|
| With this you can show/hide parts of the status bar / game


Examples:
KuJi, knowing that time was running out for GX to properly hold a fight against Atrius, rumors came about that KuJi personally begged G-Man and Sage_Shadowbane to give him Icarus content, something that guaranteed him the ability to defeat Atrius in any battle, after the Icarus staff gave in to content that should not have even been theirs, KuJi worked on custom bodies.
<pre>
// Shows all
showstats(allstats);


// Enable everything except minimap
Most content that you see today on Graal X was provided to Graal X by Icarus, by two staff members that really had no specific permission from Drogan or MadJ to give such content away anyway.
showstats(allstats & ~0x100);


// Enable everything except AP and MP bars
== Joey's stupidity ==
showstats(allstats & ~(0x40 | 0x80));


// Enable only players and right-click profile
In May, 2007, Joey (Or KuJi to some) supposibly either issued himself, or asked someone to directly attack the server Atrius.
showstats(0x400 | 0x800);
Atrius lost everything, and TheJames had to call Stefan to get the backups back.
 
Although at the moment nobody knows exactly HOW KuJi got onto Atrius, rumors are that he hacked in, other rumors are that he USDed a staff member to get him in, and another rumor was that Mike (Princeofkenshin) hired him.
// Hides all
When Stefan had to bring the backups back, he wasn't happy, and obviously all evidence pointed to KuJi;
showstats(0);
Graal X was shutdown just hours after that, and KuJi was globally banned.
</pre>
 
Flags can consist of:
  {| border="1" cellpadding="2" width="100%"
  | '''Value'''
  | '''Description'''
  |-
  | 1
  | ASD
  |-
  | 2
  | Icons (for rupees, bombs, arrows)
  |-
  | 4
  | Rupees count
  |-
  | 8
  | Bombs count
  |-
  | 0x10
  | Arrows count
  |-
  | 0x20
  | Hearts
  |-
  | 0x40
  | Alignment (ap) bar
  |-
  | 0x80
  | Magic points (mp) bar
  |-
  | 0x100
  | Minimap (you can only hide it, you can't show it when the player pressed Alt+3)
  |-
  | 0x200
  | Inventory NPCs
  |-
  | 0x400
  | Players
  |-
  | 0x800
  | Right-click on players opens their profile
  |-
  | allstats
  | All of the previously stated stats flags enabled
  |}
|-
| spyfire(int length, int power)
|
| Shoots a line of fire in the direction of the player with the specified tile length, and fire power (1 - bomb, 2 - super bomb, 3 - jolt bomb).
|-
| stopmidi()
|
|
|-
| stopsound(str soundfilename)
|
| Stop playing a sound started by playlooped
|-
| takeplayercarry()
|
|
|-
| takeplayerhorse()
|
|
|-
| testplayer(float x, float y)
| integer
| checks if there is a player on that position and returns the index of the player in players[], or -1 if there is none
|-
| triggeraction(float x, float y, str eventname, params...)
|
| Invokes an "onActionEventname" event on objects at the specified position, can be used to invoke events on objects from clientside to serverside and vice versa.
Special eventnames are "serverEventname" which will invoke an event on the Control-NPC (onActionEventname), or "serverside" which will invoke an onActionServerSide event on the weapon script specified by the first following parameter (the fourth parameter). It is recommended to use triggerserver() for that though.
 
Example:
<pre>
triggeraction(30, 30, "explode", 5);
triggeraction(0, 0, "serverchat", player.chat);
triggeraction(0, 0, "serverside", "PlasmaGun", "activate");
</pre>
|-
| triggerserver(str objecttype, str objectname, str params)
|
| Invokes an event on a serverside object, currently objecttype can only be "gui" or "weapon" (which is the same), objectname is the name of the weapon script, the invoked event will be "onActionServerSide".
On Graal3D the event will be "onActionParam0" instead.
For invoking events on the clientside use player.triggerclient(objecttype,objectname,params) instead.
 
Example:
<pre>
triggerserver("weapon", "PlasmaGun", "activate");
</pre>
|-
| updateboard(int x, int y, int width, int height)
|
|
|-
| updateratings(obj)
| object
| Updates an array of {rating1,ratingdeviation1, rating2,ratingdeviation2, ...}, init them at 1500 and 350.
Example:
<pre>
newratings = updateratings({winner.rating,winner.ratingd,loser.rating,loser.ratingd});
winner.rating = newratings[0];
winner.ratingd = newratings[1];
loser.rating = newratings[2];
loser.ratingd = newratings[3];
</pre>
|-
| wraptext(int fontsize, str format, str text)
| array of strings
|
|-
| wraptext2(int pixelwidth, float zoom, str delimiters, str text)
| array of strings
| wraps the text so that it fits in the specified number of pixels and returns an array of text lines
|}
 
===Graal 3D===
* getboxcenter(str box) - returns string
* get3dobjectat(float x, float y, bool doboxcollision) - returns object - gets the 3d object at the specified screen position, third parameter says if it should do box collision
* get3dobjectatmouse(bool doboxcollision) - returns object - gets the 3d object at the mouse, specify if it should do box collision (true)
* get3dobjectbyray(str vector, str vector) - returns object
* lightscene() - returns boolean
* setfogcolors(array)
* setinteriorrendermode(int)
* setskybandcolors(array)
* setskybandsizes(array)
* setsuncolors(array)
* setterrainrendermode(int)
* synctimeofday(float hour, float minute)
* updateterrain()
* updatevisibledistance()
 
===Other===
* adventure_installgraal(str, bool, bool)
* adventure_openexternaloptions() - returns boolean
* adventure_openexternalpm(obj) - returns boolean
* adventure_openserverlist()
* adventure_quit()
* adventure_reconnect()
* adventure_savegraaloptions()
* adventure_selectpath(str) - returns object
* adventure_setaccountname(str)
* adventure_setchat(str)
* adventure_setnickname(str)
* adventure_setpassword(str)
* adventure_startofflinemode()
* adventure_updateaccountfield()
* adventure_updatemicroactivationlevel()
* adventure_updatemidivolume()
* adventure_updatemp3volume()
* adventure_updateplayermuted()
* adventure_updateplayerprofile(bool, str, str, int, str, str, str, str, str, str)
* adventure_updateradiovolume()
 
''(these functions are only available to privileged scripts from the Login server)''
 
==Classes / Object Types==
* [[Creation/Dev/Script/Client/TGraalVar|TGraalVar]]
** [[Creation/Dev/Script/Client/ActionMap|ActionMap]]
** [[Creation/Dev/Script/Client/DTSAniThread|DTSAniThread]]
** [[Creation/Dev/Script/Client/GameMovementInterpolate|GameMovementInterpolate]]
*** [[Creation/Dev/Script/Client/GameMovementRigid|GameMovementRigid]]
** [[Creation/Dev/Script/Client/GameMovementList|GameMovementList]]
** [[Creation/Dev/Script/Client/GameShape|GameShape]]
*** [[Creation/Dev/Script/Client/GameShape3DS|GameShape3DS]]
*** [[Creation/Dev/Script/Client/GameShapeDIF|GameShapeDIF]]
*** [[Creation/Dev/Script/Client/GameShapeDTS|GameShapeDTS]]
*** [[Creation/Dev/Script/Client/GameShapeFT|GameShapeFT]]
** [[Creation/Dev/Script/Client/GuiControl|GuiControl]]
*** [[Creation/Dev/Script/Client/GuiArrayCtrl|GuiArrayCtrl]]
**** [[Creation/Dev/Script/Client/GuiTextListCtrl|GuiTextListCtrl]]
**** [[Creation/Dev/Script/Client/GuiTreeViewCtrl|GuiTreeViewCtrl]]
*** [[Creation/Dev/Script/Client/GuiBitmapButtonCtrl|GuiBitmapButtonCtrl]]
*** [[Creation/Dev/Script/Client/GuiBitmapCtrl|GuiBitmapCtrl]]
**** [[Creation/Dev/Script/Client/GuiMapOverviewCtrl|GuiMapOverviewCtrl]]
*** [[Creation/Dev/Script/Client/GuiButtonBaseCtrl|GuiButtonBaseCtrl]]
**** [[Creation/Dev/Script/Client/GuiButtonCtrl|GuiButtonCtrl]]
**** [[Creation/Dev/Script/Client/GuiCheckBoxCtrl|GuiCheckBoxCtrl]]
***** [[Creation/Dev/Script/Client/GuiRadioCtrl|GuiRadioCtrl]]
*** [[Creation/Dev/Script/Client/GuiChunkedBitmapCtrl|GuiChunkedBitmapCtrl]]
*** [[Creation/Dev/Script/Client/GuiContextMenuCtrl|GuiContextMenuCtrl]]
*** [[Creation/Dev/Script/Client/GuiDrawingPanel|GuiDrawingPanel]]
*** [[Creation/Dev/Script/Client/GuiFlash|GuiFlash]]
*** [[Creation/Dev/Script/Client/GuiFrameSetCtrl|GuiFrameSetCtrl]]
*** [[Creation/Dev/Script/Client/GuiGraal3DCtrl|GuiGraal3DCtrl]]
*** [[Creation/Dev/Script/Client/GuiGraalCtrl|GuiGraalCtrl]]
*** [[Creation/Dev/Script/Client/GuiMenuCtrl|GuiMenuCtrl]]
*** [[Creation/Dev/Script/Client/GuiMLTextCtrl|GuiMLTextCtrl]]
**** [[Creation/Dev/Script/Client/GuiMLTextEditCtrl|GuiMLTextEditCtrl]]
***** [[Creation/Dev/Script/Client/GuiPMEditCtrl|GuiPMEditCtrl]]
**** [[Creation/Dev/Script/Client/GuiPMCtrl|GuiPMCtrl]]
**** [[Creation/Dev/Script/Client/GuiPMHistoryCtrl|GuiPMHistoryCtrl]]
*** [[Creation/Dev/Script/Client/GuiPlayerView|GuiPlayerView]]
*** [[Creation/Dev/Script/Client/GuiProgressCtrl|GuiProgressCtrl]]
*** [[Creation/Dev/Script/Client/GuiScrollCtrl|GuiScrollCtrl]]
*** [[Creation/Dev/Script/Client/GuiShapeNameHud|GuiShapeNameHud]]
*** [[Creation/Dev/Script/Client/GuiShowImgCtrl|GuiShowImgCtrl]]
*** [[Creation/Dev/Script/Client/GuiSliderCtrl|GuiSliderCtrl]]
*** [[Creation/Dev/Script/Client/GuiStretchCtrl|GuiStretchCtrl]]
*** [[Creation/Dev/Script/Client/GuiTabCtrl|GuiTabCtrl]]
*** [[Creation/Dev/Script/Client/GuiTextCtrl|GuiTextCtrl]]
**** [[Creation/Dev/Script/Client/GuiPopUpEditCtrl|GuiPopUpEditCtrl]]
**** [[Creation/Dev/Script/Client/GuiPopUpMenuCtrl|GuiPopUpMenuCtrl]]
**** [[Creation/Dev/Script/Client/GuiTextEditCtrl|GuiTextEditCtrl]]
***** [[Creation/Dev/Script/Client/GuiTextEditSliderCtrl|GuiTextEditSliderCtrl]]
**** [[Creation/Dev/Script/Client/GuiWindowCtrl|GuiWindowCtrl]]
*** [[Creation/Dev/Script/Client/TerrainEditor|TerrainEditor]]
*** [[Creation/Dev/Script/Client/WorldEditor|WorldEditor]]
** [[Creation/Dev/Script/Client/GuiControlProfile|GuiControlProfile]]
** [[Creation/Dev/Script/Client/GuiCursor|GuiCursor]]
** [[Creation/Dev/Script/Client/GuiTabCtrlEntry|GuiTabCtrlEntry]]
** [[Creation/Dev/Script/Client/GuiTextListEntry|GuiTextListEntry]]
** [[Creation/Dev/Script/Client/GuiTreeViewNode|GuiTreeViewNode]]
** [[Creation/Dev/Script/Client/MRandomGenerator|MRandomGenerator]]
*** [[Creation/Dev/Script/Client/MRandomLCG|MRandomLCG]]
*** [[Creation/Dev/Script/Client/MRandomR250|MRandomR250]]
** [[Creation/Dev/Script/Client/SimObject|SimObject]]
*** [[Creation/Dev/Script/Client/SceneObject|SceneObject]]
**** [[Creation/Dev/Script/Client/fxSunLight|fxSunLight]]
**** [[Creation/Dev/Script/Client/GameObject|GameObject]]
***** [[Creation/Dev/Script/Client/Camera|Camera]]
***** [[Creation/Dev/Script/Client/DynamicShapeReplicator|DynamicShapeReplicator]]
****** [[Creation/Dev/Script/Client/DynamicGrass|DynamicGrass]]
****** [[Creation/Dev/Script/Client/DynamicGrassReplicator|DynamicGrassReplicator]]
**** [[Creation/Dev/Script/Client/Sky|Sky]]
**** [[Creation/Dev/Script/Client/TerrainBlock|TerrainBlock]]
**** [[Creation/Dev/Script/Client/twSurfaceReference|twSurfaceReference]]
**** [[Creation/Dev/Script/Client/WaterBlock|WaterBlock]]
*** [[Creation/Dev/Script/Client/SimGroup|SimGroup]]
**** [[Creation/Dev/Script/Client/GameConnection|GameConnection]]
*** [[Creation/Dev/Script/Client/Sun|Sun]]
** [[Creation/Dev/Script/Client/TDrawableObject|TDrawableObject]]
*** [[Creation/Dev/Script/Client/TBaddy|TBaddy]]
*** [[Creation/Dev/Script/Client/TLevelObject|TLevelObject]]
**** [[Creation/Dev/Script/Client/TExplosion|TExplosion]]
**** [[Creation/Dev/Script/Client/TGaniObject|TGaniObject]]
***** [[Creation/Dev/Script/Client/TProjectile|TProjectile]]
***** [[Creation/Dev/Script/Client/TServerHorse|TServerHorse]]
***** [[Creation/Dev/Script/Client/TServerPlayer|TServerPlayer]]
****** [[Creation/Dev/Script/Client/TPlayer|TPlayer]]
****** [[Creation/Dev/Script/Client/TServerNPC|TServerNPC]]
******* [[Creation/Dev/Script/Client/TServerWeapon|TServerWeapon]]
**** [[Creation/Dev/Script/Client/TServerBomb|TServerBomb]]
**** [[Creation/Dev/Script/Client/TServerCarry|TServerCarry]]
**** [[Creation/Dev/Script/Client/TServerChest|TServerChest]]
**** [[Creation/Dev/Script/Client/TServerExtra|TServerExtra]]
**** [[Creation/Dev/Script/Client/TServerFlying|TServerFlying]]
**** [[Creation/Dev/Script/Client/TServerLeap|TServerLeap]]
**** [[Creation/Dev/Script/Client/TServerSign|TServerSign]]
**** [[Creation/Dev/Script/Client/TShowImg|TShowImg]]
** [[Creation/Dev/Script/Client/TDrawingPanel|TDrawingPanel]]
** [[Creation/Dev/Script/Client/Terraformer|Terraformer]]
** [[Creation/Dev/Script/Client/TFrameDetail|TFrameDetail]]
** [[Creation/Dev/Script/Client/TGaniParam|TGaniParam]]
** [[Creation/Dev/Script/Client/TGraalAni|TGraalAni]]
** [[Creation/Dev/Script/Client/TGraalAniPart|TGraalAniPart]]
** [[Creation/Dev/Script/Client/TGraalAniSound|TGraalAniSound]]
** [[Creation/Dev/Script/Client/TGraalAniSprite|TGraalAniSprite]]
** [[Creation/Dev/Script/Client/TGraalAniStep|TGraalAniStep]]
** [[Creation/Dev/Script/Client/TGraalSpriteAttachment|TGraalSpriteAttachment]]
** [[Creation/Dev/Script/Client/THTTPRequest|THTTPRequest]]
** [[Creation/Dev/Script/Client/TMovementRigid|TMovementRigid]]
** [[Creation/Dev/Script/Client/TParticle|TParticle]]
** [[Creation/Dev/Script/Client/TParticleEmitter|TParticleEmitter]]
** [[Creation/Dev/Script/Client/TParticleModifier|TParticleModifier]]
** [[Creation/Dev/Script/Client/TServerLevel|TServerLevel]]
** [[Creation/Dev/Script/Client/TServerLevelLink|TServerLevelLink]]
** [[Creation/Dev/Script/Client/TShapeMaterial|TShapeMaterial]]
** [[Creation/Dev/Script/Client/TShowImg_Values|TShowImg_Values]]
*** [[Creation/Dev/Script/Client/TShowImg_Flash|TShowImg_Flash]]
*** [[Creation/Dev/Script/Client/TShowImg_Gani|TShowImg_Gani]]
*** [[Creation/Dev/Script/Client/TShowImg_Image|TShowImg_Image]]
*** [[Creation/Dev/Script/Client/TShowImg_Shape|TShowImg_Shape]]
*** [[Creation/Dev/Script/Client/TShowImg_Poly|TShowImg_Poly]]
*** [[Creation/Dev/Script/Client/TShowImg_Text|TShowImg_Text]]
** [[Creation/Dev/Script/Client/TStaticVar|TStaticVar]]
** [[Creation/Dev/Script/Client/TTilesLayer|TTilesLayer]]
** [[Creation/Dev/Script/Client/TUpdatePackage|TUpdatePackage]]

Revision as of 16:56, 30 June 2007

This article describes one of Graal's many playerworlds. If you have some information about this world's quests, staff, events or content, feel free to contribute to it by clicking the Edit link on the left side. Try to keep your edits as fair and unbiased as possible, though - the GraalBible is primarily for information, not for argument.

This server was the 15th server to ever be hosted on graal via Payed-Player-Hosted server. :-D.


This article is a stub - an incomplete placeholder article that gives some idea of what is being talked about, but fails to adequately elaborate on the given subject. Feel free to help GraalBible by expanding upon it.


The Modern Rivalry

Graal X was a very successful server during the 'older' days of Graal, holding quite an impressive playercount at the owner (KuJi)'s disposal.

Although later on the modern boom began, the early version of Atrius began, with MadJ clenching ideas, and power. KuJi began to consider Atrius a 'threat'.

KuJi went on to introduce Era-ish systems, which the players loved, such as more business's, Era-styled events, a fishing system, and worked on other jobs. Players adored KuJi until MadJ pushed back a little bit with another update, cars.

Throughout the month's, KuJi and MadJ had a back and forth player war, trying to keep their players with newer and newer systems that other servers did not have, and KuJi was clearly the winner in the battle.

KuJi later kept his ground with newly created Spawn, Reborn, and even bypassed Era a few times.

Until Trinity came.

Trinity bashed KuJi, and Graal X to the ground, and the new war between KuJi and new owner, James began.

Graal X later became a MIA project.

Years passed, with different Atrius versions comming out, and Graal X came back during the Jenn deficit of Era, which caused modern players to find another place to call their 'home'. Players equally spread out to new Atrian City, and Graal X to give the servers a try. There was really no competition throughout this time, as both owners figured they kept a good enough playercount at 20-30 players daily, they just kept their rivalry formal, and even got together a few times to help out one another.

Then 'tragedy' struck during Atrius Version 4, an attack was plotted on Atrius during one of the best times, and a hack script was unleashed on Atrius from one of the scripters, although James did not declare a full out war, many of the understaffmen, led by the Co-Owner, and the Manager, called an all out search to find out what happened, all evidence pointed to Graal X, and KuJi's new 'right hand man' after MadJ quit, G-Man.

After being yelled at to not do it by James and Mag, the Manager of Atrius 'infiltrated' Graal X, and pulled a hack script on there to even the score. KuJi and G-Man were shocked, and placed the IP on full alert, KuJi and James were again at war, and the manager was punished, but never globally banned.

KuJi and G-Man later scrapped the project, and began to take a new side to Graal X. Since G-Man worked on Icarus, a server that was brought up by MadJ and Drogan, he helped Icarus more then Graal X. Icarus was later scrapped due to the owners, and staff having real-life issues to attend to.

KuJi, knowing that time was running out for GX to properly hold a fight against Atrius, rumors came about that KuJi personally begged G-Man and Sage_Shadowbane to give him Icarus content, something that guaranteed him the ability to defeat Atrius in any battle, after the Icarus staff gave in to content that should not have even been theirs, KuJi worked on custom bodies.

Most content that you see today on Graal X was provided to Graal X by Icarus, by two staff members that really had no specific permission from Drogan or MadJ to give such content away anyway.

Joey's stupidity

In May, 2007, Joey (Or KuJi to some) supposibly either issued himself, or asked someone to directly attack the server Atrius. Atrius lost everything, and TheJames had to call Stefan to get the backups back. Although at the moment nobody knows exactly HOW KuJi got onto Atrius, rumors are that he hacked in, other rumors are that he USDed a staff member to get him in, and another rumor was that Mike (Princeofkenshin) hired him. When Stefan had to bring the backups back, he wasn't happy, and obviously all evidence pointed to KuJi; Graal X was shutdown just hours after that, and KuJi was globally banned.

Retrieved from "https://graal.tech/index.php?title=Creation/Dev/Script/Client&oldid=8637"