Creation/Dev/Script/Clientside Functions
From Graal Bible
| [R] | denotes it is read-only. |
| [3D] | denotes it is a Graal3D function. |
| [opengl] | denotes it is functional only in opengl mode. |
Variables
| Variable | 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
| Variable | 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. | |
| 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. | |
| format(string, string, ...) | See format(). | |
| 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 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, float, float, float) hitobjects(float, float, float) hitplayer(int, float, float, float) isadminguild(str) - returns boolean isclassloaded(str) - returns boolean iscursoron() - returns boolean isdevicefullscreenonly(str) - returns boolean isdownloading(str) - returns boolean - checks 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 isimgpixeltransparent(str, int, int) - returns boolean 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-file-dialog for the download location of files (from scripted RC) selectfileforupload() - opens the select-file-dialog for uploading of files (into scripted RC) 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
TGraalVar:
initialized - boolean [R]
ispaused - boolean - suspends the script if set to paused
joinedclasses - object
maxlooplimit - integer - sets the maxmimum number of loop iterations, default 10000; the allowed range for this can vary from server to server
name - string
scripterrors - object [R] - gives the list of script errors which were reported for this object
scriptlogmissingfunctions - boolean
timeout - float
addarray(obj) - adds another array to this variable
addarraymember(str) - returns object - adds an array member with a name and returns the new array member
addnamedstring(str, str) - returns object
cancelevents(str) - removes all previously scheduled events (scheduleevent) of the specified event name
catchevent(str, str, str) - adds an event handler for the specified object and event, third parameter is the function which receives the event (first parameter of the event will be the object for which the event occured)
clearemptyvars() - removes empty subvariables from memory
clearvars() - clears all dynamic variables
copyfrom(obj) - copies all variables and array values from another object, doesn't work for protected variables like players though
getarraymember(str) - returns object - searches for an array member by name
getdynamicvarnames() - returns object - gets the names of all dynamic (not built-in) subvariables of this object
geteditvarnames() - returns object - gets the names of all dynamic variables which can be modified
getfunctions() - returns object - gets the names of all functions of the object as array, also each entry has subvariables which give more information about the function ("parameters", "description", "scope")
getstaticvarnames() - returns object - gets the names of all static (built-in) subvariables of this object
getvarnames() - returns object - gets the names of all subvariables of this object
hasfunction(str) - returns boolean - checks if the object has a function of the specified name (also checks if it can be called by the current script object)
ignoreevent(str, str) - lets the object ignore an event (second parameter) of the specified object name
ignoreevents(str) - lets the object ignore all previously catched events of the specified object name
insertarray(int, obj) - inserts an array at the specified index
isinclass(str) - returns boolean - checks if the object has joined the specified class
join(str) - lets the object join a class and inherit all functions and event handlers of that class
leave(str) - leaves a previously joined class
loadfolder(str, int) - loads the content of a folder into the variable, you must specify the folder name and pattern (e.g. "levels/bodies/*.png") and if it should be recursive
loadini(str) - loads an .ini file into the variable, you can access variables by obj.inisection.varname
loadlines(str) - loads a file and adds it line by line to the variable (as array)
loadstring(str) - loads the content of a file into the variable
loadvars(str) - loads the variables from a file where each line has the format varname=value
loadvarsfromarray(obj) - loads the variables from a string list of the format varname=value
loadxml(str)
loadxmlfromstring(str)
objecttype() - returns string - returns the object type, which can be TGraalVar, TProjectile etc.
savelines(str, int) - saves the array line by line into a file, the second parameter is the save mode (0 - overwrite, 1 - append)
savestring(str, int) - saves the value as string into a file, the second parameter is the save mode (0 - overwrite, 1 - append)
savevars(str, int) - saves the subvars in the format varname=value into a file, the second parameter is the save mode (0 - overwrite, 1 - append)
savevarstoarray(bool) - returns object - saves the subvars in the format varname=value into an array, you must specify if it should be sorted
savexml(str, int)
savexmltostring() - returns string
scheduleevent(float, str, params...) - returns object - invokes an event (onEventname) after the specified delay (in seconds), second parameter is the event name, followed by the parameters
settimer(float) - invokes an onTimeout event after the specified time, similar to 'timeout=value'
sortascending() - sorts the array in ascending order (smallest value first)
sortbyvalue(str, str, bool) - sorts an array, specify the variable of the array members which is compared, also the variable type and if it should be sorted ascending; variable type can be "string", otherwise it is sorted by floating point value
sortdescending() - sorts the array in descending order (highest value first)
subarray2(int, int, int, int) - returns object - extracts a two-dimensional array, specify startpos1, length1, startpos2, length2
timershow() - lets an npc show the current timeout variable, deprecated
trigger(str, params...) - invokes an event on the object (onEventname) with the specified event name and parameters, doesn't interrupt the current script
ActionMap (TGraalVar):
bind(str, str, str)
getbinding(str) - returns string
getcommand(str, str) - returns string
load() - returns boolean
pop()
push()
save()
unbind(str, str)
DTSAniThread (TGraalVar):
aniindex - integer [R]
atend - boolean [R]
attack - boolean
endpos - float
hold - boolean
position - float
sequence - string
startpos - float
state - string
timescale - float
transtitiontime - float
isintransition() - returns boolean
play()
GameMovementInterpolate (TGraalVar):
rigid - object [R]
applyimpulse(str, str)
GameMovementRigid (GameMovementInterpolate):
addrigidmove(str, str) - adds torque and force vector
GameMovementList (TGraalVar):
finishmoves()
move3d(str, float, int)
GameShape (TGraalVar):
pixelshader - string
vertexshader - string
GameShapeDIF (GameShape):
activatelight(str)
deactivatelight(str)
GameShapeDTS (GameShape):
materiallist - object [R]
materials - object [R]
forceanimations() - starts to animate the object to make sure the animations are the wished start position
getanimation(int) - returns object
listnodes() - returns object
pauseanimation(int)
playanimation(int, str, int) - returns object - specify animation slot, animation name and flags (1 - hold, 2 - atend, 4 - attackanimation)
playanimation2(int, str, int, float, float, float, float) - returns object - specify animation slot, animation name, flags, startpos, endpos, timescale, transitiontime
stopanimation(int)
GameShapeFT (GameShape):
levels - integer
seed - integer
GuiControl (TGraalVar):
acceptdropfiles - boolean
active - boolean
alpha - float
awake - boolean [R]
blue - float
canmove - boolean
canresize - boolean
clientextent - string
clientheight - integer
clientwidth - integer
clipmove - boolean - when the user moves the control (see canMove) then this makes sure that the control is not moving outside the parents bounds, by default true
color - string
editing - boolean
extent - string - width and height of the control
flickerbasetime - float - if you want to let controls flicker at different time but with the same frequency, then set this to some random value (e.g. random(0,1))
flickering - boolean - lets the control automatically show and hide itself in flickertime intervals
flickertime - float - says in what interval the control is shown and hidden, in seconds; works only in combination with flickering=true
green - float
height - integer
hint - string - text which is displayed when the user moves the mouse over the control
hinttime - float - says after how much time of not moving the mouse the hint should appear
horizsizing - string - specifies the horizontal resizing behaviour when the parent control is resized: right, width, left, center or relative
layer - integer [R]
minextent - string - minimum width and height for the control which should be enforced
minsize - string - the same like "minExtent"
mode - integer - the control drawing mode (0 - add, 1 - transparent, 2 - subtract, 3 - daynight)
parent - object [R]
position - string
profile - object
red - float
resizeheight - boolean
resizewidth - boolean
scrolllinex - integer - if this is the first control inside a GuiScrollCtrl, then this defines by how many pixel the scroll control is scrolled horizontally when clicking on the left/right scroll bar buttons
scrollliney - integer - if this is the first control inside a GuiScrollCtrl, then this defines by how many pixel the scroll control is scrolled vertically when clicking on the up/down scroll bar buttons
showhint - boolean - whether the hint should be shown when the user moves the mouse over the control
style - string
useownprofile - boolean
vertsizing - string - specifies the vertical resizing behaviour when the parent control is resized: bottom, height, top, center or relative
visible - boolean
width - integer
x - integer
y - integer
addcontrol(obj)
bringtofront()
clearcontrols()
destroy()
getparent() - returns object
globaltolocalcoord(str) - returns string - converts global screen coordinates to a position relative to the controls origin (0,0), can be used to know where exactly the user has clicked inside a control
hide()
isactuallyvisible() - returns boolean
isfirstresponder() - returns boolean
localtoglobalcoord(str) - returns string - converts a position relative to the controls origin (0,0) to global screen coordinates, can be used to know where on the screen a control is displayed in case it is a child of another control (e.g. GuiWindowCtrl or GuiScrollCtrl)
makefirstresponder(bool)
pushtoback()
resize(int, int, int, int)
show()
showtop() - calls show(), tabfirst() and bringtofront()
startdrag()
tabfirst() - returns object
EditManager (GuiControl):
GuiArrayCtrl (GuiControl):
allowmultipleselections - boolean
GuiTextListCtrl (GuiArrayCtrl):
clipcolumntext - boolean
columns - string - of format "0 16", offset of the tabulators
enumerate - boolean
fitparentwidth - boolean
groupsortorder - string
iconheight - integer [R]
iconwidth - integer [R]
resizecell - boolean
selected - object [R]
sortcolumn - integer
sortmode - string
sortorder - string
addrow(int, str) - returns object - the added row
clearrows()
clearselection()
findtext(str) - returns integer - row index
findtextid(str) - returns integer - row id
getrowatpoint(int, int) - returns integer - row index
getrowidatpoint(int, int) - returns integer - row id
getrownumbyid(int) - returns integer
getselectedid() - returns integer - row id
getselectedids() - returns object - array of row ids
getselectedrow() - returns integer - row index
getselectedrows() - returns object - array of row indices
getselectedtext() - returns string
insertrow(int, int, str) - returns object - the inserted row
isidselected(int) - returns boolean
isrowselected(int) - returns boolean
makevisible(int)
makevisiblebyid(int)
removerow(int)
removerowbyid(int)
rowcount() - returns integer
seticonsize(int, int)
setrowactivebyid(int, bool)
setrowbyid(int, str)
setselectedbyid(int)
setselectedbytext(str)
setselectedrow(int)
sort()
GuiTreeViewCtrl (GuiArrayCtrl):
boxwidth - integer
clipcolumntext - boolean
columns - string - of format "0 16", offset of the tabulators
expanded - boolean
expandedimage - integer
expandedselectedimage - integer
expandondoubleclick - boolean
extent - string [R]
firstlinevisible - boolean
fitparentwidth - boolean
groupsortorder - string
height - integer [R]
hint - string
image - integer
level - integer [R]
name - string - same as 'text'
nodes - object [R]
parent - object [R]
position - string [R]
profile - object
selectedimage - integer
sortgroup - integer
sortmode - string
sortorder - string
sortvalue - integer
statuswidth - integer
text - string
useownprofile - boolean
visible - boolean
width - integer [R]
x - integer [R]
y - integer [R]
addlines(obj, bool)
addnode(str) - returns object
addnodebypath(str, str) - returns object
addvars(obj, bool)
clearnodes()
clearrows() - same as clearNodes()
destroy()
getfullname(str) - returns string
getnode(str) - returns object
getnodeat(int, int) - returns object
getnodebypath(str, str) - returns object
getselectednode() - returns object
select()
seticonsize(int, int)
sort()
GuiBitmapBorderCtrl (GuiControl):
tile - boolean
GuiBitmapButtonCtrl (GuiControl):
mouseoverbitmap - string
normalbitmap - string
pressedbitmap - string
text - string
setbitmap(str, int)
GuiBitmapCtrl (GuiControl):
bitmap - string
tile - boolean - specifies if the bitmap should be repeated (true) or stretched (false)
wrap - boolean - same as 'tile', kept for compatibility
setbitmap(str)
setvalue(int, int) - sets the offset of the image (horizontal and vertical)
GuiMapOverviewCtrl (GuiBitmapCtrl):
mapalpha - float
pointsize - float
GuiBrowserCtrl (GuiControl):
url - string
GuiButtonBaseCtrl (GuiControl):
buttontype - string
checked - boolean
groupnum - integer
text - string
gettext() - returns string
performclick()
settext(str)
GuiButtonCtrl (GuiButtonBaseCtrl):
stylesection - string
seticonsize(int, int)
GuiCheckBoxCtrl (GuiButtonBaseCtrl):
GuiRadioCtrl (GuiCheckBoxCtrl):
GuiContextMenuCtrl (GuiControl):
clipcolumntext - boolean
columns - string - of format "0 16", offset of the tabulators
enumerate - boolean
fitparentwidth - boolean
groupsortorder - string
iconheight - integer [R]
iconwidth - integer [R]
maxpopupheight - integer
profile - object
resizecell - boolean
rows - object [R]
scrollprofile - object
selected - object [R]
sortcolumn - integer
sortmode - string
sortorder - string
textprofile - object
width - integer
addrow(int, str) - returns object - the added row
clearrows()
clearselection()
close()
findtext(str) - returns integer - row index
findtextid(str) - returns integer - row id
getrowatpoint(int, int) - returns integer - row index
getrowidatpoint(int, int) - returns integer - row id
getrownumbyid(int) - returns integer
getselectedid() - returns integer - row id
getselectedids() - returns object - array of row ids
getselectedrow() - returns integer - row index
getselectedrows() - returns object - array of row indices
getselectedtext() - returns string
insertrow(int, int, str) - returns object - the inserted row
isidselected(int) - returns boolean
isopen() - returns boolean
isrowselected(int) - returns boolean
makevisible(int)
makevisiblebyid(int)
open(int, int) - opens the menu at the specified screen position, if possible use openAtMouse() instead
openatmouse()
removerow(int)
removerowbyid(int)
rowcount() - returns integer
seticonsize(int, int)
setrowactivebyid(int, bool)
setrowbyid(int, str)
setselectedbyid(int)
setselectedbytext(str)
setselectedrow(int)
sort()
GuiStartMenuCtrl (GuiContextMenuCtrl):
text - string
width - integer
gettext() - returns string
settext(str)
GuiDrawingPanel (GuiControl):
parth - integer [R]
partw - integer [R]
partx - integer [R]
party - integer [R]
clearall()
clearrectangle(int, int, int, int)
drawimage(int, int, str)
drawimagerectangle(int, int, str, int, int, int, int)
drawimagestretched(int, int, int, int, str, int, int, int, int)
saveimage(str)
GuiFlash (GuiControl):
backgroundalpha - float
downloadwebfiles - boolean
hideonoverlap - boolean
loopmovie - boolean
messageonoverlap - string
moviename - string
requiresactivex - boolean - same as requiresplugin
requiresplugin - boolean - only displays the flash file if the flash plugin or activex control could be loaded
tryactivex - boolean - same as tryplugin
tryplugin - boolean - tries to load the flash plugin or activex control to display the flash file
getflashvariable(str) - returns string
loadmovie(str, bool, float)
playmovie()
restartmovie()
setbackgroundalpha(float)
setflashvariable(str, str)
setlooping(bool)
stopmovie()
GuiFrameSetCtrl (GuiControl):
autobalance - boolean
bordercolor - string
borderenable - string
bordermovable - string
borderwidth - integer
columncount - integer
fudgefactor - integer
minextent - string
rowcount - integer
getcolumncount() - returns integer
getcolumnoffset(int) - returns integer
getrowcount() - returns integer
getrowoffset(int) - returns integer
setcolumncount(int)
setcolumnoffset(int, int)
setrowcount(int)
setrowoffset(int, int)
GuiGraal3DCtrl (GuiControl):
GuiGraalCtrl (GuiControl):
GuiInputCtrl (GuiControl):
GuiMenuCtrl (GuiControl):
iconheight - integer [R]
iconwidth - integer [R]
addmenu(str) - returns object
clearmenus()
findmenu(str) - returns object
removemenu(str)
seticonsize(int, int)
GuiMLTextCtrl (GuiControl):
allowcolorchars - boolean
allowedtags - string
alpha - float
deniedsound - string
disallowedtags - string
htmlcompatibility - boolean
htmllinks - boolean - will automatically open a webbrowser when clicking on a link if you don't want to do it yourself by handling onURL() events via script
maxchars - integer
parsetags - boolean
syntaxhighlighting - boolean
text - string
urlbase - string
wordwrap - boolean
addtext(str, bool)
getcursorline() - returns integer
getline(int) - returns string
getlinecount() - returns integer
getlines() - returns object - array of lines
gettext() - returns string
reflow()
scrolltobottom()
scrolltotag(str)
scrolltotop()
setlines(obj)
settext(str)
Continued on Creation/Dev/Script/Clientside_Functions_Continued