Graal Bible - User contributions [en]

Creation/Dev/Script/Clientside Functions

2011-10-13T15:55:03Z

Tolnaftate2004: /* Functions */ trace

[[Category:Scripting Reference]]
{| border="0" cellpadding="2" width="50%"
|[R]
| denotes it is read-only.
|-
|[3D]
| denotes it is a Graal3D function.
|-
|[opengl]
| denotes it is functional only in opengl mode.
|}

==Variables==
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| allfeatures
| ''integer [R]''
|
|-
| allplayerscount
| ''integer [R]''
| Returns the count of all players on your playerlist, including IRC bots.
|-
| allrenderobjecttypes
| ''integer [R]''
|
|-
| allstats
| ''integer [R]''
| Used with showstats() in order to show all stats.
|-
| canspin
| ''boolean [R]''
| Returns true of false if the player has spin attack.
|-
| carriesblackstone
| ''boolean [R]''
| Returns whether the player is carrying a black stone.
|-
| carriesbush
| ''boolean [R]''
| Returns whether the player is carrying a bush.
|-
| carriesnpc
| ''boolean [R]''
| Returns whether the player is carrying an NPC
|-
| carriessign
| ''boolean [R]''
| Returns whether the player is carrying a sign.
|-
| carriesstone
| ''boolean [R]''
| Returns whether the player is carrying a stone.
|-
| carriesvase
| ''boolean [R]''
| Returns whether the player is carrying a vase.
|-
| downloadfile
| ''string [R]''
| Returns the currently downloaded file.
|-
| downloadpos
| ''integer [R]''
| Returns the position of the currently downloaded file.
|-
| downloadsize
| ''integer [R]''
| Returns the size of the currently downloaded file.
|-
| editingmission
| ''boolean''
|
|-
| emoticonchar
| ''string [R]''
|
|-
| focusx
| ''float [R]''
| Position of the camera in tile units.
|-
| focusy
| ''float [R]''
| Position of the camera in tile units.
|-
| ghostsnear
| ''boolean [R]''
| If a ghost(observer) is in the same level as the player.
|-
| graalplugincookie
| ''string [R]''
|
|-
| graalversion
| ''float [R]''
| Version of Graal the player is using.
|-
| gravity
| ''float''
| The gravity value that effects how fast projectiles fall. It universally effects all projectiles.
|-
| installedlanguages
| ''string [R]''
|
|-
| isapplicationactive
| ''boolean [R]''
| Is Graal window active?
|-
| iscarrying
| ''boolean [R]''
| Returns true of false if the player is carrying something.
|-
| isfocused
| ''boolean [R]''
|
|-
| isgraal3d
| ''boolean [R]''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| isleader
| ''boolean [R]''
| Player was the first to enter the level.
|-
| isonmap
| ''boolean [R]''
| Player is on a map.
|-
| isopengl
| ''boolean [R]''
| Graal is in opengl mode.
|-
| isrecordingvideo
| ''boolean [R]''
| Player is currently recording(alt+6) Graal.
|-
| jpegquality
| ''integer''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| lastdownloadfile
| ''string [R]''
| The last file downloaded.
|-
| leftmousebutton
| ''boolean [R]''
| If the left mouse button is pressed.
|-
| leftmousebuttonglobal
| ''boolean [R]''
| If the left mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| levelorgx
| ''float [R]''
|
|-
| levelorgy
| ''float [R]''
|
|-
| lighteffectsenabled
| ''boolean''
| Whether the player has their lights enabled via options.
|-
| middlemousebutton
| ''boolean [R]''
| If the middle mouse button is pressed
|-
| middlemousebuttonglobal
| ''boolean [R]''
| If the middle mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| mousebuttons
| ''integer [R]''
|
|-
| mousebuttonsglobal
| ''integer [R]''
|
|-
| mousepitch
| ''float [R] [3D]''
|
|-
| mousescreenx
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the x-axis.
|-
| mousescreeny
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the y-axis.
|-
| mousewheeldelta
| ''integer [R]''
| How much the mouse wheel has been scrolled.
|-
| mousex
| ''float''
| Position of the mouse in the level, in tile units, on the x-axis.
|-
| mousey
| ''float''
| Position of the mouse in the level, in tile units, on the y-axis
|-
| mouseyaw
| ''float [R] [3D]''
|
|-
| musiclen
| ''integer [R]''
| Length of current playing '''MP3'''
|-
| musicpos
| ''integer [R]''
| Position of current playing '''MP3'''
|-
| particleeffectsenabled
| ''boolean''
| If player has particles enabled in their options.
|-
| rightmousebutton
| ''boolean [R]''
| If the right mouse button is pressed
|-
| rightmousebuttonglobal
| ''boolean [R]''
| If the right mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| screenheight
| ''integer [R]''
| Height of the Graal screen in pixel units.
|-
| screenwidth
| ''integer [R]''
| Width of the Graal screen in pixel units.
|-
| scriptedcontrols
| ''boolean [R]''
|
|-
| scriptedplayerlist
| ''boolean [R]''
| Whether the player has the scripted playerlist enabled.
|-
| scriptlogwritetoreadonly
| ''boolean''
|
|-
| selectedlistplayers
| ''object''
| An object of all players selected on the playerlist.
|-
| selectedsword
| ''integer''
|
|-
| selectedweapon
| ''integer''
| Index of the currently selected weapon.
|-
| servername
| ''string [R]''
| Name of the server.
|-
| serverstartconnect
| ''string''
|
|-
| serverstartparams
| ''string''
|
|-
| shotbybaddy
| ''boolean [R]''
| If the player is shot by a baddy(default) arrow.
|-
| shotbyplayer
| ''boolean [R]''
| If the player is shot by another players arrow.
|-
| showterraingrid
| ''boolean''
|
|-
| spritesimage
| ''string''
| Filename of the currently set sprite image.
|-
| statusimage
| ''string''
| Filename of the currently set state image.
|-
| timevar
| ''integer [R].''
|
|-
| timevar2
| ''float [R]''
|
|-
| timevar3
| ''float [R] [3D]''
| Synchronized time which works on both server and client-side, precision is milliseconds.
|-
| wasshooted
| ''boolean [R]''
| If the player is shot by a default arrow.
|-
| waterheight
| ''float''
|
|-
| weapons
| ''object [R]''
| all the players weapons, this includes login inherited weapons.
|-
| weaponsenabled
| ''boolean''
| If the players weapons are enabled via disableweapons()/enableweapons().
|-
| weathereffectsenabled
| ''boolean''
| If weather is enabled in the players options.
|-
| worldclockstopped
| ''boolean''
|
|-
| worldhour
| ''integer''
|
|-
| worldminute
| ''float''
|
|-
| worldminutesofday
| ''float''
|
|-
| worldrealsecondsperday
| ''float''
|
|-
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Function'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| addcontrol(object)
|
| adds 'object' to the parent control.
|-
| addmaterialmapping(string, string)
| [3D]
| returns boolean.
|-
| addtiledef(string image, string prefix, int format)
|
| Adds a tileset definition with the supplied tileset image, level prefix and tileset format (0=pics1, 1=new world, 5=terrain).
|-
| addtiledef2(string image, string prefix, int x, int y)
|
| Overlays an image on the tileset with the supplied tileset image and level prefix. Parameters 'x' and 'y' represent the x and y position on the tileset of where to place the new image.
|-
| aindexof(float, array)
|
| Returns integer - the position of 'float' in the array.
|-
| arccos(float)
|
| Returns float - the arc cosine of 'float'.
|-
| arcsin(float)
|
| Returns float - the arc sine of 'float'.
|-
| attachplayertoobj(integer1, integer2)
|
| Attaches the player to the object with the matching ID where integer1 is the object type (currently only NPCs - 0) and integer2 is the ID of the desired object.
|-
| base64decode(string)
|
| Returns string - Decodes a base64 string.
|-
| base64encode(string)
|
| Returns string - Encodes string in to several characters of a 64 printable character set (A-Z, a-z, 0-9, + and /, while "=" is a special suffix code)
|-
| boxcontains(string, string)
|
| returns boolean.
|-
| boxcontainsvector(string, string)
|
| returns boolean
|-
| boxintersect(string, string)
|
| returns string
|-
| boxoverlaps(string, string)
|
| returns boolean
|-
| boxscale(string, string)
|
| returns string
|-
| callnpc(int index, string function)
|
| Calls a function from an NPC where 'index' is the NPC's index and 'function' is the function name.
|-
| callweapon(int index, string function)
|
| Calls a function from a weapon where 'index' is the weapon's index and 'function' is the function name.
|-
| castray({x,y,x}, {x,y,z}, string type)
| [3D]
| returns object - specify the start and end of the ray, and the object types (e.g. "staticts,terrain,interior")
|-
| checksum(string)
|
| returns float
|-
| contains(string2, string1)
|
| returns boolean - True if string1 is contained within string2.
|-
| copystrings(string, string)
|
|
|-
| cursoroff()
| [opengl]
| Disables the visible mouse cursor.
|-
| cursoron()
| [opengl]
| Enables the visible mouse cursor.
|-
| degtorad(float)
|
| returns float - Converts angle measurements of degrees to radians
|-
| detachplayer()
|
| Detaches a player from an attached object.
|-
| disabledefmovement()
|
| Disables the default movement system and controls(including weapons, sword, grab. Does not include Q-menu, pause, map...).
|-
| disablemap()
|
| Disables the default map (M).
|-
| disablepause()
|
| Disables the default pause (P).
|-
| disableselectweapons()
|
| Disables the default Q-menu (Q).
|-
| disableweapons()
|
| Disables the default sword (S) and weapons (D).
|-
| [[Creation/Dev/Output_Methods#echo.28.29|echo(string)]]
|
| echos 'string' to the debug window(F2).
|-
| enabledefmovement()
|
| Enables the default movement system.
|-
| [[Creation/Dev/Script/Functions/enablefeatures(int)|enablefeatures(int)]]
|
|
|-
| enablemap()
|
| Enables the default map system(M).
|-
| enablepause()
|
| Enables the default pause system(P).
|-
| enableselectweapons()
|
| Enables the default Q-menu(Q).
|-
| enableweapons()
|
| Enables the default sword(S) and weapons(D).
|-
| escapestring(string)
|
| returns string - adds \\ in front of ", ' and \\, and removes non-printable characters
|-
| explodebomb(integer)
|
| explodes the bomb with the id of 'integer'.
|-
| extractfilebase(string)
|
| returns string
|-
| extractfileext(string)
|
| Takes in a file name, and returns its extension.
|-
| extractfilepath(string)
|
| returns string
|-
| fileexists(string)
|
| returns boolean of whether the file 'str' exists in the players Graal/ directory(does not search subfolders).
|-
| filesize(string)
|
| Returns the size(int) of the file 'string' in the players Graal/ directory(does not search subfolders).
|-
| fileupdate(string)
|
| returns boolean
|-
| findani(string)
|
| returns object
|-
| findfiles(string, integer)
|
| returns object
|-
| findlevel(string)
|
| returns object
|-
| findnearestplayer(float1, float2)
|
| Returns the closest player's object relevant to float1 and float2.
|-
| findnearestplayers(float, float)
|
| Returns the closest players' object relevant to float1 and float2.
|-
| findnpcbyid(integer)
|
| Returns the NPC object with the ID of 'int'.
|-
| findpathinarray(obj1, obj2, obj3, obj4, obj5, int, int, int)
|
| Returns object - Simple path-finding: Obj1 being tiles that allow walking, Obj2 being tiles that don't allow walking, Obj3; tiles that shouldn't be allowed to walked on, Obj4; tiles that are able to be walked on, Obj5; tiles where we may stop. Integers are relevant to the startx, starty and maximum path length. - Arrays for allowed/non-allowed tiles are only checked if they aren't null.
|-
| findplayer(string)
|
| Returns the player object with the account equal to string.
|-
| findplayerbycommunityname(string)
|
| Returns the player object with the community name equal to string.
|-
| findplayerbyid(integer)
|
| Returns the player object with the ID equal to integer.
|-
| findweapon(string)
|
| Returns the weapon object with the name equal to string.
|-
| [[Creation/Dev/Output_Methods#format.28.29_function|format(string, string, ...)]]
|
| See [[Creation/Dev/Output_Methods#format.28.29_function|format()]].
|-
| [[Creation/Dev/Output_Methods#format2.28.29_function|format2(string, array)]]
|
| Like format(), except that this expects the format string and an array of variables instead of passing the variables as separate parameters.
|-
| freefileresources(string)
|
|
|-
| freezeplayer(float)
|
| Freezes the player for the number of seconds specified by float.
|-
| get3dobjectat(float, float, boolean)
| [3D]
| Gets the 3d object at the specified screen position, third parameter true if it should do box collision.
|-
| get3dobjectatmouse(boolean)
| [3D]
| Gets the 3d object at the mouse. Parameter true if it should do box collision.
|-
| get3dobjectbyray(string, string)
| [3D]
| returns object
|-
| get3dobjectsbybox(string, string)
| [3D]
| 1st parameter defines the box {minx,miny,minz, maxx,maxy,maxz}. Second parameter specifies the type of object to find (e.g. "staticts,terrain,interior")
|-
| get3dscreenposition(string, boolean)
| [3D]
| returns string
|-
| getanglesfromvector({x, y, z})
|
| Returns an array that contains the angles the 3D vector {x, y, z} makes with the X-Y and X-Z axes.
|-
| getascii(string)
|
| Returns the [http://www.asciitable.com/ ascii] code for string.
|-
| getbasepackage()
|
| returns object
|-
| getboxcenter(string)
|
| Returns an array containing the center of a 3D box specified by string ({x0,y0,z0,x1,y1,z1,...}).
|-
| getdesktopresolution()
|
| returns string
|-
| getdisplaydevicelist()
|
| returns string
|-
| getdownloadedupdatepackagesize()
|
| Returns the size of the downloaded update package.
|-
| getdownloadingpackage()
|
| Returns a reference to current update package being downloaded.
|-
| getdownloadingpackagescount()
|
| Returns a count of the number of update packages to download.
|-
| getdropz(string)
|
| returns float
|-
| getExtension(string)
|
| This function is the same as extractFileExt(). Takes in a file name, and returns its extension.
|-
| getfilemodtime(string)
|
| Returns a timestamp of when the file was last modified (in unix time compatible to timevar2). This function accepts both exact file path and plain file name.
|-
| gethttprequest(string, integer, string)
|
| returns object (This function is the same as requestHttp())
|-
| getimgheight(string)
|
| Returns the height (in pixels) of the filename indicated by string.
|-
| getimgpixel(string, integer, integer)
|
| returns object
|-
| getimgwidth(string)
|
| Returns the width(in pixels) of the filename indicated by string.
|-
| getkeycode(string)
|
| Returns the keycode of the key indicated by string. The keycode returned can be used in keydown2().
|-
| getloginaccountname()
|
| Presumably used for the login server. Use player.account instead.
|-
| getmapx(string)
|
| Gets the x coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmapy(string)
|
| Gets the y coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmusicfilename()
|
| Returns the filename of the music currently playing.
|-
| getmusicstatus()
|
| Returns the status of the music currently playing.
|-
| getmusictags()
|
| Returns the tags of the music currently playing. This function can be used to retrieve the title and artist info of the music.
|-
| getnearestplayer(float, float)
|
| Deprecated. Use findnearestplayer() instead.
|-
| getnearestplayers(float, float)
|
| Deprecated. Use findnearestplayers() instead.
|-
| getpackagesdownloadcomplete()
|
| Returns 'true' if the package downloads are complete.
|-
| getpackagesdownloaded()
|
| Returns 'true' if the most recent packages are already downloaded.
|-
| getplatform()
|
| Returns the platform that the player is using. (i.e. windows, mac, or linux)
|-
| getresolutionlist(string)
|
| returns string
|-
| getservername()
|
| Returns the name of the server the player is currently connected to.
|-
| getstringkeys(string)
|
| Returns an array of the variables that begins with the supplied string.
|-
| getterraintexture(float, float)
|
| returns string
|-
| getterraintextureindex(float, float)
|
| returns integer
|-
| gettextheight(float zoom, string style, string font)
|
| returns integer - The height in pixels of the text with the given zoom, style and font.
|-
| gettextwidth(float zoom, string style, string font, string text)
|
| returns integer - The width of the text with the given zoom, style, font and text.
|-
| gettileset()
|
| returns string - the current main tileset (pics1.png, picso.png etc.)
|-
| gettilesettype()
|
| returns integer - the current tileset type (pics1.png:0, picso.png:5 etc.)
|-
| gettotalupdatepackagesize()
|
| returns integer - The total size of the update packages.
|-
| getupdatepackage(string name)
|
| returns object - A reference to the update package with the given name.
|-
| getvectorfromangles(float, float)
|
| returns string
|-
| getz(float, float)
|
| returns float
|-
| graalcontrolhasfocus(bool)
|
| returns boolean - Whether or not the graal control has focus. Parameter says if it should also check if the chat bar has the focus
|-
| hideplayer(float time)
|
| Hides player for the specified amount of time.
|-
| hidesword(float time)
|
| Hides the player's sword for the specified amount of time.
|-
| hitnpc(int index, float halfhearts, float fromx, float fromy)
|
| Hit's npc with specified index causing the specified amount of halfhearts in damage. It also knocks back the npc based on the from X and Y coordinate passed to it.
|-
| hitobjects(float power, float x, float y)
|
| Hurts all the npcs with the specified power on the position passed to it.
|-
| hitplayer(int index, float halfhearts, float fromx, float fromy)
|
| Hit's player with specified index causing the specified amount of halfhearts in damage. It also knocks back the player based on the from X and Y coordinate passed to it. Use 0 as the index to hit your own player.
|-
| isadminguild(str guildname)
|
| returns boolean - If the passed guildname is an admin guild or not.
|-
| isclassloaded(str classname)
|
| returns boolean - If the passed classname is loaded for the client.
|-
| iscursoron()
|
| returns boolean - If the cursor is on or not.
|-
| isdevicefullscreenonly(str device)
|
| returns boolean - If the device is full screen only or not.
|-
| isdownloading(str filename)
|
| returns boolean - If a file is currently downloaded or requested from the server.
|-
| isdownloadingfiles()
|
| returns boolean - checks if Graal is currently downloading or requesting files from the server.
|-
| isfullscreenmode()
|
| returns boolean - checks if Graal is currently in fullscreen mode.
|-
| isimgrectangletransparent(str, int, int, int, int)
|
| returns boolean
|-
| ismusicplaying()
|
| returns boolean
|-
| isobject(str)
|
| returns boolean
|-
| issoundplaying(str)
|
| returns boolean
|-
| keydown(int)
|
| returns boolean
|-
| keydown2(int, bool)
|
| returns boolean
|-
| keydown2global(int, bool)
|
| returns boolean
|-
| keydownglobal(int)
|
| returns boolean
|-
| keyname(int)
|
| returns string
|-
| lay2(str, float, float)
|
|
|-
| lightscene()
|
| returns boolean
|-
| loadclass(str)
|
|
|-
| loadmap(str)
|
|
|-
| loadtranslation(str)
|
|
|-
| lowercase(str)
|
| returns string
|-
| ltmfs(bool)
|
|
|-
| ltmmax(float, float)
|
|
|-
| ltmmin(float, float)
|
|
|-
| makescreenshot2(str, int, float, float, float, int, int)
|
|
|-
| matrixcreate(str, str)
|
| returns string
|-
| matrixcreatefromeuler(str)
|
| returns string
|-
| matrixmulpoint(str, str)
|
| returns string
|-
| matrixmultiply(str, str)
|
| returns string
|-
| matrixmulvector(str, str)
|
| returns string
|-
| md5(str)
|
| returns string
|-
| noplayerkilling()
|
|
|-
| onwall(float, float)
|
| returns boolean
|-
| onwall2(float, float, float, float)
|
| returns boolean
|-
| onwater(float, float)
|
| returns boolean
|-
| onwater2(float, float, float, float)
|
| returns boolean
|-
| opengraalurl(str)
|
|
|-
| openurl(str)
|
|
|-
| openurl2(str, int, int)
|
|
|-
| play(str)
|
|
|-
| play2(str, float, float, float)
|
|
|-
| play3d(str, bool, str, str)
|
|
|-
| playlooped(str)
|
|
|-
| playlooped2(str, float, float, float)
|
|
|-
| popdialog()
|
|
|-
| pushdialog(obj)
|
|
|-
| putleaps(int, float, float)
|
|
|-
| radtodeg(float)
|
| returns float
|-
| randomstring(str)
|
| returns string
|-
| removetiledefs(str)
|
|
|-
| replaceani(str, str)
|
|
|-
| requestfiledeletion(str)
|
|
|-
| requestfilerename(str, str)
|
|
|-
| requestfilesmove(str, str)
|
|
|-
| requesthttp(str, int, str)
|
| returns object
|-
| requesttext(str, str)
|
|
|-
| requesturl(str)
|
| returns object
|-
| resetfocus()
|
|
|-
| rotationadd(str, str)
|
| returns string
|-
| rotationaddeuler(str, str)
|
| returns string
|-
| rotationfromeuler(str)
|
| returns string
|-
| rotationsub(str, str)
|
| returns string
|-
| rotationtoeuler(str)
|
| returns string
|-
| rungarbagecollector()
|
|
|-
| savelog(str)
|
|
|-
| say(int)
|
|
|-
| say2(str)
|
|
|-
| screenx(float, float)
|
| returns integer
|-
| screeny(float, float)
|
| returns integer
|-
| selectfilefordownload(str)
|
| opens the select
|-
| selectfileforupload()
|
| opens the select
|-
| [[Creation/Dev/Output_Methods#sendrpgmessage.28.29|sendrpgmessage(str)]]
|
|
|-
| sendtext(str, str, params...)
|
|
|-
| [[Creation/Dev/Output_Methods#sendtorc.28.29|sendtorc(str)]]
|
|
|-
| serverwarp(str)
|
|
|-
| setani(str, str)
|
|
|-
| setbeltcolor(str)
|
|
|-
| setcoatcolor(str)
|
|
|-
| setcontentcontrol(obj)
|
|
|-
| setcursor2(str)
|
|
|-
| seteffect(float, float, float, float)
|
|
|-
| setfocus(float, float)
|
|
|-
| setfogcolors(obj)
|
|
|-
| setgender(str)
|
|
|-
| sethead(str)
|
|
|-
| setinteriorrendermode(int)
|
|
|-
| setletters(str)
|
|
|-
| setmap(str, str, float, float)
|
| sets a text map (you can see the tiles of other levels but not the npcs), parameters are text file with level names, the map image (not used anymore), default x and y for the head icons; use gmaps if possible instead of this
|-
| setminimap(str, str, float, float)
|
| parameters are a text file with level names, the image, default x and y; use gmaps if possible instead of this
|-
| setmusicvolume(float, float)
|
|
|-
| setplayerdir(str)
|
|
|-
| setshield(str, int)
|
|
|-
| setshoecolor(str)
|
|
|-
| setshootparams(str)
|
|
|-
| setskincolor(str)
|
|
|-
| setskybandcolors(obj)
|
|
|-
| setskybandsizes(obj)
|
|
|-
| setsleevecolor(str)
|
|
|-
| setspritesimage(str)
|
|
|-
| setstatusimage(str)
|
|
|-
| setsuncolors(obj)
|
|
|-
| setsword(str, int)
|
|
|-
| setterrainrendermode(int)
|
|
|-
| showstats(int)
|
|
|-
| spyfire(int, int)
|
|
|-
| startrecordvideo()
|
| returns boolean
|-
| stopmidi()
|
| same as stopmusic(), kept for compatibility
|-
| stopmusic()
|
|
|-
| stoprecordvideo()
|
| returns boolean
|-
| stopsound(str)
|
|
|-
| strcmp(str, str)
|
| returns integer
|-
| strequals(str, str)
|
| returns boolean
|-
| switchtoopengl()
|
|
|-
| synctimeofday(float, float)
|
|
|-
| takeplayercarry()
|
|
|-
| takeplayerhorse()
|
|
|-
| testplayer(float, float)
|
| returns integer
|-
| [[Creation/Dev/Output_Methods#echo.28.29|trace(string)]]
|
| same as [[Creation/Dev/Output_Methods#echo.28.29|echo()]]. Included for compatibility with ActionScript. As such, it should be considered deprecated.
|-
| triggeraction(float, float, str, params...)
|
|
|-
| triggerserver(str, str)
|
|
|-
| update3dterrain(float, float, float, float)
|
|
|-
| updateboard(int, int, int, int)
|
|
|-
| updateterrain()
|
|
|-
| updatevisibledistance()
|
|
|-
| uploadfile(str)
|
| uploads a file, you must provide the full path provided by a onDropFiles() event, also this will only work if the scripted RC has currently a file browser window open; once the file is uploaded an onFilesUploaded event will be invoked
|-
| uppercase(str)
|
| returns string
|-
| [[Vectors#Vector_Addition|vectoradd(str, str)]]
|
| returns string
|-
| [[Cross Product|vectorcross(str, str)]]
|
| returns string
|-
| [[Vectors#Distance_Between_Terminal_Points|vectordist(str, str)]]
|
| returns float
|-
| [[Dot Product|vectordot(str, str)]]
|
| returns float
|-
| [[Vectors#Vector_Length_.28Magnitude.2FModulus.29|vectorlen(str)]]
|
| returns float
|-
| [[Vectors#Unit_Length|vectornormalize(str)]]
|
| returns string
|-
| vectororthobasis(str)
|
| returns string
|-
| [[Vectors#Vector-Scalar_Multiplication|vectorscale(str, float)]]
|
| returns string
|-
| [[Vectors#Vector_Subtraction|vectorsub(str, str)]]
|
| returns string
|-
| worldx(float, float)
|
| returns float
|-
| worldy(float, float)
|
| returns float
|-
| wraptext(int, str, str)
|
| returns object
|-
| wraptext2(int, float, str, str)
|
| returns object
|}
 

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

=GUI Objects=
GUI Objects are currently well documented starting here [[Creation/Dev/Script/Client/GuiControl]].

=Preference Variables=
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| $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::capture::allowbyscript
|
| boolean [R]
|-
| $pref::capture::area
|
| string
|-
| $pref::capture::audiobitrate
|
| integer
|-
| $pref::capture::disabledaynight
|
| boolean
|-
| $pref::capture::format
|
| string
|-
| $pref::capture::fps
|
| integer
|-
| $pref::capture::hideinterface
|
| boolean
|-
| $pref::capture::recordaudio
|
| boolean
|-
| $pref::capture::showmouse
|
| boolean
|-
| $pref::capture::size
|
| string
|-
| $pref::capture::videobitrate
|
| integer
|-
| $pref::graal::allowglobalpms
|
| boolean
|-
| $pref::graal::automapping
|
| boolean
|-
| $pref::graal::defaultfontname
|
| string
|-
| $pref::graal::defaultfontsize
|
| integer
|-
| $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::video::defaultguistyle
|
| string
|-
| $pref::video::detailfactor
|
| float
|-
| $pref::video::fogdistance
|
| float
|-
| $pref::video::fullscreenmode
|
| string
|-
| $pref::video::resolution
|
| integer
|-
| $pref::video::screenshotformat
|
| string
|-
| $pref::video::visibledistance
|
| float
|-
| $pref::video::windowmode
|
| string
|}

Creation/Dev/Script/Clientside Functions

2011-09-20T01:36:54Z

Tolnaftate2004: /* Functions */

[[Category:Scripting Reference]]
{| border="0" cellpadding="2" width="50%"
|[R]
| denotes it is read-only.
|-
|[3D]
| denotes it is a Graal3D function.
|-
|[opengl]
| denotes it is functional only in opengl mode.
|}

==Variables==
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| allfeatures
| ''integer [R]''
|
|-
| allplayerscount
| ''integer [R]''
| Returns the count of all players on your playerlist, including IRC bots.
|-
| allrenderobjecttypes
| ''integer [R]''
|
|-
| allstats
| ''integer [R]''
| Used with showstats() in order to show all stats.
|-
| canspin
| ''boolean [R]''
| Returns true of false if the player has spin attack.
|-
| carriesblackstone
| ''boolean [R]''
| Returns whether the player is carrying a black stone.
|-
| carriesbush
| ''boolean [R]''
| Returns whether the player is carrying a bush.
|-
| carriesnpc
| ''boolean [R]''
| Returns whether the player is carrying an NPC
|-
| carriessign
| ''boolean [R]''
| Returns whether the player is carrying a sign.
|-
| carriesstone
| ''boolean [R]''
| Returns whether the player is carrying a stone.
|-
| carriesvase
| ''boolean [R]''
| Returns whether the player is carrying a vase.
|-
| downloadfile
| ''string [R]''
| Returns the currently downloaded file.
|-
| downloadpos
| ''integer [R]''
| Returns the position of the currently downloaded file.
|-
| downloadsize
| ''integer [R]''
| Returns the size of the currently downloaded file.
|-
| editingmission
| ''boolean''
|
|-
| emoticonchar
| ''string [R]''
|
|-
| focusx
| ''float [R]''
| Position of the camera in tile units.
|-
| focusy
| ''float [R]''
| Position of the camera in tile units.
|-
| ghostsnear
| ''boolean [R]''
| If a ghost(observer) is in the same level as the player.
|-
| graalplugincookie
| ''string [R]''
|
|-
| graalversion
| ''float [R]''
| Version of Graal the player is using.
|-
| gravity
| ''float''
| The gravity value that effects how fast projectiles fall. It universally effects all projectiles.
|-
| installedlanguages
| ''string [R]''
|
|-
| isapplicationactive
| ''boolean [R]''
| Is Graal window active?
|-
| iscarrying
| ''boolean [R]''
| Returns true of false if the player is carrying something.
|-
| isfocused
| ''boolean [R]''
|
|-
| isgraal3d
| ''boolean [R]''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| isleader
| ''boolean [R]''
| Player was the first to enter the level.
|-
| isonmap
| ''boolean [R]''
| Player is on a map.
|-
| isopengl
| ''boolean [R]''
| Graal is in opengl mode.
|-
| isrecordingvideo
| ''boolean [R]''
| Player is currently recording(alt+6) Graal.
|-
| jpegquality
| ''integer''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| lastdownloadfile
| ''string [R]''
| The last file downloaded.
|-
| leftmousebutton
| ''boolean [R]''
| If the left mouse button is pressed.
|-
| leftmousebuttonglobal
| ''boolean [R]''
| If the left mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| levelorgx
| ''float [R]''
|
|-
| levelorgy
| ''float [R]''
|
|-
| lighteffectsenabled
| ''boolean''
| Whether the player has their lights enabled via options.
|-
| middlemousebutton
| ''boolean [R]''
| If the middle mouse button is pressed
|-
| middlemousebuttonglobal
| ''boolean [R]''
| If the middle mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| mousebuttons
| ''integer [R]''
|
|-
| mousebuttonsglobal
| ''integer [R]''
|
|-
| mousepitch
| ''float [R] [3D]''
|
|-
| mousescreenx
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the x-axis.
|-
| mousescreeny
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the y-axis.
|-
| mousewheeldelta
| ''integer [R]''
| How much the mouse wheel has been scrolled.
|-
| mousex
| ''float''
| Position of the mouse in the level, in tile units, on the x-axis.
|-
| mousey
| ''float''
| Position of the mouse in the level, in tile units, on the y-axis
|-
| mouseyaw
| ''float [R] [3D]''
|
|-
| musiclen
| ''integer [R]''
| Length of current playing '''MP3'''
|-
| musicpos
| ''integer [R]''
| Position of current playing '''MP3'''
|-
| particleeffectsenabled
| ''boolean''
| If player has particles enabled in their options.
|-
| rightmousebutton
| ''boolean [R]''
| If the right mouse button is pressed
|-
| rightmousebuttonglobal
| ''boolean [R]''
| If the right mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| screenheight
| ''integer [R]''
| Height of the Graal screen in pixel units.
|-
| screenwidth
| ''integer [R]''
| Width of the Graal screen in pixel units.
|-
| scriptedcontrols
| ''boolean [R]''
|
|-
| scriptedplayerlist
| ''boolean [R]''
| Whether the player has the scripted playerlist enabled.
|-
| scriptlogwritetoreadonly
| ''boolean''
|
|-
| selectedlistplayers
| ''object''
| An object of all players selected on the playerlist.
|-
| selectedsword
| ''integer''
|
|-
| selectedweapon
| ''integer''
| Index of the currently selected weapon.
|-
| servername
| ''string [R]''
| Name of the server.
|-
| serverstartconnect
| ''string''
|
|-
| serverstartparams
| ''string''
|
|-
| shotbybaddy
| ''boolean [R]''
| If the player is shot by a baddy(default) arrow.
|-
| shotbyplayer
| ''boolean [R]''
| If the player is shot by another players arrow.
|-
| showterraingrid
| ''boolean''
|
|-
| spritesimage
| ''string''
| Filename of the currently set sprite image.
|-
| statusimage
| ''string''
| Filename of the currently set state image.
|-
| timevar
| ''integer [R].''
|
|-
| timevar2
| ''float [R]''
|
|-
| timevar3
| ''float [R] [3D]''
| Synchronized time which works on both server and client-side, precision is milliseconds.
|-
| wasshooted
| ''boolean [R]''
| If the player is shot by a default arrow.
|-
| waterheight
| ''float''
|
|-
| weapons
| ''object [R]''
| all the players weapons, this includes login inherited weapons.
|-
| weaponsenabled
| ''boolean''
| If the players weapons are enabled via disableweapons()/enableweapons().
|-
| weathereffectsenabled
| ''boolean''
| If weather is enabled in the players options.
|-
| worldclockstopped
| ''boolean''
|
|-
| worldhour
| ''integer''
|
|-
| worldminute
| ''float''
|
|-
| worldminutesofday
| ''float''
|
|-
| worldrealsecondsperday
| ''float''
|
|-
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Function'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| addcontrol(object)
|
| adds 'object' to the parent control.
|-
| addmaterialmapping(string, string)
| [3D]
| returns boolean.
|-
| addtiledef(string image, string prefix, int format)
|
| Adds a tileset definition with the supplied tileset image, level prefix and tileset format (0=pics1, 1=new world, 5=terrain).
|-
| addtiledef2(string image, string prefix, int x, int y)
|
| Overlays an image on the tileset with the supplied tileset image and level prefix. Parameters 'x' and 'y' represent the x and y position on the tileset of where to place the new image.
|-
| aindexof(float, array)
|
| Returns integer - the position of 'float' in the array.
|-
| arccos(float)
|
| Returns float - the arc cosine of 'float'.
|-
| arcsin(float)
|
| Returns float - the arc sine of 'float'.
|-
| attachplayertoobj(integer1, integer2)
|
| Attaches the player to the object with the matching ID where integer1 is the object type (currently only NPCs - 0) and integer2 is the ID of the desired object.
|-
| base64decode(string)
|
| Returns string - Decodes a base64 string.
|-
| base64encode(string)
|
| Returns string - Encodes string in to several characters of a 64 printable character set (A-Z, a-z, 0-9, + and /, while "=" is a special suffix code)
|-
| boxcontains(string, string)
|
| returns boolean.
|-
| boxcontainsvector(string, string)
|
| returns boolean
|-
| boxintersect(string, string)
|
| returns string
|-
| boxoverlaps(string, string)
|
| returns boolean
|-
| boxscale(string, string)
|
| returns string
|-
| callnpc(int index, string function)
|
| Calls a function from an NPC where 'index' is the NPC's index and 'function' is the function name.
|-
| callweapon(int index, string function)
|
| Calls a function from a weapon where 'index' is the weapon's index and 'function' is the function name.
|-
| castray({x,y,x}, {x,y,z}, string type)
| [3D]
| returns object - specify the start and end of the ray, and the object types (e.g. "staticts,terrain,interior")
|-
| checksum(string)
|
| returns float
|-
| contains(string2, string1)
|
| returns boolean - True if string1 is contained within string2.
|-
| copystrings(string, string)
|
|
|-
| cursoroff()
| [opengl]
| Disables the visible mouse cursor.
|-
| cursoron()
| [opengl]
| Enables the visible mouse cursor.
|-
| degtorad(float)
|
| returns float - Converts angle measurements of degrees to radians
|-
| detachplayer()
|
| Detaches a player from an attached object.
|-
| disabledefmovement()
|
| Disables the default movement system and controls(including weapons, sword, grab. Does not include Q-menu, pause, map...).
|-
| disablemap()
|
| Disables the default map (M).
|-
| disablepause()
|
| Disables the default pause (P).
|-
| disableselectweapons()
|
| Disables the default Q-menu (Q).
|-
| disableweapons()
|
| Disables the default sword (S) and weapons (D).
|-
| [[Creation/Dev/Output_Methods#echo.28.29|echo(string)]]
|
| echos 'string' to the debug window(F2).
|-
| enabledefmovement()
|
| Enables the default movement system.
|-
| [[Creation/Dev/Script/Functions/enablefeatures(int)|enablefeatures(int)]]
|
|
|-
| enablemap()
|
| Enables the default map system(M).
|-
| enablepause()
|
| Enables the default pause system(P).
|-
| enableselectweapons()
|
| Enables the default Q-menu(Q).
|-
| enableweapons()
|
| Enables the default sword(S) and weapons(D).
|-
| escapestring(string)
|
| returns string - adds \\ in front of ", ' and \\, and removes non-printable characters
|-
| explodebomb(integer)
|
| explodes the bomb with the id of 'integer'.
|-
| extractfilebase(string)
|
| returns string
|-
| extractfileext(string)
|
| Takes in a file name, and returns its extension.
|-
| extractfilepath(string)
|
| returns string
|-
| fileexists(string)
|
| returns boolean of whether the file 'str' exists in the players Graal/ directory(does not search subfolders).
|-
| filesize(string)
|
| Returns the size(int) of the file 'string' in the players Graal/ directory(does not search subfolders).
|-
| fileupdate(string)
|
| returns boolean
|-
| findani(string)
|
| returns object
|-
| findfiles(string, integer)
|
| returns object
|-
| findlevel(string)
|
| returns object
|-
| findnearestplayer(float1, float2)
|
| Returns the closest player's object relevant to float1 and float2.
|-
| findnearestplayers(float, float)
|
| Returns the closest players' object relevant to float1 and float2.
|-
| findnpcbyid(integer)
|
| Returns the NPC object with the ID of 'int'.
|-
| findpathinarray(obj1, obj2, obj3, obj4, obj5, int, int, int)
|
| Returns object - Simple path-finding: Obj1 being tiles that allow walking, Obj2 being tiles that don't allow walking, Obj3; tiles that shouldn't be allowed to walked on, Obj4; tiles that are able to be walked on, Obj5; tiles where we may stop. Integers are relevant to the startx, starty and maximum path length. - Arrays for allowed/non-allowed tiles are only checked if they aren't null.
|-
| findplayer(string)
|
| Returns the player object with the account equal to string.
|-
| findplayerbycommunityname(string)
|
| Returns the player object with the community name equal to string.
|-
| findplayerbyid(integer)
|
| Returns the player object with the ID equal to integer.
|-
| findweapon(string)
|
| Returns the weapon object with the name equal to string.
|-
| [[Creation/Dev/Output_Methods#format.28.29_function|format(string, string, ...)]]
|
| See [[Creation/Dev/Output_Methods#format.28.29_function|format()]].
|-
| [[Creation/Dev/Output_Methods#format2.28.29_function|format2(string, array)]]
|
| Like format(), except that this expects the format string and an array of variables instead of passing the variables as separate parameters.
|-
| freefileresources(string)
|
|
|-
| freezeplayer(float)
|
| Freezes the player for the number of seconds specified by float.
|-
| get3dobjectat(float, float, boolean)
| [3D]
| Gets the 3d object at the specified screen position, third parameter true if it should do box collision.
|-
| get3dobjectatmouse(boolean)
| [3D]
| Gets the 3d object at the mouse. Parameter true if it should do box collision.
|-
| get3dobjectbyray(string, string)
| [3D]
| returns object
|-
| get3dobjectsbybox(string, string)
| [3D]
| 1st parameter defines the box {minx,miny,minz, maxx,maxy,maxz}. Second parameter specifies the type of object to find (e.g. "staticts,terrain,interior")
|-
| get3dscreenposition(string, boolean)
| [3D]
| returns string
|-
| getanglesfromvector({x, y, z})
|
| Returns an array that contains the angles the 3D vector {x, y, z} makes with the X-Y and X-Z axes.
|-
| getascii(string)
|
| Returns the [http://www.asciitable.com/ ascii] code for string.
|-
| getbasepackage()
|
| returns object
|-
| getboxcenter(string)
|
| Returns an array containing the center of a 3D box specified by string ({x0,y0,z0,x1,y1,z1,...}).
|-
| getdesktopresolution()
|
| returns string
|-
| getdisplaydevicelist()
|
| returns string
|-
| getdownloadedupdatepackagesize()
|
| Returns the size of the downloaded update package.
|-
| getdownloadingpackage()
|
| Returns a reference to current update package being downloaded.
|-
| getdownloadingpackagescount()
|
| Returns a count of the number of update packages to download.
|-
| getdropz(string)
|
| returns float
|-
| getExtension(string)
|
| This function is the same as extractFileExt(). Takes in a file name, and returns its extension.
|-
| getfilemodtime(string)
|
| Returns a timestamp of when the file was last modified (in unix time compatible to timevar2). This function accepts both exact file path and plain file name.
|-
| gethttprequest(string, integer, string)
|
| returns object (This function is the same as requestHttp())
|-
| getimgheight(string)
|
| Returns the height (in pixels) of the filename indicated by string.
|-
| getimgpixel(string, integer, integer)
|
| returns object
|-
| getimgwidth(string)
|
| Returns the width(in pixels) of the filename indicated by string.
|-
| getkeycode(string)
|
| Returns the keycode of the key indicated by string. The keycode returned can be used in keydown2().
|-
| getloginaccountname()
|
| Presumably used for the login server. Use player.account instead.
|-
| getmapx(string)
|
| Gets the x coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmapy(string)
|
| Gets the y coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmusicfilename()
|
| Returns the filename of the music currently playing.
|-
| getmusicstatus()
|
| Returns the status of the music currently playing.
|-
| getmusictags()
|
| Returns the tags of the music currently playing. This function can be used to retrieve the title and artist info of the music.
|-
| getnearestplayer(float, float)
|
| Deprecated. Use findnearestplayer() instead.
|-
| getnearestplayers(float, float)
|
| Deprecated. Use findnearestplayers() instead.
|-
| getpackagesdownloadcomplete()
|
| Returns 'true' if the package downloads are complete.
|-
| getpackagesdownloaded()
|
| Returns 'true' if the most recent packages are already downloaded.
|-
| getplatform()
|
| Returns the platform that the player is using. (i.e. windows, mac, or linux)
|-
| getresolutionlist(string)
|
| returns string
|-
| getservername()
|
| Returns the name of the server the player is currently connected to.
|-
| getstringkeys(string)
|
| Returns an array of the variables that begins with the supplied string.
|-
| getterraintexture(float, float)
|
| returns string
|-
| getterraintextureindex(float, float)
|
| returns integer
|-
| gettextheight(float zoom, string style, string font)
|
| returns integer - The height in pixels of the text with the given zoom, style and font.
|-
| gettextwidth(float zoom, string style, string font, string text)
|
| returns integer - The width of the text with the given zoom, style, font and text.
|-
| gettileset()
|
| returns string - the current main tileset (pics1.png, picso.png etc.)
|-
| gettilesettype()
|
| returns integer - the current tileset type (pics1.png:0, picso.png:5 etc.)
|-
| gettotalupdatepackagesize()
|
| returns integer - The total size of the update packages.
|-
| getupdatepackage(string name)
|
| returns object - A reference to the update package with the given name.
|-
| getvectorfromangles(float, float)
|
| returns string
|-
| getz(float, float)
|
| returns float
|-
| graalcontrolhasfocus(bool)
|
| returns boolean - Whether or not the graal control has focus. Parameter says if it should also check if the chat bar has the focus
|-
| hideplayer(float time)
|
| Hides player for the specified amount of time.
|-
| hidesword(float time)
|
| Hides the player's sword for the specified amount of time.
|-
| hitnpc(int index, float halfhearts, float fromx, float fromy)
|
| Hit's npc with specified index causing the specified amount of halfhearts in damage. It also knocks back the npc based on the from X and Y coordinate passed to it.
|-
| hitobjects(float power, float x, float y)
|
| Hurts all the npcs with the specified power on the position passed to it.
|-
| hitplayer(int index, float halfhearts, float fromx, float fromy)
|
| Hit's player with specified index causing the specified amount of halfhearts in damage. It also knocks back the player based on the from X and Y coordinate passed to it. Use 0 as the index to hit your own player.
|-
| isadminguild(str guildname)
|
| returns boolean - If the passed guildname is an admin guild or not.
|-
| isclassloaded(str classname)
|
| returns boolean - If the passed classname is loaded for the client.
|-
| iscursoron()
|
| returns boolean - If the cursor is on or not.
|-
| isdevicefullscreenonly(str device)
|
| returns boolean - If the device is full screen only or not.
|-
| isdownloading(str filename)
|
| returns boolean - If a file is currently downloaded or requested from the server.
|-
| isdownloadingfiles()
|
| returns boolean - checks if Graal is currently downloading or requesting files from the server.
|-
| isfullscreenmode()
|
| returns boolean - checks if Graal is currently in fullscreen mode.
|-
| isimgrectangletransparent(str, int, int, int, int)
|
| returns boolean
|-
| ismusicplaying()
|
| returns boolean
|-
| isobject(str)
|
| returns boolean
|-
| issoundplaying(str)
|
| returns boolean
|-
| keydown(int)
|
| returns boolean
|-
| keydown2(int, bool)
|
| returns boolean
|-
| keydown2global(int, bool)
|
| returns boolean
|-
| keydownglobal(int)
|
| returns boolean
|-
| keyname(int)
|
| returns string
|-
| lay2(str, float, float)
|
|
|-
| lightscene()
|
| returns boolean
|-
| loadclass(str)
|
|
|-
| loadmap(str)
|
|
|-
| loadtranslation(str)
|
|
|-
| lowercase(str)
|
| returns string
|-
| ltmfs(bool)
|
|
|-
| ltmmax(float, float)
|
|
|-
| ltmmin(float, float)
|
|
|-
| makescreenshot2(str, int, float, float, float, int, int)
|
|
|-
| matrixcreate(str, str)
|
| returns string
|-
| matrixcreatefromeuler(str)
|
| returns string
|-
| matrixmulpoint(str, str)
|
| returns string
|-
| matrixmultiply(str, str)
|
| returns string
|-
| matrixmulvector(str, str)
|
| returns string
|-
| md5(str)
|
| returns string
|-
| noplayerkilling()
|
|
|-
| onwall(float, float)
|
| returns boolean
|-
| onwall2(float, float, float, float)
|
| returns boolean
|-
| onwater(float, float)
|
| returns boolean
|-
| onwater2(float, float, float, float)
|
| returns boolean
|-
| opengraalurl(str)
|
|
|-
| openurl(str)
|
|
|-
| openurl2(str, int, int)
|
|
|-
| play(str)
|
|
|-
| play2(str, float, float, float)
|
|
|-
| play3d(str, bool, str, str)
|
|
|-
| playlooped(str)
|
|
|-
| playlooped2(str, float, float, float)
|
|
|-
| popdialog()
|
|
|-
| pushdialog(obj)
|
|
|-
| putleaps(int, float, float)
|
|
|-
| radtodeg(float)
|
| returns float
|-
| randomstring(str)
|
| returns string
|-
| removetiledefs(str)
|
|
|-
| replaceani(str, str)
|
|
|-
| requestfiledeletion(str)
|
|
|-
| requestfilerename(str, str)
|
|
|-
| requestfilesmove(str, str)
|
|
|-
| requesthttp(str, int, str)
|
| returns object
|-
| requesttext(str, str)
|
|
|-
| requesturl(str)
|
| returns object
|-
| resetfocus()
|
|
|-
| rotationadd(str, str)
|
| returns string
|-
| rotationaddeuler(str, str)
|
| returns string
|-
| rotationfromeuler(str)
|
| returns string
|-
| rotationsub(str, str)
|
| returns string
|-
| rotationtoeuler(str)
|
| returns string
|-
| rungarbagecollector()
|
|
|-
| savelog(str)
|
|
|-
| say(int)
|
|
|-
| say2(str)
|
|
|-
| screenx(float, float)
|
| returns integer
|-
| screeny(float, float)
|
| returns integer
|-
| selectfilefordownload(str)
|
| opens the select
|-
| selectfileforupload()
|
| opens the select
|-
| [[Creation/Dev/Output_Methods#sendrpgmessage.28.29|sendrpgmessage(str)]]
|
|
|-
| sendtext(str, str, params...)
|
|
|-
| [[Creation/Dev/Output_Methods#sendtorc.28.29|sendtorc(str)]]
|
|
|-
| serverwarp(str)
|
|
|-
| setani(str, str)
|
|
|-
| setbeltcolor(str)
|
|
|-
| setcoatcolor(str)
|
|
|-
| setcontentcontrol(obj)
|
|
|-
| setcursor2(str)
|
|
|-
| seteffect(float, float, float, float)
|
|
|-
| setfocus(float, float)
|
|
|-
| setfogcolors(obj)
|
|
|-
| setgender(str)
|
|
|-
| sethead(str)
|
|
|-
| setinteriorrendermode(int)
|
|
|-
| setletters(str)
|
|
|-
| setmap(str, str, float, float)
|
| sets a text map (you can see the tiles of other levels but not the npcs), parameters are text file with level names, the map image (not used anymore), default x and y for the head icons; use gmaps if possible instead of this
|-
| setminimap(str, str, float, float)
|
| parameters are a text file with level names, the image, default x and y; use gmaps if possible instead of this
|-
| setmusicvolume(float, float)
|
|
|-
| setplayerdir(str)
|
|
|-
| setshield(str, int)
|
|
|-
| setshoecolor(str)
|
|
|-
| setshootparams(str)
|
|
|-
| setskincolor(str)
|
|
|-
| setskybandcolors(obj)
|
|
|-
| setskybandsizes(obj)
|
|
|-
| setsleevecolor(str)
|
|
|-
| setspritesimage(str)
|
|
|-
| setstatusimage(str)
|
|
|-
| setsuncolors(obj)
|
|
|-
| setsword(str, int)
|
|
|-
| setterrainrendermode(int)
|
|
|-
| showstats(int)
|
|
|-
| spyfire(int, int)
|
|
|-
| startrecordvideo()
|
| returns boolean
|-
| stopmidi()
|
| same as stopmusic(), kept for compatibility
|-
| stopmusic()
|
|
|-
| stoprecordvideo()
|
| returns boolean
|-
| stopsound(str)
|
|
|-
| strcmp(str, str)
|
| returns integer
|-
| strequals(str, str)
|
| returns boolean
|-
| switchtoopengl()
|
|
|-
| synctimeofday(float, float)
|
|
|-
| takeplayercarry()
|
|
|-
| takeplayerhorse()
|
|
|-
| testplayer(float, float)
|
| returns integer
|-
| trace(str)
|
| same as echo()
|-
| triggeraction(float, float, str, params...)
|
|
|-
| triggerserver(str, str)
|
|
|-
| update3dterrain(float, float, float, float)
|
|
|-
| updateboard(int, int, int, int)
|
|
|-
| updateterrain()
|
|
|-
| updatevisibledistance()
|
|
|-
| uploadfile(str)
|
| uploads a file, you must provide the full path provided by a onDropFiles() event, also this will only work if the scripted RC has currently a file browser window open; once the file is uploaded an onFilesUploaded event will be invoked
|-
| uppercase(str)
|
| returns string
|-
| [[Vectors#Vector_Addition|vectoradd(str, str)]]
|
| returns string
|-
| [[Cross Product|vectorcross(str, str)]]
|
| returns string
|-
| [[Vectors#Distance_Between_Terminal_Points|vectordist(str, str)]]
|
| returns float
|-
| [[Dot Product|vectordot(str, str)]]
|
| returns float
|-
| [[Vectors#Vector_Length_.28Magnitude.2FModulus.29|vectorlen(str)]]
|
| returns float
|-
| [[Vectors#Unit_Length|vectornormalize(str)]]
|
| returns string
|-
| vectororthobasis(str)
|
| returns string
|-
| [[Vectors#Vector-Scalar_Multiplication|vectorscale(str, float)]]
|
| returns string
|-
| [[Vectors#Vector_Subtraction|vectorsub(str, str)]]
|
| returns string
|-
| worldx(float, float)
|
| returns float
|-
| worldy(float, float)
|
| returns float
|-
| wraptext(int, str, str)
|
| returns object
|-
| wraptext2(int, float, str, str)
|
| returns object
|}
 

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

=GUI Objects=
GUI Objects are currently well documented starting here [[Creation/Dev/Script/Client/GuiControl]].

=Preference Variables=
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| $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::capture::allowbyscript
|
| boolean [R]
|-
| $pref::capture::area
|
| string
|-
| $pref::capture::audiobitrate
|
| integer
|-
| $pref::capture::disabledaynight
|
| boolean
|-
| $pref::capture::format
|
| string
|-
| $pref::capture::fps
|
| integer
|-
| $pref::capture::hideinterface
|
| boolean
|-
| $pref::capture::recordaudio
|
| boolean
|-
| $pref::capture::showmouse
|
| boolean
|-
| $pref::capture::size
|
| string
|-
| $pref::capture::videobitrate
|
| integer
|-
| $pref::graal::allowglobalpms
|
| boolean
|-
| $pref::graal::automapping
|
| boolean
|-
| $pref::graal::defaultfontname
|
| string
|-
| $pref::graal::defaultfontsize
|
| integer
|-
| $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::video::defaultguistyle
|
| string
|-
| $pref::video::detailfactor
|
| float
|-
| $pref::video::fogdistance
|
| float
|-
| $pref::video::fullscreenmode
|
| string
|-
| $pref::video::resolution
|
| integer
|-
| $pref::video::screenshotformat
|
| string
|-
| $pref::video::visibledistance
|
| float
|-
| $pref::video::windowmode
|
| string
|}

Creation/Dev/Script/Clientside Functions

2011-09-20T01:34:06Z

Tolnaftate2004: /* Functions */

[[Category:Scripting Reference]]
{| border="0" cellpadding="2" width="50%"
|[R]
| denotes it is read-only.
|-
|[3D]
| denotes it is a Graal3D function.
|-
|[opengl]
| denotes it is functional only in opengl mode.
|}

==Variables==
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| allfeatures
| ''integer [R]''
|
|-
| allplayerscount
| ''integer [R]''
| Returns the count of all players on your playerlist, including IRC bots.
|-
| allrenderobjecttypes
| ''integer [R]''
|
|-
| allstats
| ''integer [R]''
| Used with showstats() in order to show all stats.
|-
| canspin
| ''boolean [R]''
| Returns true of false if the player has spin attack.
|-
| carriesblackstone
| ''boolean [R]''
| Returns whether the player is carrying a black stone.
|-
| carriesbush
| ''boolean [R]''
| Returns whether the player is carrying a bush.
|-
| carriesnpc
| ''boolean [R]''
| Returns whether the player is carrying an NPC
|-
| carriessign
| ''boolean [R]''
| Returns whether the player is carrying a sign.
|-
| carriesstone
| ''boolean [R]''
| Returns whether the player is carrying a stone.
|-
| carriesvase
| ''boolean [R]''
| Returns whether the player is carrying a vase.
|-
| downloadfile
| ''string [R]''
| Returns the currently downloaded file.
|-
| downloadpos
| ''integer [R]''
| Returns the position of the currently downloaded file.
|-
| downloadsize
| ''integer [R]''
| Returns the size of the currently downloaded file.
|-
| editingmission
| ''boolean''
|
|-
| emoticonchar
| ''string [R]''
|
|-
| focusx
| ''float [R]''
| Position of the camera in tile units.
|-
| focusy
| ''float [R]''
| Position of the camera in tile units.
|-
| ghostsnear
| ''boolean [R]''
| If a ghost(observer) is in the same level as the player.
|-
| graalplugincookie
| ''string [R]''
|
|-
| graalversion
| ''float [R]''
| Version of Graal the player is using.
|-
| gravity
| ''float''
| The gravity value that effects how fast projectiles fall. It universally effects all projectiles.
|-
| installedlanguages
| ''string [R]''
|
|-
| isapplicationactive
| ''boolean [R]''
| Is Graal window active?
|-
| iscarrying
| ''boolean [R]''
| Returns true of false if the player is carrying something.
|-
| isfocused
| ''boolean [R]''
|
|-
| isgraal3d
| ''boolean [R]''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| isleader
| ''boolean [R]''
| Player was the first to enter the level.
|-
| isonmap
| ''boolean [R]''
| Player is on a map.
|-
| isopengl
| ''boolean [R]''
| Graal is in opengl mode.
|-
| isrecordingvideo
| ''boolean [R]''
| Player is currently recording(alt+6) Graal.
|-
| jpegquality
| ''integer''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| lastdownloadfile
| ''string [R]''
| The last file downloaded.
|-
| leftmousebutton
| ''boolean [R]''
| If the left mouse button is pressed.
|-
| leftmousebuttonglobal
| ''boolean [R]''
| If the left mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| levelorgx
| ''float [R]''
|
|-
| levelorgy
| ''float [R]''
|
|-
| lighteffectsenabled
| ''boolean''
| Whether the player has their lights enabled via options.
|-
| middlemousebutton
| ''boolean [R]''
| If the middle mouse button is pressed
|-
| middlemousebuttonglobal
| ''boolean [R]''
| If the middle mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| mousebuttons
| ''integer [R]''
|
|-
| mousebuttonsglobal
| ''integer [R]''
|
|-
| mousepitch
| ''float [R] [3D]''
|
|-
| mousescreenx
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the x-axis.
|-
| mousescreeny
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the y-axis.
|-
| mousewheeldelta
| ''integer [R]''
| How much the mouse wheel has been scrolled.
|-
| mousex
| ''float''
| Position of the mouse in the level, in tile units, on the x-axis.
|-
| mousey
| ''float''
| Position of the mouse in the level, in tile units, on the y-axis
|-
| mouseyaw
| ''float [R] [3D]''
|
|-
| musiclen
| ''integer [R]''
| Length of current playing '''MP3'''
|-
| musicpos
| ''integer [R]''
| Position of current playing '''MP3'''
|-
| particleeffectsenabled
| ''boolean''
| If player has particles enabled in their options.
|-
| rightmousebutton
| ''boolean [R]''
| If the right mouse button is pressed
|-
| rightmousebuttonglobal
| ''boolean [R]''
| If the right mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| screenheight
| ''integer [R]''
| Height of the Graal screen in pixel units.
|-
| screenwidth
| ''integer [R]''
| Width of the Graal screen in pixel units.
|-
| scriptedcontrols
| ''boolean [R]''
|
|-
| scriptedplayerlist
| ''boolean [R]''
| Whether the player has the scripted playerlist enabled.
|-
| scriptlogwritetoreadonly
| ''boolean''
|
|-
| selectedlistplayers
| ''object''
| An object of all players selected on the playerlist.
|-
| selectedsword
| ''integer''
|
|-
| selectedweapon
| ''integer''
| Index of the currently selected weapon.
|-
| servername
| ''string [R]''
| Name of the server.
|-
| serverstartconnect
| ''string''
|
|-
| serverstartparams
| ''string''
|
|-
| shotbybaddy
| ''boolean [R]''
| If the player is shot by a baddy(default) arrow.
|-
| shotbyplayer
| ''boolean [R]''
| If the player is shot by another players arrow.
|-
| showterraingrid
| ''boolean''
|
|-
| spritesimage
| ''string''
| Filename of the currently set sprite image.
|-
| statusimage
| ''string''
| Filename of the currently set state image.
|-
| timevar
| ''integer [R].''
|
|-
| timevar2
| ''float [R]''
|
|-
| timevar3
| ''float [R] [3D]''
| Synchronized time which works on both server and client-side, precision is milliseconds.
|-
| wasshooted
| ''boolean [R]''
| If the player is shot by a default arrow.
|-
| waterheight
| ''float''
|
|-
| weapons
| ''object [R]''
| all the players weapons, this includes login inherited weapons.
|-
| weaponsenabled
| ''boolean''
| If the players weapons are enabled via disableweapons()/enableweapons().
|-
| weathereffectsenabled
| ''boolean''
| If weather is enabled in the players options.
|-
| worldclockstopped
| ''boolean''
|
|-
| worldhour
| ''integer''
|
|-
| worldminute
| ''float''
|
|-
| worldminutesofday
| ''float''
|
|-
| worldrealsecondsperday
| ''float''
|
|-
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Function'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| addcontrol(object)
|
| adds 'object' to the parent control.
|-
| addmaterialmapping(string, string)
| [3D]
| returns boolean.
|-
| addtiledef(string image, string prefix, int format)
|
| Adds a tileset definition with the supplied tileset image, level prefix and tileset format (0=pics1, 1=new world, 5=terrain).
|-
| addtiledef2(string image, string prefix, int x, int y)
|
| Overlays an image on the tileset with the supplied tileset image and level prefix. Parameters 'x' and 'y' represent the x and y position on the tileset of where to place the new image.
|-
| aindexof(float, array)
|
| Returns integer - the position of 'float' in the array.
|-
| arccos(float)
|
| Returns float - the arc cosine of 'float'.
|-
| arcsin(float)
|
| Returns float - the arc sine of 'float'.
|-
| attachplayertoobj(integer1, integer2)
|
| Attaches the player to the object with the matching ID where integer1 is the object type (currently only NPCs - 0) and integer2 is the ID of the desired object.
|-
| base64decode(string)
|
| Returns string - Decodes a base64 string.
|-
| base64encode(string)
|
| Returns string - Encodes string in to several characters of a 64 printable character set (A-Z, a-z, 0-9, + and /, while "=" is a special suffix code)
|-
| boxcontains(string, string)
|
| returns boolean.
|-
| boxcontainsvector(string, string)
|
| returns boolean
|-
| boxintersect(string, string)
|
| returns string
|-
| boxoverlaps(string, string)
|
| returns boolean
|-
| boxscale(string, string)
|
| returns string
|-
| callnpc(int index, string function)
|
| Calls a function from an NPC where 'index' is the NPC's index and 'function' is the function name.
|-
| callweapon(int index, string function)
|
| Calls a function from a weapon where 'index' is the weapon's index and 'function' is the function name.
|-
| castray({x,y,x}, {x,y,z}, string type)
| [3D]
| returns object - specify the start and end of the ray, and the object types (e.g. "staticts,terrain,interior")
|-
| checksum(string)
|
| returns float
|-
| contains(string2, string1)
|
| returns boolean - True if string1 is contained within string2.
|-
| copystrings(string, string)
|
|
|-
| cursoroff()
| [opengl]
| Disables the visible mouse cursor.
|-
| cursoron()
| [opengl]
| Enables the visible mouse cursor.
|-
| degtorad(float)
|
| returns float - Converts angle measurements of degrees to radians
|-
| detachplayer()
|
| Detaches a player from an attached object.
|-
| disabledefmovement()
|
| Disables the default movement system and controls(including weapons, sword, grab. Does not include Q-menu, pause, map...).
|-
| disablemap()
|
| Disables the default map (M).
|-
| disablepause()
|
| Disables the default pause (P).
|-
| disableselectweapons()
|
| Disables the default Q-menu (Q).
|-
| disableweapons()
|
| Disables the default sword (S) and weapons (D).
|-
| [[Creation/Dev/Output_Methods#echo.28.29|echo(string)]]
|
| echos 'string' to the debug window(F2).
|-
| enabledefmovement()
|
| Enables the default movement system.
|-
| [[Creation/Dev/Script/Functions/enablefeatures(int)|enablefeatures(int)]]
|
|
|-
| enablemap()
|
| Enables the default map system(M).
|-
| enablepause()
|
| Enables the default pause system(P).
|-
| enableselectweapons()
|
| Enables the default Q-menu(Q).
|-
| enableweapons()
|
| Enables the default sword(S) and weapons(D).
|-
| escapestring(string)
|
| returns string - adds \\ in front of ", ' and \\, and removes non-printable characters
|-
| explodebomb(integer)
|
| explodes the bomb with the id of 'integer'.
|-
| extractfilebase(string)
|
| returns string
|-
| extractfileext(string)
|
| Takes in a file name, and returns its extension.
|-
| extractfilepath(string)
|
| returns string
|-
| fileexists(string)
|
| returns boolean of whether the file 'str' exists in the players Graal/ directory(does not search subfolders).
|-
| filesize(string)
|
| Returns the size(int) of the file 'string' in the players Graal/ directory(does not search subfolders).
|-
| fileupdate(string)
|
| returns boolean
|-
| findani(string)
|
| returns object
|-
| findfiles(string, integer)
|
| returns object
|-
| findlevel(string)
|
| returns object
|-
| findnearestplayer(float1, float2)
|
| Returns the closest player's object relevant to float1 and float2.
|-
| findnearestplayers(float, float)
|
| Returns the closest players' object relevant to float1 and float2.
|-
| findnpcbyid(integer)
|
| Returns the NPC object with the ID of 'int'.
|-
| findpathinarray(obj1, obj2, obj3, obj4, obj5, int, int, int)
|
| Returns object - Simple path-finding: Obj1 being tiles that allow walking, Obj2 being tiles that don't allow walking, Obj3; tiles that shouldn't be allowed to walked on, Obj4; tiles that are able to be walked on, Obj5; tiles where we may stop. Integers are relevant to the startx, starty and maximum path length. - Arrays for allowed/non-allowed tiles are only checked if they aren't null.
|-
| findplayer(string)
|
| Returns the player object with the account equal to string.
|-
| findplayerbycommunityname(string)
|
| Returns the player object with the community name equal to string.
|-
| findplayerbyid(integer)
|
| Returns the player object with the ID equal to integer.
|-
| findweapon(string)
|
| Returns the weapon object with the name equal to string.
|-
| [[Creation/Dev/Output_Methods#format.28.29_function|format(string, string, ...)]]
|
| See [[Creation/Dev/Output_Methods#format.28.29_function|format()]].
|-
| [[Creation/Dev/Output_Methods#format2.28.29_function|format2(string, array)]]
|
| Like format(), except that this expects the format string and an array of variables instead of passing the variables as separate parameters.
|-
| freefileresources(string)
|
|
|-
| freezeplayer(float)
|
| Freezes the player for the number of seconds specified by float.
|-
| get3dobjectat(float, float, boolean)
| [3D]
| Gets the 3d object at the specified screen position, third parameter true if it should do box collision.
|-
| get3dobjectatmouse(boolean)
| [3D]
| Gets the 3d object at the mouse. Parameter true if it should do box collision.
|-
| get3dobjectbyray(string, string)
| [3D]
| returns object
|-
| get3dobjectsbybox(string, string)
| [3D]
| 1st parameter defines the box {minx,miny,minz, maxx,maxy,maxz}. Second parameter specifies the type of object to find (e.g. "staticts,terrain,interior")
|-
| get3dscreenposition(string, boolean)
| [3D]
| returns string
|-
| getanglesfromvector({x, y, z})
|
| Returns an array that contains the angles the 3D vector {x, y, z} makes with the X-Y and X-Z axes.
|-
| getascii(string)
|
| Returns the [http://www.asciitable.com/ ascii] code for string.
|-
| getbasepackage()
|
| returns object
|-
| getboxcenter(string)
|
| Returns an array containing the center of a 3D box specified by string ({x0,y0,z0,x1,y1,z1,...}).
|-
| getdesktopresolution()
|
| returns string
|-
| getdisplaydevicelist()
|
| returns string
|-
| getdownloadedupdatepackagesize()
|
| Returns the size of the downloaded update package.
|-
| getdownloadingpackage()
|
| Returns a reference to current update package being downloaded.
|-
| getdownloadingpackagescount()
|
| Returns a count of the number of update packages to download.
|-
| getdropz(string)
|
| returns float
|-
| getExtension(string)
|
| This function is the same as extractFileExt(). Takes in a file name, and returns its extension.
|-
| getfilemodtime(string)
|
| Returns a timestamp of when the file was last modified (in unix time compatible to timevar2). This function accepts both exact file path and plain file name.
|-
| gethttprequest(string, integer, string)
|
| returns object (This function is the same as requestHttp())
|-
| getimgheight(string)
|
| Returns the height (in pixels) of the filename indicated by string.
|-
| getimgpixel(string, integer, integer)
|
| returns object
|-
| getimgwidth(string)
|
| Returns the width(in pixels) of the filename indicated by string.
|-
| getkeycode(string)
|
| Returns the keycode of the key indicated by string. The keycode returned can be used in keydown2().
|-
| getloginaccountname()
|
| Presumably used for the login server. Use player.account instead.
|-
| getmapx(string)
|
| Gets the x coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmapy(string)
|
| Gets the y coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmusicfilename()
|
| Returns the filename of the music currently playing.
|-
| getmusicstatus()
|
| Returns the status of the music currently playing.
|-
| getmusictags()
|
| Returns the tags of the music currently playing. This function can be used to retrieve the title and artist info of the music.
|-
| getnearestplayer(float, float)
|
| Deprecated. Use findnearestplayer() instead.
|-
| getnearestplayers(float, float)
|
| Deprecated. Use findnearestplayers() instead.
|-
| getpackagesdownloadcomplete()
|
| Returns 'true' if the package downloads are complete.
|-
| getpackagesdownloaded()
|
| Returns 'true' if the most recent packages are already downloaded.
|-
| getplatform()
|
| Returns the platform that the player is using. (i.e. windows, mac, or linux)
|-
| getresolutionlist(string)
|
| returns string
|-
| getservername()
|
| Returns the name of the server the player is currently connected to.
|-
| getstringkeys(string)
|
| Returns an array of the variables that begins with the supplied string.
|-
| getterraintexture(float, float)
|
| returns string
|-
| getterraintextureindex(float, float)
|
| returns integer
|-
| gettextheight(float zoom, string style, string font)
|
| returns integer - The height in pixels of the text with the given zoom, style and font.
|-
| gettextwidth(float zoom, string style, string font, string text)
|
| returns integer - The width of the text with the given zoom, style, font and text.
|-
| gettileset()
|
| returns string - the current main tileset (pics1.png, picso.png etc.)
|-
| gettilesettype()
|
| returns integer - the current tileset type (pics1.png:0, picso.png:5 etc.)
|-
| gettotalupdatepackagesize()
|
| returns integer - The total size of the update packages.
|-
| getupdatepackage(string name)
|
| returns object - A reference to the update package with the given name.
|-
| getvectorfromangles(float, float)
|
| returns string
|-
| getz(float, float)
|
| returns float
|-
| graalcontrolhasfocus(bool)
|
| returns boolean - Whether or not the graal control has focus. Parameter says if it should also check if the chat bar has the focus
|-
| hideplayer(float time)
|
| Hides player for the specified amount of time.
|-
| hidesword(float time)
|
| Hides the player's sword for the specified amount of time.
|-
| hitnpc(int index, float halfhearts, float fromx, float fromy)
|
| Hit's npc with specified index causing the specified amount of halfhearts in damage. It also knocks back the npc based on the from X and Y coordinate passed to it.
|-
| hitobjects(float power, float x, float y)
|
| Hurts all the npcs with the specified power on the position passed to it.
|-
| hitplayer(int index, float halfhearts, float fromx, float fromy)
|
| Hit's player with specified index causing the specified amount of halfhearts in damage. It also knocks back the player based on the from X and Y coordinate passed to it. Use 0 as the index to hit your own player.
|-
| isadminguild(str guildname)
|
| returns boolean - If the passed guildname is an admin guild or not.
|-
| isclassloaded(str classname)
|
| returns boolean - If the passed classname is loaded for the client.
|-
| iscursoron()
|
| returns boolean - If the cursor is on or not.
|-
| isdevicefullscreenonly(str device)
|
| returns boolean - If the device is full screen only or not.
|-
| isdownloading(str filename)
|
| returns boolean - If a file is currently downloaded or requested from the server.
|-
| isdownloadingfiles()
|
| returns boolean - checks if Graal is currently downloading or requesting files from the server.
|-
| isfullscreenmode()
|
| returns boolean - checks if Graal is currently in fullscreen mode.
|-
| isimgrectangletransparent(str, int, int, int, int)
|
| returns boolean
|-
| ismusicplaying()
|
| returns boolean
|-
| isobject(str)
|
| returns boolean
|-
| issoundplaying(str)
|
| returns boolean
|-
| keydown(int)
|
| returns boolean
|-
| keydown2(int, bool)
|
| returns boolean
|-
| keydown2global(int, bool)
|
| returns boolean
|-
| keydownglobal(int)
|
| returns boolean
|-
| keyname(int)
|
| returns string
|-
| lay2(str, float, float)
|
|
|-
| lightscene()
|
| returns boolean
|-
| loadclass(str)
|
|
|-
| loadmap(str)
|
|
|-
| loadtranslation(str)
|
|
|-
| lowercase(str)
|
| returns string
|-
| ltmfs(bool)
|
|
|-
| ltmmax(float, float)
|
|
|-
| ltmmin(float, float)
|
|
|-
| makescreenshot2(str, int, float, float, float, int, int)
|
|
|-
| matrixcreate(str, str)
|
| returns string
|-
| matrixcreatefromeuler(str)
|
| returns string
|-
| matrixmulpoint(str, str)
|
| returns string
|-
| matrixmultiply(str, str)
|
| returns string
|-
| matrixmulvector(str, str)
|
| returns string
|-
| md5(str)
|
| returns string
|-
| noplayerkilling()
|
|
|-
| onwall(float, float)
|
| returns boolean
|-
| onwall2(float, float, float, float)
|
| returns boolean
|-
| onwater(float, float)
|
| returns boolean
|-
| onwater2(float, float, float, float)
|
| returns boolean
|-
| opengraalurl(str)
|
|
|-
| openurl(str)
|
|
|-
| openurl2(str, int, int)
|
|
|-
| play(str)
|
|
|-
| play2(str, float, float, float)
|
|
|-
| play3d(str, bool, str, str)
|
|
|-
| playlooped(str)
|
|
|-
| playlooped2(str, float, float, float)
|
|
|-
| popdialog()
|
|
|-
| pushdialog(obj)
|
|
|-
| putleaps(int, float, float)
|
|
|-
| radtodeg(float)
|
| returns float
|-
| randomstring(str)
|
| returns string
|-
| removetiledefs(str)
|
|
|-
| replaceani(str, str)
|
|
|-
| requestfiledeletion(str)
|
|
|-
| requestfilerename(str, str)
|
|
|-
| requestfilesmove(str, str)
|
|
|-
| requesthttp(str, int, str)
|
| returns object
|-
| requesttext(str, str)
|
|
|-
| requesturl(str)
|
| returns object
|-
| resetfocus()
|
|
|-
| rotationadd(str, str)
|
| returns string
|-
| rotationaddeuler(str, str)
|
| returns string
|-
| rotationfromeuler(str)
|
| returns string
|-
| rotationsub(str, str)
|
| returns string
|-
| rotationtoeuler(str)
|
| returns string
|-
| rungarbagecollector()
|
|
|-
| savelog(str)
|
|
|-
| say(int)
|
|
|-
| say2(str)
|
|
|-
| screenx(float, float)
|
| returns integer
|-
| screeny(float, float)
|
| returns integer
|-
| selectfilefordownload(str)
|
| opens the select
|-
| selectfileforupload()
|
| opens the select
|-
| sendrpgmessage(str)
|
|
|-
| sendtext(str, str, params...)
|
|
|-
| sendtorc(str)
|
|
|-
| serverwarp(str)
|
|
|-
| setani(str, str)
|
|
|-
| setbeltcolor(str)
|
|
|-
| setcoatcolor(str)
|
|
|-
| setcontentcontrol(obj)
|
|
|-
| setcursor2(str)
|
|
|-
| seteffect(float, float, float, float)
|
|
|-
| setfocus(float, float)
|
|
|-
| setfogcolors(obj)
|
|
|-
| setgender(str)
|
|
|-
| sethead(str)
|
|
|-
| setinteriorrendermode(int)
|
|
|-
| setletters(str)
|
|
|-
| setmap(str, str, float, float)
|
| sets a text map (you can see the tiles of other levels but not the npcs), parameters are text file with level names, the map image (not used anymore), default x and y for the head icons; use gmaps if possible instead of this
|-
| setminimap(str, str, float, float)
|
| parameters are a text file with level names, the image, default x and y; use gmaps if possible instead of this
|-
| setmusicvolume(float, float)
|
|
|-
| setplayerdir(str)
|
|
|-
| setshield(str, int)
|
|
|-
| setshoecolor(str)
|
|
|-
| setshootparams(str)
|
|
|-
| setskincolor(str)
|
|
|-
| setskybandcolors(obj)
|
|
|-
| setskybandsizes(obj)
|
|
|-
| setsleevecolor(str)
|
|
|-
| setspritesimage(str)
|
|
|-
| setstatusimage(str)
|
|
|-
| setsuncolors(obj)
|
|
|-
| setsword(str, int)
|
|
|-
| setterrainrendermode(int)
|
|
|-
| showstats(int)
|
|
|-
| spyfire(int, int)
|
|
|-
| startrecordvideo()
|
| returns boolean
|-
| stopmidi()
|
| same as stopmusic(), kept for compatibility
|-
| stopmusic()
|
|
|-
| stoprecordvideo()
|
| returns boolean
|-
| stopsound(str)
|
|
|-
| strcmp(str, str)
|
| returns integer
|-
| strequals(str, str)
|
| returns boolean
|-
| switchtoopengl()
|
|
|-
| synctimeofday(float, float)
|
|
|-
| takeplayercarry()
|
|
|-
| takeplayerhorse()
|
|
|-
| testplayer(float, float)
|
| returns integer
|-
| trace(str)
|
| same as echo()
|-
| triggeraction(float, float, str, params...)
|
|
|-
| triggerserver(str, str)
|
|
|-
| update3dterrain(float, float, float, float)
|
|
|-
| updateboard(int, int, int, int)
|
|
|-
| updateterrain()
|
|
|-
| updatevisibledistance()
|
|
|-
| uploadfile(str)
|
| uploads a file, you must provide the full path provided by a onDropFiles() event, also this will only work if the scripted RC has currently a file browser window open; once the file is uploaded an onFilesUploaded event will be invoked
|-
| uppercase(str)
|
| returns string
|-
| [[Vectors#Vector_Addition|vectoradd(str, str)]]
|
| returns string
|-
| [[Cross Product|vectorcross(str, str)]]
|
| returns string
|-
| [[Vectors#Distance_Between_Terminal_Points|vectordist(str, str)]]
|
| returns float
|-
| [[Dot Product|vectordot(str, str)]]
|
| returns float
|-
| [[Vectors#Vector_Length_.28Magnitude.2FModulus.29|vectorlen(str)]]
|
| returns float
|-
| [[Vectors#Unit_Length|vectornormalize(str)]]
|
| returns string
|-
| vectororthobasis(str)
|
| returns string
|-
| [[Vectors#Vector-Scalar_Multiplication|vectorscale(str, float)]]
|
| returns string
|-
| [[Vectors#Vector_Subtraction|vectorsub(str, str)]]
|
| returns string
|-
| worldx(float, float)
|
| returns float
|-
| worldy(float, float)
|
| returns float
|-
| wraptext(int, str, str)
|
| returns object
|-
| wraptext2(int, float, str, str)
|
| returns object
|}
 

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

=GUI Objects=
GUI Objects are currently well documented starting here [[Creation/Dev/Script/Client/GuiControl]].

=Preference Variables=
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| $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::capture::allowbyscript
|
| boolean [R]
|-
| $pref::capture::area
|
| string
|-
| $pref::capture::audiobitrate
|
| integer
|-
| $pref::capture::disabledaynight
|
| boolean
|-
| $pref::capture::format
|
| string
|-
| $pref::capture::fps
|
| integer
|-
| $pref::capture::hideinterface
|
| boolean
|-
| $pref::capture::recordaudio
|
| boolean
|-
| $pref::capture::showmouse
|
| boolean
|-
| $pref::capture::size
|
| string
|-
| $pref::capture::videobitrate
|
| integer
|-
| $pref::graal::allowglobalpms
|
| boolean
|-
| $pref::graal::automapping
|
| boolean
|-
| $pref::graal::defaultfontname
|
| string
|-
| $pref::graal::defaultfontsize
|
| integer
|-
| $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::video::defaultguistyle
|
| string
|-
| $pref::video::detailfactor
|
| float
|-
| $pref::video::fogdistance
|
| float
|-
| $pref::video::fullscreenmode
|
| string
|-
| $pref::video::resolution
|
| integer
|-
| $pref::video::screenshotformat
|
| string
|-
| $pref::video::visibledistance
|
| float
|-
| $pref::video::windowmode
|
| string
|}

Vectorlen

2011-09-20T01:30:51Z

Tolnaftate2004: redirect

#REDIRECT [[Vectors#Vector_Length_.28Magnitude.2FModulus.29]]

Vectornormalize

2011-09-20T01:30:10Z

Tolnaftate2004: redirect

#REDIRECT [[Vectors#Unit_Length]]

Vectorscale

2011-09-20T01:28:40Z

Tolnaftate2004: redirect

#REDIRECT[[Vectors#Vector-Scalar_Multiplication]]

Vectordist

2011-09-20T01:26:48Z

Tolnaftate2004: redirect

#REDIRECT [[Vectors#Distance_Between_Terminal_Points]]

Vectorsub

2011-09-20T01:25:48Z

Tolnaftate2004: redirect

#REDIRECT [[Vectors#Vector_Subtraction]]

Vectoradd

2011-09-20T01:24:51Z

Tolnaftate2004: redirect

#REDIRECT [[Vectors#Vector_Addition]]

Vectorcross

2011-09-20T01:22:14Z

Tolnaftate2004: redirect

#REDIRECT [[Cross_Product]]

Vectordot

2011-09-20T01:21:33Z

Tolnaftate2004: redirect

#REDIRECT [[Dot_Product]]

Creation/Dev/Script/Clientside Functions

2011-09-20T01:18:31Z

Tolnaftate2004: /* Functions */ missing ]

[[Category:Scripting Reference]]
{| border="0" cellpadding="2" width="50%"
|[R]
| denotes it is read-only.
|-
|[3D]
| denotes it is a Graal3D function.
|-
|[opengl]
| denotes it is functional only in opengl mode.
|}

==Variables==
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| allfeatures
| ''integer [R]''
|
|-
| allplayerscount
| ''integer [R]''
| Returns the count of all players on your playerlist, including IRC bots.
|-
| allrenderobjecttypes
| ''integer [R]''
|
|-
| allstats
| ''integer [R]''
| Used with showstats() in order to show all stats.
|-
| canspin
| ''boolean [R]''
| Returns true of false if the player has spin attack.
|-
| carriesblackstone
| ''boolean [R]''
| Returns whether the player is carrying a black stone.
|-
| carriesbush
| ''boolean [R]''
| Returns whether the player is carrying a bush.
|-
| carriesnpc
| ''boolean [R]''
| Returns whether the player is carrying an NPC
|-
| carriessign
| ''boolean [R]''
| Returns whether the player is carrying a sign.
|-
| carriesstone
| ''boolean [R]''
| Returns whether the player is carrying a stone.
|-
| carriesvase
| ''boolean [R]''
| Returns whether the player is carrying a vase.
|-
| downloadfile
| ''string [R]''
| Returns the currently downloaded file.
|-
| downloadpos
| ''integer [R]''
| Returns the position of the currently downloaded file.
|-
| downloadsize
| ''integer [R]''
| Returns the size of the currently downloaded file.
|-
| editingmission
| ''boolean''
|
|-
| emoticonchar
| ''string [R]''
|
|-
| focusx
| ''float [R]''
| Position of the camera in tile units.
|-
| focusy
| ''float [R]''
| Position of the camera in tile units.
|-
| ghostsnear
| ''boolean [R]''
| If a ghost(observer) is in the same level as the player.
|-
| graalplugincookie
| ''string [R]''
|
|-
| graalversion
| ''float [R]''
| Version of Graal the player is using.
|-
| gravity
| ''float''
| The gravity value that effects how fast projectiles fall. It universally effects all projectiles.
|-
| installedlanguages
| ''string [R]''
|
|-
| isapplicationactive
| ''boolean [R]''
| Is Graal window active?
|-
| iscarrying
| ''boolean [R]''
| Returns true of false if the player is carrying something.
|-
| isfocused
| ''boolean [R]''
|
|-
| isgraal3d
| ''boolean [R]''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| isleader
| ''boolean [R]''
| Player was the first to enter the level.
|-
| isonmap
| ''boolean [R]''
| Player is on a map.
|-
| isopengl
| ''boolean [R]''
| Graal is in opengl mode.
|-
| isrecordingvideo
| ''boolean [R]''
| Player is currently recording(alt+6) Graal.
|-
| jpegquality
| ''integer''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| lastdownloadfile
| ''string [R]''
| The last file downloaded.
|-
| leftmousebutton
| ''boolean [R]''
| If the left mouse button is pressed.
|-
| leftmousebuttonglobal
| ''boolean [R]''
| If the left mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| levelorgx
| ''float [R]''
|
|-
| levelorgy
| ''float [R]''
|
|-
| lighteffectsenabled
| ''boolean''
| Whether the player has their lights enabled via options.
|-
| middlemousebutton
| ''boolean [R]''
| If the middle mouse button is pressed
|-
| middlemousebuttonglobal
| ''boolean [R]''
| If the middle mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| mousebuttons
| ''integer [R]''
|
|-
| mousebuttonsglobal
| ''integer [R]''
|
|-
| mousepitch
| ''float [R] [3D]''
|
|-
| mousescreenx
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the x-axis.
|-
| mousescreeny
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the y-axis.
|-
| mousewheeldelta
| ''integer [R]''
| How much the mouse wheel has been scrolled.
|-
| mousex
| ''float''
| Position of the mouse in the level, in tile units, on the x-axis.
|-
| mousey
| ''float''
| Position of the mouse in the level, in tile units, on the y-axis
|-
| mouseyaw
| ''float [R] [3D]''
|
|-
| musiclen
| ''integer [R]''
| Length of current playing '''MP3'''
|-
| musicpos
| ''integer [R]''
| Position of current playing '''MP3'''
|-
| particleeffectsenabled
| ''boolean''
| If player has particles enabled in their options.
|-
| rightmousebutton
| ''boolean [R]''
| If the right mouse button is pressed
|-
| rightmousebuttonglobal
| ''boolean [R]''
| If the right mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| screenheight
| ''integer [R]''
| Height of the Graal screen in pixel units.
|-
| screenwidth
| ''integer [R]''
| Width of the Graal screen in pixel units.
|-
| scriptedcontrols
| ''boolean [R]''
|
|-
| scriptedplayerlist
| ''boolean [R]''
| Whether the player has the scripted playerlist enabled.
|-
| scriptlogwritetoreadonly
| ''boolean''
|
|-
| selectedlistplayers
| ''object''
| An object of all players selected on the playerlist.
|-
| selectedsword
| ''integer''
|
|-
| selectedweapon
| ''integer''
| Index of the currently selected weapon.
|-
| servername
| ''string [R]''
| Name of the server.
|-
| serverstartconnect
| ''string''
|
|-
| serverstartparams
| ''string''
|
|-
| shotbybaddy
| ''boolean [R]''
| If the player is shot by a baddy(default) arrow.
|-
| shotbyplayer
| ''boolean [R]''
| If the player is shot by another players arrow.
|-
| showterraingrid
| ''boolean''
|
|-
| spritesimage
| ''string''
| Filename of the currently set sprite image.
|-
| statusimage
| ''string''
| Filename of the currently set state image.
|-
| timevar
| ''integer [R].''
|
|-
| timevar2
| ''float [R]''
|
|-
| timevar3
| ''float [R] [3D]''
| Synchronized time which works on both server and client-side, precision is milliseconds.
|-
| wasshooted
| ''boolean [R]''
| If the player is shot by a default arrow.
|-
| waterheight
| ''float''
|
|-
| weapons
| ''object [R]''
| all the players weapons, this includes login inherited weapons.
|-
| weaponsenabled
| ''boolean''
| If the players weapons are enabled via disableweapons()/enableweapons().
|-
| weathereffectsenabled
| ''boolean''
| If weather is enabled in the players options.
|-
| worldclockstopped
| ''boolean''
|
|-
| worldhour
| ''integer''
|
|-
| worldminute
| ''float''
|
|-
| worldminutesofday
| ''float''
|
|-
| worldrealsecondsperday
| ''float''
|
|-
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Function'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| addcontrol(object)
|
| adds 'object' to the parent control.
|-
| addmaterialmapping(string, string)
| [3D]
| returns boolean.
|-
| addtiledef(string image, string prefix, int format)
|
| Adds a tileset definition with the supplied tileset image, level prefix and tileset format (0=pics1, 1=new world, 5=terrain).
|-
| addtiledef2(string image, string prefix, int x, int y)
|
| Overlays an image on the tileset with the supplied tileset image and level prefix. Parameters 'x' and 'y' represent the x and y position on the tileset of where to place the new image.
|-
| aindexof(float, array)
|
| Returns integer - the position of 'float' in the array.
|-
| arccos(float)
|
| Returns float - the arc cosine of 'float'.
|-
| arcsin(float)
|
| Returns float - the arc sine of 'float'.
|-
| attachplayertoobj(integer1, integer2)
|
| Attaches the player to the object with the matching ID where integer1 is the object type (currently only NPCs - 0) and integer2 is the ID of the desired object.
|-
| base64decode(string)
|
| Returns string - Decodes a base64 string.
|-
| base64encode(string)
|
| Returns string - Encodes string in to several characters of a 64 printable character set (A-Z, a-z, 0-9, + and /, while "=" is a special suffix code)
|-
| boxcontains(string, string)
|
| returns boolean.
|-
| boxcontainsvector(string, string)
|
| returns boolean
|-
| boxintersect(string, string)
|
| returns string
|-
| boxoverlaps(string, string)
|
| returns boolean
|-
| boxscale(string, string)
|
| returns string
|-
| callnpc(int index, string function)
|
| Calls a function from an NPC where 'index' is the NPC's index and 'function' is the function name.
|-
| callweapon(int index, string function)
|
| Calls a function from a weapon where 'index' is the weapon's index and 'function' is the function name.
|-
| castray({x,y,x}, {x,y,z}, string type)
| [3D]
| returns object - specify the start and end of the ray, and the object types (e.g. "staticts,terrain,interior")
|-
| checksum(string)
|
| returns float
|-
| contains(string2, string1)
|
| returns boolean - True if string1 is contained within string2.
|-
| copystrings(string, string)
|
|
|-
| cursoroff()
| [opengl]
| Disables the visible mouse cursor.
|-
| cursoron()
| [opengl]
| Enables the visible mouse cursor.
|-
| degtorad(float)
|
| returns float - Converts angle measurements of degrees to radians
|-
| detachplayer()
|
| Detaches a player from an attached object.
|-
| disabledefmovement()
|
| Disables the default movement system and controls(including weapons, sword, grab. Does not include Q-menu, pause, map...).
|-
| disablemap()
|
| Disables the default map (M).
|-
| disablepause()
|
| Disables the default pause (P).
|-
| disableselectweapons()
|
| Disables the default Q-menu (Q).
|-
| disableweapons()
|
| Disables the default sword (S) and weapons (D).
|-
| echo(string)
|
| echos 'string' to the debug window(F2).
|-
| enabledefmovement()
|
| Enables the default movement system.
|-
| [[Creation/Dev/Script/Functions/enablefeatures(int)|enablefeatures(int)]]
|
|
|-
| enablemap()
|
| Enables the default map system(M).
|-
| enablepause()
|
| Enables the default pause system(P).
|-
| enableselectweapons()
|
| Enables the default Q-menu(Q).
|-
| enableweapons()
|
| Enables the default sword(S) and weapons(D).
|-
| escapestring(string)
|
| returns string - adds \\ in front of ", ' and \\, and removes non-printable characters
|-
| explodebomb(integer)
|
| explodes the bomb with the id of 'integer'.
|-
| extractfilebase(string)
|
| returns string
|-
| extractfileext(string)
|
| Takes in a file name, and returns its extension.
|-
| extractfilepath(string)
|
| returns string
|-
| fileexists(string)
|
| returns boolean of whether the file 'str' exists in the players Graal/ directory(does not search subfolders).
|-
| filesize(string)
|
| Returns the size(int) of the file 'string' in the players Graal/ directory(does not search subfolders).
|-
| fileupdate(string)
|
| returns boolean
|-
| findani(string)
|
| returns object
|-
| findfiles(string, integer)
|
| returns object
|-
| findlevel(string)
|
| returns object
|-
| findnearestplayer(float1, float2)
|
| Returns the closest player's object relevant to float1 and float2.
|-
| findnearestplayers(float, float)
|
| Returns the closest players' object relevant to float1 and float2.
|-
| findnpcbyid(integer)
|
| Returns the NPC object with the ID of 'int'.
|-
| findpathinarray(obj1, obj2, obj3, obj4, obj5, int, int, int)
|
| Returns object - Simple path-finding: Obj1 being tiles that allow walking, Obj2 being tiles that don't allow walking, Obj3; tiles that shouldn't be allowed to walked on, Obj4; tiles that are able to be walked on, Obj5; tiles where we may stop. Integers are relevant to the startx, starty and maximum path length. - Arrays for allowed/non-allowed tiles are only checked if they aren't null.
|-
| findplayer(string)
|
| Returns the player object with the account equal to string.
|-
| findplayerbycommunityname(string)
|
| Returns the player object with the community name equal to string.
|-
| findplayerbyid(integer)
|
| Returns the player object with the ID equal to integer.
|-
| findweapon(string)
|
| Returns the weapon object with the name equal to string.
|-
| [[Creation/Dev/Output_Methods#format.28.29_function|format(string, string, ...)]]
|
| See [[Creation/Dev/Output_Methods#format.28.29_function|format()]].
|-
| [[Creation/Dev/Output_Methods#format2.28.29_function|format2(string, array)]]
|
| Like format(), except that this expects the format string and an array of variables instead of passing the variables as separate parameters.
|-
| freefileresources(string)
|
|
|-
| freezeplayer(float)
|
| Freezes the player for the number of seconds specified by float.
|-
| get3dobjectat(float, float, boolean)
| [3D]
| Gets the 3d object at the specified screen position, third parameter true if it should do box collision.
|-
| get3dobjectatmouse(boolean)
| [3D]
| Gets the 3d object at the mouse. Parameter true if it should do box collision.
|-
| get3dobjectbyray(string, string)
| [3D]
| returns object
|-
| get3dobjectsbybox(string, string)
| [3D]
| 1st parameter defines the box {minx,miny,minz, maxx,maxy,maxz}. Second parameter specifies the type of object to find (e.g. "staticts,terrain,interior")
|-
| get3dscreenposition(string, boolean)
| [3D]
| returns string
|-
| getanglesfromvector({x, y, z})
|
| Returns an array that contains the angles the 3D vector {x, y, z} makes with the X-Y and X-Z axes.
|-
| getascii(string)
|
| Returns the [http://www.asciitable.com/ ascii] code for string.
|-
| getbasepackage()
|
| returns object
|-
| getboxcenter(string)
|
| Returns an array containing the center of a 3D box specified by string ({x0,y0,z0,x1,y1,z1,...}).
|-
| getdesktopresolution()
|
| returns string
|-
| getdisplaydevicelist()
|
| returns string
|-
| getdownloadedupdatepackagesize()
|
| Returns the size of the downloaded update package.
|-
| getdownloadingpackage()
|
| Returns a reference to current update package being downloaded.
|-
| getdownloadingpackagescount()
|
| Returns a count of the number of update packages to download.
|-
| getdropz(string)
|
| returns float
|-
| getExtension(string)
|
| This function is the same as extractFileExt(). Takes in a file name, and returns its extension.
|-
| getfilemodtime(string)
|
| Returns a timestamp of when the file was last modified (in unix time compatible to timevar2). This function accepts both exact file path and plain file name.
|-
| gethttprequest(string, integer, string)
|
| returns object (This function is the same as requestHttp())
|-
| getimgheight(string)
|
| Returns the height (in pixels) of the filename indicated by string.
|-
| getimgpixel(string, integer, integer)
|
| returns object
|-
| getimgwidth(string)
|
| Returns the width(in pixels) of the filename indicated by string.
|-
| getkeycode(string)
|
| Returns the keycode of the key indicated by string. The keycode returned can be used in keydown2().
|-
| getloginaccountname()
|
| Presumably used for the login server. Use player.account instead.
|-
| getmapx(string)
|
| Gets the x coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmapy(string)
|
| Gets the y coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmusicfilename()
|
| Returns the filename of the music currently playing.
|-
| getmusicstatus()
|
| Returns the status of the music currently playing.
|-
| getmusictags()
|
| Returns the tags of the music currently playing. This function can be used to retrieve the title and artist info of the music.
|-
| getnearestplayer(float, float)
|
| Deprecated. Use findnearestplayer() instead.
|-
| getnearestplayers(float, float)
|
| Deprecated. Use findnearestplayers() instead.
|-
| getpackagesdownloadcomplete()
|
| Returns 'true' if the package downloads are complete.
|-
| getpackagesdownloaded()
|
| Returns 'true' if the most recent packages are already downloaded.
|-
| getplatform()
|
| Returns the platform that the player is using. (i.e. windows, mac, or linux)
|-
| getresolutionlist(string)
|
| returns string
|-
| getservername()
|
| Returns the name of the server the player is currently connected to.
|-
| getstringkeys(string)
|
| Returns an array of the variables that begins with the supplied string.
|-
| getterraintexture(float, float)
|
| returns string
|-
| getterraintextureindex(float, float)
|
| returns integer
|-
| gettextheight(float zoom, string style, string font)
|
| returns integer - The height in pixels of the text with the given zoom, style and font.
|-
| gettextwidth(float zoom, string style, string font, string text)
|
| returns integer - The width of the text with the given zoom, style, font and text.
|-
| gettileset()
|
| returns string - the current main tileset (pics1.png, picso.png etc.)
|-
| gettilesettype()
|
| returns integer - the current tileset type (pics1.png:0, picso.png:5 etc.)
|-
| gettotalupdatepackagesize()
|
| returns integer - The total size of the update packages.
|-
| getupdatepackage(string name)
|
| returns object - A reference to the update package with the given name.
|-
| getvectorfromangles(float, float)
|
| returns string
|-
| getz(float, float)
|
| returns float
|-
| graalcontrolhasfocus(bool)
|
| returns boolean - Whether or not the graal control has focus. Parameter says if it should also check if the chat bar has the focus
|-
| hideplayer(float time)
|
| Hides player for the specified amount of time.
|-
| hidesword(float time)
|
| Hides the player's sword for the specified amount of time.
|-
| hitnpc(int index, float halfhearts, float fromx, float fromy)
|
| Hit's npc with specified index causing the specified amount of halfhearts in damage. It also knocks back the npc based on the from X and Y coordinate passed to it.
|-
| hitobjects(float power, float x, float y)
|
| Hurts all the npcs with the specified power on the position passed to it.
|-
| hitplayer(int index, float halfhearts, float fromx, float fromy)
|
| Hit's player with specified index causing the specified amount of halfhearts in damage. It also knocks back the player based on the from X and Y coordinate passed to it. Use 0 as the index to hit your own player.
|-
| isadminguild(str guildname)
|
| returns boolean - If the passed guildname is an admin guild or not.
|-
| isclassloaded(str classname)
|
| returns boolean - If the passed classname is loaded for the client.
|-
| iscursoron()
|
| returns boolean - If the cursor is on or not.
|-
| isdevicefullscreenonly(str device)
|
| returns boolean - If the device is full screen only or not.
|-
| isdownloading(str filename)
|
| returns boolean - If a file is currently downloaded or requested from the server.
|-
| isdownloadingfiles()
|
| returns boolean - checks if Graal is currently downloading or requesting files from the server.
|-
| isfullscreenmode()
|
| returns boolean - checks if Graal is currently in fullscreen mode.
|-
| isimgrectangletransparent(str, int, int, int, int)
|
| returns boolean
|-
| ismusicplaying()
|
| returns boolean
|-
| isobject(str)
|
| returns boolean
|-
| issoundplaying(str)
|
| returns boolean
|-
| keydown(int)
|
| returns boolean
|-
| keydown2(int, bool)
|
| returns boolean
|-
| keydown2global(int, bool)
|
| returns boolean
|-
| keydownglobal(int)
|
| returns boolean
|-
| keyname(int)
|
| returns string
|-
| lay2(str, float, float)
|
|
|-
| lightscene()
|
| returns boolean
|-
| loadclass(str)
|
|
|-
| loadmap(str)
|
|
|-
| loadtranslation(str)
|
|
|-
| lowercase(str)
|
| returns string
|-
| ltmfs(bool)
|
|
|-
| ltmmax(float, float)
|
|
|-
| ltmmin(float, float)
|
|
|-
| makescreenshot2(str, int, float, float, float, int, int)
|
|
|-
| matrixcreate(str, str)
|
| returns string
|-
| matrixcreatefromeuler(str)
|
| returns string
|-
| matrixmulpoint(str, str)
|
| returns string
|-
| matrixmultiply(str, str)
|
| returns string
|-
| matrixmulvector(str, str)
|
| returns string
|-
| md5(str)
|
| returns string
|-
| noplayerkilling()
|
|
|-
| onwall(float, float)
|
| returns boolean
|-
| onwall2(float, float, float, float)
|
| returns boolean
|-
| onwater(float, float)
|
| returns boolean
|-
| onwater2(float, float, float, float)
|
| returns boolean
|-
| opengraalurl(str)
|
|
|-
| openurl(str)
|
|
|-
| openurl2(str, int, int)
|
|
|-
| play(str)
|
|
|-
| play2(str, float, float, float)
|
|
|-
| play3d(str, bool, str, str)
|
|
|-
| playlooped(str)
|
|
|-
| playlooped2(str, float, float, float)
|
|
|-
| popdialog()
|
|
|-
| pushdialog(obj)
|
|
|-
| putleaps(int, float, float)
|
|
|-
| radtodeg(float)
|
| returns float
|-
| randomstring(str)
|
| returns string
|-
| removetiledefs(str)
|
|
|-
| replaceani(str, str)
|
|
|-
| requestfiledeletion(str)
|
|
|-
| requestfilerename(str, str)
|
|
|-
| requestfilesmove(str, str)
|
|
|-
| requesthttp(str, int, str)
|
| returns object
|-
| requesttext(str, str)
|
|
|-
| requesturl(str)
|
| returns object
|-
| resetfocus()
|
|
|-
| rotationadd(str, str)
|
| returns string
|-
| rotationaddeuler(str, str)
|
| returns string
|-
| rotationfromeuler(str)
|
| returns string
|-
| rotationsub(str, str)
|
| returns string
|-
| rotationtoeuler(str)
|
| returns string
|-
| rungarbagecollector()
|
|
|-
| savelog(str)
|
|
|-
| say(int)
|
|
|-
| say2(str)
|
|
|-
| screenx(float, float)
|
| returns integer
|-
| screeny(float, float)
|
| returns integer
|-
| selectfilefordownload(str)
|
| opens the select
|-
| selectfileforupload()
|
| opens the select
|-
| sendrpgmessage(str)
|
|
|-
| sendtext(str, str, params...)
|
|
|-
| sendtorc(str)
|
|
|-
| serverwarp(str)
|
|
|-
| setani(str, str)
|
|
|-
| setbeltcolor(str)
|
|
|-
| setcoatcolor(str)
|
|
|-
| setcontentcontrol(obj)
|
|
|-
| setcursor2(str)
|
|
|-
| seteffect(float, float, float, float)
|
|
|-
| setfocus(float, float)
|
|
|-
| setfogcolors(obj)
|
|
|-
| setgender(str)
|
|
|-
| sethead(str)
|
|
|-
| setinteriorrendermode(int)
|
|
|-
| setletters(str)
|
|
|-
| setmap(str, str, float, float)
|
| sets a text map (you can see the tiles of other levels but not the npcs), parameters are text file with level names, the map image (not used anymore), default x and y for the head icons; use gmaps if possible instead of this
|-
| setminimap(str, str, float, float)
|
| parameters are a text file with level names, the image, default x and y; use gmaps if possible instead of this
|-
| setmusicvolume(float, float)
|
|
|-
| setplayerdir(str)
|
|
|-
| setshield(str, int)
|
|
|-
| setshoecolor(str)
|
|
|-
| setshootparams(str)
|
|
|-
| setskincolor(str)
|
|
|-
| setskybandcolors(obj)
|
|
|-
| setskybandsizes(obj)
|
|
|-
| setsleevecolor(str)
|
|
|-
| setspritesimage(str)
|
|
|-
| setstatusimage(str)
|
|
|-
| setsuncolors(obj)
|
|
|-
| setsword(str, int)
|
|
|-
| setterrainrendermode(int)
|
|
|-
| showstats(int)
|
|
|-
| spyfire(int, int)
|
|
|-
| startrecordvideo()
|
| returns boolean
|-
| stopmidi()
|
| same as stopmusic(), kept for compatibility
|-
| stopmusic()
|
|
|-
| stoprecordvideo()
|
| returns boolean
|-
| stopsound(str)
|
|
|-
| strcmp(str, str)
|
| returns integer
|-
| strequals(str, str)
|
| returns boolean
|-
| switchtoopengl()
|
|
|-
| synctimeofday(float, float)
|
|
|-
| takeplayercarry()
|
|
|-
| takeplayerhorse()
|
|
|-
| testplayer(float, float)
|
| returns integer
|-
| trace(str)
|
| same as echo()
|-
| triggeraction(float, float, str, params...)
|
|
|-
| triggerserver(str, str)
|
|
|-
| update3dterrain(float, float, float, float)
|
|
|-
| updateboard(int, int, int, int)
|
|
|-
| updateterrain()
|
|
|-
| updatevisibledistance()
|
|
|-
| uploadfile(str)
|
| uploads a file, you must provide the full path provided by a onDropFiles() event, also this will only work if the scripted RC has currently a file browser window open; once the file is uploaded an onFilesUploaded event will be invoked
|-
| uppercase(str)
|
| returns string
|-
| [[Vectors#Vector_Addition|vectoradd(str, str)]]
|
| returns string
|-
| [[Cross Product|vectorcross(str, str)]]
|
| returns string
|-
| [[Vectors#Distance_Between_Terminal_Points|vectordist(str, str)]]
|
| returns float
|-
| [[Dot Product|vectordot(str, str)]]
|
| returns float
|-
| [[Vectors#Vector_Length_.28Magnitude.2FModulus.29|vectorlen(str)]]
|
| returns float
|-
| [[Vectors#Unit_Length|vectornormalize(str)]]
|
| returns string
|-
| vectororthobasis(str)
|
| returns string
|-
| [[Vectors#Vector-Scalar_Multiplication|vectorscale(str, float)]]
|
| returns string
|-
| [[Vectors#Vector_Subtraction|vectorsub(str, str)]]
|
| returns string
|-
| worldx(float, float)
|
| returns float
|-
| worldy(float, float)
|
| returns float
|-
| wraptext(int, str, str)
|
| returns object
|-
| wraptext2(int, float, str, str)
|
| returns object
|}
 

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

=GUI Objects=
GUI Objects are currently well documented starting here [[Creation/Dev/Script/Client/GuiControl]].

=Preference Variables=
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| $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::capture::allowbyscript
|
| boolean [R]
|-
| $pref::capture::area
|
| string
|-
| $pref::capture::audiobitrate
|
| integer
|-
| $pref::capture::disabledaynight
|
| boolean
|-
| $pref::capture::format
|
| string
|-
| $pref::capture::fps
|
| integer
|-
| $pref::capture::hideinterface
|
| boolean
|-
| $pref::capture::recordaudio
|
| boolean
|-
| $pref::capture::showmouse
|
| boolean
|-
| $pref::capture::size
|
| string
|-
| $pref::capture::videobitrate
|
| integer
|-
| $pref::graal::allowglobalpms
|
| boolean
|-
| $pref::graal::automapping
|
| boolean
|-
| $pref::graal::defaultfontname
|
| string
|-
| $pref::graal::defaultfontsize
|
| integer
|-
| $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::video::defaultguistyle
|
| string
|-
| $pref::video::detailfactor
|
| float
|-
| $pref::video::fogdistance
|
| float
|-
| $pref::video::fullscreenmode
|
| string
|-
| $pref::video::resolution
|
| integer
|-
| $pref::video::screenshotformat
|
| string
|-
| $pref::video::visibledistance
|
| float
|-
| $pref::video::windowmode
|
| string
|}

Creation/Dev/Script/Clientside Functions

2011-09-20T01:17:59Z

Tolnaftate2004: /* Functions */ links

[[Category:Scripting Reference]]
{| border="0" cellpadding="2" width="50%"
|[R]
| denotes it is read-only.
|-
|[3D]
| denotes it is a Graal3D function.
|-
|[opengl]
| denotes it is functional only in opengl mode.
|}

==Variables==
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| allfeatures
| ''integer [R]''
|
|-
| allplayerscount
| ''integer [R]''
| Returns the count of all players on your playerlist, including IRC bots.
|-
| allrenderobjecttypes
| ''integer [R]''
|
|-
| allstats
| ''integer [R]''
| Used with showstats() in order to show all stats.
|-
| canspin
| ''boolean [R]''
| Returns true of false if the player has spin attack.
|-
| carriesblackstone
| ''boolean [R]''
| Returns whether the player is carrying a black stone.
|-
| carriesbush
| ''boolean [R]''
| Returns whether the player is carrying a bush.
|-
| carriesnpc
| ''boolean [R]''
| Returns whether the player is carrying an NPC
|-
| carriessign
| ''boolean [R]''
| Returns whether the player is carrying a sign.
|-
| carriesstone
| ''boolean [R]''
| Returns whether the player is carrying a stone.
|-
| carriesvase
| ''boolean [R]''
| Returns whether the player is carrying a vase.
|-
| downloadfile
| ''string [R]''
| Returns the currently downloaded file.
|-
| downloadpos
| ''integer [R]''
| Returns the position of the currently downloaded file.
|-
| downloadsize
| ''integer [R]''
| Returns the size of the currently downloaded file.
|-
| editingmission
| ''boolean''
|
|-
| emoticonchar
| ''string [R]''
|
|-
| focusx
| ''float [R]''
| Position of the camera in tile units.
|-
| focusy
| ''float [R]''
| Position of the camera in tile units.
|-
| ghostsnear
| ''boolean [R]''
| If a ghost(observer) is in the same level as the player.
|-
| graalplugincookie
| ''string [R]''
|
|-
| graalversion
| ''float [R]''
| Version of Graal the player is using.
|-
| gravity
| ''float''
| The gravity value that effects how fast projectiles fall. It universally effects all projectiles.
|-
| installedlanguages
| ''string [R]''
|
|-
| isapplicationactive
| ''boolean [R]''
| Is Graal window active?
|-
| iscarrying
| ''boolean [R]''
| Returns true of false if the player is carrying something.
|-
| isfocused
| ''boolean [R]''
|
|-
| isgraal3d
| ''boolean [R]''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| isleader
| ''boolean [R]''
| Player was the first to enter the level.
|-
| isonmap
| ''boolean [R]''
| Player is on a map.
|-
| isopengl
| ''boolean [R]''
| Graal is in opengl mode.
|-
| isrecordingvideo
| ''boolean [R]''
| Player is currently recording(alt+6) Graal.
|-
| jpegquality
| ''integer''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| lastdownloadfile
| ''string [R]''
| The last file downloaded.
|-
| leftmousebutton
| ''boolean [R]''
| If the left mouse button is pressed.
|-
| leftmousebuttonglobal
| ''boolean [R]''
| If the left mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| levelorgx
| ''float [R]''
|
|-
| levelorgy
| ''float [R]''
|
|-
| lighteffectsenabled
| ''boolean''
| Whether the player has their lights enabled via options.
|-
| middlemousebutton
| ''boolean [R]''
| If the middle mouse button is pressed
|-
| middlemousebuttonglobal
| ''boolean [R]''
| If the middle mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| mousebuttons
| ''integer [R]''
|
|-
| mousebuttonsglobal
| ''integer [R]''
|
|-
| mousepitch
| ''float [R] [3D]''
|
|-
| mousescreenx
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the x-axis.
|-
| mousescreeny
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the y-axis.
|-
| mousewheeldelta
| ''integer [R]''
| How much the mouse wheel has been scrolled.
|-
| mousex
| ''float''
| Position of the mouse in the level, in tile units, on the x-axis.
|-
| mousey
| ''float''
| Position of the mouse in the level, in tile units, on the y-axis
|-
| mouseyaw
| ''float [R] [3D]''
|
|-
| musiclen
| ''integer [R]''
| Length of current playing '''MP3'''
|-
| musicpos
| ''integer [R]''
| Position of current playing '''MP3'''
|-
| particleeffectsenabled
| ''boolean''
| If player has particles enabled in their options.
|-
| rightmousebutton
| ''boolean [R]''
| If the right mouse button is pressed
|-
| rightmousebuttonglobal
| ''boolean [R]''
| If the right mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| screenheight
| ''integer [R]''
| Height of the Graal screen in pixel units.
|-
| screenwidth
| ''integer [R]''
| Width of the Graal screen in pixel units.
|-
| scriptedcontrols
| ''boolean [R]''
|
|-
| scriptedplayerlist
| ''boolean [R]''
| Whether the player has the scripted playerlist enabled.
|-
| scriptlogwritetoreadonly
| ''boolean''
|
|-
| selectedlistplayers
| ''object''
| An object of all players selected on the playerlist.
|-
| selectedsword
| ''integer''
|
|-
| selectedweapon
| ''integer''
| Index of the currently selected weapon.
|-
| servername
| ''string [R]''
| Name of the server.
|-
| serverstartconnect
| ''string''
|
|-
| serverstartparams
| ''string''
|
|-
| shotbybaddy
| ''boolean [R]''
| If the player is shot by a baddy(default) arrow.
|-
| shotbyplayer
| ''boolean [R]''
| If the player is shot by another players arrow.
|-
| showterraingrid
| ''boolean''
|
|-
| spritesimage
| ''string''
| Filename of the currently set sprite image.
|-
| statusimage
| ''string''
| Filename of the currently set state image.
|-
| timevar
| ''integer [R].''
|
|-
| timevar2
| ''float [R]''
|
|-
| timevar3
| ''float [R] [3D]''
| Synchronized time which works on both server and client-side, precision is milliseconds.
|-
| wasshooted
| ''boolean [R]''
| If the player is shot by a default arrow.
|-
| waterheight
| ''float''
|
|-
| weapons
| ''object [R]''
| all the players weapons, this includes login inherited weapons.
|-
| weaponsenabled
| ''boolean''
| If the players weapons are enabled via disableweapons()/enableweapons().
|-
| weathereffectsenabled
| ''boolean''
| If weather is enabled in the players options.
|-
| worldclockstopped
| ''boolean''
|
|-
| worldhour
| ''integer''
|
|-
| worldminute
| ''float''
|
|-
| worldminutesofday
| ''float''
|
|-
| worldrealsecondsperday
| ''float''
|
|-
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Function'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| addcontrol(object)
|
| adds 'object' to the parent control.
|-
| addmaterialmapping(string, string)
| [3D]
| returns boolean.
|-
| addtiledef(string image, string prefix, int format)
|
| Adds a tileset definition with the supplied tileset image, level prefix and tileset format (0=pics1, 1=new world, 5=terrain).
|-
| addtiledef2(string image, string prefix, int x, int y)
|
| Overlays an image on the tileset with the supplied tileset image and level prefix. Parameters 'x' and 'y' represent the x and y position on the tileset of where to place the new image.
|-
| aindexof(float, array)
|
| Returns integer - the position of 'float' in the array.
|-
| arccos(float)
|
| Returns float - the arc cosine of 'float'.
|-
| arcsin(float)
|
| Returns float - the arc sine of 'float'.
|-
| attachplayertoobj(integer1, integer2)
|
| Attaches the player to the object with the matching ID where integer1 is the object type (currently only NPCs - 0) and integer2 is the ID of the desired object.
|-
| base64decode(string)
|
| Returns string - Decodes a base64 string.
|-
| base64encode(string)
|
| Returns string - Encodes string in to several characters of a 64 printable character set (A-Z, a-z, 0-9, + and /, while "=" is a special suffix code)
|-
| boxcontains(string, string)
|
| returns boolean.
|-
| boxcontainsvector(string, string)
|
| returns boolean
|-
| boxintersect(string, string)
|
| returns string
|-
| boxoverlaps(string, string)
|
| returns boolean
|-
| boxscale(string, string)
|
| returns string
|-
| callnpc(int index, string function)
|
| Calls a function from an NPC where 'index' is the NPC's index and 'function' is the function name.
|-
| callweapon(int index, string function)
|
| Calls a function from a weapon where 'index' is the weapon's index and 'function' is the function name.
|-
| castray({x,y,x}, {x,y,z}, string type)
| [3D]
| returns object - specify the start and end of the ray, and the object types (e.g. "staticts,terrain,interior")
|-
| checksum(string)
|
| returns float
|-
| contains(string2, string1)
|
| returns boolean - True if string1 is contained within string2.
|-
| copystrings(string, string)
|
|
|-
| cursoroff()
| [opengl]
| Disables the visible mouse cursor.
|-
| cursoron()
| [opengl]
| Enables the visible mouse cursor.
|-
| degtorad(float)
|
| returns float - Converts angle measurements of degrees to radians
|-
| detachplayer()
|
| Detaches a player from an attached object.
|-
| disabledefmovement()
|
| Disables the default movement system and controls(including weapons, sword, grab. Does not include Q-menu, pause, map...).
|-
| disablemap()
|
| Disables the default map (M).
|-
| disablepause()
|
| Disables the default pause (P).
|-
| disableselectweapons()
|
| Disables the default Q-menu (Q).
|-
| disableweapons()
|
| Disables the default sword (S) and weapons (D).
|-
| echo(string)
|
| echos 'string' to the debug window(F2).
|-
| enabledefmovement()
|
| Enables the default movement system.
|-
| [[Creation/Dev/Script/Functions/enablefeatures(int)|enablefeatures(int)]]
|
|
|-
| enablemap()
|
| Enables the default map system(M).
|-
| enablepause()
|
| Enables the default pause system(P).
|-
| enableselectweapons()
|
| Enables the default Q-menu(Q).
|-
| enableweapons()
|
| Enables the default sword(S) and weapons(D).
|-
| escapestring(string)
|
| returns string - adds \\ in front of ", ' and \\, and removes non-printable characters
|-
| explodebomb(integer)
|
| explodes the bomb with the id of 'integer'.
|-
| extractfilebase(string)
|
| returns string
|-
| extractfileext(string)
|
| Takes in a file name, and returns its extension.
|-
| extractfilepath(string)
|
| returns string
|-
| fileexists(string)
|
| returns boolean of whether the file 'str' exists in the players Graal/ directory(does not search subfolders).
|-
| filesize(string)
|
| Returns the size(int) of the file 'string' in the players Graal/ directory(does not search subfolders).
|-
| fileupdate(string)
|
| returns boolean
|-
| findani(string)
|
| returns object
|-
| findfiles(string, integer)
|
| returns object
|-
| findlevel(string)
|
| returns object
|-
| findnearestplayer(float1, float2)
|
| Returns the closest player's object relevant to float1 and float2.
|-
| findnearestplayers(float, float)
|
| Returns the closest players' object relevant to float1 and float2.
|-
| findnpcbyid(integer)
|
| Returns the NPC object with the ID of 'int'.
|-
| findpathinarray(obj1, obj2, obj3, obj4, obj5, int, int, int)
|
| Returns object - Simple path-finding: Obj1 being tiles that allow walking, Obj2 being tiles that don't allow walking, Obj3; tiles that shouldn't be allowed to walked on, Obj4; tiles that are able to be walked on, Obj5; tiles where we may stop. Integers are relevant to the startx, starty and maximum path length. - Arrays for allowed/non-allowed tiles are only checked if they aren't null.
|-
| findplayer(string)
|
| Returns the player object with the account equal to string.
|-
| findplayerbycommunityname(string)
|
| Returns the player object with the community name equal to string.
|-
| findplayerbyid(integer)
|
| Returns the player object with the ID equal to integer.
|-
| findweapon(string)
|
| Returns the weapon object with the name equal to string.
|-
| [[Creation/Dev/Output_Methods#format.28.29_function|format(string, string, ...)]]
|
| See [[Creation/Dev/Output_Methods#format.28.29_function|format()]].
|-
| [[Creation/Dev/Output_Methods#format2.28.29_function|format2(string, array)]]
|
| Like format(), except that this expects the format string and an array of variables instead of passing the variables as separate parameters.
|-
| freefileresources(string)
|
|
|-
| freezeplayer(float)
|
| Freezes the player for the number of seconds specified by float.
|-
| get3dobjectat(float, float, boolean)
| [3D]
| Gets the 3d object at the specified screen position, third parameter true if it should do box collision.
|-
| get3dobjectatmouse(boolean)
| [3D]
| Gets the 3d object at the mouse. Parameter true if it should do box collision.
|-
| get3dobjectbyray(string, string)
| [3D]
| returns object
|-
| get3dobjectsbybox(string, string)
| [3D]
| 1st parameter defines the box {minx,miny,minz, maxx,maxy,maxz}. Second parameter specifies the type of object to find (e.g. "staticts,terrain,interior")
|-
| get3dscreenposition(string, boolean)
| [3D]
| returns string
|-
| getanglesfromvector({x, y, z})
|
| Returns an array that contains the angles the 3D vector {x, y, z} makes with the X-Y and X-Z axes.
|-
| getascii(string)
|
| Returns the [http://www.asciitable.com/ ascii] code for string.
|-
| getbasepackage()
|
| returns object
|-
| getboxcenter(string)
|
| Returns an array containing the center of a 3D box specified by string ({x0,y0,z0,x1,y1,z1,...}).
|-
| getdesktopresolution()
|
| returns string
|-
| getdisplaydevicelist()
|
| returns string
|-
| getdownloadedupdatepackagesize()
|
| Returns the size of the downloaded update package.
|-
| getdownloadingpackage()
|
| Returns a reference to current update package being downloaded.
|-
| getdownloadingpackagescount()
|
| Returns a count of the number of update packages to download.
|-
| getdropz(string)
|
| returns float
|-
| getExtension(string)
|
| This function is the same as extractFileExt(). Takes in a file name, and returns its extension.
|-
| getfilemodtime(string)
|
| Returns a timestamp of when the file was last modified (in unix time compatible to timevar2). This function accepts both exact file path and plain file name.
|-
| gethttprequest(string, integer, string)
|
| returns object (This function is the same as requestHttp())
|-
| getimgheight(string)
|
| Returns the height (in pixels) of the filename indicated by string.
|-
| getimgpixel(string, integer, integer)
|
| returns object
|-
| getimgwidth(string)
|
| Returns the width(in pixels) of the filename indicated by string.
|-
| getkeycode(string)
|
| Returns the keycode of the key indicated by string. The keycode returned can be used in keydown2().
|-
| getloginaccountname()
|
| Presumably used for the login server. Use player.account instead.
|-
| getmapx(string)
|
| Gets the x coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmapy(string)
|
| Gets the y coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmusicfilename()
|
| Returns the filename of the music currently playing.
|-
| getmusicstatus()
|
| Returns the status of the music currently playing.
|-
| getmusictags()
|
| Returns the tags of the music currently playing. This function can be used to retrieve the title and artist info of the music.
|-
| getnearestplayer(float, float)
|
| Deprecated. Use findnearestplayer() instead.
|-
| getnearestplayers(float, float)
|
| Deprecated. Use findnearestplayers() instead.
|-
| getpackagesdownloadcomplete()
|
| Returns 'true' if the package downloads are complete.
|-
| getpackagesdownloaded()
|
| Returns 'true' if the most recent packages are already downloaded.
|-
| getplatform()
|
| Returns the platform that the player is using. (i.e. windows, mac, or linux)
|-
| getresolutionlist(string)
|
| returns string
|-
| getservername()
|
| Returns the name of the server the player is currently connected to.
|-
| getstringkeys(string)
|
| Returns an array of the variables that begins with the supplied string.
|-
| getterraintexture(float, float)
|
| returns string
|-
| getterraintextureindex(float, float)
|
| returns integer
|-
| gettextheight(float zoom, string style, string font)
|
| returns integer - The height in pixels of the text with the given zoom, style and font.
|-
| gettextwidth(float zoom, string style, string font, string text)
|
| returns integer - The width of the text with the given zoom, style, font and text.
|-
| gettileset()
|
| returns string - the current main tileset (pics1.png, picso.png etc.)
|-
| gettilesettype()
|
| returns integer - the current tileset type (pics1.png:0, picso.png:5 etc.)
|-
| gettotalupdatepackagesize()
|
| returns integer - The total size of the update packages.
|-
| getupdatepackage(string name)
|
| returns object - A reference to the update package with the given name.
|-
| getvectorfromangles(float, float)
|
| returns string
|-
| getz(float, float)
|
| returns float
|-
| graalcontrolhasfocus(bool)
|
| returns boolean - Whether or not the graal control has focus. Parameter says if it should also check if the chat bar has the focus
|-
| hideplayer(float time)
|
| Hides player for the specified amount of time.
|-
| hidesword(float time)
|
| Hides the player's sword for the specified amount of time.
|-
| hitnpc(int index, float halfhearts, float fromx, float fromy)
|
| Hit's npc with specified index causing the specified amount of halfhearts in damage. It also knocks back the npc based on the from X and Y coordinate passed to it.
|-
| hitobjects(float power, float x, float y)
|
| Hurts all the npcs with the specified power on the position passed to it.
|-
| hitplayer(int index, float halfhearts, float fromx, float fromy)
|
| Hit's player with specified index causing the specified amount of halfhearts in damage. It also knocks back the player based on the from X and Y coordinate passed to it. Use 0 as the index to hit your own player.
|-
| isadminguild(str guildname)
|
| returns boolean - If the passed guildname is an admin guild or not.
|-
| isclassloaded(str classname)
|
| returns boolean - If the passed classname is loaded for the client.
|-
| iscursoron()
|
| returns boolean - If the cursor is on or not.
|-
| isdevicefullscreenonly(str device)
|
| returns boolean - If the device is full screen only or not.
|-
| isdownloading(str filename)
|
| returns boolean - If a file is currently downloaded or requested from the server.
|-
| isdownloadingfiles()
|
| returns boolean - checks if Graal is currently downloading or requesting files from the server.
|-
| isfullscreenmode()
|
| returns boolean - checks if Graal is currently in fullscreen mode.
|-
| isimgrectangletransparent(str, int, int, int, int)
|
| returns boolean
|-
| ismusicplaying()
|
| returns boolean
|-
| isobject(str)
|
| returns boolean
|-
| issoundplaying(str)
|
| returns boolean
|-
| keydown(int)
|
| returns boolean
|-
| keydown2(int, bool)
|
| returns boolean
|-
| keydown2global(int, bool)
|
| returns boolean
|-
| keydownglobal(int)
|
| returns boolean
|-
| keyname(int)
|
| returns string
|-
| lay2(str, float, float)
|
|
|-
| lightscene()
|
| returns boolean
|-
| loadclass(str)
|
|
|-
| loadmap(str)
|
|
|-
| loadtranslation(str)
|
|
|-
| lowercase(str)
|
| returns string
|-
| ltmfs(bool)
|
|
|-
| ltmmax(float, float)
|
|
|-
| ltmmin(float, float)
|
|
|-
| makescreenshot2(str, int, float, float, float, int, int)
|
|
|-
| matrixcreate(str, str)
|
| returns string
|-
| matrixcreatefromeuler(str)
|
| returns string
|-
| matrixmulpoint(str, str)
|
| returns string
|-
| matrixmultiply(str, str)
|
| returns string
|-
| matrixmulvector(str, str)
|
| returns string
|-
| md5(str)
|
| returns string
|-
| noplayerkilling()
|
|
|-
| onwall(float, float)
|
| returns boolean
|-
| onwall2(float, float, float, float)
|
| returns boolean
|-
| onwater(float, float)
|
| returns boolean
|-
| onwater2(float, float, float, float)
|
| returns boolean
|-
| opengraalurl(str)
|
|
|-
| openurl(str)
|
|
|-
| openurl2(str, int, int)
|
|
|-
| play(str)
|
|
|-
| play2(str, float, float, float)
|
|
|-
| play3d(str, bool, str, str)
|
|
|-
| playlooped(str)
|
|
|-
| playlooped2(str, float, float, float)
|
|
|-
| popdialog()
|
|
|-
| pushdialog(obj)
|
|
|-
| putleaps(int, float, float)
|
|
|-
| radtodeg(float)
|
| returns float
|-
| randomstring(str)
|
| returns string
|-
| removetiledefs(str)
|
|
|-
| replaceani(str, str)
|
|
|-
| requestfiledeletion(str)
|
|
|-
| requestfilerename(str, str)
|
|
|-
| requestfilesmove(str, str)
|
|
|-
| requesthttp(str, int, str)
|
| returns object
|-
| requesttext(str, str)
|
|
|-
| requesturl(str)
|
| returns object
|-
| resetfocus()
|
|
|-
| rotationadd(str, str)
|
| returns string
|-
| rotationaddeuler(str, str)
|
| returns string
|-
| rotationfromeuler(str)
|
| returns string
|-
| rotationsub(str, str)
|
| returns string
|-
| rotationtoeuler(str)
|
| returns string
|-
| rungarbagecollector()
|
|
|-
| savelog(str)
|
|
|-
| say(int)
|
|
|-
| say2(str)
|
|
|-
| screenx(float, float)
|
| returns integer
|-
| screeny(float, float)
|
| returns integer
|-
| selectfilefordownload(str)
|
| opens the select
|-
| selectfileforupload()
|
| opens the select
|-
| sendrpgmessage(str)
|
|
|-
| sendtext(str, str, params...)
|
|
|-
| sendtorc(str)
|
|
|-
| serverwarp(str)
|
|
|-
| setani(str, str)
|
|
|-
| setbeltcolor(str)
|
|
|-
| setcoatcolor(str)
|
|
|-
| setcontentcontrol(obj)
|
|
|-
| setcursor2(str)
|
|
|-
| seteffect(float, float, float, float)
|
|
|-
| setfocus(float, float)
|
|
|-
| setfogcolors(obj)
|
|
|-
| setgender(str)
|
|
|-
| sethead(str)
|
|
|-
| setinteriorrendermode(int)
|
|
|-
| setletters(str)
|
|
|-
| setmap(str, str, float, float)
|
| sets a text map (you can see the tiles of other levels but not the npcs), parameters are text file with level names, the map image (not used anymore), default x and y for the head icons; use gmaps if possible instead of this
|-
| setminimap(str, str, float, float)
|
| parameters are a text file with level names, the image, default x and y; use gmaps if possible instead of this
|-
| setmusicvolume(float, float)
|
|
|-
| setplayerdir(str)
|
|
|-
| setshield(str, int)
|
|
|-
| setshoecolor(str)
|
|
|-
| setshootparams(str)
|
|
|-
| setskincolor(str)
|
|
|-
| setskybandcolors(obj)
|
|
|-
| setskybandsizes(obj)
|
|
|-
| setsleevecolor(str)
|
|
|-
| setspritesimage(str)
|
|
|-
| setstatusimage(str)
|
|
|-
| setsuncolors(obj)
|
|
|-
| setsword(str, int)
|
|
|-
| setterrainrendermode(int)
|
|
|-
| showstats(int)
|
|
|-
| spyfire(int, int)
|
|
|-
| startrecordvideo()
|
| returns boolean
|-
| stopmidi()
|
| same as stopmusic(), kept for compatibility
|-
| stopmusic()
|
|
|-
| stoprecordvideo()
|
| returns boolean
|-
| stopsound(str)
|
|
|-
| strcmp(str, str)
|
| returns integer
|-
| strequals(str, str)
|
| returns boolean
|-
| switchtoopengl()
|
|
|-
| synctimeofday(float, float)
|
|
|-
| takeplayercarry()
|
|
|-
| takeplayerhorse()
|
|
|-
| testplayer(float, float)
|
| returns integer
|-
| trace(str)
|
| same as echo()
|-
| triggeraction(float, float, str, params...)
|
|
|-
| triggerserver(str, str)
|
|
|-
| update3dterrain(float, float, float, float)
|
|
|-
| updateboard(int, int, int, int)
|
|
|-
| updateterrain()
|
|
|-
| updatevisibledistance()
|
|
|-
| uploadfile(str)
|
| uploads a file, you must provide the full path provided by a onDropFiles() event, also this will only work if the scripted RC has currently a file browser window open; once the file is uploaded an onFilesUploaded event will be invoked
|-
| uppercase(str)
|
| returns string
|-
| [[Vectors#Vector_Addition|vectoradd(str, str)]]
|
| returns string
|-
| [[Cross Product|vectorcross(str, str)]
|
| returns string
|-
| [[Vectors#Distance_Between_Terminal_Points|vectordist(str, str)]]
|
| returns float
|-
| [[Dot Product|vectordot(str, str)]]
|
| returns float
|-
| [[Vectors#Vector_Length_.28Magnitude.2FModulus.29|vectorlen(str)]]
|
| returns float
|-
| [[Vectors#Unit_Length|vectornormalize(str)]]
|
| returns string
|-
| vectororthobasis(str)
|
| returns string
|-
| [[Vectors#Vector-Scalar_Multiplication|vectorscale(str, float)]]
|
| returns string
|-
| [[Vectors#Vector_Subtraction|vectorsub(str, str)]]
|
| returns string
|-
| worldx(float, float)
|
| returns float
|-
| worldy(float, float)
|
| returns float
|-
| wraptext(int, str, str)
|
| returns object
|-
| wraptext2(int, float, str, str)
|
| returns object
|}
 

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

=GUI Objects=
GUI Objects are currently well documented starting here [[Creation/Dev/Script/Client/GuiControl]].

=Preference Variables=
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| $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::capture::allowbyscript
|
| boolean [R]
|-
| $pref::capture::area
|
| string
|-
| $pref::capture::audiobitrate
|
| integer
|-
| $pref::capture::disabledaynight
|
| boolean
|-
| $pref::capture::format
|
| string
|-
| $pref::capture::fps
|
| integer
|-
| $pref::capture::hideinterface
|
| boolean
|-
| $pref::capture::recordaudio
|
| boolean
|-
| $pref::capture::showmouse
|
| boolean
|-
| $pref::capture::size
|
| string
|-
| $pref::capture::videobitrate
|
| integer
|-
| $pref::graal::allowglobalpms
|
| boolean
|-
| $pref::graal::automapping
|
| boolean
|-
| $pref::graal::defaultfontname
|
| string
|-
| $pref::graal::defaultfontsize
|
| integer
|-
| $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::video::defaultguistyle
|
| string
|-
| $pref::video::detailfactor
|
| float
|-
| $pref::video::fogdistance
|
| float
|-
| $pref::video::fullscreenmode
|
| string
|-
| $pref::video::resolution
|
| integer
|-
| $pref::video::screenshotformat
|
| string
|-
| $pref::video::visibledistance
|
| float
|-
| $pref::video::windowmode
|
| string
|}

Creation/Dev/Script/Clientside Functions

2011-09-20T01:13:57Z

Tolnaftate2004: /* Functions */

[[Category:Scripting Reference]]
{| border="0" cellpadding="2" width="50%"
|[R]
| denotes it is read-only.
|-
|[3D]
| denotes it is a Graal3D function.
|-
|[opengl]
| denotes it is functional only in opengl mode.
|}

==Variables==
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| allfeatures
| ''integer [R]''
|
|-
| allplayerscount
| ''integer [R]''
| Returns the count of all players on your playerlist, including IRC bots.
|-
| allrenderobjecttypes
| ''integer [R]''
|
|-
| allstats
| ''integer [R]''
| Used with showstats() in order to show all stats.
|-
| canspin
| ''boolean [R]''
| Returns true of false if the player has spin attack.
|-
| carriesblackstone
| ''boolean [R]''
| Returns whether the player is carrying a black stone.
|-
| carriesbush
| ''boolean [R]''
| Returns whether the player is carrying a bush.
|-
| carriesnpc
| ''boolean [R]''
| Returns whether the player is carrying an NPC
|-
| carriessign
| ''boolean [R]''
| Returns whether the player is carrying a sign.
|-
| carriesstone
| ''boolean [R]''
| Returns whether the player is carrying a stone.
|-
| carriesvase
| ''boolean [R]''
| Returns whether the player is carrying a vase.
|-
| downloadfile
| ''string [R]''
| Returns the currently downloaded file.
|-
| downloadpos
| ''integer [R]''
| Returns the position of the currently downloaded file.
|-
| downloadsize
| ''integer [R]''
| Returns the size of the currently downloaded file.
|-
| editingmission
| ''boolean''
|
|-
| emoticonchar
| ''string [R]''
|
|-
| focusx
| ''float [R]''
| Position of the camera in tile units.
|-
| focusy
| ''float [R]''
| Position of the camera in tile units.
|-
| ghostsnear
| ''boolean [R]''
| If a ghost(observer) is in the same level as the player.
|-
| graalplugincookie
| ''string [R]''
|
|-
| graalversion
| ''float [R]''
| Version of Graal the player is using.
|-
| gravity
| ''float''
| The gravity value that effects how fast projectiles fall. It universally effects all projectiles.
|-
| installedlanguages
| ''string [R]''
|
|-
| isapplicationactive
| ''boolean [R]''
| Is Graal window active?
|-
| iscarrying
| ''boolean [R]''
| Returns true of false if the player is carrying something.
|-
| isfocused
| ''boolean [R]''
|
|-
| isgraal3d
| ''boolean [R]''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| isleader
| ''boolean [R]''
| Player was the first to enter the level.
|-
| isonmap
| ''boolean [R]''
| Player is on a map.
|-
| isopengl
| ''boolean [R]''
| Graal is in opengl mode.
|-
| isrecordingvideo
| ''boolean [R]''
| Player is currently recording(alt+6) Graal.
|-
| jpegquality
| ''integer''
|
|-
| isgraalplugin
| ''boolean [R]''
|
|-
| lastdownloadfile
| ''string [R]''
| The last file downloaded.
|-
| leftmousebutton
| ''boolean [R]''
| If the left mouse button is pressed.
|-
| leftmousebuttonglobal
| ''boolean [R]''
| If the left mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| levelorgx
| ''float [R]''
|
|-
| levelorgy
| ''float [R]''
|
|-
| lighteffectsenabled
| ''boolean''
| Whether the player has their lights enabled via options.
|-
| middlemousebutton
| ''boolean [R]''
| If the middle mouse button is pressed
|-
| middlemousebuttonglobal
| ''boolean [R]''
| If the middle mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| mousebuttons
| ''integer [R]''
|
|-
| mousebuttonsglobal
| ''integer [R]''
|
|-
| mousepitch
| ''float [R] [3D]''
|
|-
| mousescreenx
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the x-axis.
|-
| mousescreeny
| ''integer''
| Position of the mouse in the Graal screen, in pixel units on the y-axis.
|-
| mousewheeldelta
| ''integer [R]''
| How much the mouse wheel has been scrolled.
|-
| mousex
| ''float''
| Position of the mouse in the level, in tile units, on the x-axis.
|-
| mousey
| ''float''
| Position of the mouse in the level, in tile units, on the y-axis
|-
| mouseyaw
| ''float [R] [3D]''
|
|-
| musiclen
| ''integer [R]''
| Length of current playing '''MP3'''
|-
| musicpos
| ''integer [R]''
| Position of current playing '''MP3'''
|-
| particleeffectsenabled
| ''boolean''
| If player has particles enabled in their options.
|-
| rightmousebutton
| ''boolean [R]''
| If the right mouse button is pressed
|-
| rightmousebuttonglobal
| ''boolean [R]''
| If the right mouse button is pressed. Returns whether mouse is in focus of GUIs or not.
|-
| screenheight
| ''integer [R]''
| Height of the Graal screen in pixel units.
|-
| screenwidth
| ''integer [R]''
| Width of the Graal screen in pixel units.
|-
| scriptedcontrols
| ''boolean [R]''
|
|-
| scriptedplayerlist
| ''boolean [R]''
| Whether the player has the scripted playerlist enabled.
|-
| scriptlogwritetoreadonly
| ''boolean''
|
|-
| selectedlistplayers
| ''object''
| An object of all players selected on the playerlist.
|-
| selectedsword
| ''integer''
|
|-
| selectedweapon
| ''integer''
| Index of the currently selected weapon.
|-
| servername
| ''string [R]''
| Name of the server.
|-
| serverstartconnect
| ''string''
|
|-
| serverstartparams
| ''string''
|
|-
| shotbybaddy
| ''boolean [R]''
| If the player is shot by a baddy(default) arrow.
|-
| shotbyplayer
| ''boolean [R]''
| If the player is shot by another players arrow.
|-
| showterraingrid
| ''boolean''
|
|-
| spritesimage
| ''string''
| Filename of the currently set sprite image.
|-
| statusimage
| ''string''
| Filename of the currently set state image.
|-
| timevar
| ''integer [R].''
|
|-
| timevar2
| ''float [R]''
|
|-
| timevar3
| ''float [R] [3D]''
| Synchronized time which works on both server and client-side, precision is milliseconds.
|-
| wasshooted
| ''boolean [R]''
| If the player is shot by a default arrow.
|-
| waterheight
| ''float''
|
|-
| weapons
| ''object [R]''
| all the players weapons, this includes login inherited weapons.
|-
| weaponsenabled
| ''boolean''
| If the players weapons are enabled via disableweapons()/enableweapons().
|-
| weathereffectsenabled
| ''boolean''
| If weather is enabled in the players options.
|-
| worldclockstopped
| ''boolean''
|
|-
| worldhour
| ''integer''
|
|-
| worldminute
| ''float''
|
|-
| worldminutesofday
| ''float''
|
|-
| worldrealsecondsperday
| ''float''
|
|-
|}

=Functions=
{| border="1" cellpadding="2" width="100%"
| '''Function'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| addcontrol(object)
|
| adds 'object' to the parent control.
|-
| addmaterialmapping(string, string)
| [3D]
| returns boolean.
|-
| addtiledef(string image, string prefix, int format)
|
| Adds a tileset definition with the supplied tileset image, level prefix and tileset format (0=pics1, 1=new world, 5=terrain).
|-
| addtiledef2(string image, string prefix, int x, int y)
|
| Overlays an image on the tileset with the supplied tileset image and level prefix. Parameters 'x' and 'y' represent the x and y position on the tileset of where to place the new image.
|-
| aindexof(float, array)
|
| Returns integer - the position of 'float' in the array.
|-
| arccos(float)
|
| Returns float - the arc cosine of 'float'.
|-
| arcsin(float)
|
| Returns float - the arc sine of 'float'.
|-
| attachplayertoobj(integer1, integer2)
|
| Attaches the player to the object with the matching ID where integer1 is the object type (currently only NPCs - 0) and integer2 is the ID of the desired object.
|-
| base64decode(string)
|
| Returns string - Decodes a base64 string.
|-
| base64encode(string)
|
| Returns string - Encodes string in to several characters of a 64 printable character set (A-Z, a-z, 0-9, + and /, while "=" is a special suffix code)
|-
| boxcontains(string, string)
|
| returns boolean.
|-
| boxcontainsvector(string, string)
|
| returns boolean
|-
| boxintersect(string, string)
|
| returns string
|-
| boxoverlaps(string, string)
|
| returns boolean
|-
| boxscale(string, string)
|
| returns string
|-
| callnpc(int index, string function)
|
| Calls a function from an NPC where 'index' is the NPC's index and 'function' is the function name.
|-
| callweapon(int index, string function)
|
| Calls a function from a weapon where 'index' is the weapon's index and 'function' is the function name.
|-
| castray({x,y,x}, {x,y,z}, string type)
| [3D]
| returns object - specify the start and end of the ray, and the object types (e.g. "staticts,terrain,interior")
|-
| checksum(string)
|
| returns float
|-
| contains(string2, string1)
|
| returns boolean - True if string1 is contained within string2.
|-
| copystrings(string, string)
|
|
|-
| cursoroff()
| [opengl]
| Disables the visible mouse cursor.
|-
| cursoron()
| [opengl]
| Enables the visible mouse cursor.
|-
| degtorad(float)
|
| returns float - Converts angle measurements of degrees to radians
|-
| detachplayer()
|
| Detaches a player from an attached object.
|-
| disabledefmovement()
|
| Disables the default movement system and controls(including weapons, sword, grab. Does not include Q-menu, pause, map...).
|-
| disablemap()
|
| Disables the default map (M).
|-
| disablepause()
|
| Disables the default pause (P).
|-
| disableselectweapons()
|
| Disables the default Q-menu (Q).
|-
| disableweapons()
|
| Disables the default sword (S) and weapons (D).
|-
| echo(string)
|
| echos 'string' to the debug window(F2).
|-
| enabledefmovement()
|
| Enables the default movement system.
|-
| [[Creation/Dev/Script/Functions/enablefeatures(int)|enablefeatures(int)]]
|
|
|-
| enablemap()
|
| Enables the default map system(M).
|-
| enablepause()
|
| Enables the default pause system(P).
|-
| enableselectweapons()
|
| Enables the default Q-menu(Q).
|-
| enableweapons()
|
| Enables the default sword(S) and weapons(D).
|-
| escapestring(string)
|
| returns string - adds \\ in front of ", ' and \\, and removes non-printable characters
|-
| explodebomb(integer)
|
| explodes the bomb with the id of 'integer'.
|-
| extractfilebase(string)
|
| returns string
|-
| extractfileext(string)
|
| Takes in a file name, and returns its extension.
|-
| extractfilepath(string)
|
| returns string
|-
| fileexists(string)
|
| returns boolean of whether the file 'str' exists in the players Graal/ directory(does not search subfolders).
|-
| filesize(string)
|
| Returns the size(int) of the file 'string' in the players Graal/ directory(does not search subfolders).
|-
| fileupdate(string)
|
| returns boolean
|-
| findani(string)
|
| returns object
|-
| findfiles(string, integer)
|
| returns object
|-
| findlevel(string)
|
| returns object
|-
| findnearestplayer(float1, float2)
|
| Returns the closest player's object relevant to float1 and float2.
|-
| findnearestplayers(float, float)
|
| Returns the closest players' object relevant to float1 and float2.
|-
| findnpcbyid(integer)
|
| Returns the NPC object with the ID of 'int'.
|-
| findpathinarray(obj1, obj2, obj3, obj4, obj5, int, int, int)
|
| Returns object - Simple path-finding: Obj1 being tiles that allow walking, Obj2 being tiles that don't allow walking, Obj3; tiles that shouldn't be allowed to walked on, Obj4; tiles that are able to be walked on, Obj5; tiles where we may stop. Integers are relevant to the startx, starty and maximum path length. - Arrays for allowed/non-allowed tiles are only checked if they aren't null.
|-
| findplayer(string)
|
| Returns the player object with the account equal to string.
|-
| findplayerbycommunityname(string)
|
| Returns the player object with the community name equal to string.
|-
| findplayerbyid(integer)
|
| Returns the player object with the ID equal to integer.
|-
| findweapon(string)
|
| Returns the weapon object with the name equal to string.
|-
| [[Creation/Dev/Output_Methods#format.28.29_function|format(string, string, ...)]]
|
| See [[Creation/Dev/Output_Methods#format.28.29_function|format()]].
|-
| [[Creation/Dev/Output_Methods#format2.28.29_function|format2(string, array)]]
|
| Like format(), except that this expects the format string and an array of variables instead of passing the variables as separate parameters.
|-
| freefileresources(string)
|
|
|-
| freezeplayer(float)
|
| Freezes the player for the number of seconds specified by float.
|-
| get3dobjectat(float, float, boolean)
| [3D]
| Gets the 3d object at the specified screen position, third parameter true if it should do box collision.
|-
| get3dobjectatmouse(boolean)
| [3D]
| Gets the 3d object at the mouse. Parameter true if it should do box collision.
|-
| get3dobjectbyray(string, string)
| [3D]
| returns object
|-
| get3dobjectsbybox(string, string)
| [3D]
| 1st parameter defines the box {minx,miny,minz, maxx,maxy,maxz}. Second parameter specifies the type of object to find (e.g. "staticts,terrain,interior")
|-
| get3dscreenposition(string, boolean)
| [3D]
| returns string
|-
| getanglesfromvector({x, y, z})
|
| Returns an array that contains the angles the 3D vector {x, y, z} makes with the X-Y and X-Z axes.
|-
| getascii(string)
|
| Returns the [http://www.asciitable.com/ ascii] code for string.
|-
| getbasepackage()
|
| returns object
|-
| getboxcenter(string)
|
| Returns an array containing the center of a 3D box specified by string ({x0,y0,z0,x1,y1,z1,...}).
|-
| getdesktopresolution()
|
| returns string
|-
| getdisplaydevicelist()
|
| returns string
|-
| getdownloadedupdatepackagesize()
|
| Returns the size of the downloaded update package.
|-
| getdownloadingpackage()
|
| Returns a reference to current update package being downloaded.
|-
| getdownloadingpackagescount()
|
| Returns a count of the number of update packages to download.
|-
| getdropz(string)
|
| returns float
|-
| getExtension(string)
|
| This function is the same as extractFileExt(). Takes in a file name, and returns its extension.
|-
| getfilemodtime(string)
|
| Returns a timestamp of when the file was last modified (in unix time compatible to timevar2). This function accepts both exact file path and plain file name.
|-
| gethttprequest(string, integer, string)
|
| returns object (This function is the same as requestHttp())
|-
| getimgheight(string)
|
| Returns the height (in pixels) of the filename indicated by string.
|-
| getimgpixel(string, integer, integer)
|
| returns object
|-
| getimgwidth(string)
|
| Returns the width(in pixels) of the filename indicated by string.
|-
| getkeycode(string)
|
| Returns the keycode of the key indicated by string. The keycode returned can be used in keydown2().
|-
| getloginaccountname()
|
| Presumably used for the login server. Use player.account instead.
|-
| getmapx(string)
|
| Gets the x coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmapy(string)
|
| Gets the y coordinate location in the gmap of the level indicated by string. The top-left level starts at (0, 0).
|-
| getmusicfilename()
|
| Returns the filename of the music currently playing.
|-
| getmusicstatus()
|
| Returns the status of the music currently playing.
|-
| getmusictags()
|
| Returns the tags of the music currently playing. This function can be used to retrieve the title and artist info of the music.
|-
| getnearestplayer(float, float)
|
| Deprecated. Use findnearestplayer() instead.
|-
| getnearestplayers(float, float)
|
| Deprecated. Use findnearestplayers() instead.
|-
| getpackagesdownloadcomplete()
|
| Returns 'true' if the package downloads are complete.
|-
| getpackagesdownloaded()
|
| Returns 'true' if the most recent packages are already downloaded.
|-
| getplatform()
|
| Returns the platform that the player is using. (i.e. windows, mac, or linux)
|-
| getresolutionlist(string)
|
| returns string
|-
| getservername()
|
| Returns the name of the server the player is currently connected to.
|-
| getstringkeys(string)
|
| Returns an array of the variables that begins with the supplied string.
|-
| getterraintexture(float, float)
|
| returns string
|-
| getterraintextureindex(float, float)
|
| returns integer
|-
| gettextheight(float zoom, string style, string font)
|
| returns integer - The height in pixels of the text with the given zoom, style and font.
|-
| gettextwidth(float zoom, string style, string font, string text)
|
| returns integer - The width of the text with the given zoom, style, font and text.
|-
| gettileset()
|
| returns string - the current main tileset (pics1.png, picso.png etc.)
|-
| gettilesettype()
|
| returns integer - the current tileset type (pics1.png:0, picso.png:5 etc.)
|-
| gettotalupdatepackagesize()
|
| returns integer - The total size of the update packages.
|-
| getupdatepackage(string name)
|
| returns object - A reference to the update package with the given name.
|-
| getvectorfromangles(float, float)
|
| returns string
|-
| getz(float, float)
|
| returns float
|-
| graalcontrolhasfocus(bool)
|
| returns boolean - Whether or not the graal control has focus. Parameter says if it should also check if the chat bar has the focus
|-
| hideplayer(float time)
|
| Hides player for the specified amount of time.
|-
| hidesword(float time)
|
| Hides the player's sword for the specified amount of time.
|-
| hitnpc(int index, float halfhearts, float fromx, float fromy)
|
| Hit's npc with specified index causing the specified amount of halfhearts in damage. It also knocks back the npc based on the from X and Y coordinate passed to it.
|-
| hitobjects(float power, float x, float y)
|
| Hurts all the npcs with the specified power on the position passed to it.
|-
| hitplayer(int index, float halfhearts, float fromx, float fromy)
|
| Hit's player with specified index causing the specified amount of halfhearts in damage. It also knocks back the player based on the from X and Y coordinate passed to it. Use 0 as the index to hit your own player.
|-
| isadminguild(str guildname)
|
| returns boolean - If the passed guildname is an admin guild or not.
|-
| isclassloaded(str classname)
|
| returns boolean - If the passed classname is loaded for the client.
|-
| iscursoron()
|
| returns boolean - If the cursor is on or not.
|-
| isdevicefullscreenonly(str device)
|
| returns boolean - If the device is full screen only or not.
|-
| isdownloading(str filename)
|
| returns boolean - If a file is currently downloaded or requested from the server.
|-
| isdownloadingfiles()
|
| returns boolean - checks if Graal is currently downloading or requesting files from the server.
|-
| isfullscreenmode()
|
| returns boolean - checks if Graal is currently in fullscreen mode.
|-
| isimgrectangletransparent(str, int, int, int, int)
|
| returns boolean
|-
| ismusicplaying()
|
| returns boolean
|-
| isobject(str)
|
| returns boolean
|-
| issoundplaying(str)
|
| returns boolean
|-
| keydown(int)
|
| returns boolean
|-
| keydown2(int, bool)
|
| returns boolean
|-
| keydown2global(int, bool)
|
| returns boolean
|-
| keydownglobal(int)
|
| returns boolean
|-
| keyname(int)
|
| returns string
|-
| lay2(str, float, float)
|
|
|-
| lightscene()
|
| returns boolean
|-
| loadclass(str)
|
|
|-
| loadmap(str)
|
|
|-
| loadtranslation(str)
|
|
|-
| lowercase(str)
|
| returns string
|-
| ltmfs(bool)
|
|
|-
| ltmmax(float, float)
|
|
|-
| ltmmin(float, float)
|
|
|-
| makescreenshot2(str, int, float, float, float, int, int)
|
|
|-
| matrixcreate(str, str)
|
| returns string
|-
| matrixcreatefromeuler(str)
|
| returns string
|-
| matrixmulpoint(str, str)
|
| returns string
|-
| matrixmultiply(str, str)
|
| returns string
|-
| matrixmulvector(str, str)
|
| returns string
|-
| md5(str)
|
| returns string
|-
| noplayerkilling()
|
|
|-
| onwall(float, float)
|
| returns boolean
|-
| onwall2(float, float, float, float)
|
| returns boolean
|-
| onwater(float, float)
|
| returns boolean
|-
| onwater2(float, float, float, float)
|
| returns boolean
|-
| opengraalurl(str)
|
|
|-
| openurl(str)
|
|
|-
| openurl2(str, int, int)
|
|
|-
| play(str)
|
|
|-
| play2(str, float, float, float)
|
|
|-
| play3d(str, bool, str, str)
|
|
|-
| playlooped(str)
|
|
|-
| playlooped2(str, float, float, float)
|
|
|-
| popdialog()
|
|
|-
| pushdialog(obj)
|
|
|-
| putleaps(int, float, float)
|
|
|-
| radtodeg(float)
|
| returns float
|-
| randomstring(str)
|
| returns string
|-
| removetiledefs(str)
|
|
|-
| replaceani(str, str)
|
|
|-
| requestfiledeletion(str)
|
|
|-
| requestfilerename(str, str)
|
|
|-
| requestfilesmove(str, str)
|
|
|-
| requesthttp(str, int, str)
|
| returns object
|-
| requesttext(str, str)
|
|
|-
| requesturl(str)
|
| returns object
|-
| resetfocus()
|
|
|-
| rotationadd(str, str)
|
| returns string
|-
| rotationaddeuler(str, str)
|
| returns string
|-
| rotationfromeuler(str)
|
| returns string
|-
| rotationsub(str, str)
|
| returns string
|-
| rotationtoeuler(str)
|
| returns string
|-
| rungarbagecollector()
|
|
|-
| savelog(str)
|
|
|-
| say(int)
|
|
|-
| say2(str)
|
|
|-
| screenx(float, float)
|
| returns integer
|-
| screeny(float, float)
|
| returns integer
|-
| selectfilefordownload(str)
|
| opens the select
|-
| selectfileforupload()
|
| opens the select
|-
| sendrpgmessage(str)
|
|
|-
| sendtext(str, str, params...)
|
|
|-
| sendtorc(str)
|
|
|-
| serverwarp(str)
|
|
|-
| setani(str, str)
|
|
|-
| setbeltcolor(str)
|
|
|-
| setcoatcolor(str)
|
|
|-
| setcontentcontrol(obj)
|
|
|-
| setcursor2(str)
|
|
|-
| seteffect(float, float, float, float)
|
|
|-
| setfocus(float, float)
|
|
|-
| setfogcolors(obj)
|
|
|-
| setgender(str)
|
|
|-
| sethead(str)
|
|
|-
| setinteriorrendermode(int)
|
|
|-
| setletters(str)
|
|
|-
| setmap(str, str, float, float)
|
| sets a text map (you can see the tiles of other levels but not the npcs), parameters are text file with level names, the map image (not used anymore), default x and y for the head icons; use gmaps if possible instead of this
|-
| setminimap(str, str, float, float)
|
| parameters are a text file with level names, the image, default x and y; use gmaps if possible instead of this
|-
| setmusicvolume(float, float)
|
|
|-
| setplayerdir(str)
|
|
|-
| setshield(str, int)
|
|
|-
| setshoecolor(str)
|
|
|-
| setshootparams(str)
|
|
|-
| setskincolor(str)
|
|
|-
| setskybandcolors(obj)
|
|
|-
| setskybandsizes(obj)
|
|
|-
| setsleevecolor(str)
|
|
|-
| setspritesimage(str)
|
|
|-
| setstatusimage(str)
|
|
|-
| setsuncolors(obj)
|
|
|-
| setsword(str, int)
|
|
|-
| setterrainrendermode(int)
|
|
|-
| showstats(int)
|
|
|-
| spyfire(int, int)
|
|
|-
| startrecordvideo()
|
| returns boolean
|-
| stopmidi()
|
| same as stopmusic(), kept for compatibility
|-
| stopmusic()
|
|
|-
| stoprecordvideo()
|
| returns boolean
|-
| stopsound(str)
|
|
|-
| strcmp(str, str)
|
| returns integer
|-
| strequals(str, str)
|
| returns boolean
|-
| switchtoopengl()
|
|
|-
| synctimeofday(float, float)
|
|
|-
| takeplayercarry()
|
|
|-
| takeplayerhorse()
|
|
|-
| testplayer(float, float)
|
| returns integer
|-
| trace(str)
|
| same as echo()
|-
| triggeraction(float, float, str, params...)
|
|
|-
| triggerserver(str, str)
|
|
|-
| update3dterrain(float, float, float, float)
|
|
|-
| updateboard(int, int, int, int)
|
|
|-
| updateterrain()
|
|
|-
| updatevisibledistance()
|
|
|-
| uploadfile(str)
|
| uploads a file, you must provide the full path provided by a onDropFiles() event, also this will only work if the scripted RC has currently a file browser window open; once the file is uploaded an onFilesUploaded event will be invoked
|-
| uppercase(str)
|
| returns string
|-
| vectoradd(str, str)
|
| returns string
|-
| vectorcross(str, str)
|
| returns string
|-
| vectordist(str, str)
|
| returns float
|-
| vectordot(str, str)
|
| returns float
|-
| vectorlen(str)
|
| returns float
|-
| vectornormalize(str)
|
| returns string
|-
| vectororthobasis(str)
|
| returns string
|-
| vectorscale(str, float)
|
| returns string
|-
| vectorsub(str, str)
|
| returns string
|-
| worldx(float, float)
|
| returns float
|-
| worldy(float, float)
|
| returns float
|-
| wraptext(int, str, str)
|
| returns object
|-
| wraptext2(int, float, str, str)
|
| returns object
|}
 

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

=GUI Objects=
GUI Objects are currently well documented starting here [[Creation/Dev/Script/Client/GuiControl]].

=Preference Variables=
{| border="1" cellpadding="2" width="100%"
| '''Variable'''
|width="100px"|'''Type'''
| '''Notes'''
|-
| $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::capture::allowbyscript
|
| boolean [R]
|-
| $pref::capture::area
|
| string
|-
| $pref::capture::audiobitrate
|
| integer
|-
| $pref::capture::disabledaynight
|
| boolean
|-
| $pref::capture::format
|
| string
|-
| $pref::capture::fps
|
| integer
|-
| $pref::capture::hideinterface
|
| boolean
|-
| $pref::capture::recordaudio
|
| boolean
|-
| $pref::capture::showmouse
|
| boolean
|-
| $pref::capture::size
|
| string
|-
| $pref::capture::videobitrate
|
| integer
|-
| $pref::graal::allowglobalpms
|
| boolean
|-
| $pref::graal::automapping
|
| boolean
|-
| $pref::graal::defaultfontname
|
| string
|-
| $pref::graal::defaultfontsize
|
| integer
|-
| $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::video::defaultguistyle
|
| string
|-
| $pref::video::detailfactor
|
| float
|-
| $pref::video::fogdistance
|
| float
|-
| $pref::video::fullscreenmode
|
| string
|-
| $pref::video::resolution
|
| integer
|-
| $pref::video::screenshotformat
|
| string
|-
| $pref::video::visibledistance
|
| float
|-
| $pref::video::windowmode
|
| string
|}

Creation/Dev/Output Methods

2011-09-20T01:10:57Z

Tolnaftate2004: /* format2 function */

[[Category:Scripting Reference]]
== Introduction ==
With the addition of the [[GScript|new scripting engine]], there are a number of new methods in which you can create output from an NPC. In this article, I will discuss a couple of ways.

== Useful Things To Know ==
If you've played with the new engine for a while, you're probably aware of the string concationation operators. If not, here they are.
<pre>String Concatenation a @ b
with space a SPC b
with newline a NL b
with tabulator a TAB b</pre>
What these operators do is join values together to form one value.

An example of using @ would be:
<pre>"Hello, " @ player.account</pre>
... which would produce "Hello, accountnamehere".

The SPC, NL and TAB operators work using the same principal - except that they insert a Space, New Line or Tab Space respectively.

If you don't put a space at the end of the first value or at the beginning of the second value when using @, you don't get a visible space, for example:
<pre>"Hello" @ "World"</pre>
... will produce "HelloWorld".

However! If you use SPC, you'll get a space in place of the operator:
<pre>"Hello" SPC "World"</pre>
... producing "Hello World".

You can use these operators just about anywhere that a variable is requested, i.e. setting a variable, or sending to a function.

== format() function ==
Or, if you aren't so interested in using the concationation operators, you can use the ''format()'' function.

What this function does, is that it takes a sort of template from the first parameter you give it, and replaces % codes with other parameters you give it.

Now, the template format primarily uses the following % characters:
<pre>%d %i - Integer
%f - Float (number with decimal)
%s - String
%c - Single character
%% - Literal "%" character
%x %X - Print an integer as a hexadecimal</pre>
There are more, since the function is made to be compatible with C's ''printf()'' function.

In the template, every % code will be replaced with the respective parameter.

Say you want to produce "Hello, '''Mr. Skyld'''. You ate '''4''' apples today!" using format(). First, your format would be this:
<pre>"Hello, %s. You ate %i apples today!"</pre>
... and you must not forget to give the parameters containing the values:
<pre>format("Hello, %s. You ate %i apples today!", "Mr. Skyld", 4);</pre>
You can give the format() functions as many parameters as necessary to build up your value. If you use a % code and a value isn't present for it, a 0 (zero) will appear in it's place.

== format2() function==
You can also use ''format2()'', which acts just like format() with the exception that instead of passing variables as separate parameters, they are sent as an array to the 2nd parameter.
The example above would become
<pre>format2("Hello, %s. You ate %i apples today!", {"Mr. Skyld", 4});</pre>

Along with format2() came the indexing of the parameters. This method will work with both format() and format2() functions. It allows us to choose which parameter to place in which position in the format string. The problem of parameters being placed in the wrong order will not exist if each parameter has a different data type, however.

<pre>format2("Hello, %2$s. You ate %1$s apples today!", {"four","Mr. Skyld"});</pre>
In the example, both parameters are strings, so it would be necessary to give them an index when trying to insert them in a different order than they were passed. ''%1$s'' refers to the 1st object in the array inserted as a string. ''%n$T'' is general; the nth parameter inserted with datatype of ''T''.

Now, let's continue on various ways of outputting data.

== Outputs ==
=== Direct Output ===
Direct Output is sending an output directly to the game client, or to RC/NC. There are a number of functions for these tasks.

==== echo() ====
The echo() function will, on the serverside, send data to NC (by default), so RC users who have the NPC-Control right will see the message in RC chat, and on the clientside, sends the message to the F2 window. It expects one parameter, and that's the message you're sending. For example:
<pre>echo("This is a message!");</pre>
The message "This is a message!" will appear either in RC or the F2 window using this example.

Servers can change the [[Server_options#Send_NPC_output_to_RCs|sendechotorc]] server option to allow echo() messages to be sent to everyone on RC.

==== sendtorc() ====
The sendtorc() function works in the same way that the echo() function does, however, it only usually works on the serverside. It will appear to all RC users. For example:
<pre>sendtorc("This is a message!");</pre>
... will send "NPC-Server (Server): This is a message!" to RC.

'''Note''' that this function can only be used on the clientside when Client-RC is active.

==== sendtonc() ====
The sendtonc() function works in exactly the same way as echo() does serverside, except the message will display '''only''' to NC users.

==== sendrpgmessage() ====
The sendrpgmessage() will send a message appearing in the player's F2 log window and can be used on both client- and server-side. For example:
<pre>sendrpgmessage("This is a message!");</pre>
... will send "This is a message!" to the player's F2 window.

=== Working with Files ===
==== loadstring() ====
loadstring() is an object function which loads the contents of a given file.

Say that the file "levels/file.txt" contains the message "HELLO WORLD". If you want to load that value into a variable called "myVar", you should use this function:
<pre>myVar.loadstring("levels/file.txt");</pre>
You can easily check the contents of the file:
<pre>echo(myVar);</pre>
Use myVar.escape() if you want to print a string that might contain special characters like new-line which would not appear on RC-chat.

==== savestring() ====
savestring() is another object function, however, instead of loading the contents of a file, it writes the contents instead.

Consider this with the previous example:
<pre>myVar = "HELLO PLANET";
myVar.savestring("levels/file.txt", 0);</pre>
... would write "HELLO PLANET" to "levels/file.txt".

The second operator, which is 0 (zero) in that example, is the '''Append''' function, and decides whether the file should be overwritten with the new value, or whether the new value should be added onto the end of the file. If you specify '''1''', then the value will be appended, if not, it will overwrite the file.

==== savevars() ====
savevars() is an object function which saves the variables of an object into a file. Consider this example:
<pre>myVar = new TStaticVar(); // Create a TStaticVar
myVar.variable = "Hello";
myVar.secondvariable = "World";
myVar.saveVars("levels/test.txt", 0);</pre>
This will save the variables inside the "myVar" object into "levels/test.txt". You can then recall these variables using loadvars();

Like savelines(), the second parameter controls whether the variables are to be appended to the file. '''0''' will overwrite the file, and '''1''' will append to the file.

==== loadvars() ====
loadvars() is another object function which loads savevars()-style variables from a file into an object. Let's say you used the previous example from savevars(), then you could restore these values using the following:
<pre>myNewVar.loadvars("levels/test.txt");
echo(myNewVar.secondvariable);</pre>
... which will output "World".

=== Private Messages (PMs) ===
From the serverside, you can send PMs to players. They appear from the NPC-Server.

If you wanted to send a PM to the player "Skyld" (if the player is online), the you would use the following example:
<pre>findPlayer("Skyld").sendPM("This is a PM");</pre>
... and then the specified player, in this case Skyld, would receive the PM "This is a PM".

If you want to send a PM to the current player, you would simply use:
<pre>player.sendPM("This is a PM");</pre>

Creation/Dev/Output Methods

2011-09-20T01:10:36Z

Tolnaftate2004: /* format2() function */ separate from format

[[Category:Scripting Reference]]
== Introduction ==
With the addition of the [[GScript|new scripting engine]], there are a number of new methods in which you can create output from an NPC. In this article, I will discuss a couple of ways.

== Useful Things To Know ==
If you've played with the new engine for a while, you're probably aware of the string concationation operators. If not, here they are.
<pre>String Concatenation a @ b
with space a SPC b
with newline a NL b
with tabulator a TAB b</pre>
What these operators do is join values together to form one value.

An example of using @ would be:
<pre>"Hello, " @ player.account</pre>
... which would produce "Hello, accountnamehere".

The SPC, NL and TAB operators work using the same principal - except that they insert a Space, New Line or Tab Space respectively.

If you don't put a space at the end of the first value or at the beginning of the second value when using @, you don't get a visible space, for example:
<pre>"Hello" @ "World"</pre>
... will produce "HelloWorld".

However! If you use SPC, you'll get a space in place of the operator:
<pre>"Hello" SPC "World"</pre>
... producing "Hello World".

You can use these operators just about anywhere that a variable is requested, i.e. setting a variable, or sending to a function.

== format() function ==
Or, if you aren't so interested in using the concationation operators, you can use the ''format()'' function.

What this function does, is that it takes a sort of template from the first parameter you give it, and replaces % codes with other parameters you give it.

Now, the template format primarily uses the following % characters:
<pre>%d %i - Integer
%f - Float (number with decimal)
%s - String
%c - Single character
%% - Literal "%" character
%x %X - Print an integer as a hexadecimal</pre>
There are more, since the function is made to be compatible with C's ''printf()'' function.

In the template, every % code will be replaced with the respective parameter.

Say you want to produce "Hello, '''Mr. Skyld'''. You ate '''4''' apples today!" using format(). First, your format would be this:
<pre>"Hello, %s. You ate %i apples today!"</pre>
... and you must not forget to give the parameters containing the values:
<pre>format("Hello, %s. You ate %i apples today!", "Mr. Skyld", 4);</pre>
You can give the format() functions as many parameters as necessary to build up your value. If you use a % code and a value isn't present for it, a 0 (zero) will appear in it's place.

== format2 function==
You can also use ''format2()'', which acts just like format() with the exception that instead of passing variables as separate parameters, they are sent as an array to the 2nd parameter.
The example above would become
<pre>format2("Hello, %s. You ate %i apples today!", {"Mr. Skyld", 4});</pre>

Along with format2() came the indexing of the parameters. This method will work with both format() and format2() functions. It allows us to choose which parameter to place in which position in the format string. The problem of parameters being placed in the wrong order will not exist if each parameter has a different data type, however.

<pre>format2("Hello, %2$s. You ate %1$s apples today!", {"four","Mr. Skyld"});</pre>
In the example, both parameters are strings, so it would be necessary to give them an index when trying to insert them in a different order than they were passed. ''%1$s'' refers to the 1st object in the array inserted as a string. ''%n$T'' is general; the nth parameter inserted with datatype of ''T''.

Now, let's continue on various ways of outputting data.

== Outputs ==
=== Direct Output ===
Direct Output is sending an output directly to the game client, or to RC/NC. There are a number of functions for these tasks.

==== echo() ====
The echo() function will, on the serverside, send data to NC (by default), so RC users who have the NPC-Control right will see the message in RC chat, and on the clientside, sends the message to the F2 window. It expects one parameter, and that's the message you're sending. For example:
<pre>echo("This is a message!");</pre>
The message "This is a message!" will appear either in RC or the F2 window using this example.

Servers can change the [[Server_options#Send_NPC_output_to_RCs|sendechotorc]] server option to allow echo() messages to be sent to everyone on RC.

==== sendtorc() ====
The sendtorc() function works in the same way that the echo() function does, however, it only usually works on the serverside. It will appear to all RC users. For example:
<pre>sendtorc("This is a message!");</pre>
... will send "NPC-Server (Server): This is a message!" to RC.

'''Note''' that this function can only be used on the clientside when Client-RC is active.

==== sendtonc() ====
The sendtonc() function works in exactly the same way as echo() does serverside, except the message will display '''only''' to NC users.

==== sendrpgmessage() ====
The sendrpgmessage() will send a message appearing in the player's F2 log window and can be used on both client- and server-side. For example:
<pre>sendrpgmessage("This is a message!");</pre>
... will send "This is a message!" to the player's F2 window.

=== Working with Files ===
==== loadstring() ====
loadstring() is an object function which loads the contents of a given file.

Say that the file "levels/file.txt" contains the message "HELLO WORLD". If you want to load that value into a variable called "myVar", you should use this function:
<pre>myVar.loadstring("levels/file.txt");</pre>
You can easily check the contents of the file:
<pre>echo(myVar);</pre>
Use myVar.escape() if you want to print a string that might contain special characters like new-line which would not appear on RC-chat.

==== savestring() ====
savestring() is another object function, however, instead of loading the contents of a file, it writes the contents instead.

Consider this with the previous example:
<pre>myVar = "HELLO PLANET";
myVar.savestring("levels/file.txt", 0);</pre>
... would write "HELLO PLANET" to "levels/file.txt".

The second operator, which is 0 (zero) in that example, is the '''Append''' function, and decides whether the file should be overwritten with the new value, or whether the new value should be added onto the end of the file. If you specify '''1''', then the value will be appended, if not, it will overwrite the file.

==== savevars() ====
savevars() is an object function which saves the variables of an object into a file. Consider this example:
<pre>myVar = new TStaticVar(); // Create a TStaticVar
myVar.variable = "Hello";
myVar.secondvariable = "World";
myVar.saveVars("levels/test.txt", 0);</pre>
This will save the variables inside the "myVar" object into "levels/test.txt". You can then recall these variables using loadvars();

Like savelines(), the second parameter controls whether the variables are to be appended to the file. '''0''' will overwrite the file, and '''1''' will append to the file.

==== loadvars() ====
loadvars() is another object function which loads savevars()-style variables from a file into an object. Let's say you used the previous example from savevars(), then you could restore these values using the following:
<pre>myNewVar.loadvars("levels/test.txt");
echo(myNewVar.secondvariable);</pre>
... which will output "World".

=== Private Messages (PMs) ===
From the serverside, you can send PMs to players. They appear from the NPC-Server.

If you wanted to send a PM to the player "Skyld" (if the player is online), the you would use the following example:
<pre>findPlayer("Skyld").sendPM("This is a PM");</pre>
... and then the specified player, in this case Skyld, would receive the PM "This is a PM".

If you want to send a PM to the current player, you would simply use:
<pre>player.sendPM("This is a PM");</pre>

Creation/Dev/Script/Functions/enablefeatures

2011-09-18T08:13:25Z

Tolnaftate2004:

[[Category:Scripting Reference]]
''Clientside''

example:
<pre>function onCreated()
{
enablefeatures(allfeatures - 0x100);
}
</pre>

Disables hearts over the player's head.

Features are encoded as bits as listed below:
{| border="1" cellpadding="2" width="100%"
|'''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
|-
|}

'''Note:''' 0x#### is simply hexadecimal notation, so these codes hold no special meaning other than being numbers written in radix-16. E.g., 0x10 = 16 is the 4th bit (starting with the 0th bit).

Creation/Dev/GScript/Constants

2011-09-05T19:42:49Z

Tolnaftate2004:

[[Category:Scripting Reference]]
As one might be able to deduce, a '''constant''' has a single value and will retain that value as long as that constant exists. A constant is ''not'' a variable for one very important reason: its value is not variable!

A constant is only accessible in the script where you have defined it, they
are not shared between the server-side and client-side parts either.

The const keyword is more of a directive than a declaration; within a script the identifier (or in C-parlance, lvalue) in the const directive is replaced throughout the script with the value (or rvalue). This leads to limitations on what the value can be, e.g., only a string or number literal can be used as the replacement value.

== Constants defined by keyword 'const' ==

const intVar = temp.val; // will not work, temp.val is not constant
const intVar = 3;
intVar = 4; // will not work
player.chat = intVar; // displays 3

The value of the constant cannot change even in conjunction with the use of the "=" operator. This is the power of a constant. However, player.variables cannot be defined as a constant (client(r).variables, too, possibly). Const only allows literals when assigning values.

A constant may be used most likely to keep a variable that is available to any script from changing its value due to any foreign script interfering. It can also be used to give some cryptic value an easy to understand name, and by putting the const definition at the beginning of the script it can easily be configured.

== Enumeration ==

A special type of constants are enumerators:

enum {
enum0,
enum1,
enum2
};

When you put names in an enumerator list, then it is automatically generating constants by enumarating the names - enum0 will be zero, enum1 will be 1, enum2 will be 2.

enum modes {
IDLE,
WALK
};

By giving a name to the enumerator list you can group enumerations - you can access the constants by modes.IDLE and modes.WALK.

enum {
enum10 = 10,
enum11,
enumstr = "string"
};

You can assign values to the constants like you do for normal constants. It will automatically enumerate the following entries by adding one to the last value, so enum11 will be 11. You can also assign a string value.

Worlds/Zenkou

2011-09-05T19:34:55Z

Tolnaftate2004: updating...

[[Category:Worlds]][[Category:Zenkou]]
{{playerworld}}
{| align="left"
|[[Image:Login_server_zenkou.png]]
|}
== Background Information ==
A tropical paradise server with battle somewhat similar to the Final Fantasies, in that it is turn-based. It is loose-RPG, which simply means RPG is not enforced, though it is an RPG server. The server is grossly understaffed, so if interested in applying for a position on the server, contact Zeon, the manager, or Haro 41, the co-manager.

'''Zenkou''' is a well-anticipated server with much promise. Though styled with the beautiful graphics by Graal's own Haro 41, intriguing scripts, and detailed levels '''Zenkou''' doesn't take it over the top, and overall is unique in its aspects.

== Current Staff ==
=== Management ===
Current Owner and Manager: Zeon 
Account name: MASTERCOLA 
 
Current Co-Manager: Haro 
Account name: haro41
=== Administration ===

Name: pfa 
Account: Tolnaftate2004 
 
Name: KillaBe 
Account: racycle 
''' Applying ''' 
One cannot apply for this position, rather, they must be promoted from a lower development or player-relations position.

=== Scripting Team ===
Current Scripter General: pfa 
Account name: Tolnaftate2004 
''' Others ''' 
Name: none 
Account: none 
''' Applying ''' 
*One must have a good knowledge of the following:
** Scripting, GS2 required
** RC and NC, though we're not particularly stingy about this
** Graal's internal workings, or good-enough theories thereof
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere
=== LAT / Levels Team ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: *lavaman 
Account: lavaman 
''' Applying ''' 
* One must have a good knowledge of the following:
** The tileset, particularly, Zenkou's
** Detailing, good, but not over-the-top
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere

=== Gani Team ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: none 
Account: none 
''' Applying ''' 
* One must have a good knowledge of the following:
** Graalshop, both movie and standard development
** .gani text-file syntax
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere
=== GAT / Graphics Team ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: none 
Account: none 
''' Applying ''' 
* One must have a good knowledge of the following:
** A graphics program of your choice
** The zenkou style of graphics
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere

=== GP / Z-Police ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: none 
Account: none 
''' Applying ''' 
* Must not be power-hungry, and must not have the tendency to abuse power
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere

=== FAQ / Z-FAQ ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: none 
Account: none 
''' Applying ''' 
* Must not be power-hungry, and must not have the tendency to abuse power
* Must have a good knowledge of the following:
** Geography and location of buildings, and other landmarks
** Use and effects of weapons
** Storyline and gameplay
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere

To apply, contact Haro, Zeon, pfa or the head of the department you wish to join.
{{stub}}

Cross Product

2007-12-13T22:01:54Z

Tolnaftate2004: /* General Application of the Cross Product */ Spelling

The Cross Product is a property of [[Vectors|vectors]]. The cross product takes two vectors and returns a third, which is perpendicular, or orthogonal, to the passed vectors. This vector is referred to as the normal vector, which normally is corrected to have a total magnitude of one in mathematics.

== Definition ==
If vectors u and v are crossed ("u cross v"), the magnitude of the normal vector is equal to |u||v|sin(θ). Thus,
|u × v| = |u||v||sin(θ)||'''n'''|
|u × v| = |u||v||sin(θ)|
In other applications, this magnitude has been found to be equal to the area of the parallelogram whose vertecies are at '''0''', '''u''', '''u'''+'''v''', and '''v'''.

In addition,
u × '''0''' = '''0'''
u × v = -(v × u)
(ru) × (sv) = (rs) u × v (where r and s are scalars)

== General Application of the Cross Product ==
It is common practice in mathematics to write vectors as sums of the unit vectors, '''i''', '''j''', and '''k'''. These each have a magnitude of one and, from the origin, move precisely 1 unit on the x, y, and z axes respectively.

Say, then, that we have two vectors, u and v.
u = <u1,u2,u3>
v = <v1,v2,v3>
We can rewrite these vectors in terms of '''i''', '''j''', and '''k'''.
u = u1'''i''' + u2'''j''' + u3'''k'''
v = v1'''i''' + v2'''j''' + v3'''k'''
We can then "multiply" them in an algebraic manner.
u × v = (u1v1)'''i''' × '''i''' + (u1v2)'''i''' × '''j''' + (u1v3)'''i''' × '''k''' + (u2v1)'''j''' × '''i''' + (u2v2)'''j''' × '''j''' +
(u2v3)'''j''' × '''k''' + (u3v1)'''k''' × '''i''' + (u3v2)'''k''' × '''j''' + (u3v3)'''k''' × '''k'''
We can remove immediately any terms where the vector is crossing itself. The angle between two parallel vectors, a and b, is 0, thus a × b = |a||b|sin(0)|n| = 0 . So, the above statement simplifies to

u × v = (u1v2)'''i''' × '''j''' + (u1v3)'''i''' × '''k''' + (u2v1)'''j''' × '''i''' + (u2v3)'''j''' × '''k''' + (u3v1)'''k''' × '''i''' + (u3v2)'''k''' × '''j'''
Because the cross product reflects the normal vector, the following hold:
i × j = -(j × i) = k
j × k = -(k × j) = i
k × i = -(i × k) = j
Then, we can simplify our equation further:
u × v = (u1v2)'''k''' + (u1v3)(-'''j''') + (u2v1)(-'''k''') + (u2v3)'''i''' + (u3v1)'''j''' + (u3v2)(-'''i''')
= (u2v3-u3v2)'''i''' + (u3v1-u1v3)'''j''' + (u1v2-u2v1)'''k'''
= (u2v3-u3v2)'''i''' - (u1v3-u3v1)'''j''' + (u1v2-u2v1)'''k''' (u-components are in order)
This describes the direction of the normal vector to the vectors u and v. This sum can be expressed in [[Matrix|matrices]]
<table>
<tr>
<td>        =</td>
<td>
<table frame="vsides" style="border: 1px solid black;">
<tr>
<td>u2</td>
<td>u3</td>
</tr>
<tr>
<td>v2</td>
<td>v3</td>
</tr>
</table>
</td>
<td>'''i''' - </td>
<td>
<table frame="vsides" style="border: 1px solid black;">
<tr>
<td>u1</td>
<td>u3</td>
</tr>
<tr>
<td>v1</td>
<td>v3</td>
</tr>
</table>
</td>
<td>'''j''' + </td>
<td>
<table frame="vsides" style="border: 1px solid black;">
<tr>
<td>u1</td>
<td>u2</td>
</tr>
<tr>
<td>v1</td>
<td>v2</td>
</tr>
</table>
</td>
<td>'''k'''</td>
</tr>
</table>
<table><tr><td>        =</td><td><table frame="vsides" style="border: 1px solid black;"><tr> <td>'''i'''</td><td>'''j'''</td><td>'''k'''</td> </tr><tr> <td>u1</td><td>u2</td><td>u3</td> </tr><tr> <td>v1</td><td>v2</td><td>v3</td> </tr></table></td></tr></table>

== The Cross Product in GraalScript ==
The cross product of two vector arrays in Graal can be obtained through the vectorcross({{graycourier|u}},{{graycourier|v}}) function. It's return value is a vector, w1'''i''' + w2'''j''' + w3'''k''', where the vector w is calculated from the determinant of the above [[Matrix|matrix]].

News/2007/November

2007-11-29T05:03:43Z

Tolnaftate2004: /* November */ "Utopian" sounds like "Yutopian", hence, "a Utopian"

=== November ===

* '''November 26th''' - '''Doomsday!''' {{News/Playerworlds}}

Doomsday is back! Yes! Doomsday IS BACK!

For those of you who remember Doomsday, you can relive it, and also those who missed the legendary Doomsday era, you can relive it with the full experince because we have the same EXACT overworld!

Although this is a GREAT moment of Graal, with the return of one of the greatest servers ever, WE NEED STAFF! We are hiring GFX staff, Gani makers and scripters.
HELP BRING BACK A LEGACY!

* '''November 25th''' - '''Utopia!''' {{News/Playerworlds}}

Hello all Graalians, Utopia is on its way! Utopia was origionally created a long time ago, but now it is here because of Ork and Chris Zakuto! Come one come all to Utopia! Utopia has alot of Releases, and stuff that is Under construction. so come along to play with friends and become a Utopian!

[[Image:utopialogo.png]]

* '''November 24th''' - '''Zone Snow Race!''' {{News/Zone}}

We have released the new snow race map and did several events for winning small and big items. You can take either part to have fun beating other players by foot, with hover bike or mech, or get Zone Gold and win an item by being the first in one of the 11 different race tracks. Thanks to Dan for creating this new event.

[[Image:Screenshot_zonerace.png]] People lining up at the race start

[[Image:Screenshot_zonerace2.png]] Mech event finish

* '''November 22nd''' - '''Happy Thanksgiving!''' {{News/Zone}}

Happy Thanksgiving to all Graalians! On Zone, for this delicious holiday, we give you delicious cake! Buy them at the traders and throw them at your friends! And come back on Saturday to take part in the new Snowrace event!

* '''November 3rd''' - '''7 New Zone Medals''' {{News/Zone}}

Come online and get 7 more medals! They show up in your profile. Hints: 4 of them don't require you to kill someone, one is only available in Iricia, one in Guild Wars map, and one only requires one hard to get kill.

* '''November 1st''' - '''Ol' West is Getting Some Work Done!''' {{News/Playerworlds}}

[[Image:Olwestcoming.png|Ol' West]]

Yep, Ol' West is getting some work done! Mag has returned and he's been working hard on the factions system and a new bullet-showing system, as shown in the picture. He can't finish the factions, though, mainly due to the lack of LATs. Log on Ol' West for more info, or to just have some fun.

Creation/Dev/Releases/Client/5.006

2007-10-17T04:27:30Z

Tolnaftate2004: /* GUI */ & -> &amp; to show HTML code.

==Release date==

July 13th 2007 for Mac, Linux and Windows. This is the first public version of v5.

==New Features==

===General===

* improved external playerlist (Windows):
** the external playerlist is now working on the login server
** you can dock it to the left or right side of the desktop
** you can show/hide it individually from the main Graal Window
** shows a tray menu icon for displaying incoming PMs
** fixed problems with the transparency of some head icons
** displays the head on Kingdoms and Zone
* PMs are now always using the internal scripted PM window
** prevents problems with javascript exploits inside PMs
** allows us to improve and customize the PM window in the future (since it is scripted)
** prevents problems with missing dlls on some Windows installations
* new log window:
** on Windows it is using the internal log window
** it is using several different tabs which only display log messages for files, scripts, sounds etc. instead of displaying everything in one huge log
** optimized to not lag when the window is not visible
* the Graal window is snapping to the desktop border when moved near the border
* the profile window on Windows is resizable now
* the in-game option window and profile window on Linux/Mac are resizable now
* improved the login to servers:
** it shows a message "Connecting to ..."
** the login to servers using GS2 is much faster
** it is directly connecting to the login server instead of displaying the start screen first
* when a PM from a npcserver is received and the PM history for it is more than 100k bytes then the history for it will be deleted, for preventing too huge files (many servers send a welcome message each time you login)
* files that contain "bomy" or start with "b_" are no longer saved into levels/bomys (requested by the Graal2001 developers)
* Linux packaging:
** it is possible again to start graal by just typing "graal" on the command line (instead of typing "graalexe")
** SDL is not used anymore, which fixes some problems with the keyboard input (key repeat)
* drastically reduced the memory taken by scripts and the scripting engine
* the setup is not scanning the current folder anymore, so it's starting much faster when being downloaded to the temporary internet folder and started from there
* improved protection against memory hacking
* for saving screenshots it is now using the internal file dialog instead of the Windows file dialog which often made problems with messed up Windows installations (missing dlls)
* the Graal executable is signed, so it's easier to check that it hasn't been modified, and advanced Antivirus-programs don't complain anymore when Graal is updating

===Translation System===

* the client is now multi-language again: it is using the translation file format .po like on Graal Kingdoms
** you can find the files in translations/*.po (requires you to run the setup to see the files) and you can add new files if you want to translate the Graal interface into other languages (right now only German-de and French-fr are provided beside English)
** to start a new translations copy gui_en.po to gui_DOMAIN.po and guiwindows_en.po to guiwindows_DOMAIN.po (domain can be en,fr,de,pt,es etc.)
** po files can be edited either with text editor or a specialized po-editor like poedit.net
** as encoding use ISO 8859-15 (or ISO 8859-1 or Windows codepage 1252)
* the new client-side language support can also be used on servers with GS2:
** create a .po file on the serverside and make it downloadable, the filename must end with "_de.po" if it is a german translation, "_fr.po" if it's a french translation etc.
** on client-side load the translation with the command loadtranslation(file) - that will download "file_DOMAIN.po" depending on the players language
** in scripts you can use the translated strings with the script function "_()" (it is very short for easy usage) - that call will return the translation if one is existing, otherwise the original text
** it is planned in the future that an RC command is added which let's you easily generate a blank po file based on the occurances of _() in the scripts, for that also use the function N_() which is not changing the text, but is marking the text for being included in the scan (for text that you don't want to translate immediately)
** if the player is connecting for the first time then the translation might not be downloaded yet, thats why there is an event onTranslationUpdated(file)
** when the player changes the language in the options then an event onPlayerLanguageChanges(playerobject) is invoked, the same like on server-side
*** on clientside the playerobject is always the local player (there is no event yet when other people change their language)
*** it is recommended to update the text on GUI controls when the language changes

===GUI===

* GuiControl:
** added function clearControls() for removing all controls[] at once
** you can make controls easily alpha-transparent or color them by accessing the following attributes:
*** red (0..1)
*** green (0..1)
*** blue (0..1)
*** alpha (0..1)
*** color (for changing all color attributes at once, format is {0..255,0..255,0..255,0..255})
*** mode (0 - add, 1 - alpha transparent, 2 - subtract, 3 - daynight effect)
*** this will also colorize the sub-controls or make the sub-controls alpha-transparent
*** if sub-controls don't want to be made transparent then use an alpha value greater than 1 (e.g. 10)
** the attribute "clipmove" is now also taken into account when resizing the control - by default the engine is making sure that you don't move a control out of the parents bounds, by setting clipmove = false that check is disabled
** fixed problems with the onShow/onHide events, they are now invoked when a control is becoming actually visible or invisible on the screen (corresponding to control.isActuallyVisible())
** you can let controls "flicker" by setting flickering = true;
*** you can change the flicker interval by setting "flickertime"
*** let controls flicker non-synchronized by setting "flickerbasetime" to a random value
** added attribute "hinttime" (by default 0.5 seconds) which says after how much time of the mouse not moving the hint will be shown
** fixed problems with centered GUI-controls (horizSizing = "center", vertSizing = "center") which are now correctly centered when added, not only when the parent control is resized
** fixed odd resizing of the parent control when a child control uses horizSizing = "left" and x is below 0, or vertSizing = "top" and y is below 0
** new script event: onFirstResponderChanges(newfirstresponder) is invoked when the input focus switched to another control
** fixed some problems with added controls receiving the input focus even if they shouldn't
** onKeyDown() and onKeyUp() now give an exact keycode as first parameter which includes modifier keys
*** modifier values are 0x100 for shift, 0x200 for control key, 0x400 for alt key
*** you can check e.g. for control key by if ((keycode & 0x200)!=0)
** added support for dragging files from files explorer to Graal GUI controls to expand the functionality of scripted RC and level editors:
*** set control.acceptdropfiles = true
*** once the user drops a file on the control an event controlname.onDropFiles(mousexpos,mouseypos,files) will be invoked, parameters are the mouse x and y positions and an array of filenames (with at least one file in it, but can be more than that)
*** to let the scripted RC upload the file call uploadFile(filename)
*** if you script editors, then you can use this to let the user place graphics or gani files in the level or editor space
*** this is currently working on Windows and Linux (where it only shows the drop-icon when the control under the mouse is actually accepting the files)

* GuiFlash:
** accepts urls (on Windows) for displaying videos and similar
** if you want the file downloaded instead of streamed, set downloadWebfiles=true;
** the position of the flash control is correctly updated when the parent control is moving
** flash controls can be partially clipped (e.g. be inside a scroll control)
** flash controls work on Linux
*** it is automatically checking for libflashplayer.so in the firefox or mozilla plugin folder
*** web videos are currently not working
** some attributes have been renamed, but the old variant is still work: use "tryplugin" instead of "tryactivex" and "requiresplugin" instead of "requiresactivex"
** when the parent control is hidden then the flash control will be hidden too

* GuiContextMenuCtrl:
** correctly draws the icon even if an entry has no text
** updates the icons when an image drawn on the icon has been downloaded
** readded attribute "maxpopupheight" which limits the height of the menu for preventing the menu from covering the whole screen (also works for GuiPopUpCtrl and GuiPopUpEditCtrl since they are using a GuiContextMenuCtrl for displaying the menu)
** new function openAtMouse() which opens the menu at the mouse position, use this if possible instead of open(x,y)

* GuiPopUpCtrl:
** when closing a combo box (GuiPopUpCtrl) or similar then it is not wrongly switching the focus to the next control anymore

* GuiScrollCtrl:
** added functions scrollToTop() and scrollToBottom() which simply call scrollto(0, 0) and scrollto(0, 0x7fffffff)
** added checks for HOME and END key for scrolling to the top or to the bottom
** when profile.bitmap is updated (or the file is updated) then the size of the up/down button and scroll bar are updated

* GuiMLTextCtrl:
** added html-tag <blink>blinking text</blink>
** added support for ampersand character codes like &amp; which displays a "&"
** fixed a problem with two new lines adding a space in front of the line (when they should be ignored)
** fixed a problem with lists (ul-tag) not being correctly indented
** fixed a problem with scrolling back to the last click position when resizing the control when it's inside a scroll control (only supposed to happen for GuiMLTextEditCtrl)
** set "htmllinks = true" if you want Graal to automatically open a webbrowser when clicking on a link
** scrollToTag(tagname) accepts tagnames starting with "#" (it will automatically remove the "#" to match the tag names)
** better compatibility for the "size" attribute inside "font" tags:
*** when the size is between 1 and 7 then it will use HTML-compatible font sizing (1 - small, 3 - default size, 7 - large text)
*** when size is above 7 then it will still use it for the exact font size for compatibility with existing Graal scripts
** fixed problems with breaking words at the end of the line
** html comments  are ignored now, as well as several non-supported tags (form, head, label, object, select)

* GuiTextListEntry:
** added "flickertime" (by default 1 second) which specifies the flicker interval of the icon of the list entry
** easier selection of multiple entries via keyboard: you can now use the Home and End keys and select several entries by pressing Shift and moving the cursor keys

* GuiTextEditSliderCtrl:
** support for floating point ranges (e.g. range = {0.1,1}), to display floating point values set format = "%.1f" or similar

* GuiTextEditCtrl:
** fixed resizing problems when horizSizing is "width", it is not allowing anymore that the parent control is made smaller and messing up the size of the text edit field

* GuiWindowCtrl:
** new attribute "clientrelative" - if enabled then sub-controls are positioned automatically to not overlap the header or the borders;
*** use clientwidth and clientheight to get the available space for sub-controls
*** this allows to use different GUI styles/profiles without manually updating the position of sub-controls
*** clipping is only done for left, right and bottom side to allow placing of custom buttons on the title bar
** new function isActiveWindow() to know if this is the currently selected window (top window in the list of its parents children) and is drawn highlighted
** a window is activated / put on top of the other windows when you click with the mouse on a sub-control (previously you needed to click on the window title for that)

* GuiSliderCtrl:
** the slider can be moved by keyboard (Up/Left for reducing the value, Right/Down for increasing the value, Home and End for jumping to the minimum or maximum value)
** the position of the thumb is automatically updated when the control is resized

* GuiCheckBoxCtrl:
** draws the graphics for the pressed-state also when the mouse is over the control, for improving the look

* GuiButtonCtrl (also GuiCheckBoxCtrl, GuiRadioCtrl):
** added support for hot-keys: if the button text contains a "&" then the following character will be underlined and the button will be activated when that key is pressed, e.g. you can activate a button that has the text "&Close" by pressing 'C'
*** use "&&" if you just want to display a "&" without the hot-key function
** improved the support to navigate the GUI via keyboard:
*** buttons, tabulator buttons, check boxes, radio buttons, combo boxes (GuiPopUpCtrl) and sliders are now by default tabable which means that you can move the focus to them by pressing the Tab key (if the window has the input focus)
*** when a button, check box or radio button has the focus then you can move the focus to the next or previous control by pressing up/left/down/right (e.g. scrolling through a list of buttons)

* GuiShowImgCtrl:
** fixed clipping of GuiShowImgCtrls which use "text" - you need to specify width, height, offsetx and offsety if you don't want to have the text clipped (especially needed when you use style "c" for centered text or "r" for right-aligned text)

* GuiInputCtrl:
** Linux/Mac: fixed a problem with GuiInputCtrl capturing the focus on creation even if it's not visible

===Graphics===

* Video capture:
** press Alt+6 for recording videos, configure it in the options
** the video is saved in the Graal folder under videos/ (*.avi format)
** it is currently saving uncompressed and without sound
* Easy skinning of GUI controls:
** set GuiControl.style to "mytheme.wba" or "mytheme.zip" for skinning controls
** it will replace the graphics and colors for most controls, except the font size/style
** use the new attribute "clientrelative" for GuiWindowCtrl for making them compatible with different styles without needing to reposition the sub controls
** known problems:
*** not all styles look perfectly yet
*** when switching between styles that use the same name for graphics then it might still show the graphics from the old style; restart the game to fix that
*** some controls still use the font type and size defined in the regular GUI profiles (control.profile)
** there are new GUI controls for using taskbar skins:
*** GuiTaskBar - displays a bar with space for a start button on the left side, 'task'-buttons in the middle, and a tray or time display on the right side; if the control is not using any 'style' then it will look like a normal GuiControl
*** GuiStartMenuCtrl - similar to a GuiContextMenuCtrl, but displays a bigger menu like the Windows start menu
*** GuiButtonCtrl.stylesection - buttons can be skinned, by changing 'stylesection' you can specify what look the button should use, e.g. "Taskbar.StartButton", "Taskbar.ButtonHorz"
* players and npcs can be made transparent - you can now use the same attributes like for showimgs/findimgs for setting red,green,blue,alpha and mode
* fixed a bug with reading pngs that had a bad palette size
* added support for 1-bit pngs
* when an image is downloaded from the web and doesn't have a known file extension then the engine is trying to guess the file type by reading the content and displaying it correctly in most cases
* when a web image is not existing then it is printing an error in F2 now and is not saving the data returned by the webserver anymore
* Windows version graphics:
** printing an error in the F2 window when the graphics card is out of video RAM (some images will not appear then)
** trying to free all possible resources when the graphics card is out of video RAM to reduce that error
** when loading images the engine is cutting out all fully transparent parts to minimize the use of video memory
** fixed some problems with icons and classic bodies not refreshing or not displaying
* Linux/Mac version graphics:
** optimized the usage of graphics - it is using directly 8-bit palettized images with OpenGL and for tile drawing (before: always converting to 24 bit or 32 bit)
** smoother drawing of stretched images (like in windows version)
** improved font system which is more compatible, better looking and taking less ressources
* Text drawing: right-aligned italic text is shifted 2 pixels to the left to prevent clipping problems
* Improved support for bmp:
** fixed a bug in the bmp reader so that bmps with odd width or height are correctly displayed
** support for 32 bit bmps
** not crashing on unsupported formats
* particles support text shadow (emitter.particle.textshadow, shadowcolor, shadowoffset)
* Linux/Mac: the scripted effects can be turned off directly in the options now (that only works when servers support those options)

===Sounds===

* playlooped() is updating the volume each time it is called depending on the distance to the player
* music files are now played non-looped by default when using the play() command, use playlooped() if you want to play a looped music or stream
* when the volume is zero then wavs and mp3s are not downloaded anymore
* downloaded wav files are automatically played (with the right volume and looping if requested)
* when a music file (mp3, midi etc.) is played but is not existing yet then it is automatically played once it is downloaded
* on Windows XP/Vista 64 bit it is by default not trying to use sounds because it freezes Graal, you can turn off this behaviour by setting "tryloadsoundson64bit=true" in the Graal options file - open game_config.txt with Wordpad

===Scripting===

* correct class loading on clientside - onCreated() will be called on the joining object once the class has been downloaded from the server
* Full support for client-side classes:
** caching of classes
** when a class is downloaded then the script is suspended while downloading
** when calling a function of an object which is waiting for classes then the calling script will be suspended until it is loaded (to avoid errors with missing functions)
** you can pre-load classes by calling loadclass(classname)
** you can check if a class is loaded with isClassLoaded(classname)
** when a class is downloaded from the server then an event onClassLoaded(classname) will be invoked
* class-scripts are deleted from memory when switching servers
* script function: obj.addArrayMember(name) adds an array member with a name, returns the added object so that you can easily add sub variables
** use obj.getArrayMember(name) to find a named array member (the first occurance in the array)
* the script function isObject(objectname) is working better - checks if the variable exists, and if it's a static variable (GUI, TStaticVar etc.), is an array, or is linking to some other variable - before it was only checking if a global variable with that name exists;
** if you want to check if that variable is actually a static object, then check var.objecttype()!=2
* added function obj.clearVars() which removes all dynamic sub variables, it doesn't send deletion of client. vars and similar yet though
* added script variable obj.scripterrors which gives the list of errors reported for the object, e.g. "Function func not found"
* New script function getFileModTime(filename)
** gets the time of the last modificatin of a file
** it's using unix time which is compatible to timevar2 (seconds since 1970-01-01)
** accepts both exact file path and plain file name
* When a script function is requiring more parameters than provided then the error message is also displaying the object type (not just the function name)
* obj.getfunctions() also lists functions contained in joined classes
* new script function object.hasfunction(functionname) - tells if the object has the specified function and can be called
* Added support for function objects:
** this will print "param: 123"
function onCreated() {
this.func = this.func1;
this.func(123);
}
function func1(param) {
echo("param: " @ param);
}
** You can also do this, but keep care to add a semicolon behind the function declaration:
this.func = function() {
echo("nameless function");
};
** There is a protection against unsetting functions, since often scripts use the same name for functions and variables. If the variable is not linking to a function but the script contains a function with that name, then it will use the function defined in the script instead. You can however link to another function.
* You can now create empty arrays simplier by doing "var = {};" (it was displaying a syntax error before)
* when array members are updated then printing the array will correctly show the updated state (in most cases)
* New script command object.loadini(inifilename) for loading an ini file into a variable; you can access the variables by object.inisection.varname
* added script functions findnearestplayer(x,y) and findnearestplayers(x,y) on clientside, also getnearestplayer(x, y) and getnearestplayers(x, y) (which return indices instead of objects)
* keydownglobal(0..10) has been fixed - with this function you can check the status of the default keys (which also use joystick input) even when some GUI control has the input
* added a way to increase the loop limit for scripts: obj.maxlooplimit = 100000; will increase the number of maxmimum allowed loop iterations for the object to 100000 (default 10000)
** if you have some script that is sometimes requiring more than 10000 loop iterations then this helps to prevent problems
** the allowed range for maxlooplimit might be restricted on some servers though
* scripts can access image files; currently supported file extensions:
.txt,.rtf,.htm,.html,.xml,.nw,.gani,.gmap,.gupd,.hfl,
.cs,.gs,.arc,.dat,.css,.ini,.uis,.png,.mng,.gif,.jpeg,
.jpg,.jp2,.bmp,.bm8,.tga,.dds
* scripts can read files from the updatepackages/ folder and tileobjects/ folder (tileobjects contain files required for the scripted editor)
* it is finally possible to replace sprites.png and state.png by script:
** GS1: setspritesimage filename; setstatusimage filename;
** GS2: setspritesimage("filename"); setstatusimage("filename"); or use the global variables spritesimage or statusimage
** those images will then be used to draw the default classic GUI (state.png) and default sprite effects like when carrying a bush or swimming (sprites.png)
** the images will be reset to the default value when switching a server
* fixed some problems with weapons when switching from GS1 to GS2: because weapons are basicly npcs, some built-in variables like 'hp' were protected, but since the weapons are not really requiring those they have been removed now, so you can use them as normal variables again (e.g. this.hp = 50.2; );
** the built-in variables that were removed are:
alpha, ani, aniparams,
anistep, blue, green, mode, gmap, height, hp, maxhp, red, rotation, stretchx,
stretchy, width, zoom
* new function for detecting if the game is currently in fullscreen mode: isfullscreenmode() returns true or false; it is also possible to switch to fullscreen mode or window mode, but only for authorized scripts
* it is now possible to trigger npcs from clientside using the triggerserver() function:
** triggerserver("npc",npcname,params) is invoking an onActionServerSide(params) event on the server-side
** it works even if the player is not near the npc (so you need to check that if required)
** to use this in GS1 you need to do triggeraction 0,0,servernpc,npcname,params; and check for "if (actionserverside)" in the triggered npc
* improved support for displaying flash resources in Graal:
** in showimgs/findimgs and GuiShowImgCtrl you can set flashfile = "name.swf" and then access the attributes by the variable "flash"
** fixed some major compatibility problems
** gradient brushes are correctly handled and displayed
** it is possible now to list all available flash resources of a file by displaying flash.objectnames
** display the number of frames: flash.framecount
** you can also set the frame number of sub objects: do flash.objectname = "clipname", flash.object.frame = subframenumber you can change the color of the flash resource (by setting red,green,blue,alpha of the showimg)
** correct scaling when the GuiShowImgCtrl is inside a GuiStretchCtrl (or the showimg is displayed in the gani script of a scaled player/npc)
** you can access the layers (depths) of the flash movie with flash.getLayer("name" or index), and then change red,green,blue,alpha (or 'color' for changing all at once) and frame or even access sub-layers, use flash.layernames to get the available names
** resources (meshes, gradient textures) are removed from memory after a few seconds of non-usage
* improved the support for moving and resizing the GraalControl so that other controls can be placed in the game window without hiding parts of the game
* when using string.tokenize(delimiters) and the delimiter is new line ('\n') then it is also skiping line feeds ('\r') which are in front of new line, which makes it easier to read DOS/Windows formated texts
* new player attribute player.communityname which displays the name the player is using for the forums etc.
** by default players have now an account name which is basicly just a number (Graal12345) and can later register a communityname which is then used for the fourms, wiki etc.
** on the playerlist and PMs it will display the community name instead of the account name, scripts are supposed to do the same
* for improving the playerlist and similar things it is now possible to force the gserver to send player attributes (#P/player.attr[]) to all players on the server instead to only people that 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
* getstringkeys(variablenamestart) is now also returning the names of sub variables which are empty but have themself sub-variables
* added player.mapicon which is used for drawing the head on the map and mini-map, this is usually updated by the playerlist script
* TDrawingPanels (icons) have a new attribute: icon.isclear says if the icon is empty (no drawing operation done yet or everything cleared with clearall())

==Bug Fixes==

* General bugs
** fixed a problem that crashed the client on serverswitch when still having PMs on the player list from players that already logged out
** when downloading files with the scripted RC into the Graal folder then it is using the correct path and is not moving the file to the level/images/download folder anymore
** fixed a problem with defaultmovement where the player was not moved on the map when the player was moved by script
** on vista it doesn't display a runtime error when you close the program anymore

* Script engine bugs
** fixed the script garbage collector (deleting unused/unlinked TStaticVar)
** showimgs/findimgs that are attached to the player via attachtoowner=true are correctly synchronized to the player position (and don't lag behind)
** hideimg() is not crashing the engine anymore if it contains gani scripts
** the destroy() function for GuiControls and TStaticVar are not causing crashes anymore, but the objects are disappearing from scripting so you can correctly recreate them
** fixed a problem with the random function - int(random(0,upperlimit)) was sometimes returning 'upperlimit' due to rounding if a floating point value is very close to an integer value - the random() function is now preventing that the result is identical to the upper limit
** fixed a script problem where "-" was seen as number (-1)
** fixed a crash when returning a temp. array from a suspended function (sleep/waitfor in a public function)
** fixed the modulus operator 'a % b' for the case that a is negative and b is high number (>10000), previously it was giving a negative number which should not happen (-3 % 100000 should give 99997)

Vectors

2007-10-11T02:45:06Z

Tolnaftate2004: /* Vector Length (Magnitude) */ Magnitude == Modulus

'''Vectors''' are mathematical representations of any thing that has a length, or magnitude, and direction. Positions are also described using vectors which start at the origin of the coordinate system (0,0,0).

== Definition ==
In GraalScript, a vector is limited to three dimensions, however, mathematics allows for analyses of vectors in n-dimensions. Vectors do not have positions. Two vectors are said to be parallel if they have the same direction (u || v), and are said to be equal if they are parallel and have the same magnitude (u = v). Vectors are generally described by their terminal points with respect to the origin (0,0,0).

The basic format of a vector in GraalScript is {x,y,z} where x, y, and z are all floating points in reference to the axis to which they correspond. Built into GraalScript are several functions which can be used to analyze these vectors.

In mathematics, vectors are often written
v = <v1,v2,v3>
for a vector in three dimensions. They can also be written as the sum of unit vectors, i = <1,0,0>, j = <0,1,0>, and k = <0,0,1> on the x, y, and z axes, respectively. In this case, the vector would be written as
v = v1i + v2j + v3k
where the values of v are treated as scalars (numerical multipliers) of the unit vectors.

To denote the difference between a scalar and a vector, vectors are often written with a directional arrow above them, which looks like the top half of an arrow pointing right. In GraalScript, a scalar and a vector are impossible to confuse: a scalar is a floating point whereas a vector is a string.

=== Vector Length (Magnitude/Modulus) ===
Being as vectors are merely written by terminal point coordinates, there is no immediate way to determine the magnitude of the vector. Mathematically, the terminal point lies on a sphere that has the same radius as the vector's magnitude. Thus, we can use the equation of a sphere to calculate the magnitude. 
r2 = x2 + y2 + z2 
r = √(x2 + y2 + z2)
where r is the magnitude. Generally, the magnitude is denoted as |v| or ||v||. This was chosen, because absolute value refers to distance from the origin, thus the marks were suitable. In GraalScript, however, the magnitude of any vector can be calculated simply by plugging a vector string into the '''vectorlen({{graycourier|v}})''' function.

=== Unit Length ===
A vector is said to have "unit length" when it's magnitude is one. '''i''', '''j''', and '''k''' are each unit vectors because their magnitudes are each one. To make a vector of unit length, the vector must merely be divided by it's magnitude.
Let v be a vector and u be the direction (unit vector) of v.
v = <1,7,1>
|v| = √(12 + 72 + 12) = √51
u = v/|v| = <1/√51,7/√51,1/√51>

Graalscript has a built-in function, '''vectornormalize({{graycourier|1=v}})''',to perform such a calculation.

== Vector Modification ==
Along with vectorlen are a plethora of functions built into GraalScript all for the purpose of modifying vectors.

=== Vector Addition ===
[[Image:Vectors-addition.png|thumb|right|Vector addition]]
Given the vectors u and v, we could create a third vector that has the magnitude of u and v, were the two vectors to be placed tip-to-end. This is called vector addition and can be done with the function '''vectoradd({{graycourier|u}},{{graycourier|v}})'''. This takes the terminal coordinates and adds them together. to make a new vector: 
w = <u1+v1, u2+v2, u3+v3>.
 

=== Vector-Scalar Multiplication ===
[[Image:Vectors-scalar-multiplication.png|thumb|left|Vector-scalar multiplication]]
With a vector, v, and a scalar, s, we could make a new vector that is s times larger than v. This can be accomplished in GraalScript with the function '''vectorscale({{graycourier|v}},{{graycourier|s}})'''. The vector is thus extended in the following manner: 
s·v = s·<v1,v2,v3> = <s·v1,s·v2,s·v3>.
 

=== Vector Subtraction ===
[[Image:Vectors-subtraction.png|thumb|right|Vector subtraction]]
With these two properties, we find that vector subtraction is possible, and no longer a new idea. This is done in GraalScript with the use of the '''vectorsub({{graycourier|u}},{{graycourier|v}})''' function. 
u-v = u + (-v) = u + (-1)·v
You can imagine this as the two vectors placed tip-to-end, but the second is facing the opposite direction.
 

=== Distance Between Terminal Points ===
Without creating a third vector, it is simple in GraalScript to find the distance between the two points at which two vectors end. This function is '''vectordist({{graycourier|u}},{{graycourier|v}})'''. 
The return value would be
√((u1-v1)2+(u2-v2)2+(u3-v3)2)
The mathematical operation is the pythagorean theorem (or a combination of two). As may be evident, the distance is the magnitude of '''u'''-'''v'''.

== Other functions ==
vectordot({{graycourier|u}},{{graycourier|v}}): see [[Dot Product]]. 
vectorcross({{graycourier|u}},{{graycourier|v}}): see [[Cross Product]].

Euler Rotation

2007-10-09T19:33:15Z

Tolnaftate2004:

== Definitions ==
Euler - Pronounced Oiler; discovered that as 1 is continuously compounded, it reaches a number, ''e''. However, Euler rotation is taking a 3-dimensional axes set and rotating them about the z-axis followed by a forward or backward rotation to create a new axes set.
For objects that inherit the property 'eulerrotation', the format is supposedly "Δ''α'' Δ''β'' Δ''γ''". Read further for a better explanation.

''θ'': greek letter ''theta'' 
''φ'': greek letter ''phi'' 
''theta'' and ''phi'' are commonly used in trigonometry for angles (but phi is most commonly used as a constant: 1.618...). 
''α'': 1st greek letter ''alpha''. For our purposes, it will represent The angle between the original x axis and the normal vector(1). 
''β'': 2nd greek letter ''beta''. For our purposes, it will represent the forward or backward "tilt". 
''γ'': 3rd greek letter ''gamma''. For our purposes, it will represent the angle between the normal vector(1) and the new x axis. 

Therefore, images and text could be rotated, something that could not be done before, so that said image or text would have a three-dimensional effect. If all said is true, eulerrotation = "0 -pi/3 0"; for text would project it in a Star Wars-like fashion.

sin(''θ'') = y / ''r'' (Δy of a point from the center on a circle with radius ''r'')
cos(''θ'') = x / ''r'' (Δx of a point from the center on a circle with radius ''r'')
sin(''θ'' ± ''φ'') = sin(''θ'') cos(''φ'') ± cos(''θ'') sin(''φ'')
-cos(''θ'' ± ''φ'') = -cos(''θ'') cos(''φ'') ± sin(''θ'') sin(''φ'')

In addition (not really useful):
tan(''θ'') = sin(''θ'') / cos(''θ'')
cot(''θ'') = cos(''θ'') / sin(''θ'')
sec(''θ'') = 1 / cos(''θ'')
csc(''θ'') = 1 / sin(''θ'')

<hr width="33%" NOSHADE>
(1) The normal vector is the vector perpendicular to the original z and the new z axes. This can be calculated through [[Cross Product|cross product]].

== Rotation Matrices ==
'''Note:''' The following example uses MATLAB notation for the matrix transformation.
[cos(''γ'') sin(''γ'') 0; -sin(''γ'') cos(''γ'') 0; 0 0 1] * ...
[1 0 0; 0 cos(''α'') sin(''α''); 0 -sin(''α'') cos(''α'')] * ...
[cos(''β'') sin(''β'') 0; -sin(''β'') cos(''β'') 0; 0 0 1] * ...
([x0 y0 z0]') = [x y z]'

Talk:Creation/New Player Development Guide

2007-10-04T07:59:07Z

Tolnaftate2004:

== NAT? LAT? GAT? ==

I don't like that we are promoting these age-old names that are sort of dated... Do we have to put those on this page?

These titles are still very commonplace. --[[User:Tolnaftate2004|Tolnaftate2004]] 09:59, 4 October 2007 (CEST)

Worlds/Zenkou

2007-10-04T07:55:47Z

Tolnaftate2004: Both Kirai and Mystic hold an admin position

{{playerworld}}
{| align="left"
|[[Image:Login_server_zenkou.png]]
|}
== Background Information ==
A tropical paradise server with battle somewhat similar to the Final Fantasies, in that it is turn-based. It is loose-RPG, which simply means RPG is not enforced, though it is an RPG server. The server is grossly understaffed, so if interested in applying for a position on the server, contact Zeon, the manager, or Haro 41, the co-manager.

'''Zenkou''' is a well-anticipated server with much promise. Though styled with the beautiful graphics by Graal's own Haro 41, intriguing scripts, and detailed levels '''Zenkou''' doesn't take it over the top, and overall is unique in its aspects.

== Beating a New Path ==
=== GUI ===
'''Zenkou''' has taken the initiative and gone forth to materialized some of the most interesting ideas on Graal. Currently visible are the Graphical User Interface (GUI), originally scripted in GS1 before the release of Graal 3 and the use of GuiControls. It is unique in that it snaps to objects, is draggable, and acted like windows in a window, before it was so easily done. The soon-to-come GUI v4 will be scripted in it entirety in GS2 and will use the new engine to its full potential in making a complex script, as one might imagine it might be, into something more functional and compact.
=== Battle System ===
'''Zenkou''' is proud to present it's up-and-coming attraction, simply referred to as "the battle system." It is a turn-based system resembling that of Final Fantasy, and employs an algorithm in determining the order on a basis of speed. The system is functional and is in the final development stages before being released into the public.
=== Outfit ("Taylor") System ===
A very interesting aspect of the game is the ability to change one's outfit using the Outfit tool, which allows you to preview, save, and delete any outfit that one might want to use. The server does not use the old characteristic-changing method found in other servers' "Taylor" systems, but rather displays it graphically.
=== Mouse-Control ===
'''Zenkou''' is revolutionary in that most of the server can be controlled by mouse click-and-drag. There is not a server out there that can brag the same mouse-control as Zenkou.

== Current Staff ==
=== Management ===
Current Owner and Manager: Zeon 
Account name: MASTERCOLA 
 
Current Co-Manager: pfa 
Account name: Tolnaftate2004
=== Administration ===

Name: Mystic 
Account: MysticX2X 
 
Name: Kirai
Account: -Ching 
''' Applying ''' 
One cannot apply for this position, rather, they must be promoted from a lower development or player-relations position.

=== NAT / Scripting Team ===
Current Head Scripter: pfa 
Account name: Tolnaftate2004 
''' Others ''' 
Name: none 
Account: none 
''' Applying ''' 
*One must have a good knowledge of the following:
** Scripting, GS2 required
** RC and NC, though we're not particularly stingy about this
** Graal's internal workings, or good-enough theories thereof
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere
=== LAT / Levels Team ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: Mystic 
Account: MysticX2X 
''' Applying ''' 
* One must have a good knowledge of the following:
** The tileset, particularly, Zenkou's
** Detailing, good, but not over-the-top
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere

=== Gani Team ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: Hachi 
Account: Bl0nkt 
''' Applying ''' 
* One must have a good knowledge of the following:
** Graalshop, both movie and standard development
** .gani text-file syntax
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere
=== GAT / Graphics Team ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: - 
Account: KMashaneyK 
''' Applying ''' 
* One must have a good knowledge of the following:
** A graphics program of your choice
** The zenkou style of graphics
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere
=== GP / Z-Police ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: none 
Account: none-Ching 
''' Applying ''' 
* Must not be power-hungry, and must not have the tendency to abuse power
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere
=== FAQ / Z-FAQ ===
Current Head Designer: none 
Account name: none 
''' Others ''' 
Name: Nythe 
Account: Akoalin 
''' Applying ''' 
* Must not be power-hungry, and must not have the tendency to abuse power
* Must have a good knowledge of the following:
** Geography and location of buildings, and other landmarks
** Use and effects of weapons
** Storyline and gameplay
* Must be good-humored and good-natured
* Must have an interest in the project - please do not apply if your loyalties lie elsewhere

To apply, contact Haro, Zeon or the head of the department you wish to join.
{{stub}}

Creation/Dev/GScript/Constants

2007-09-07T07:43:26Z

Tolnaftate2004: Sections

As one might be able to deduce, a '''constant''' has a single value and will retain that value as long as that constant exists. A constant is ''not'' a variable for one very important reason: it's value is not variable!

A constant is only accessible in the script where you have defined it, they
are not shared between the server-side and client-side parts either.

== Constants defined by keyword 'const' ==

const intVar = temp.val; // will not work, temp.val is not constant
const intVar = 3;
intVar = 4; // will not work
player.chat = intVar; // displays 3

The value of the constant cannot change even in conjunction with the use of the "=" operator. This is the power of a constant. However, player.variables cannot be defined as a constant (client(r).variables, too, possibly). Const only allows literals when assigning values.

A constant may be used most likely to keep a variable that is available to any script from changing its value due to any foreign script interfering. It can also be used to give some cryptic value an easy to understand name, and by putting the const definition at the beginning of the script it can easily be configured.

== Enumeration ==

A special type of constants are enumerators:

enum {
enum0,
enum1,
enum2
};

When you put names in an enumerator list, then it is automatically generating constants by enumarating the names - enum0 will be zero, enum1 will be 1, enum2 will be 2.

enum modes {
IDLE,
WALK
};

By giving a name to the enumerator list you can group enumerations - you can access the constants by modes.IDLE and modes.WALK.

enum {
enum10 = 10,
enum11,
enumstr = "string"
};

You can assign values to the constants like you do for normal constants. It will automatically enumerate the following entries by adding one to the last value, so enum11 will be 11. You can also assign a string value.

Creation/Dev/GScript/Constants

2007-09-07T07:38:29Z

Tolnaftate2004: Spelling

As one might be able to deduce, a '''constant''' has a single value and will retain that value as long as that constant exists. A constant is ''not'' a variable for one very important reason: it's value is not variable!

const intVar = 3;
intVar = 4; // will not work
player.chat = intVar; // displays 3

The value of the constant cannot change even in conjunction with the use of the "=" operator. This is the power of a constant. However, player.variables cannot be defined as a constant (client(r).variables, too, possibly).

A constant may be used most likely to keep a variable that is available to any script from changing its value due to any foreign script interfering. It can also be used to give some cryptic value an easy to understand name, and by putting the const definition at the beginning of the script it can easily be configured.

A constant is only accessible in the script where you have defined it, they
are not shared between the server-side and client-side parts either.

A special type of constants are enumerators:

enum {
enum0,
enum1,
enum2
};

When you put names in an enumerator list, then it is automatically generating constants by enumarating the names - enum0 will be zero, enum1 will be 1, enum2 will be 2.

enum modes {
IDLE,
WALK
};

By giving a name to the enumerator list you can group enumerations - you can access the constants by modes.IDLE and modes.WALK.

enum {
enum10 = 10,
enum11,
enumstr = "string"
};

You can assign values to the constants like you do for normal constants. It will automatically enumerate the following entries by adding one to the last value, so enum11 will be 11. You can also assign a string value.

Template:Code

2007-09-07T07:34:39Z

Tolnaftate2004:

<includeonly>{| style="border: 1px dashed #000000; border-collapse: collapse;"
|{{{1}}}
|}</includeonly><noinclude>This is for new documentation!

Usage: 
<nowiki>{{code|1=something}}</nowiki></noinclude>

Template:Code

2007-09-04T16:50:33Z

Tolnaftate2004: Hack for linux/mac without courier new font

<includeonly>{| style="border: 1px dashed #000000; border-collapse: collapse;"
|{{{1}}}
|}</includeonly><noinclude>This is for new documentation!

Usage: 
<nowiki>{{code|1=something}}</nowiki></noinclude>

Template:Code

2007-09-04T16:46:02Z

Tolnaftate2004:

<includeonly>{| style="border: 0px solid #000000; border-collapse: collapse; font-family: Courier New,fixed; font-size: 10px; color: DimGrey;"
|{{{1}}}
|}</includeonly><noinclude>This is for new documentation!

Usage: 
<nowiki>{{code|1=something}}</nowiki></noinclude>
{| font-family:monospace
| blah
|}

Matrix

2007-09-04T16:43:04Z

Tolnaftate2004:

A '''matrix''' (''pl.'' matrices) is a list of numbers, generally who have a relationship between them, that are ordered in a type of mathematical array. A matrix, m, may be written as either [m], or (m) in mathematics, where m is a placeholder for the numbers in the matrix.

== Reading a Matrix ==
Typically in math, a matrix is ordered in rows and columns, which are counted by increasing i and j respectively. One can think of a matrix as a 2-dimensional array where each object in the 1st dimension holds an array of numbers in that row.

An entry at i=2 and j=3 is noted by either M[2,3] or m2,3. These numbers are important for some modifications involving these matrices.

In GraalScript, however, matrices are used to perform calculations involving objects that rotate, move, or are scaled. The first three elements in such an array are for position:

{{code|1=
x = m[0]; y = m[1]; z = m[2];
}}
The following three elements are for rotation:
{{code|1=
eulerrotation = m.subarray(3,3);
}}
The final element is angle in degrees:
{{code|1=
temp.angle = degtorad(m[6]);
}}
== Demystifying Matrices in GraalScript ==
If you have ever tested any of the matrix functions built into GraalScript, you may be lost as to where the return value comes from. Well, luckily there are some adept enough with math to understand these fu {{code|1=nctions. These are their findings.

=== matrixcreate() ===
Let '''v''' be a vector and '''a''' consisting of a vector and a scalar.

==== Usage ====
{{code|1=
strMatrix = matrixcreate(v,a);
}}
Where v describes the translation (position) and 'a' describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7 (this will be explained later).

==== Example ====
{{code|1=
temp.matrix = matrixcreate({1,1,1},{1,7,1,1});
// This will return 1,1,1,0.140028,0.980196058,0.140028,7.14595223
}}

==== The Math Behind the Function ====
The first three numbers of the return value should be rather familiar. It is the vector you passed to the function. The other four seem to come out of nowhere. However, there is a method to this madness. The first of these three are merely a property of angles. Because of the [[Dot Product]] of vectors, we are able to calculate the cosine of the angle between two vectors. Well, we have actually created a new vector in this code!

As defined in [[Vectors]], we know that there are three unit vectors that lay on the x, y, and z axes. These vectors have been given the letters '''i''', '''j''', and '''k''', respectively. The first value defined in the "rotation" is multiplied to '''i''', the second to '''j''', and so forth, and this makes a new vector. However, this still does not tell us why we have these numbers returned to us.

From the definition of the dot product, we know that
cos(θ) = uv/(|u||v|)
The first three numbers returned to us are the cosine of the angles between the new vector (in this case, <1,7,1>) and each of our unit vectors. For example:
cos(α) = <1,7,1><1,0,0>/(|<1,7,1>||<1,0,0>|) = 1/√51 = 0.1400280084
cos(β) = <1,7,1><0,1,0>/(|<1,7,1>||<0,1,0>|) = 7/√51 = 0.9801960588
cos(γ) = <1,7,1><0,0,1>/(|<1,7,1>||<0,0,1>|) = 1/√51 = 0.1400280084

''There is an evident difference between the values given here and the return value. A computer cannot calculate cosine on its own. It merely uses a method of estimation.''

cos(α)2 + cos(β)2 + cos(γ)2 = 1 (1)

<hr width="33%" noshade="noshade">
(1) The returned values are accurate within ±10-5

So far, we have 6 of 7 figured out. The last is the simplest of them all. Plugging the new vector into vectorlen() or using √(x2 + y2 + z2) returns it's magnitude. This, multiplied by the fourth number of the second parameter, is the last of the returned values (and as far as anyone can tell the vector passed to the function has no bearing on the return value).

=== matrixcreatefromeuler() ===
Let '''r''' be an array describing rotation, {α,β,γ}.

==== Usage ====
{{code|1=
strMatrix = matrixcreatefromeuler(r);
}}
Where r describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7.

==== Example ====
{{code|1=
temp.matrix = matrixcreatefromeuler({pi/2,0,pi/2});
// This will return 0,0,0,-0.577350258,-0.577350258,-0.577350258,119.999976018
}}

==== The Math Behind the Function ====
'''Coming soon!'''

User:Tolnaftate2004

2007-07-08T23:18:18Z

Tolnaftate2004: /* Documentation */

===Contributions===
====Documentation====
* [[Creation/Dev/GScript/Constants|Constants]]
* [[Creation/Dev/GScript/Changeimgpart|Changeimgpart]]
* [[Creation/Dev/GScript/Requesthttp|Requesthttp]]
* [[Euler Rotation]]
* [[Polar Rotation]]
* [[Vectors]]
* [[Matrix]]
* [[Dot Product]]
* [[Cross Product]]

====Templates====
*[[Template:Graycourier|Graycourier]]
*[[Template:Code|Code]]
*[[Template:Doctitle|Doctitle]]

Euler Rotation

2007-04-21T23:15:24Z

Tolnaftate2004: Note: using MATLAB notation

== Definitions ==
Euler - Pronounced Oiler; discovered that as 1 is continuously compounded, it reaches a number, ''e''. However, Euler rotation is taking a 3-dimensional axes set and rotating them about the z-axis followed by a forward or backward rotation to create a new axes set.
For objects that inherit the property 'eulerrotation', the format is supposedly "Δ''α'' Δ''β'' Δ''γ''". Read further for a better explanation.

''θ'': greek letter ''theta'' 
''φ'': greek letter ''phi'' 
''theta'' and ''phi'' are commonly used in trigonometry for angles (but phi is most commonly used as a constant: 1.618...). 
''α'': 1st greek letter ''alpha''. For our purposes, it will represent The angle between the original x axis and the normal vector(1). 
''β'': 2nd greek letter ''beta''. For our purposes, it will represent the forward or backward "tilt". 
''γ'': 3rd greek letter ''gamma''. For our purposes, it will represent the angle between the normal vector(1) and the new x axis. 

Therefore, images and text could be rotated, something that could not be done before, so that said image or text would have a three-dimensional effect. If all said is true, eulerrotation = "0 -pi/3 0"; for text would project it in a Star Wars-like fashion.

sin(''θ'') = y / ''r'' (Δy of a point from the center on a circle with radius ''r'')
cos(''θ'') = x / ''r'' (Δx of a point from the center on a circle with radius ''r'')
sin(''θ'' ± ''φ'') = sin(''θ'') cos(''φ'') ± cos(''θ'') sin(''φ'')
-cos(''θ'' ± ''φ'') = -cos(''θ'') cos(''φ'') ± sin(''θ'') sin(''φ'')

In addition (not really useful):
tan(''θ'') = sin(''θ'') / cos(''θ'')
cot(''θ'') = cos(''θ'') / sin(''θ'')
sec(''θ'') = 1 / cos(''θ'')
csc(''θ'') = 1 / sin(''θ'')

<hr width="33%" NOSHADE>
(1) The normal vector is the vector normal to the original z and the new z axes. This can be calculated through [[Cross Product|cross product]].

== Rotation Matrices ==
'''Note:''' The following example uses MATLAB notation for the matrix transformation.
[cos(''γ'') sin(''γ'') 0; -sin(''γ'') cos(''γ'') 0; 0 0 1] * ...
[1 0 0; 0 cos(''α'') sin(''α''); 0 -sin(''α'') cos(''α'')] * ...
[cos(''α'') sin(''α'') 0; -sin(''α'') cos(''α'') 0; 0 0 1] * ...
([x0 y0 z0]') = [x y z]'

Euler Rotation

2007-04-21T23:14:19Z

Tolnaftate2004: True Euler Rotation

== Definitions ==
Euler - Pronounced Oiler; discovered that as 1 is continuously compounded, it reaches a number, ''e''. However, Euler rotation is taking a 3-dimensional axes set and rotating them about the z-axis followed by a forward or backward rotation to create a new axes set.
For objects that inherit the property 'eulerrotation', the format is supposedly "Δ''α'' Δ''β'' Δ''γ''". Read further for a better explanation.

''θ'': greek letter ''theta'' 
''φ'': greek letter ''phi'' 
''theta'' and ''phi'' are commonly used in trigonometry for angles (but phi is most commonly used as a constant: 1.618...). 
''α'': 1st greek letter ''alpha''. For our purposes, it will represent The angle between the original x axis and the normal vector(1). 
''β'': 2nd greek letter ''beta''. For our purposes, it will represent the forward or backward "tilt". 
''γ'': 3rd greek letter ''gamma''. For our purposes, it will represent the angle between the normal vector(1) and the new x axis. 

Therefore, images and text could be rotated, something that could not be done before, so that said image or text would have a three-dimensional effect. If all said is true, eulerrotation = "0 -pi/3 0"; for text would project it in a Star Wars-like fashion.

sin(''θ'') = y / ''r'' (Δy of a point from the center on a circle with radius ''r'')
cos(''θ'') = x / ''r'' (Δx of a point from the center on a circle with radius ''r'')
sin(''θ'' ± ''φ'') = sin(''θ'') cos(''φ'') ± cos(''θ'') sin(''φ'')
-cos(''θ'' ± ''φ'') = -cos(''θ'') cos(''φ'') ± sin(''θ'') sin(''φ'')

In addition (not really useful):
tan(''θ'') = sin(''θ'') / cos(''θ'')
cot(''θ'') = cos(''θ'') / sin(''θ'')
sec(''θ'') = 1 / cos(''θ'')
csc(''θ'') = 1 / sin(''θ'')

<hr width="33%" NOSHADE>
(1) The normal vector is the vector normal to the original z and the new z axes. This can be calculated through [[Cross Product|cross product]].

== Rotation Matrices ==
[cos(''γ'') sin(''γ'') 0; -sin(''γ'') cos(''γ'') 0; 0 0 1] * ...
[1 0 0; 0 cos(''α'') sin(''α''); 0 -sin(''α'') cos(''α'')] * ...
[cos(''α'') sin(''α'') 0; -sin(''α'') cos(''α'') 0; 0 0 1] * ...
([x0 y0 z0]') = [x y z]'

Polar Rotation

2007-04-21T22:59:27Z

Tolnaftate2004: This is Polar Rotation. Euler Rotation is a bit more basic. My mistake. I will fix it soon.

== Definitions ==
''θ'': greek letter ''theta'' 
''φ'': greek letter ''phi'' 
''theta'' and ''phi'' are commonly used in trigonometry for angles (but phi is most commonly used as a constant: 1.618...). 
''α'': 1st greek letter ''alpha''. For our purposes, it will represent rotation about the y-axis. 
''β'': 2nd greek letter ''beta''. For our purposes, it will represent rotation about the x-axis. 
''γ'': 3rd greek letter ''gamma''. For our purposes, it will represent rotation about the z-axis. 

sin(''θ'') = y / ''r'' (Δy of a point from the center on a circle with radius ''r'')
cos(''θ'') = x / ''r'' (Δx of a point from the center on a circle with radius ''r'')
sin(''θ'' ± ''φ'') = sin(''θ'') cos(''φ'') ± cos(''θ'') sin(''φ'')
-cos(''θ'' ± ''φ'') = -cos(''θ'') cos(''φ'') ± sin(''θ'') sin(''φ'')

In addition (not really useful):
tan(''θ'') = sin(''θ'') / cos(''θ'')
cot(''θ'') = cos(''θ'') / sin(''θ'')
sec(''θ'') = 1 / cos(''θ'')
csc(''θ'') = 1 / sin(''θ'')

== Deriving the 2D equations ==

Simply: 
x² + y² = ''r''²; the basic equation of a circle with center (0,0)
x² + y² + z² = ''r''²; the basic equation of a sphere with center (0,0,0)
sin²(''θ'') + cos²(''θ'') = 1

arctan(y/x) = ''θ''; arctan() being the inverse of tangent
tan(arctan(y/x)) = tan(''θ'')
y/x = tan(''θ'')
y/x = ''r'' sin(''θ'') / ''r'' cos(''θ'')

Thus, 
''r'' sin(''θ'') = y
''r'' cos(''θ'') = x

Likewise,
sin(''θ'') = y / ''r''
cos(''θ'') = x / ''r''

Plugging into the circle equation, we get
''r''² = ''r''² cos²(''θ'') + ''r''² sin²(''θ'')

Compare:
√(a² + b²) = c (the distance formula)
x² + y² = ''r''² (established as the equation of a circle)

√(a² + b²) = c
( √(a² + b²) )² = c²
a² + b² = c²

== Rotation on a single plane ==

Think of a circle with some radius, ''r'', and a point somewhere on it. This circle is a two-dimensional figure on the xy [or y(x)] plane. The angle between 0º and the point is ''θ''. 
Trigonometric functions sine and cosine are specific to determine x and y values according the the angle passed as its parameter. 

To keep things simple, we will rotate about the (invisible) z-axis. In doing so, x and y are changing. Any z values that a point may have remain constant. ''φ'' is a second angle, representing the amount of rotation. 

y = ''r'' sin(''θ''), so,
y = ''r'' sin(''θ'' + ''φ'')
y = ''r'' ( sin(''θ'') cos(''φ'') + cos(''θ'') sin(''φ'') )
y = ''r'' sin(''θ'') cos(''φ'') + ''r'' cos(''θ'') sin(''φ'')
Using substitutions form above, we can simplify to 
y = y cos(''φ'') + x sin(''φ'')

Alternatively, 
x = ''r'' cos(''θ'')
x = ''r'' cos(''θ'' + ''φ'')
x = ''r'' ( cos(''θ'') cos(''φ'') - sin(''θ'') sin(''φ'') )
x = ''r'' cos(''θ'') cos(''φ'') - ''r'' sin(''θ'') sin(''φ'')
x = x cos(''φ'') - y sin(''φ'')

== Deriving the 3D equations ==
[[Image:Pointonsphere.png|thumb|right|This image shows how to determine the cartesian coordinates of a point on a sphere in terms of sine and cosine. The point is at the upper tip of the green triangle.]]
As above, we can change the sphere's equation into a series of distance formulas
x² + y² + z² = ''r''²
( √(x² + y²) )² + z² = ''r''²
( √( ( √(x² + y²) )² + z² ) )² = ''r''²
√( x² + y² + z² ) = ''r''
''r''√( ( sin²(''θ'') + cos²(''θ'') ) sin²(''φ'') + cos²(''φ'') ) = ''r''
√( ( √( sin²(''θ'') + cos²(''θ'') ) )² sin²(''φ'') + cos²(''φ'') ) = 1
( sin²(''θ'') + cos²(''θ'') )² sin²(''φ'') + cos²(''φ'') = 1
sin²(''θ'') sin²(''φ'') + cos²(''θ'') sin²(''φ'') + cos²(''φ'') = 1

Comparing with the original equation we can split it up and get individual equations for x,y, and z.
y = sin(''θ'') sin(''φ'') (1)
x = cos(''θ'') sin(''φ'') (1)
z = cos(''φ'')

The equation is
( sin²(''θ'') + cos²(''θ'') ) ( sin²(''φ'') + cos²(''φ'') ) = 1

So, why doesn't the ( sin²(''θ'') + cos²(''θ'') ) distribute to the cos²(''φ'')? If you'll recall, ( sin²(''θ'') + cos²(''θ'') ) = 1, so it ''could be'' that it was. But also, it was left out so that there were only 3 terms as opposed to 4 (We only want three: x, y, and z!).

<hr width="33%" NOSHADE>
(1) The portion used contained the original x or y equation, so was split up to match, but it doesn't matter in the end.

== Rotation on three planes ==

Now in three dimensions: 
Imagine three planes that intersect: xy [y(x)], yz [z(y)], zx [x(z)] (using these names helps remember the order of calculations if re-writing the script... you'll see). 
For this, instead of merely one rotation angle, we will need three (''α'', ''β'', and ''γ''). Also, we will need to replace the simple x and y with their three-dimensional counterparts and add a z (To begin, ''f'' = ''f''0, where ''f'' is a function, x, y, or z). 
x0 = ''r'' sin(''α'') cos(''β'')
y0 = ''r'' sin(''α'') sin(''β'')
z0 = ''r'' cos(''α'')

About the x-axis: 
Finally, rotate our three planes to replace z with x, y with z, and x with y. 
nz = z cos(''β'') + y sin(''β'')
ny = y cos(''β'') - z sin(''β'')
Note how as the axes are switched, the x, y, and z or replaced respectively from the 2D rotation equations!

We then replace y with ny and z with nz. So in a sense, 
z = nz
y = ny

About the y-axis: 
Now imagine the 3 planes rotate forward 90º and 90º to the left. The z has taken the place of the x, x in the stead of y, and y in that of z. The idea of this rotation is now just like that above, but y is constant. 
nx = x cos(''α'') + z sin(''α'')
nz = z cos(''α'') - x sin(''α'')

x = nx

The two-dimensions calculations work for rotations about the z-axis. 
About the z-axis: 
ny = y cos(''γ'') + x sin(''γ'')
nx = x cos(''γ'') - y sin(''γ'')

We expand to simplify: 

x = x cos(''γ'') - y sin(''γ'')
x = ( x0 cos(''α'') + ( z0 cos(''β'') + y0 sin(''β'') ) sin(''α'') ) cos(''γ'') - ( y0 cos(''β'') - z0 sin(''β'') ) sin(''γ'')
x = x0 cos(''α'') cos(''γ'') + z0 cos(''β'') sin(''α'') cos(''γ'') + y0 sin(''β'') sin(''α'') cos(''γ'') - y0 cos(''β'') sin(''γ'') + z0 sin(''β'') sin(''γ'')
x = x0 cos(''α'') cos(''γ'') + y0 ( sin(''β'') sin(''α'') cos(''γ'') - cos(''β'') sin(''γ'') ) + z0 ( cos(''β'') sin(''α'') cos(''γ'') + sin(''β'') sin(''γ'') )

y = y cos(''γ'') + x sin(''γ'')
y = ( y0 cos(''β'') - z0 sin(''β'') ) cos(''γ'') + ( x0 cos(''α'') + ( z0 cos(''β'') + y0 sin(''β'') ) sin(''α'') ) sin(''γ'')
y = y0 cos(''β'') cos(''γ'') - z0 sin(''β'') cos(''γ'') + x0 cos(''α'') sin(''γ'') + z0 cos(''β'') sin(''α'') sin(''γ'') + y0 sin(''β'') sin(''α'') sin(''γ'')
y = x0 cos(''α'') sin(''γ'') + y0 ( cos(''β'') cos(''γ'') + sin(''β'') sin(''α'') sin(''γ'') ) + z0 ( -sin(''β'') cos(''γ'') + cos(''β'') sin(''α'') sin(''γ'') )

z = z cos(''α'') - x sin(''α'')
z = ( z0 cos(''β'') + y0 sin(''β'') ) cos(''α'') - x0 sin(''α'')
z = z0 cos(''β'') cos(''α'') + y0 sin(''β'') cos(''α'') - x0 sin(''α'')

As is, the object will display in an orthographic projection, which means that z has no bearing on the perspective. To give a perspective projection, the x and y can be distorted by some equation like: 
x = centerx + h / (h-z)
y = centery - h / (h-z)

== Links ==
[http://forums.graalonline.com/forums/showthread.php?t=54167 Amon-ra's explanation and models (continues on p. 2)]

Matrix

2007-04-21T22:27:48Z

Tolnaftate2004:

A '''matrix''' (''pl.'' matrices) is a list of numbers, generally who have a relationship between them, that are ordered in a type of mathematical array. A matrix, m, may be written as either [m], or (m) in mathematics, where m is a placeholder for the numbers in the matrix.

== Reading a Matrix ==
A matrix is ordered in rows and columns, which are counted by increasing i and j respectively. One can think of a matrix as a 2-dimensional array where each object in the 1st dimension holds an array of numbers in that row.

An entry at i=2 and j=3 is noted by either M[2,3] or m2,3. These numbers are important for some modifications involving these matrices.

== Demystifying Matrices in GraalScript ==
If you have ever tested any of the matrix functions built into GraalScript, you may be lost as to where the return value comes from. Well, luckily there are some adept enough with math to understand these functions. These are their findings.

=== matrixcreate() ===
Let '''v''' be a vector and '''a''' consisting of a vector and a scalar.

==== Usage ====
{{code|1=
strMatrix = matrixcreate(v,a);
}}
Where v describes the translation (position) and 'a' describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7 (this will be explained later).

==== Example ====
{{code|1=
temp.matrix = matrixcreate({1,1,1},{1,7,1,1});
// This will return 1,1,1,0.140028,0.980196058,0.140028,7.14595223
}}

==== The Math Behind the Function ====
The first three numbers of the return value should be rather familiar. It is the vector you passed to the function. The other four seem to come out of nowhere. However, there is a method to this madness. The first of these three are merely a property of angles. Because of the [[Dot Product]] of vectors, we are able to calculate the cosine of the angle between two vectors. Well, we have actually created a new vector in this code!

As defined in [[Vectors]], we know that there are three unit vectors that lay on the x, y, and z axes. These vectors have been given the letters '''i''', '''j''', and '''k''', respectively. The first value defined in the "rotation" is multiplied to '''i''', the second to '''j''', and so forth, and this makes a new vector. However, this still does not tell us why we have these numbers returned to us.

From the definition of the dot product, we know that
cos(θ) = uv/(|u||v|)
The first three numbers returned to us are the cosine of the angles between the new vector (in this case, <1,7,1>) and each of our unit vectors. For example:
cos(α) = <1,7,1><1,0,0>/(|<1,7,1>||<1,0,0>|) = 1/√51 = 0.1400280084
cos(β) = <1,7,1><0,1,0>/(|<1,7,1>||<0,1,0>|) = 7/√51 = 0.9801960588
cos(γ) = <1,7,1><0,0,1>/(|<1,7,1>||<0,0,1>|) = 1/√51 = 0.1400280084

''There is an evident difference between the values given here and the return value. A computer cannot calculate cosine on its own. It merely uses a method of estimation.''

cos(α)2 + cos(β)2 + cos(γ)2 = 1 (1)

<hr width="33%" noshade="noshade">
(1) The returned values are accurate within ±10-5

So far, we have 6 of 7 figured out. The last is the simplest of them all. Plugging the new vector into vectorlen() or using √(x2 + y2 + z2) returns it's magnitude. This, multiplied by the fourth number of the second parameter, is the last of the returned values (and as far as anyone can tell the vector passed to the function has no bearing on the return value).

=== matrixcreatefromeuler() ===
Let '''r''' be an array describing rotation, {α,β,γ}.

==== Usage ====
{{code|1=
strMatrix = matrixcreatefromeuler(r);
}}
Where r describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7.

==== Example ====
{{code|1=
temp.matrix = matrixcreatefromeuler({pi/2,0,pi/2});
// This will return 0,0,0,-0.577350258,-0.577350258,-0.577350258,119.999976018
}}

==== The Math Behind the Function ====
'''Coming soon!'''

Matrix

2007-04-21T22:26:40Z

Tolnaftate2004: Spelling, removed math portion

A '''matrix''' (''pl.'' matrices) is a list of numbers, generally who have a relationship between them, that are ordered in a type of mathematical array. A matrix, m, may be written as either |m|, [m], or sometimes even (m) in mathematics, where m is a placeholder for the numbers in the matrix.

''Any matrix examples below will use the |m| notation for simplicity.''

== Reading a Matrix ==
A matrix is ordered in rows and columns, which are counted by increasing i and j respectively. One can think of a matrix as a 2-dimensional array where each object in the 1st dimension holds an array of numbers in that row.

An entry at i=2 and j=3 is noted by either M[2,3] or m2,3. These numbers are important for some modifications involving these matrices.

== Demystifying Matrices in GraalScript ==
If you have ever tested any of the matrix functions built into GraalScript, you may be lost as to where the return value comes from. Well, luckily there are some adept enough with math to understand these functions. These are their findings.

=== matrixcreate() ===
Let '''v''' be a vector and '''a''' consisting of a vector and a scalar.

==== Usage ====
{{code|1=
strMatrix = matrixcreate(v,a);
}}
Where v describes the translation (position) and 'a' describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7 (this will be explained later).

==== Example ====
{{code|1=
temp.matrix = matrixcreate({1,1,1},{1,7,1,1});
// This will return 1,1,1,0.140028,0.980196058,0.140028,7.14595223
}}

==== The Math Behind the Function ====
The first three numbers of the return value should be rather familiar. It is the vector you passed to the function. The other four seem to come out of nowhere. However, there is a method to this madness. The first of these three are merely a property of angles. Because of the [[Dot Product]] of vectors, we are able to calculate the cosine of the angle between two vectors. Well, we have actually created a new vector in this code!

As defined in [[Vectors]], we know that there are three unit vectors that lay on the x, y, and z axes. These vectors have been given the letters '''i''', '''j''', and '''k''', respectively. The first value defined in the "rotation" is multiplied to '''i''', the second to '''j''', and so forth, and this makes a new vector. However, this still does not tell us why we have these numbers returned to us.

From the definition of the dot product, we know that
cos(θ) = uv/(|u||v|)
The first three numbers returned to us are the cosine of the angles between the new vector (in this case, <1,7,1>) and each of our unit vectors. For example:
cos(α) = <1,7,1><1,0,0>/(|<1,7,1>||<1,0,0>|) = 1/√51 = 0.1400280084
cos(β) = <1,7,1><0,1,0>/(|<1,7,1>||<0,1,0>|) = 7/√51 = 0.9801960588
cos(γ) = <1,7,1><0,0,1>/(|<1,7,1>||<0,0,1>|) = 1/√51 = 0.1400280084

''There is an evident difference between the values given here and the return value. A computer cannot calculate cosine on its own. It merely uses a method of estimation.''

cos(α)2 + cos(β)2 + cos(γ)2 = 1 (1)

<hr width="33%" noshade="noshade">
(1) The returned values are accurate within ±10-5

So far, we have 6 of 7 figured out. The last is the simplest of them all. Plugging the new vector into vectorlen() or using √(x2 + y2 + z2) returns it's magnitude. This, multiplied by the fourth number of the second parameter, is the last of the returned values (and as far as anyone can tell the vector passed to the function has no bearing on the return value).

=== matrixcreatefromeuler() ===
Let '''r''' be an array describing rotation, {α,β,γ}.

==== Usage ====
{{code|1=
strMatrix = matrixcreatefromeuler(r);
}}
Where r describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7.

==== Example ====
{{code|1=
temp.matrix = matrixcreatefromeuler({pi/2,0,pi/2});
// This will return 0,0,0,-0.577350258,-0.577350258,-0.577350258,119.999976018
}}

==== The Math Behind the Function ====
'''Coming soon!'''

Dot Product

2007-01-23T21:46:14Z

Tolnaftate2004: /* Deriving the Dot Product */

The Dot Product is a property of vectors. It is defined as the sum of the products of each component of a [[Vectors|vector]]. This is a useful property when trying to determine the angle between two vectors in n-dimensions.

== Definition ==
The dot product of vectors u and v is written uv and is pronounced "u dot v". This should not be confused with the multiplication dot (below marked as · as opposed to ) 
The dot product simply returns a number. This number is the sum of products of each component of the vector. So, if we have vectors u = <3,5,7> and v = <9,4,2>, the dot product would be
uv = <3,5,7><9,4,2> = 3·9 + 5·4 + 7·2 = 61
This value has special meaning with vectors. It can also be calculated by the magnitude of u multiplied by the magnitude of v multiplied by the cosine of the angle between them.
|u||v|cos(θ)

== Deriving the Dot Product ==
The dot product was merely derived from the law of cosines:
c2 = a2 + b2 - 2 · a · b · cos(θ)

Imagine a triangle with three points, A, B, and C and we are trying to find the size of angle &ang;BAC. In this triangle, AB = c, AC = b, and BC = a. Thus, we have
(AB)2 = (BC)2 + (AC)2 - 2 · (BC) · (AC) · cos(θ)
(AB)2 - (BC)2 - (AC)2 = -2 · (BC) · (AC) · cos(θ)
[(AB)2 - (BC)2 - (AC)2] / [-2 · (BC) · (AC)] = cos(θ)
[-(AB)2 + (BC)2 + (AC)2] / [2 · (BC) · (AC)] = cos(θ)
At this point, we replace all sides with vectors. BC = |u|, AC = |v|, AB = |u-v|.
[-|u-v|2 + |u|2 + |v|2] / [2 · |u| · |v|] = cos(θ)
[-[(u12 - 2·u1·v1 + v12) + (u22 - 2·u2·v2 + v22) + (u32 - 2·u3·v3 + v13)] + u12 + u22 + u32 + v12 + v22 + v32] / [2·|u|·|v|] = cos(θ)
This calculation is done by "multiplying" the two vectors together. In reality, |u|2 = uu, so it is merely following the definition of the dot product above.
[-(-2·u1·v1 - 2·u2·v2 - 2·u3·v3)] / [2·|u|·|v|] = cos(θ)
[2·u1·v1 + 2·u2·v2 + 2·u3·v3)] / [2·|u|·|v|] = cos(θ)
[u1·v1 + u2·v2 + u3·v3)] / [|u|·|v|] = cos(θ)
And since
u1·v1 + u2·v2 + u3·v3 = uv
We have then
uv/[|u||v|] = cos(θ)
uv = |u||v|cos(θ)

== The Dot Product in GraalScript ==
The dot product is a function of vectors in format {x,y,z}. It returns a float, as it should. This function in GraalScript is '''vectordot({{graycourier|u}},{{graycourier|v}})'''. It's return value is just simply xuxv + yuyv + zuzv.

Creation/Dev/Output Methods

2007-01-12T20:56:00Z

Tolnaftate2004: /* format() function */ %n$T format, usage.

== Introduction ==
With the addition of the [[GScript|new scripting engine]], there are a number of new methods in which you can create output from an NPC. In this article, I will discuss a couple of ways.

== Useful Things To Know ==
If you've played with the new engine for a while, you're probably aware of the string concationation operators. If not, here they are.
<pre>String Concatenation a @ b
with space a SPC b
with newline a NL b
with tabulator a TAB b</pre>
What these operators do is join values together to form one value.

An example of using @ would be:
<pre>"Hello, " @ player.account</pre>
... which would produce "Hello, accountnamehere".

The SPC, NL and TAB operators work using the same principal - except that they insert a Space, New Line or Tab Space respectively.

If you don't put a space at the end of the first value or at the beginning of the second value when using @, you don't get a visible space, for example:
<pre>"Hello" @ "World"</pre>
... will produce "HelloWorld".

However! If you use SPC, you'll get a space in place of the operator:
<pre>"Hello" SPC "World"</pre>
... producing "Hello World".

You can use these operators just about anywhere that a variable is requested, i.e. setting a variable, or sending to a function.

== format() function ==
Or, if you aren't so interested in using the concationation operators, you can use the ''format()'' function.

What this function does, is that it takes a sort of template from the first parameter you give it, and replaces % codes with other parameters you give it.

Now, the template format primarily uses the following % characters:
<pre>%d %i - Integer
%f - Float (number with decimal)
%s - String
%c - Single character
%% - Literal "%" character
%x %X - Print an integer as a hexadecimal</pre>
There are more, since the function is made to be compatible with C's ''printf()'' function.

In the template, every % code will be replaced with the respective parameter.

Say you want to produce "Hello, '''Mr. Skyld'''. You ate '''4''' apples today!" using format(). First, your format would be this:
<pre>"Hello, %s. You ate %i apples today!"</pre>
... and you must not forget to give the parameters containing the values:
<pre>format("Hello, %s. You ate %i apples today!", "Mr. Skyld", 4);</pre>
You can give the format() functions as many parameters as necessary to build up your value. If you use a % code and a value isn't present for it, a 0 (zero) will appear in it's place.

You can also use ''format2()'', which acts just like format() with the exception that instead of passing variables as separate parameters, they are sent as an array to the 2nd parameter.
The example above would become
<pre>format2("Hello, %s. You ate %i apples today!", {"Mr. Skyld", 4});</pre>

Along with format2() came the indexing of the parameters. This method will work with both format() and format2() functions. It allows us to choose which parameter to place in which position in the format string. The problem of parameters being placed in the wrong order will not exist if each parameter has a different data type, however.

<pre>format2("Hello, %2$s. You ate %1$s apples today!", {"four","Mr. Skyld"});</pre>
In the example, both parameters are strings, so it would be necessary to give them an index when trying to insert them in a different order than they were passed. ''%1$s'' refers to the 1st object in the array inserted as a string. ''%n$T'' is general; the nth parameter inserted with datatype of ''T''.

Now, let's continue on various ways of outputting data.

== Outputs ==
=== Direct Output ===
Direct Output is sending an output directly to the game client, or to RC/NC. There are a number of functions for these tasks.

==== echo() ====
The echo() function will, on the serverside, send data to NC, so RC users who have the NPC-Control right will see the message in RC chat, and on the clientside, sends the message to the F2 window. It expects one parameter, and that's the message you're sending. For example:
<pre>echo("This is a message!");</pre>
The message "This is a message!" will appear either in RC or the F2 window using this example.

==== sendtorc() ====
The sendtorc() function works in the same way that the echo() function does, however, it only usually works on the serverside. It will appear to all RC users. For example:
<pre>sendtorc("This is a message!");</pre>
... will send "NPC-Server (Server): This is a message!" to RC.

'''Note''' that this function can only be used on the clientside when Client-RC is active.

==== sendtonc() ====
The sendtonc() function works in exactly the same way as echo() does serverside.

==== sendrpgmessage() ====
The sendrpgmessage() works much the same as echo() does clientside. It will result in a message appearing in the player's F2 log window. For example:
<pre>sendrpgmessage("This is a message!");</pre>
... will send "This is a message!" to the player's F2 window.

=== Working with Files ===
==== loadstring() ====
loadstring() is an object function which loads the contents of a given file.

Say that the file "levels/file.txt" contains the message "HELLO WORLD". If you want to load that value into a variable called "myVar", you should use this function:
<pre>myVar.loadstring("levels/file.txt");</pre>
You can easily check the contents of the file:
<pre>echo(myVar);</pre>

==== savestring() ====
savestring() is another object function, however, instead of loading the contents of a file, it writes the contents instead.

Consider this with the previous example:
<pre>myVar = "HELLO PLANET";
myVar.savestring("levels/file.txt", 0);</pre>
... would write "HELLO PLANET" to "levels/file.txt".

The second operator, which is 0 (zero) in that example, is the '''Append''' function, and decides whether the file should be overwritten with the new value, or whether the new value should be added onto the end of the file. If you specify '''1''', then the value will be appended, if not, it will overwrite the file.

==== savevars() ====
savevars() is an object function which saves the variables of an object into a file. Consider this example:
<pre>myVar = new TStaticVar(); // Create a TStaticVar
myVar.variable = "Hello";
myVar.secondvariable = "World";
myVar.saveVars("levels/test.txt", 0);</pre>
This will save the variables inside the "myVar" object into "levels/test.txt". You can then recall these variables using loadvars();

Like savelines(), the second parameter controls whether the variables are to be appended to the file. '''0''' will overwrite the file, and '''1''' will append to the file.

==== loadvars() ====
loadvars() is another object function which loads savevars()-style variables from a file into an object. Let's say you used the previous example from savevars(), then you could restore these values using the following:
<pre>myNewVar.loadvars("levels/test.txt");
echo(myNewVar.secondvariable);</pre>
... which will output "World".

=== Private Messages (PMs) ===
From the serverside, you can send PMs to players. They appear from the NPC-Server.

If you wanted to send a PM to the player "Skyld" (if the player is online), the you would use the following example:
<pre>findPlayer("Skyld").sendPM("This is a PM");</pre>
... and then the specified player, in this case Skyld, would receive the PM "This is a PM".

If you want to send a PM to the current player, you would simply use:
<pre>player.sendPM("This is a PM");</pre>

Q menu

2007-01-05T03:46:40Z

Tolnaftate2004:

The Q Menu is the standard [[Graal]] weapon selection system.
Pressing Q brings up weapons, in which the player can select weapons using the arrow keys and D, or clicking the weapon.
It contains support for bags. By using the Bagname/Weaponname format as the name of the weapon, weapons can be grouped. Normally, collected items are not seen here. (However, the custom [[Worlds/Graal Kingdoms|Graal Kingdoms]] Q Menu ''will'' display collected items.)

It was important to make the distinction between a Q menu and the inventory, because, script-wise, the inventory was separate from the Q menu.

Creation/Dev/Script/Client

2006-12-30T18:46:35Z

Tolnaftate2004: /* Matrices */

=Client Supported Script Features=

==Settings==
{| 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==
{| 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 x-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==
{| 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
|-
| 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==
''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===
* 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====
* extractfilebase(str filepath) - returns string, '/an/example/path/and/file' would return '/an/example/path/and/'
* 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'
* reloadfile(str filepath)
* 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.)''

''See more information about input/output at [[Creation/Dev/Output Methods|Output methods]]''

====Math====
* degtorad(float value) - returns float
* radtodeg(float value) - returns float

=====Matrices=====
GraalScript [[Matrix|matricies]] are arrays of seven elements: three describing translation, three describing rotation, and one describing 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=====
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====
* 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===
* 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===
{| border="1" cellpadding="2" width="100%"
| '''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:
{| border="1" cellpadding="2" width="100%"
| '''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
| The logframe where savelog stuff is added
|-
| 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 name specified. Returns false if weapon doesn't exist.
|-
| 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.
|-
| 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.
|-
| 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)
|
| Sets the color and alpha transparency of the current npc, use seteffectmode(1) to make the npc alpha-transparent instead of displaying as a light, see [[Creation/Dev/Script/Client/TServerNPC|TServerNPC]] for more.
|-
| setfocus(float x, float y)
|
| Sets the screen focus to the specified x and y.
|-
| 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:
<pre>
// Shows all
showstats(allstats);

// Enable everything except minimap
showstats(allstats & ~0x100);

// Enable everything except AP and MP bars
showstats(allstats & ~(0x40 | 0x80));

// Enable only players and right-click profile
showstats(0x400 | 0x800);

// Hides all
showstats(0);
</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]]

Creation/Dev/Script/Client

2006-12-30T18:46:07Z

Tolnaftate2004: /* Matrices */

=Client Supported Script Features=

==Settings==
{| 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==
{| 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 x-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==
{| 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
|-
| 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==
''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===
* 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====
* extractfilebase(str filepath) - returns string, '/an/example/path/and/file' would return '/an/example/path/and/'
* 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'
* reloadfile(str filepath)
* 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.)''

''See more information about input/output at [[Creation/Dev/Output Methods|Output methods]]''

====Math====
* degtorad(float value) - returns float
* radtodeg(float value) - returns float

=====Matrices=====
GraalScript matricies are an array of seven elements: three describing translation, three describing rotation, and one describing 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=====
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====
* 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===
* 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===
{| border="1" cellpadding="2" width="100%"
| '''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:
{| border="1" cellpadding="2" width="100%"
| '''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
| The logframe where savelog stuff is added
|-
| 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 name specified. Returns false if weapon doesn't exist.
|-
| 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.
|-
| 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.
|-
| 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)
|
| Sets the color and alpha transparency of the current npc, use seteffectmode(1) to make the npc alpha-transparent instead of displaying as a light, see [[Creation/Dev/Script/Client/TServerNPC|TServerNPC]] for more.
|-
| setfocus(float x, float y)
|
| Sets the screen focus to the specified x and y.
|-
| 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:
<pre>
// Shows all
showstats(allstats);

// Enable everything except minimap
showstats(allstats & ~0x100);

// Enable everything except AP and MP bars
showstats(allstats & ~(0x40 | 0x80));

// Enable only players and right-click profile
showstats(0x400 | 0x800);

// Hides all
showstats(0);
</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]]

Talk:Creation/Dev/Script/Client

2006-12-28T18:48:00Z

Tolnaftate2004:

I need help with a new system I'm making for my server, I've posted some info on the forums, but it hasn't gotten replys, and I'm stumped. Here's the forums site, it would mean a lot to me if someone could help me out a bit, thanks!!!
http://forums.graalonline.com/forums/showthread.php?t=65330

== Vectors ==

Okay, I've been writing documentation for vectors. I'm assuming by the description that vector normalize is '''u'''/|'''u'''|. I can't seem to figure out what vectororthobasis is or how vectordist could be anything other than 0. Seeing as vectors don't have position, we can assume that all of them cross at (0,0,0) (and thus the minimum distance be 0).

Hopefully I could get some clarification.

--[[User:Tolnaftate2004|Tolnaftate2004]] 20:36, 18 November 2006 (CET)

I've figured out vectordist, but vectororthobasis is still a bit fuzzy. If it is returning a vector, then there are three of them, and is peculiar that is is returning an identity ''matrix'' for the '''0''' vector.

--[[User:Tolnaftate2004|Tolnaftate2004]] 19:48, 28 December 2006 (CET)

Creation/Dev/Script/Client

2006-12-28T18:43:01Z

Tolnaftate2004: /* Vectors */

=Client Supported Script Features=

==Settings==
{| 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==
{| 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 x-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==
{| 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
|-
| 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==
''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===
* 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====
* extractfilebase(str filepath) - returns string, '/an/example/path/and/file' would return '/an/example/path/and/'
* 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'
* reloadfile(str filepath)
* 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.)''

''See more information about input/output at [[Creation/Dev/Output Methods|Output methods]]''

====Math====
* degtorad(float value) - returns float
* radtodeg(float value) - returns float

=====Matrices=====
* [[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=====
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====
* 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===
* 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===
{| border="1" cellpadding="2" width="100%"
| '''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:
{| border="1" cellpadding="2" width="100%"
| '''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
| The logframe where savelog stuff is added
|-
| 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 name specified. Returns false if weapon doesn't exist.
|-
| 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.
|-
| 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.
|-
| 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)
|
| Sets the color and alpha transparency of the current npc, use seteffectmode(1) to make the npc alpha-transparent instead of displaying as a light, see [[Creation/Dev/Script/Client/TServerNPC|TServerNPC]] for more.
|-
| setfocus(float x, float y)
|
| Sets the screen focus to the specified x and y.
|-
| 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:
<pre>
// Shows all
showstats(allstats);

// Enable everything except minimap
showstats(allstats & ~0x100);

// Enable everything except AP and MP bars
showstats(allstats & ~(0x40 | 0x80));

// Enable only players and right-click profile
showstats(0x400 | 0x800);

// Hides all
showstats(0);
</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]]

Vectors

2006-12-28T18:41:28Z

Tolnaftate2004: /* Distance Between Terminal Points */

'''Vectors''' are mathematical representations of any thing that has a length, or magnitude, and direction. Positions are also described using vectors which start at the origin of the coordinate system (0,0,0).

== Definition ==
In GraalScript, a vector is limited to three dimensions, however, mathematics allows for analyses of vectors in n-dimensions. Vectors do not have positions. Two vectors are said to be parallel if they have the same direction (u || v), and are said to be equal if they are parallel and have the same magnitude (u = v). Vectors are generally described by their terminal points with respect to the origin (0,0,0).

The basic format of a vector in GraalScript is {x,y,z} where x, y, and z are all floating points in reference to the axis to which they correspond. Built into GraalScript are several functions which can be used to analyze these vectors.

In mathematics, vectors are often written
v = <v1,v2,v3>
for a vector in three dimensions. They can also be written as the sum of unit vectors, i = <1,0,0>, j = <0,1,0>, and k = <0,0,1> on the x, y, and z axes, respectively. In this case, the vector would be written as
v = v1i + v2j + v3k
where the values of v are treated as scalars (numerical multipliers) of the unit vectors.

To denote the difference between a scalar and a vector, vectors are often written with a directional arrow above them, which looks like the top half of an arrow pointing right. In GraalScript, a scalar and a vector are impossible to confuse: a scalar is a floating point whereas a vector is a string.

=== Vector Length (Magnitude) ===
Being as vectors are merely written by terminal point coordinates, there is no immediate way to determine the magnitude of the vector. Mathematically, the terminal point lies on a sphere that has the same radius as the vector's magnitude. Thus, we can use the equation of a sphere to calculate the magnitude. 
r2 = x2 + y2 + z2 
r = √(x2 + y2 + z2)
where r is the magnitude. Generally, the magnitude is denoted as |v| or ||v||. This was chosen, because absolute value refers to distance from the origin, thus the marks were suitable. In GraalScript, however, the magnitude of any vector can be calculated simply by plugging a vector string into the '''vectorlen({{graycourier|v}})''' function.

=== Unit Length ===
A vector is said to have "unit length" when it's magnitude is one. '''i''', '''j''', and '''k''' are each unit vectors because their magnitudes are each one. To make a vector of unit length, the vector must merely be divided by it's magnitude.
Let v be a vector and u be the direction (unit vector) of v.
v = <1,7,1>
|v| = √(12 + 72 + 12) = √51
u = v/|v| = <1/√51,7/√51,1/√51>

Graalscript has a built-in function, '''vectornormalize({{graycourier|1=v}})''',to perform such a calculation.

== Vector Modification ==
Along with vectorlen are a plethora of functions built into GraalScript all for the purpose of modifying vectors.

=== Vector Addition ===
[[Image:Vectors-addition.png|thumb|right|Vector addition]]
Given the vectors u and v, we could create a third vector that has the magnitude of u and v, were the two vectors to be placed tip-to-end. This is called vector addition and can be done with the function '''vectoradd({{graycourier|u}},{{graycourier|v}})'''. This takes the terminal coordinates and adds them together. to make a new vector: 
w = <u1+v1, u2+v2, u3+v3>.
 

=== Vector-Scalar Multiplication ===
[[Image:Vectors-scalar-multiplication.png|thumb|left|Vector-scalar multiplication]]
With a vector, v, and a scalar, s, we could make a new vector that is s times larger than v. This can be accomplished in GraalScript with the function '''vectorscale({{graycourier|v}},{{graycourier|s}})'''. The vector is thus extended in the following manner: 
s·v = s·<v1,v2,v3> = <s·v1,s·v2,s·v3>.
 

=== Vector Subtraction ===
[[Image:Vectors-subtraction.png|thumb|right|Vector subtraction]]
With these two properties, we find that vector subtraction is possible, and no longer a new idea. This is done in GraalScript with the use of the '''vectorsub({{graycourier|u}},{{graycourier|v}})''' function. 
u-v = u + (-v) = u + (-1)·v
You can imagine this as the two vectors placed tip-to-end, but the second is facing the opposite direction.
 

=== Distance Between Terminal Points ===
Without creating a third vector, it is simple in GraalScript to find the distance between the two points at which two vectors end. This function is '''vectordist({{graycourier|u}},{{graycourier|v}})'''. 
The return value would be
√((u1-v1)2+(u2-v2)2+(u3-v3)2)
The mathematical operation is the pythagorean theorem (or a combination of two). As may be evident, the distance is the magnitude of '''u'''-'''v'''.

== Other functions ==
vectordot({{graycourier|u}},{{graycourier|v}}): see [[Dot Product]]. 
vectorcross({{graycourier|u}},{{graycourier|v}}): see [[Cross Product]].

Vectors

2006-12-28T18:40:53Z

Tolnaftate2004: /* Vector Modification */

'''Vectors''' are mathematical representations of any thing that has a length, or magnitude, and direction. Positions are also described using vectors which start at the origin of the coordinate system (0,0,0).

== Definition ==
In GraalScript, a vector is limited to three dimensions, however, mathematics allows for analyses of vectors in n-dimensions. Vectors do not have positions. Two vectors are said to be parallel if they have the same direction (u || v), and are said to be equal if they are parallel and have the same magnitude (u = v). Vectors are generally described by their terminal points with respect to the origin (0,0,0).

The basic format of a vector in GraalScript is {x,y,z} where x, y, and z are all floating points in reference to the axis to which they correspond. Built into GraalScript are several functions which can be used to analyze these vectors.

In mathematics, vectors are often written
v = <v1,v2,v3>
for a vector in three dimensions. They can also be written as the sum of unit vectors, i = <1,0,0>, j = <0,1,0>, and k = <0,0,1> on the x, y, and z axes, respectively. In this case, the vector would be written as
v = v1i + v2j + v3k
where the values of v are treated as scalars (numerical multipliers) of the unit vectors.

To denote the difference between a scalar and a vector, vectors are often written with a directional arrow above them, which looks like the top half of an arrow pointing right. In GraalScript, a scalar and a vector are impossible to confuse: a scalar is a floating point whereas a vector is a string.

=== Vector Length (Magnitude) ===
Being as vectors are merely written by terminal point coordinates, there is no immediate way to determine the magnitude of the vector. Mathematically, the terminal point lies on a sphere that has the same radius as the vector's magnitude. Thus, we can use the equation of a sphere to calculate the magnitude. 
r2 = x2 + y2 + z2 
r = √(x2 + y2 + z2)
where r is the magnitude. Generally, the magnitude is denoted as |v| or ||v||. This was chosen, because absolute value refers to distance from the origin, thus the marks were suitable. In GraalScript, however, the magnitude of any vector can be calculated simply by plugging a vector string into the '''vectorlen({{graycourier|v}})''' function.

=== Unit Length ===
A vector is said to have "unit length" when it's magnitude is one. '''i''', '''j''', and '''k''' are each unit vectors because their magnitudes are each one. To make a vector of unit length, the vector must merely be divided by it's magnitude.
Let v be a vector and u be the direction (unit vector) of v.
v = <1,7,1>
|v| = √(12 + 72 + 12) = √51
u = v/|v| = <1/√51,7/√51,1/√51>

Graalscript has a built-in function, '''vectornormalize({{graycourier|1=v}})''',to perform such a calculation.

== Vector Modification ==
Along with vectorlen are a plethora of functions built into GraalScript all for the purpose of modifying vectors.

=== Vector Addition ===
[[Image:Vectors-addition.png|thumb|right|Vector addition]]
Given the vectors u and v, we could create a third vector that has the magnitude of u and v, were the two vectors to be placed tip-to-end. This is called vector addition and can be done with the function '''vectoradd({{graycourier|u}},{{graycourier|v}})'''. This takes the terminal coordinates and adds them together. to make a new vector: 
w = <u1+v1, u2+v2, u3+v3>.
 

=== Vector-Scalar Multiplication ===
[[Image:Vectors-scalar-multiplication.png|thumb|left|Vector-scalar multiplication]]
With a vector, v, and a scalar, s, we could make a new vector that is s times larger than v. This can be accomplished in GraalScript with the function '''vectorscale({{graycourier|v}},{{graycourier|s}})'''. The vector is thus extended in the following manner: 
s·v = s·<v1,v2,v3> = <s·v1,s·v2,s·v3>.
 

=== Vector Subtraction ===
[[Image:Vectors-subtraction.png|thumb|right|Vector subtraction]]
With these two properties, we find that vector subtraction is possible, and no longer a new idea. This is done in GraalScript with the use of the '''vectorsub({{graycourier|u}},{{graycourier|v}})''' function. 
u-v = u + (-v) = u + (-1)·v
You can imagine this as the two vectors placed tip-to-end, but the second is facing the opposite direction.
 

=== Distance Between Terminal Points ===
Without creating a third vector, it is simple in GraalScript to find the distance between the two points at which two vectors end. This function is '''vectordist({{graycourier|u}},{{graycourier|v}})'''. 
The return value would be
√((u1-v1)2+(u2-v2)2+(u3-v3)2)
The mathematical operation is the pythagorean theorem (or a combination of two). As may be evident, the magnitude is that of '''u'''-'''v'''.

== Other functions ==
vectordot({{graycourier|u}},{{graycourier|v}}): see [[Dot Product]]. 
vectorcross({{graycourier|u}},{{graycourier|v}}): see [[Cross Product]].

Vectors

2006-12-28T18:40:34Z

Tolnaftate2004: /* Vector Modification */

'''Vectors''' are mathematical representations of any thing that has a length, or magnitude, and direction. Positions are also described using vectors which start at the origin of the coordinate system (0,0,0).

== Definition ==
In GraalScript, a vector is limited to three dimensions, however, mathematics allows for analyses of vectors in n-dimensions. Vectors do not have positions. Two vectors are said to be parallel if they have the same direction (u || v), and are said to be equal if they are parallel and have the same magnitude (u = v). Vectors are generally described by their terminal points with respect to the origin (0,0,0).

The basic format of a vector in GraalScript is {x,y,z} where x, y, and z are all floating points in reference to the axis to which they correspond. Built into GraalScript are several functions which can be used to analyze these vectors.

In mathematics, vectors are often written
v = <v1,v2,v3>
for a vector in three dimensions. They can also be written as the sum of unit vectors, i = <1,0,0>, j = <0,1,0>, and k = <0,0,1> on the x, y, and z axes, respectively. In this case, the vector would be written as
v = v1i + v2j + v3k
where the values of v are treated as scalars (numerical multipliers) of the unit vectors.

To denote the difference between a scalar and a vector, vectors are often written with a directional arrow above them, which looks like the top half of an arrow pointing right. In GraalScript, a scalar and a vector are impossible to confuse: a scalar is a floating point whereas a vector is a string.

=== Vector Length (Magnitude) ===
Being as vectors are merely written by terminal point coordinates, there is no immediate way to determine the magnitude of the vector. Mathematically, the terminal point lies on a sphere that has the same radius as the vector's magnitude. Thus, we can use the equation of a sphere to calculate the magnitude. 
r2 = x2 + y2 + z2 
r = √(x2 + y2 + z2)
where r is the magnitude. Generally, the magnitude is denoted as |v| or ||v||. This was chosen, because absolute value refers to distance from the origin, thus the marks were suitable. In GraalScript, however, the magnitude of any vector can be calculated simply by plugging a vector string into the '''vectorlen({{graycourier|v}})''' function.

=== Unit Length ===
A vector is said to have "unit length" when it's magnitude is one. '''i''', '''j''', and '''k''' are each unit vectors because their magnitudes are each one. To make a vector of unit length, the vector must merely be divided by it's magnitude.
Let v be a vector and u be the direction (unit vector) of v.
v = <1,7,1>
|v| = √(12 + 72 + 12) = √51
u = v/|v| = <1/√51,7/√51,1/√51>

Graalscript has a built-in function, '''vectornormalize({{graycourier|1=v}})''',to perform such a calculation.

== Vector Modification ==
Along with vectorlen are a plethora of functions built into GraalScript all for the purpose of modifying vectors.

=== Vector Addition ===
[[Image:Vectors-addition.png|thumb|right|Vector addition]]
Given the vectors u and v, we could create a third vector that has the magnitude of u and v, were the two vectors to be placed tip-to-end. This is called vector addition and can be done with the function '''vectoradd({{graycourier|u}},{{graycourier|v}})'''. This takes the terminal coordinates and adds them together. to make a new vector: 
w = <u1+v1, u2+v2, u3+v3>.
 

=== Vector-Scalar Multiplication ===
[[Image:Vectors-scalar-multiplication.png|thumb|left|Vector-scalar multiplication]]
With a vector, v, and a scalar, s, we could make a new vector that is s times larger than v. This can be accomplished in GraalScript with the function '''vectorscale({{graycourier|v}},{{graycourier|s}})'''. The vector is thus extended in the following manner: 
s·v = s·<v1,v2,v3> = <s·v1,s·v2,s·v3>.
 

=== Vector Subtraction ===
[[Image:Vectors-subtraction.png|thumb|right|Vector subtraction]]
With these two properties, we find that vector subtraction is possible, and no longer a new idea. This is done in GraalScript with the use of the '''vectorsub({{graycourier|u}},{{graycourier|v}})''' function. 
u-v = u + (-v) = u + (-1)·v
You can imagine this as the two vectors placed tip-to-end, but the second is facing the opposite direction.
 

=== Distance Between Terminal Points ===
Without creating a third vector, it is simple in GraalScript to find the distance between the two points at which two vectors end. This function is '''vectrodist({{graycourier|u}},{{graycourier|v}})'''. 
The return value would be
√((u1-v1)2+(u2-v2)2+(u3-v3)2)
The mathematical operation is the pythagorean theorem (or a combination of two). As may be evident, the magnitude is that of '''u'''-'''v'''.

== Other functions ==
vectordot({{graycourier|u}},{{graycourier|v}}): see [[Dot Product]]. 
vectorcross({{graycourier|u}},{{graycourier|v}}): see [[Cross Product]].

Cross Product

2006-12-28T18:28:50Z

Tolnaftate2004: /* Definition */

The Cross Product is a property of [[Vectors|vectors]]. The cross product takes two vectors and returns a third, which is perpendicular, or orthogonal, to the passed vectors. This vector is referred to as the normal vector, which normally is corrected to have a total magnitude of one in mathematics.

== Definition ==
If vectors u and v are crossed ("u cross v"), the magnitude of the normal vector is equal to |u||v|sin(θ). Thus,
|u × v| = |u||v||sin(θ)||'''n'''|
|u × v| = |u||v||sin(θ)|
In other applications, this magnitude has been found to be equal to the area of the parallelogram whose vertecies are at '''0''', '''u''', '''u'''+'''v''', and '''v'''.

In addition,
u × '''0''' = '''0'''
u × v = -(v × u)
(ru) × (sv) = (rs) u × v (where r and s are scalars)

== General Application of the Cross Product ==
It is common practice in mathematics to write vecotrs as sums of th unti vectors, '''i''', '''j''', and '''k'''. These each have a magnitude of one and, from the origin, move precisely 1 unit on the x, y, and z axes respectively.

Say, then, that we have two vectors, u and v.
u = <u1,u2,u3>
v = <v1,v2,v3>
We can rewrite these vectors in terms of '''i''', '''j''', and '''k'''.
u = u1'''i''' + u2'''j''' + u3'''k'''
v = v1'''i''' + v2'''j''' + v3'''k'''
We can then "multiply" them in an algebraic manner.
u × v = (u1v1)'''i''' × '''i''' + (u1v2)'''i''' × '''j''' + (u1v3)'''i''' × '''k''' + (u2v1)'''j''' × '''i''' + (u2v2)'''j''' × '''j''' +
(u2v3)'''j''' × '''k''' + (u3v1)'''k''' × '''i''' + (u3v2)'''k''' × '''j''' + (u3v3)'''k''' × '''k'''
We can remove immediately any terms where the vector is crossing itself. The angle between two parallel vectors, a and b, is 0, thus a × b = |a||b|sin(0)|n| = 0 . So, the above statement simplifies to

u × v = (u1v2)'''i''' × '''j''' + (u1v3)'''i''' × '''k''' + (u2v1)'''j''' × '''i''' + (u2v3)'''j''' × '''k''' + (u3v1)'''k''' × '''i''' + (u3v2)'''k''' × '''j'''
Because the cross product reflects the normal vector, the following hold:
i × j = -(j × i) = k
j × k = -(k × j) = i
k × i = -(i × k) = j
Then, we can simplify our equation further:
u × v = (u1v2)'''k''' + (u1v3)(-'''j''') + (u2v1)(-'''k''') + (u2v3)'''i''' + (u3v1)'''j''' + (u3v2)(-'''i''')
= (u2v3-u3v2)'''i''' + (u3v1-u1v3)'''j''' + (u1v2-u2v1)'''k'''
= (u2v3-u3v2)'''i''' - (u1v3-u3v1)'''j''' + (u1v2-u2v1)'''k''' (u-components are in order)
This describes the direction of the normal vector to the vectors u and v. This sum can be expressed in [[Matrix|matricies]]
<table>
<tr>
<td>        =</td>
<td>
<table frame="vsides" style="border: 1px solid black;">
<tr>
<td>u2</td>
<td>u3</td>
</tr>
<tr>
<td>v2</td>
<td>v3</td>
</tr>
</table>
</td>
<td>'''i''' - </td>
<td>
<table frame="vsides" style="border: 1px solid black;">
<tr>
<td>u1</td>
<td>u3</td>
</tr>
<tr>
<td>v1</td>
<td>v3</td>
</tr>
</table>
</td>
<td>'''j''' + </td>
<td>
<table frame="vsides" style="border: 1px solid black;">
<tr>
<td>u1</td>
<td>u2</td>
</tr>
<tr>
<td>v1</td>
<td>v2</td>
</tr>
</table>
</td>
<td>'''k'''</td>
</tr>
</table>
<table><tr><td>        =</td><td><table frame="vsides" style="border: 1px solid black;"><tr> <td>'''i'''</td><td>'''j'''</td><td>'''k'''</td> </tr><tr> <td>u1</td><td>u2</td><td>u3</td> </tr><tr> <td>v1</td><td>v2</td><td>v3</td> </tr></table></td></tr></table>

== The Cross Product in GraalScript ==
The cross product of two vector arrays in Graal can be obtained through the vectorcross({{graycourier|u}},{{graycourier|v}}) function. It's return value is a vector, w1'''i''' + w2'''j''' + w3'''k''', where the vector w is calculated from the determinant of the above [[Matrix|matrix]].

Matrix

2006-12-02T00:43:10Z

Tolnaftate2004: /* Demystifying Matricies in GraalScript */

A '''matrix''' (''pl.'' matricies) is a list of numbers, generally who have a relationship between them, that are ordered in a type of mathematical array. A matrix, m, may be written as either |m|, [m], or sometimes even (m) in mathematics, where m is a placeholder for the numbers in the matrix.

''Any matrix examples below will use the |m| notation for simplicity.''

== Reading a Matrix ==
A matrix is ordered in rows and colums, which are counted by increasing i and j respectively. One can think of a matrix as a 2-dimensional array where each object in the 1st dimension holds an array of numbers in that row.

An entry at i=2 and j=3 is noted by either M[2,3] or m2,3. These numbers are important for some modifications involving these matricies.

== Demystifying Matricies in GraalScript ==
If you have ever tested any of the matrix functions built into GraalScript, you may be lost as to where the return value comes from. Well, luckily there are some adept enough with math to understand these functions. These are their findings.

=== matrixcreate() ===
Let '''v''' be a vector and '''a''' consisting of a vector and a scalar.

==== Usage ====
{{code|1=
strMatrix = matrixcreate(v,a);
}}
Where v describes the translation (postition) and 'a' describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7 (this will be explained later).

==== Example ====
{{code|1=
temp.matrix = matrixcreate({1,1,1},{1,7,1,1});
// This will return 1,1,1,0.140028,0.980196058,0.140028,7.14595223
}}

==== The Math Behind the Function ====
The first three numbers of the return value should be rather familiar. It is the vector you passed to the function. The other four seem to come out of nowhere. However, there is a method to this madness. The first of these three are merely a property of angles. Because of the [[Dot Product]] of vectors, we are able to calculate the cosine of the angle between two vectors. Well, we have actually created a new vector in this code!

As defined in [[Vectors]], we know that there are three unit vectors that lay on the x, y, and z axes. These vectors have been given the letters '''i''', '''j''', and '''k''', respectively. The first value defined in the "rotation" is multiplied to '''i''', the second to '''j''', and so forth, and this makes a new vector. However, this still does not tell us why we have these numbers returned to us.

From the definition of the dot product, we know that
cos(θ) = uv/(|u||v|)
The first three numbers returned to us are the cosine of the angles between the new vector (in this case, <1,7,1>) and each of our unit vectors. For example:
cos(α) = <1,7,1><1,0,0>/(|<1,7,1>||<1,0,0>|) = 1/√51 = 0.1400280084
cos(β) = <1,7,1><0,1,0>/(|<1,7,1>||<0,1,0>|) = 7/√51 = 0.9801960588
cos(γ) = <1,7,1><0,0,1>/(|<1,7,1>||<0,0,1>|) = 1/√51 = 0.1400280084

''There is an evident difference between the values given here and the return value. A computer cannot calculate cosine on its own. It merely uses a method of estimation.''

cos(α)2 + cos(β)2 + cos(γ)2 = 1 (1)

<hr width="33%" noshade="noshade">
(1) The returned values are accurate within ±10-5

So far, we have 6 of 7 figured out. The last is the simplest of them all. Plugging the new vector into vectorlen() or using √(x2 + y2 + z2) returns it's magnitude. This, multiplied by the fourth number of the second parameter, is the last of the returned values (and as far as anyone can tell the vector passed to the function has no bearing on the return value).

=== matrixcreatefromeuler() ===
Let '''r''' be an array describing rotation, {α,β,γ}.

==== Usage ====
{{code|1=
strMatrix = matrixcreatefromeuler(r);
}}
Where r describes the rotation (rotation axis and angle).

==== Return Value ====
Returns a matrix array of length 7.

==== Example ====
{{code|1=
temp.matrix = matrixcreatefromeuler({pi/2,0,pi/2});
// This will return 0,0,0,-0.577350258,-0.577350258,-0.577350258,119.999976018
}}

==== The Math Behind the Function ====
'''Coming soon!'''

== Matricies in Mathematics ==
There are several matrix-specific operations in mathematics that are helpful in calculations of objects in space.

=== Matrix Addition and Subtraction ===
These operations are generally between two equal-sized matricies. This is a rather simple operation. however, we can assume that the matricies can zero-fill until they are of equal size. If we have two matricies, m and n, the sum of these two is merely mi,j±ni,j for each i and j where 0 ≤ i < # of rows and 0 ≤ j < # of columns.

<table>
<tr>
<td>
<table frame="vsides" style="border: 1px solid black;" cellspacing=3>
<tr>
<td>a</td>
<td>b</td>
</tr>
<tr>
<td>c</td>
<td>d</td>
</tr>
<tr>
<td>e</td>
<td>f</td>
</tr>
</table>
</td>
<td>+</td>
<td>
<table frame="vsides" style="border: 1px solid black;" cellspacing=3>
<tr>
<td>g</td>
<td>h</td>
</tr>
<tr>
<td>i</td>
<td>j</td>
</tr>
<tr>
<td>k</td>
<td>l</td>
</tr>
</table>
</td>
<td>=</td>
<td>
<table frame="vsides" style="border: 1px solid black;" cellspacing=3>
<tr>
<td>a+g</td>
<td>b+h</td>
</tr>
<tr>
<td>c+i</td>
<td>d+j</td>
</tr>
<tr>
<td>e+k</td>
<td>f+l</td>
</tr>
</table>
</td>
</tr>
</table>
=== Matrix Multiplication ===
In mathematics, two matricies can be multiplied together to create a third matrix. There is only one rule to multiplying matricies. That is that the number of columns of the first must be equal to the number of rows of the second.
A matrix that is ''a'' high and ''b'' wide can multiply with another matrix that is ''b'' high and ''c'' wide, but not the reverse. Their products will be a matrix with height ''a'' and width ''c''.
<table>
<tr>
<td>
<table frame="vsides" style="border: 1px solid black;" cellspacing=3>
<tr>
<td>a</td>
<td>b</td>
<td>c</td>
</tr>
<tr>
<td>d</td>
<td>e</td>
<td>f</td>
</tr>
<tr>
<td>g</td>
<td>h</td>
<td>i</td>
</tr>
</table>
</td>
<td>
<table frame="vsides" style="border: 1px solid black;" cellspacing=3>
<tr>
<td>j</td>
</tr>
<tr>
<td>k</td>
</tr>
<tr>
<td>l</td>
</tr>
</table>
</td>
<td>=</td>
<td>
<table frame="vsides" style="border: 1px solid black;" cellspacing=3>
<tr>
<td>aj+bk+cl</td>
</tr>
<tr>
<td>dj+ek+fl</td>
</tr>
<tr>
<td>gj+hk+ij</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>    3x'''3'''</td>
<td>'''3'''x1</td>
<td> </td>
<td>     3x1</td>
</tr>
</table>

The above example could be used to simply describe the equations of three planes and find the point at which three planes in three dimensions meet (three planes meet at exactly one point, two planes meet at a unique line).