Creation/Dev/Script/Clientside Functions: Difference between revisions

From Graal Bible
No edit summary
 
m (→‎Functions: trace)
 
(54 intermediate revisions by 14 users not shown)
Line 1: Line 1:
<nowiki>
[[Category:Scripting Reference]]
Global:
{| border="0" cellpadding="2" width="50%"
  $camera::movementspeed - float
|[R]
  $pref::audio::choosenvoicecodec - integer
| denotes it is read-only.
  $pref::audio::microactivatebyvolume - boolean
|-
  $pref::audio::microactivationlevel - integer
|[3D]
  $pref::audio::microinputdevice - integer
| denotes it is a Graal3D function.
  $pref::audio::microon - boolean
|-
  $pref::audio::microvolumefactor - integer
|[opengl]
  $pref::audio::midivolume - integer
| denotes it is functional only in opengl mode.
  $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::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::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)
  allfeatures - integer (read only)
  allplayerscount - integer (read only)
  allstats - integer (read only)
  canspin - boolean (read only)
  carriesblackstone - boolean (read only)
  carriesbush - boolean (read only)
  carriesnpc - boolean (read only)
  carriessign - boolean (read only)
  carriesstone - boolean (read only)
  carriesvase - boolean (read only)
  downloadfile - string (read only)
  downloadpos - integer (read only)
  downloadsize - integer (read only)
  editingmission - boolean
  emoticonchar - string (read only)
  focusx - float (read only)
  focusy - float (read only)
  graalversion - float (read only)
  gravity - float
  iscarrying - boolean (read only)
  isfocused - boolean (read only)
  isgraal3d - boolean (read only)
  isleader - boolean (read only)
  isonmap - boolean (read only)
  lastdownloadfile - string (read only)
  leftmousebutton - boolean (read only)
  levelorgx - float (read only)
  levelorgy - float (read only)
  lighteffectsenabled - boolean
  middlemousebutton - boolean (read only)
  mousebuttons - integer (read only)
  mousescreenx - integer
  mousescreeny - integer
  mousewheeldelta - integer (read only)
  mousex - float
  mousey - float
  musiclen - integer (read only)
  musicpos - integer (read only)
  particleeffectsenabled - boolean
  rightmousebutton - boolean (read only)
  screenheight - integer (read only)
  screenwidth - integer (read only)
  scriptedcontrols - boolean (read only)
  scriptedplayerlist - boolean (read only)
  scriptlogwritetoreadonly - boolean
  selectedlistplayers - object
  selectedsword - integer
  selectedweapon - integer
  servername - string (read only)
  serverstartconnect - string
  serverstartparams - string
  shotbybaddy - boolean (read only)
  shotbyplayer - boolean (read only)
  showterraingrid - boolean
  timevar - integer (read only)
  timevar2 - float (read only)
  wasshooted - boolean (read only)
  waterheight - float
  weapons - object (read only)
  weaponsenabled - boolean
  weathereffectsenabled - boolean
  worldclockstopped - boolean
  worldhour - integer
  worldminute - float
  worldminutesofday - float
  worldrealsecondsperday - float
  addcontrol(obj)
  addmaterialmapping(str, str) - returns boolean
  addtiledef(str, str, int)
  addtiledef2(str, str, int, int)
  adventure_installgraal(str, bool, bool)
  adventure_openexternaloptions() - returns boolean
  adventure_openexternalpm(obj) - returns boolean
  adventure_openserverlist()
  adventure_quit()
  adventure_savegraaloptions()
  adventure_selectfileselect(str) - lets the select-file-dialog select the specified filename in the current folder
  adventure_selectfilesetfolder(int) - switches the select-file-dialog to the specified folder index
  adventure_selectfilesetfolderbytext(str) - switches the select-file-dialog to the specified folder name
  adventure_selectfileshowhiddenfiles(bool) - enables or disables the display of hidden files in the select-file-dialog
  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()
  aindexof(float, obj) - returns integer
  attachplayertoobj(int, int)
  base64decode(str) - returns string
  base64encode(str) - returns string
  callnpc(int, params...)
  callweapon(int, params...)
  checksum(str) - returns float
  commandtoserver(str)
  contains(str, str) - returns boolean
  cursoroff()
  cursoron()
  degtorad(float) - returns float
  detachplayer()
  disabledefmovement()
  disablemap()
  disablepause()
  disableselectweapons()
  disableweapons()
  echo(str)
  enabledefmovement()
  enablefeatures(int)
  enablemap()
  enablepause()
  enableselectweapons()
  enableweapons()
  explodebomb(int)
  extractfilebase(str) - returns string
  extractfileext(str) - returns string
  extractfilename(str) - returns string
  extractfilepath(str) - returns string
  fileexists(str) - returns boolean
  filesize(str) - returns integer
  fileupdate(str) - returns boolean
  findani(str) - returns object
  findfiles(str, int) - returns object
  findfirstfile(str) - returns string
  findlevel(str) - returns object
  findnextfile(str) - returns string
  findnpcbyid(int) - returns object
  findplayer(str) - returns object
  findplayerbyid(int) - returns object
  findweapon(str) - returns object
  freezeplayer(float)
  getascii(str) - returns integer
  getbasepackage() - returns object
  getboxcenter(str) - returns string
  getdatablocktypes() - returns object
  getdisplaydevicelist() - returns string
  getdownloadedupdatepackagesize() - returns integer
  getdownloadingpackage() - returns object
  getdownloadingpackagescount() - returns integer
  getextension(str) - returns string
  gethttprequest(str, int, str) - returns object
  getimgheight(str) - returns integer
  getimgpixel(str, int, int) - returns object
  getimgwidth(str) - returns integer
  getkeycode(str) - returns integer
  getmapx(str) - returns integer
  getmapy(str) - returns integer
  getmusicstatus() - returns string
  getmusictags() - returns object
  getobjectat(float, float) - returns object
  getobjectatmouse() - returns object
  getobjectbyray(str, str) - returns object
  getpackagesdownloadcomplete() - returns boolean
  getpackagesdownloaded() - returns boolean
  getplatform() - returns string
  getresolutionlist(str) - returns string
  getservername() - returns string
  getstringkeys(str) - returns object
  getsurfacetype(float, float) - returns string
  gettextheight(float, str, str) - returns integer
  gettextwidth(float, str, str, str) - returns integer
  gettotalupdatepackagesize() - returns integer
  getupdatepackage(str) - returns object
  getz(float, float) - returns float
  hideplayer(float)
  hidesword(float)
  hitnpc(int, float, float, float)
  hitobjects(float, float, float)
  hitplayer(int, float, float, float)
  isadminguild(str) - returns boolean
  iscursoron() - returns boolean
  isdevicefullscreenonly(str) - returns boolean
  isimgpixeltransparent(str, int, int) - returns boolean
  isimgrectangletransparent(str, int, int, int, int) - returns boolean
  isobject(str) - returns boolean
  keydown(int) - returns boolean
  keydown2(int, bool) - returns boolean
  keyname(int) - returns string
  lay2(str, float, float)
  lightscene() - returns boolean
  loadmap(str)
  lowercase(str) - returns string
  mapshapeanimation(str, str, str, float) - returns boolean
  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)
  playlooped(str)
  playlooped2(str, float, float, float)
  popdialog()
  pushdialog(obj)
  putleaps(int, float, float)
  radtodeg(float) - returns float
  randomstring(str) - returns string
  reloadfile(str)
  removetiledefs(str)
  replaceani(str, str)
  requestfiledeletion(str)
  requestfilerename(str, str)
  requestfilesmove(str, str)
  requesthttp(str, int, str) - returns object
  requestmysql(str, str, str, str, str) - returns object
  requesttext(str, str)
  requesturl(str) - returns object
  resetfocus()
  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)
  setminimap(str, str, float, float)
  setmusicvolume(float, float)
  setplayerdir(str)
  setshadowdetaillevel(float)
  setshield(str, int)
  setshoecolor(str)
  setshootparams(str)
  setskincolor(str)
  setskybandcolors(obj)
  setskybandsizes(obj)
  setsleevecolor(str)
  setsuncolors(obj)
  setsword(str, int)
  setterrainrendermode(int)
  showstats(int)
  spyfire(int, int)
  stopmidi()
  stopsound(str)
  strcmp(str, str) - returns integer
  strequals(str, str) - returns boolean
  synctimeofday(float, float)
  takeplayercarry()
  takeplayerhorse()
  testplayer(float, float) - returns integer
  triggeraction(float, float, str, params...)
  triggerserver(str, str)
  updateboard(int, int, int, int)
  updateratings(obj) - returns object - updates an array of {rating1,ratingdeviation1, rating2,ratingdeviation2, ...}, init them at 1500 and 350
  updateterrain()
  updatevisibledistance()
  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


TGraalVar:
  initialized - boolean (read only)
  joinedclasses - object (read only)
  name - string (read only)
  scriptlogmissingfunctions - boolean
  timeout - float
  addarray(obj) - adds another array to this variable
  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)
  copyfrom(obj) - copies all variables and array values from another object, doesn't work for protected variables like players though
  getdatablockvars() - returns object - gets the names of all variables which are pointing to datablocks (for Graal3D, will be removed soon)
  getdynamicvarnames() - returns object - gets the names of all static (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 dynamic (not built-in) subvariables of this object
  getvarnames() - returns object - gets the names of all subvariables of this 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 float - 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
  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
  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
  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 a timeout event after the specified time, similar to 'timeout=value'
  sortascending() - sorts the array in ascending order (smallest value first)
  sortbyvalue(str, str, bool) - sorts the array by the specified variable name, you must also say what variable type it is (e.g. string) and if it should be sorted ascending
  sortdescending() - sorts the array in descending order (highest value first)
  timershow() - lets the npc show the 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)


  GuiControl (TGraalVar):
==Variables==
    active - boolean
{| border="1" cellpadding="2" width="100%"
    awake - boolean (read only)
| '''Variable'''
    canmove - boolean
|width="100px"|'''Type'''
    canresize - boolean
| '''Notes'''
    editing - boolean
|-
    extent - string
| allfeatures
    height - integer
| ''integer [R]''
    hint - string
|
    horizsizing - string
|-
    layer - integer (read only)
| allplayerscount
    minextent - string
| ''integer [R]''
    minsize - string - the same like "minExtent"
| Returns the count of all players on your playerlist, including IRC bots.
    parent - object (read only)
|-
    position - string
| allrenderobjecttypes
    profile - object
| ''integer [R]''
    resizeheight - boolean
|
    resizewidth - boolean
|-
    scrolllinex - integer
| allstats
    scrollliney - integer
| ''integer [R]''
    showhint - boolean
| Used with showstats() in order to show all stats.
    useownprofile - boolean
|-
    vertsizing - string
| canspin
    visible - boolean
| ''boolean [R]''
    width - integer
| Returns true of false if the player has spin attack.
    x - integer
|-
    y - integer
| carriesblackstone
    addcontrol(obj)
| ''boolean [R]''
    bringtofront()
| Returns whether the player is carrying a black stone.
    destroy()
|-
    getparent() - returns object
| carriesbush
    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
| ''boolean [R]''
    hide()
| Returns whether the player is carrying a bush.
    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)
| carriesnpc
    makefirstresponder(bool)
| ''boolean [R]''
    pushtoback()
| Returns whether the player is carrying an NPC
    resize(int, int, int, int)
|-
    show()
| carriessign
    showtop() - calls show(), tabfirst() and bringtofront()
| ''boolean [R]''
    tabfirst() - returns object
| 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''
|
|-
|}


    EditManager (GuiControl):


    GuiArrayCtrl (GuiControl):
      allowmultipleselections - boolean


      GuiTextListCtrl (GuiArrayCtrl):
=Functions=
        clipcolumntext - boolean
{| border="1" cellpadding="2" width="100%"
        columns - string - of format "0 16", offset of the tabulators
| '''Function'''
        enumerate - boolean
|width="100px"|'''Type'''
        fitparentwidth - boolean
| '''Notes'''
        groupsortorder - string
|-
        iconheight - integer (read only)
| addcontrol(object)
        iconwidth - integer (read only)
|
        resizecell - boolean
| adds 'object' to the parent control.
        selected - object (read only)
|-
        sortcolumn - integer
| addmaterialmapping(string, string)
        sortmode - string
| [3D]
        sortorder - string
| returns boolean.
        addrow(int, str) - returns object - the added row
|-
        clearrows()
| addtiledef(string image, string prefix, int format)
        clearselection()
|
        findtext(str) - returns integer - row index
| Adds a tileset definition with the supplied tileset image, level prefix and tileset format (0=pics1, 1=new world, 5=terrain).
        findtextid(str) - returns integer - row id
|-
        getrowatpoint(int, int) - returns integer - row index
| addtiledef2(string image, string prefix, int x, int y)
        getrowidatpoint(int, int) - returns integer - row id
|
        getrownumbyid(int) - returns integer
| 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.
        getselectedid() - returns integer - row id
|-
        getselectedids() - returns object - array of row ids
| aindexof(float, array)
        getselectedrow() - returns integer - row index
|
        getselectedrows() - returns object - array of row indices
| Returns integer - the position of 'float' in the array.
        getselectedtext() - returns string
|-
        insertrow(int, int, str) - returns object - the inserted row
| arccos(float)
        isidselected(int) - returns boolean
|
        isrowselected(int) - returns boolean
| Returns float - the arc cosine of 'float'.
        makevisible(int)
|-
        makevisiblebyid(int)
| arcsin(float)
        removerow(int)
|
        removerowbyid(int)
| Returns float - the arc sine of 'float'.
        rowcount() - returns integer
|-
        seticonsize(int, int)
| attachplayertoobj(integer1, integer2)
        setrowactivebyid(int, bool)
|
        setrowbyid(int, str)
| 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.
        setselectedbyid(int)
|-
        setselectedbytext(str)
| base64decode(string)
        setselectedrow(int)
|
        sort()
| 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 <span style="color:red; font-weight: bold;">deprecated</span>.
|-
| 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
|}
<br />


      GuiTreeViewCtrl (GuiArrayCtrl):
=Objects=
        clipcolumntext - boolean
{{:Creation/Dev/Script/Client}}
        columns - string - of format "0 16", offset of the tabulators
<br />
        expanded - boolean
        expandedimage - integer
        expandedselectedimage - integer
        expandondoubleclick - boolean
        fitparentwidth - boolean
        groupsortorder - string
        image - integer
        level - integer (read only)
        name - string
        nodes - object (read only)
        parent - object (read only)
        selectedimage - integer
        sortgroup - integer
        sortmode - string
        sortorder - string
        sortvalue - integer
        visible - boolean
        x - integer (read only)
        y - integer (read only)
        addlines(obj, bool)
        addnode(str) - returns object
        addnodebypath(str, str) - returns object
        addvars(obj, bool)
        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()


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


    GuiBitmapBorderCtrl (GuiControl):
=Preference Variables=
      tile - boolean
{| border="1" cellpadding="2" width="100%"
 
| '''Variable'''
    GuiBitmapButtonCtrl (GuiControl):
|width="100px"|'''Type'''
      mouseoverbitmap - string
| '''Notes'''
      normalbitmap - string
|-
      pressedbitmap - string
| $pref::audio::choosenvoicecodec
      text - string
|
      setbitmap(str, int)
| integer
 
|-
    GuiBitmapCtrl (GuiControl):
| $pref::audio::microactivatebyvolume
      bitmap - string
|
      wrap - boolean
| boolean
      setbitmap(str)
|-
      setvalue(int, int)
| $pref::audio::microactivationlevel
 
|
      GuiCrossHairHud (GuiBitmapCtrl):
| integer
 
|-
      GuiMapOverviewCtrl (GuiBitmapCtrl):
| $pref::audio::microinputdevice
        mapalpha - float
|
        pointsize - float
| integer
 
|-
    GuiButtonBaseCtrl (GuiControl):
| $pref::audio::microon
      buttontype - string
|
      checked - boolean
| boolean
      groupnum - integer
|-
      text - string
| $pref::audio::microvolumefactor
      gettext() - returns string
|
      performclick()
| integer
      settext(str)
|-
 
| $pref::audio::midivolume
      GuiBorderButtonCtrl (GuiButtonBaseCtrl):
|
 
| integer
      GuiButtonCtrl (GuiButtonBaseCtrl):
|-
        seticonsize(int, int)
| $pref::audio::mp3volume
 
|
      GuiCheckBoxCtrl (GuiButtonBaseCtrl):
| integer
 
|-
        GuiRadioCtrl (GuiCheckBoxCtrl):
| $pref::audio::radiovolume
 
|
    GuiChunkedBitmapCtrl (GuiControl):
| integer
      bitmap - string
|-
      tile - boolean
| $pref::audio::reversestereo
 
|
    GuiContextMenuCtrl (GuiControl):
| boolean
      clipcolumntext - boolean
|-
      columns - string - of format "0 16", offset of the tabulators
| $pref::audio::sfxvolume
      enumerate - boolean
|
      fitparentwidth - boolean
| integer
      groupsortorder - string
|-
      iconheight - integer (read only)
| $pref::audio::voicevolume
      iconwidth - integer (read only)
|
      profile - object
| integer
      resizecell - boolean
|-
      rows - object (read only)
| $pref::capture::allowbyscript
      scrollprofile - object
|
      selected - object (read only)
| boolean [R]
      sortcolumn - integer
|-
      sortmode - string
| $pref::capture::area
      sortorder - string
|
      textprofile - object
| string
      width - integer
|-
      addrow(int, str) - returns object - the added row
| $pref::capture::audiobitrate
      clearrows()
|
      clearselection()
| integer
      close()
|-
      findtext(str) - returns integer - row index
| $pref::capture::disabledaynight
      findtextid(str) - returns integer - row id
|
      getrowatpoint(int, int) - returns integer - row index
| boolean
      getrowidatpoint(int, int) - returns integer - row id
|-
      getrownumbyid(int) - returns integer
| $pref::capture::format
      getselectedid() - returns integer - row id
|
      getselectedids() - returns object - array of row ids
| string
      getselectedrow() - returns integer - row index
|-
      getselectedrows() - returns object - array of row indices
| $pref::capture::fps
      getselectedtext() - returns string
|
      insertrow(int, int, str) - returns object - the inserted row
| integer
      isidselected(int) - returns boolean
|-
      isrowselected(int) - returns boolean
| $pref::capture::hideinterface
      makevisible(int)
|
      makevisiblebyid(int)
| boolean
      open(int, int)
|-
      removerow(int)
| $pref::capture::recordaudio
      removerowbyid(int)
|
      rowcount() - returns integer
| boolean
      seticonsize(int, int)
|-
      setrowactivebyid(int, bool)
| $pref::capture::showmouse
      setrowbyid(int, str)
|
      setselectedbyid(int)
| boolean
      setselectedbytext(str)
|-
      setselectedrow(int)
| $pref::capture::size
      sort()
|
 
| string
    GuiDrawingPanel (GuiControl):
|-
      parth - integer (read only)
| $pref::capture::videobitrate
      partw - integer (read only)
|
      partx - integer (read only)
| integer
      party - integer (read only)
|-
      clearall()
| $pref::graal::allowglobalpms
      clearrectangle(int, int, int, int)
|
      drawimage(int, int, str)
| boolean
      drawimagerectangle(int, int, str, int, int, int, int)
|-
      drawimagestretched(int, int, int, int, str, int, int, int, int)
| $pref::graal::automapping
 
|
    GuiFlash (GuiControl):
| boolean
      backgroundalpha - float
|-
      loopmovie - boolean
| $pref::graal::defaultfontname
      moviename - string
|
      getflashvariable(str) - returns string
| string
      loadmovie(str, bool, float)
|-
      playmovie()
| $pref::graal::defaultfontsize
      restartmovie()
|
      setbackgroundalpha(float)
| integer
      setflashvariable(str, str)
|-
      setlooping(bool)
| $pref::graal::dontconnectlevels
      stopmovie()
|
 
| boolean
    GuiFrameSetCtrl (GuiControl):
|-
      autobalance - boolean
| $pref::graal::dontloadlistheads
      bordercolor - string
|
      borderenable - string
| boolean
      bordermovable - string
|-
      borderwidth - integer
| $pref::graal::dontsavepasswords
      columncount - integer
|
      fudgefactor - integer
| boolean
      minextent - string
|-
      rowcount - integer
| $pref::graal::dontsavepms
      getcolumncount() - returns integer
|
      getcolumnoffset(int) - returns integer
| boolean
      getrowcount() - returns integer
|-
      getrowoffset(int) - returns integer
| $pref::graal::fixedport
      setcolumncount(int)
|
      setcolumnoffset(int, int)
| boolean
      setrowcount(int)
|-
      setrowoffset(int, int)
| $pref::graal::fixedudpport
 
|
    GuiGraal3DCtrl (GuiControl):
| integer
 
|-
    GuiGraalCtrl (GuiControl):
| $pref::graal::language
 
|
    GuiMenuCtrl (GuiControl):
| string
      iconheight - integer (read only)
|-
      iconwidth - integer (read only)
| $pref::graal::limitnicknames
      addmenu(str) - returns object
|
      clearmenus()
| boolean
      findmenu(str) - returns object
|-
      removemenu(str)
| $pref::graal::loadbuddylistfromserver
      seticonsize(int, int)
|
 
| boolean
    GuiMLTextCtrl (GuiControl):
|-
      allowcolorchars - boolean
| $pref::graal::nicknamelimit
      allowedtags - string
|
      alpha - float
| integer
      deniedsound - string
|-
      disallowedtags - string
| $pref::graal::nomassmessages
      maxchars - integer
|
      parsetags - boolean
| boolean
      syntaxhighlighting - boolean
|-
      text - string
| $pref::graal::notoalls
      wordwrap - boolean
|
      addtext(str, bool)
| boolean
      getcursorline() - returns integer
|-
      getline(int) - returns string
| $pref::graal::noudp
      getlinecount() - returns integer
|
      getlines() - returns object - array of lines
| boolean
      gettext() - returns string
|-
      reflow()
| $pref::graal::showyourselfonbuddylists
      scrolltobottom()
|
      scrolltotag(int)
| boolean
      scrolltotop()
|-
      setlines(obj)
| $pref::input::mousesensitivity
      settext(str)
|
 
| float
      GuiMLTextEditCtrl (GuiMLTextCtrl):
|-
 
| $pref::interior::lockarrays
        GuiPMEditCtrl (GuiMLTextEditCtrl):
|
          sendmasspm(obj)
| boolean
          sendpm(obj)
|-
 
| $pref::video::defaultguistyle
      GuiPMCtrl (GuiMLTextCtrl):
|
        showpm(obj)
| string
 
|-
      GuiPMHistoryCtrl (GuiMLTextCtrl):
| $pref::video::detailfactor
        showhistory(obj)
|
 
| float
    GuiMouseEventCtrl (GuiControl):
|-
      lockmouse - boolean
| $pref::video::fogdistance
 
|
    GuiPlayerView (GuiControl):
| float
      ambientcolor - string
|-
      cameraz - float
| $pref::video::fullscreenmode
      lightcolor - string
|
      lightdirection - string
| string
      modelrotx - float
|-
      modelrotz - float
| $pref::video::resolution
      mountshape(int, int, str, str) - returns boolean
|
      setmodel(str, str, str)
| integer
      unmountshape(int)
|-
 
| $pref::video::screenshotformat
    GuiProgressCtrl (GuiControl):
|
      progress - float
| string
 
|-
    GuiScrollCtrl (GuiControl):
| $pref::video::visibledistance
      childmargin - string
|
      constantthumbheight - boolean
| float
      hscrollbar - string
|-
      scrollpos - string
| $pref::video::windowmode
      tile - boolean
|
      vscrollbar - string
| string
      wheelscrolllines - integer
|}
      willfirstrespond - boolean
      scrolldelta(int, int)
      scrollto(int, int)
 
    GuiShapeNameHud (GuiControl):
      alignbottom - boolean
      chatprofile - string
      damagealignbottom - boolean
      damageoffset - string
      damagetimeout - float
      distancefade - float
      fillcolor - string
      framecolor - string
      showfill - boolean
      showframe - boolean
      useshapesize - boolean
      verticaldamageoffset - float
      verticaloffset - float
 
    GuiShowImgCtrl (GuiControl):
      alpha - float
      ani - string
      ani - string
      attachoffset - string
      attachtoowner - boolean
      blue - float
      code - string - the old representation as 'font@style@text'
      dimension - integer
      dir - integer
      dir - integer
      emitter - object (read only)
      eulerrotation - string
      font - string
      green - float
      image - string
      imageindex - integer (read only)
      layer - integer
      layer - integer
      mode - integer - the image drawing mode (0 - add, 1 - transparent, 2 - subtract)
      offsetx - integer
      offsety - integer
      playerlook - boolean - if the animation should take it's head, body, sword, shield and attr[] from the owner (playerlook), set this to false if you want to set the images yourself by changing showimg.actor.head etc.
      polygon - object
      red - float
      rotation - float
      shape - string
      stretchx - float
      stretchy - float
      style - string
      text - string
      x - float
      y - float
      zoom - float
 
    GuiSliderCtrl (GuiControl):
      range - string
      ticks - integer
      value - float
 
    GuiTabCtrl (GuiControl):
      iconheight - integer (read only)
      iconwidth - integer (read only)
      leveling - integer
      maxvisibletabs - integer (read only)
      selected - object (read only)
      tabwidth - integer
      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
      getselectedrow() - returns integer - row index
      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)
      setselectedbyid(int)
      setselectedrow(int)
 
    GuiTextCtrl (GuiControl):
      text - string
      gettext() - returns string
      settext(str)
 
      GuiBubbleTextCtrl (GuiTextCtrl):
 
      GuiPopUpEditCtrl (GuiTextCtrl):
        clipcolumntext - boolean
        columns - string - of format "0 16", offset of the tabulators
        enumerate - boolean
        fitparentwidth - boolean
        groupsortorder - string
        iconheight - integer (read only)
        iconwidth - integer (read only)
        maxpopupheight - integer
        profile - object
        resizecell - boolean
        rows - object (read only)
        scrollprofile - object
        selected - object (read only)
        sortcolumn - integer
        sortmode - string
        sortorder - string
        textprofile - object
        width - integer
        addrow(int, str) - returns object - the added row
        addtext(str, int) - deprecated, use addRow() instead
        clearrows()
        clearselection()
        close()
        findtext(str) - returns integer
        findtext(str) - returns integer - row index
        findtextid(str) - returns integer - row id
        forceclose()
        forceonaction()
        getrowatpoint(int, int) - returns integer - row index
        getrowidatpoint(int, int) - returns integer - row id
        getrownumbyid(int) - returns integer
        getselected() - 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)
        open(int, int)
        removerow(int)
        removerowbyid(int)
        rowcount() - returns integer
        rowcount() - returns integer
        seticonsize(int, int)
        setrowactivebyid(int, bool)
        setrowbyid(int, str)
        setselected(int)
        setselectedbyid(int)
        setselectedbytext(str)
        setselectedbytext(str)
        setselectedrow(int)
        sort()
 
      GuiPopUpMenuCtrl (GuiTextCtrl):
        clipcolumntext - boolean
        columns - string - of format "0 16", offset of the tabulators
        enumerate - boolean
        fitparentwidth - boolean
        groupsortorder - string
        iconheight - integer (read only)
        iconwidth - integer (read only)
        maxpopupheight - integer
        profile - object
        resizecell - boolean
        rows - object (read only)
        rows - object (read only)
        scrollprofile - object
        selected - object (read only)
        sortcolumn - integer
        sortmode - string
        sortorder - string
        textprofile - object
        width - integer
        addrow(int, str) - returns object - the added row
        addtext(str, int) - deprecated, use addRow() instead
        clearrows()
        clearselection()
        close()
        findtext(str) - returns integer
        findtext(str) - returns integer - row index
        findtextid(str) - returns integer - row id
        forceclose()
        forceonaction()
        getrowatpoint(int, int) - returns integer - row index
        getrowidatpoint(int, int) - returns integer - row id
        getrownumbyid(int) - returns integer
        getselected() - 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)
        open(int, int)
        removerow(int)
        removerowbyid(int)
        rowcount() - returns integer
        rowcount() - returns integer
        seticonsize(int, int)
        setrowactivebyid(int, bool)
        setrowbyid(int, str)
        setselected(int)
        setselectedbyid(int)
        setselectedbytext(str)
        setselectedbytext(str)
        setselectedrow(int)
        sort()
 
      GuiTextEditCtrl (GuiTextCtrl):
        deniedsound - string
        historysize - integer
        password - boolean
        tabcomplete - boolean
        setselection(int, int)
        undo()
 
        GuiTextEditSliderCtrl (GuiTextEditCtrl):
          allowedit - string
          format - string
          increment - float
          range - string
          value - float
 
      GuiWindowCtrl (GuiTextCtrl):
        canclose - boolean
        canmaximize - boolean
        canminimize - boolean
        closequery - boolean
        destroyonhide - boolean
        extent - string
        maximized - boolean
        minimized - boolean
        tile - boolean
 
    TerrainEditor (GuiControl):
      adjustheightmousescale - float
      adjustheightval - float
      borderfillcolor - string
      borderframecolor - string
      borderheight - float
      borderlinemode - boolean
      brushpos - string
      enablesoftbrushes - boolean
      isdirty - boolean
      ismissiondirty - boolean
      materialgroup - integer
      paintmaterial - string
      processusesbrush - boolean
      renderborder - boolean
      rendervertexselection - boolean
      scaleval - float
      selectionhidden - boolean
      setheightval - float
      smoothfactor - float
      softselectdefaultfilter - string
      softselectfilter - string
      softselectradius - float
      attachterrain(str)
      buildmaterialmap()
      clearmodifiedflags()
      clearselection()
      getactionname(int) - returns string
      getbrushpos() - returns string
      getcurrentaction() - returns string
      getnumactions() - returns integer
      getnumtextures() - returns integer
      getterrainmaterials() - returns object
      gettexturename(int) - returns string
      markemptysquares()
      mirrorterrain(int)
      popbasematerialinfo()
      processaction(str)
      pushbasematerialinfo()
      redo()
      resetselweights(bool)
      setaction(str)
      setbrushpos(str)
      setbrushsize(int, int)
      setbrushtype(str)
      setlonebasematerial(str)
      setterrainmaterials(str)
      undo()
 
    WorldEditor (GuiControl):
      automaticsync - boolean
      axisgizmoactive - boolean
      axisgizmomaxscreenlen - integer
      boundingboxcollision - boolean
      defaulthandle - string
      dragrectcolor - string
      droptype - string
      faceselectcolor - string
      gridcolor - string
      gridsize - string
      isdirty - boolean
      lockedhandle - string
      maxscalefactor - float
      minscalefactor - float
      mousemovescale - float
      mouserotatescale - float
      mousescalescale - float
      objectsuseboxcenter - boolean
      objecttextcolor - string
      objmouseovercolor - string
      objmouseoverselectcolor - string
      objselectcolor - string
      objtextformat - string
      planarmovement - boolean
      planedim - float
      popupbackgroundcolor - string
      popuptextcolor - string
      projectdistance - float
      rendernav - boolean
      renderobjhandle - boolean
      renderobjtext - boolean
      renderplane - boolean
      renderplanehashes - boolean
      renderpopupbackground - boolean
      renderselectionbox - boolean
      rotationsnap - float
      selecthandle - string
      selectionboxcolor - string
      selectionlocked - boolean
      showmousepopupinfo - boolean
      snaprotations - boolean
      snaptogrid - boolean
      toggleignorelist - boolean
      undolimit - integer
      addundostate()
      clearignorelist()
      clearselection()
      deleteselection()
      dropselection()
      getmode() - returns string
      getselectedobject(int) - returns object
      getselectioncentroid() - returns string
      getselectionsize() - returns integer
      hideselection(bool)
      ignoreobjclass(str)
      lightselection()
      lockselection(bool)
      redo()
      reloadselection()
      selectobject(obj)
      setmode(str)
      syncselection()
      undo()
      unselectobject(obj)
 
  GuiControlProfile (TGraalVar):
    align - string
    autosizeheight - boolean
    autosizewidth - boolean
    bitmap - string
    border - integer
    bordercolor - string
    bordercolorhl - string
    bordercolorna - string
    borderthickness - integer
    cankeyfocus - boolean
    cursorcolor - string
    fillcolor - string
    fillcolorhl - string
    fillcolorna - string
    fontcolor - string
    fontcolorhl - string
    fontcolorlink - string
    fontcolorlinkhl - string
    fontcolorna - string
    fontcolorsel - string
    fontsize - integer
    fontstyle - string
    fonttype - string
    justify - string - the same like "align"
    linespacing - integer
    modal - boolean
    mouseoverselected - boolean
    numbersonly - boolean
    opaque - boolean
    returntab - boolean
    soundbuttondown - string
    soundbuttonover - string
    tab - boolean
    textoffset - string
    transparency - float
 
  GuiCursor (TGraalVar):
 
  GuiTabCtrlEntry (TGraalVar):
    hint - string
    id - integer
    text - string
    gettext() - returns string
    settext(str)
 
  GuiTextListEntry (TGraalVar):
    active - boolean
    flickering - boolean
    id - integer
    image - integer
    selectedimage - integer
    sortgroup - integer
    sortvalue - integer
    text - string
    gettext() - returns string
    settext(str)
 
  GuiTreeViewNode (TGraalVar):
    expanded - boolean
    expandedimage - integer
    expandedselectedimage - integer
    image - integer
    level - integer (read only)
    name - string
    parent - object (read only)
    selectedimage - integer
    sortgroup - integer
    sortvalue - integer
    visible - boolean
    x - integer (read only)
    y - integer (read only)
    addlines(obj, bool)
    addnode(str) - returns object
    addnodebypath(str, str) - returns object
    addvars(obj, bool)
    clearnodes()
    destroy()
    getfullname(str) - returns string
    getnode(str) - returns object
    getnodebypath(str, str) - returns object
    select()
 
  MissionArea (TGraalVar):
 
  ShapeBaseHitBox (TGraalVar):
    hitmax - string
    hitmin - string
    nodename - string
 
  ShapeImageState (TGraalVar):
    allowimagechange - boolean
    direction - boolean
    ejectshell - boolean
    emitter - object
    emitternode - string
    emittertime - float
    emittertype - string
    energydrain - float
    fire - boolean
    freezelook - boolean
    ignoreloadedforready - boolean
    loadedflag - string
    name - string
    recoil - string
    script - string
    sequence - string
    sequencerandomflash - boolean
    sound - object
    spinthread - string
    timeoutvalue - float
    transitiononammo - string
    transitiononloaded - string
    transitiononnoammo - string
    transitiononnotarget - string
    transitiononnotloaded - string
    transitiononnotwet - string
    transitionontarget - string
    transitionontimeout - string
    transitionontriggerdown - string
    transitionontriggerup - string
    transitiononwet - string
    waitfortimeout - boolean
 
  SimObject (TGraalVar):
 
    SceneObject (SimObject):
      forwardvector - string
      objectbox - string (read only)
      position - string
      rightvector - string
      rotation - string
      scale - string
      transform - string
      upvector - string
      worldbox - string (read only)
      worldboxcenter - string (read only)
      x - float
      y - float
      z - float
      getforwardvector() - returns string
      getobjectbox() - returns string
      getposition() - returns string
      getrightvector() - returns string
      getscale() - returns string
      gettransform() - returns string
      getupvector() - returns string
      getworldbox() - returns string
      getworldboxcenter() - returns string
      light()
      setforwardvector(str)
      setposition(str)
      setrightvector(str)
      setscale(str)
      settransform(str)
      setupvector(str)
 
      AudioEmitter (SceneObject):
        description - object
        filename - string
        profile - object
 
      FractalTree (SceneObject):
        deffile - string
        levels - integer
        seed - integer
 
      fxFoliageReplicator (SceneObject):
 
      fxGrassReplicator (SceneObject):
 
      fxShapeReplicator (SceneObject):
 
      fxSunLight (SceneObject):
 
      GameBase (SceneObject):
        datablock - object
 
        DynamicShapeReplicator (GameBase):
          boxmax - string
          boxmin - string
          maxgridobjects - integer
          mingridobjects - integer
          radius - integer
          shapefiles - string
          surfacetype - string
 
          DynamicGrass (DynamicShapeReplicator):
 
          DynamicGrassReplicator (DynamicShapeReplicator):
 
        Explosion (GameBase):
          datablock - object
 
        fxLight (GameBase):
          datablock - object
 
        Lightning (GameBase):
          strikesperminute - integer
 
        ParticleEmitter (GameBase):
 
        ParticleEmitterNode (GameBase):
          datablock - object
          emitter - object
 
        PathedInterior (GameBase):
 
        Precipitation (GameBase):
          maxmass - float
          maxspeed - float
          minmass - float
          minspeed - float
          percentage - float
          modifystorm(float, float)
 
        Projectile (GameBase):
          datablock - object
          initialposition - string
          initialvelocity - string
          sourceobject - object
 
        ShapeBase (GameBase):
          chat - string
          datablock - object
          shapenamecolor - string
          applydamage(float)
          applyimpulse(str, str) - returns boolean
          applyrepair(float)
          cancloak() - returns string
          detachallprojectiles()
          detachprojectiles(int)
          getairepairpoint() - returns string
          getcamerafov() - returns float
          getcontrollingclient() - returns object
          getcontrollingobject() - returns object
          getdamageflash() - returns float
          getdamagelevel() - returns float
          getdamagepercent() - returns float
          getdamagestate() - returns string
          getenergylevel() - returns float
          getenergypercent() - returns float
          geteyepoint() - returns string
          geteyetransform() - returns string
          geteyevector() - returns string
          getimageammo(int) - returns boolean
          getimageloaded(int) - returns boolean
          getimageskintag(int) - returns integer
          getimagestate(int) - returns string
          getimagetrigger(int) - returns boolean
          getmountedimage(int) - returns object
          getmountedobject(int) - returns object
          getmountedobjectcount() - returns integer
          getmountedobjectnode(int) - returns integer
          getmountnodeobject(int) - returns object
          getmountslot(str) - returns integer
          getmounttransform(int) - returns string
          getmuzzlepoint(int) - returns string
          getmuzzlevector(int) - returns string
          getobjectmount() - returns object
          getpendingimage(int) - returns object
          getrechargerate() - returns float
          getrepairrate() - returns float
          getshapename() - returns string
          getskinname() - returns string
          getslottransform(int) - returns string
          getthread(int) - returns string
          getthreadposition(int) - returns float
          getvelocity() - returns string
          getwhiteout() - returns float
          hide()
          iscloaked() - returns boolean
          isdestroyed() - returns boolean
          isdisabled() - returns boolean
          isenabled() - returns boolean
          ishidden() - returns boolean
          isimagefiring(int) - returns boolean
          isimagemounted(str) - returns boolean
          islookfrozen() - returns boolean
          ismounted() - returns boolean
          mountimage(str, int) - returns boolean
          mountobject(obj, int) - returns boolean
          pausethread(int) - returns boolean
          playaudio(int, obj) - returns boolean
          playthread(int, str) - returns boolean
          playthreadext(int, str, float, float, float, bool) - returns boolean
          registermelee(str, str, obj, int, str, str) - returns boolean
          setcamerafov(float)
          setcloaked(bool)
          setdamageflash(float)
          setdamagelevel(float)
          setdamagestate(str) - returns boolean
          setdamagevector(str)
          setenergylevel(float)
          sethidden(bool)
          setimageammo(int, bool) - returns boolean
          setimageloaded(int, bool) - returns boolean
          setimagetrigger(int, bool) - returns boolean
          setinvinciblemode(float, float)
          setrechargerate(float)
          setrepairrate(float)
          setshapename(str)
          setskinname(str)
          setthreaddir(int, bool) - returns boolean
          setvelocity(str) - returns boolean
          setwhiteout(float)
          show()
          startfade(float, float, bool)
          stopaudio(int) - returns boolean
          stopthread(int) - returns boolean
          unmount()
          unmountimage(int) - returns boolean
          unmountobject(obj) - returns boolean
          unregistermelee(int) - returns boolean
 
          AdvancedCamera (ShapeBase):
            cameramode - integer
            zoomdistance - float
            clearplayerobject()
            cleartargetobject()
            getcameraposition() - returns string
            getgodviewoffset() - returns string
            getlookatoffset() - returns string
            getthirdpersonoffset() - returns string
            setcameraposition(str)
            setflymode()
            setfollowterrainmode(bool)
            setgodviewmode()
            setgodviewoffset(str)
            setlookatoffset(str)
            setorbitchangeangle(float)
            setorbitchangezoom(float)
            setorbitminmaxdeclination(str)
            setorbitminmaxzoom(str)
            setorbitmode()
            setplayerobject(obj)
            settargetobject(obj)
            setthirdpersonmode()
            setthirdpersonoffset(str)
            setthirdpersonpanmode()
            setthirdpersontargetmode()
            settrackmode()
 
          Camera (ShapeBase):
            setflymode()
            setorbitmode(obj, str, float, float, float, bool)
 
          MissionMarker (ShapeBase):
            datablock - object
 
          PathCamera (ShapeBase):
            datablock - object
 
          Player (ShapeBase):
            datablock - object
            speed - float
            swimming - boolean (read only)
            checkdismountpoint(str, str) - returns boolean
            clearcontrolobject()
            getcontrolobject() - returns object
            getdamagelocation(str) - returns string
            getstate() - returns string
            setactionthread(str, bool, bool) - returns boolean
            setcontrolobject(obj) - returns boolean
 
            AIPlayer (Player):
              maxturnpitch - float
              maxturnyaw - float
              simplemovement - boolean
              wallcheck - boolean
              clearaim()
              getaimlocation() - returns string
              getaimobject() - returns object
              getmovedestination() - returns string
              ismoving() - returns boolean
              setaimlocation(str)
              setaimobject(obj)
              setmovedestination(str, bool)
              setmovespeed(float)
              stop()
 
          StaticShape (ShapeBase):
            datablock - object
 
          Vehicle (ShapeBase):
            datablock - object
 
            FlyingVehicle (Vehicle):
              datablock - object
              usecreateheight(bool)
 
            HoverVehicle (Vehicle):
              datablock - object
 
            WheeledVehicle (Vehicle):
              datablock - object
              getwheelcount() - returns integer
              setwheelpowered(int, bool) - returns boolean
              setwheelspring(int, obj) - returns boolean
              setwheelsteering(int, float) - returns boolean
              setwheeltire(int, obj) - returns boolean
 
        SpawnSphere (GameBase):
          indoorweight - float
          outdoorweight - float
          radius - float
          sphereweight - float
 
        Splash (GameBase):
 
        Trigger (GameBase):
          datablock - object
 
        TSStatic (GameBase):
          noshadowlevel - float
          onlyambientlight - boolean
 
          Item (TSStatic):
            datablock - object
            hide()
            show()
            startfade(float, float, bool)
 
      InteriorInstance (SceneObject):
        audioenvironment - object
        audioprofile - object
        interiorfile - string
        showterraininside - boolean
 
      Marker (SceneObject):
 
      Shape3ds (SceneObject):
 
      Sky (SceneObject):
        materiallist - string
        skyfadetime - float
        windvelocity - string
        getwindowvelocity() - returns string
        realfog(bool, float, float, float) - specify if it should show, and max, min and speed values
        stormclouds(bool, float) - specify if it should show, and the duration
        stormcloudsshow(bool)
        stormfog(float, float) - percent and duration of the fog
        stormfogshow(bool)
 
      TerrainBlock (SceneObject):
        bumpoffset - float
        bumpscale - float
        bumptexture - string
        detailtexture - string
        squaresize - integer
        terrainfile - string
        zerobumpscale - integer
 
      twSurfaceReference (SceneObject):
 
      volumeLight (SceneObject):
 
      WaterBlock (SceneObject):
        audioenvironment - object
        density - float
        depthgradient - float
        distortgridscale - float
        distortmag - float
        distorttime - float
        envmapintensity - float
        envmapovertexture - string
        envmapundertexture - string
        flowangle - float
        flowrate - float
        liquidtype - string
        maxalpha - float
        minalpha - float
        removewetedges - boolean
        shoredepth - float
        shoretexture - string
        specularcolor - string
        specularmasktex - string
        specularpower - float
        submergetexture0 - string
        submergetexture1 - string
        surfaceopacity - float
        surfaceparallax - float
        surfacetexture - string
        tessshore - float
        tesssurface - float
        usedepthmask - boolean
        viscosity - float
        wavemagnitude - float
 
    SimDataBlock (SimObject):
      isdatablock - boolean (read only)
 
      AudioDescription (SimDataBlock):
 
      AudioProfile (SimDataBlock):
        description - object
        environment - object
 
      DecalData (SimDataBlock):
        lifetime - float
 
      GameBaseData (SimDataBlock):
 
        DebrisData (GameBaseData):
          explosion - object
 
        ExplosionData (GameBaseData):
          debris - object
          particleemitter - object
          soundprofile - object
 
        fxLightData (GameBaseData):
 
        ItemData (GameBaseData):
 
        LightningData (GameBaseData):
          strikesound - object
 
        ParticleEmitterData (GameBaseData):
          particles - string
 
        ParticleEmitterNodeData (GameBaseData):
 
        PathedInteriorData (GameBaseData):
          startsound - object
          stopsound - object
          sustainsound - object
 
        PrecipitationData (GameBaseData):
          soundprofile - object
 
        ProjectileData (GameBaseData):
          armingdelay - integer
          bounceelasticity - float
          bouncefriction - float
          explosion - object
          fadedelay - integer
          gravitymod - float
          lifetime - integer
          lightradius - float
          muzzlevelocity - float
          particleemitter - object
          velinheritfactor - float
 
        ShapeBaseData (GameBaseData):
          debris - object
          explosion - object
          noshadowlevel - float
          onlyambientlight - boolean
          showhitboxes - boolean
          underwaterexplosion - object
 
          AdvancedCameraData (ShapeBaseData):
 
          CameraData (ShapeBaseData):
 
          MissionMarkerData (ShapeBaseData):
 
          PlayerData (ShapeBaseData):
            decaldata - object
            dustemitter - object
            exitingwater - object
            footbubblessound - object
            foothardsound - object
            footmetalsound - object
            footpuffemitter - object
            footshallowsound - object
            footsnowsound - object
            footsoftsound - object
            footunderwatersound - object
            footwadingsound - object
            impacthardsound - object
            impactmetalsound - object
            impactsnowsound - object
            impactsoftsound - object
            impactwatereasy - object
            impactwaterhard - object
            impactwatermedium - object
            jumpingsound - object
            movingbubblessound - object
            splash - object
            waterbreathsound - object
 
          StaticShapeData (ShapeBaseData):
 
          VehicleData (ShapeBaseData):
            dustemitter - object
            exitingwater - object
            hardimpactsound - object
            impactwatereasy - object
            impactwaterhard - object
            impactwatermedium - object
            softimpactsound - object
            waterwakesound - object
 
            FlyingVehicleData (VehicleData):
              backwardjetemitter - object
              downjetemitter - object
              enginesound - object
              forwardjetemitter - object
              jetsound - object
              trailemitter - object
 
            HoverVehicleData (VehicleData):
              dusttrailemitter - object
              enginesound - object
              floatsound - object
              forwardjetemitter - object
              jetsound - object
 
            WheeledVehicleData (VehicleData):
              enginesound - object
              jetsound - object
              squealsound - object
              tireemitter - object
              wheelimpactsound - object
 
        ShapeBaseImageData (GameBaseData):
          casing - object
          projectile - object
 
        SplashData (GameBaseData):
          explosion - object
          soundprofile - object
 
        TriggerData (GameBaseData):
 
      ParticleData (SimDataBlock):
 
      TSShapeConstructor (SimDataBlock):
 
      WheeledVehicleSpring (SimDataBlock):
 
      WheeledVehicleTire (SimDataBlock):
 
    SimGroup (SimObject):
      addcontrol(obj)
 
      GameConnection (SimGroup):
        account - string (read only)
        nick - string (read only)
        objecttype() - returns string - returns the object type, which can be TGraalVar, TProjectile etc.
 
    Sun (SimObject):
 
  TDrawableObject (TGraalVar):
    layer - integer (read only)
 
    TBaddy (TDrawableObject):
      dir - integer
      headdir - integer
      mode - integer
      power - integer
      type - integer
      x - float
      y - float
 
    TLevelObject (TDrawableObject):
      level - object (read only)
      x - float
      y - float
      z - float
 
      TExplosion (TLevelObject):
        dir - integer (read only)
        power - integer (read only)
        time - float (read only)
 
      TGaniObject (TLevelObject):
        ani - object (read only)
        aniparams - string (read only)
        anistep - integer (read only)
        attachid - integer (read only)
        attachtype - integer (read only)
        attr - object (read only)
        body - string
        bodyimg - string
        colors - object (read only)
        dir - integer
        head - string
        headimg - string
        shield - string
        sprite - integer
        sword - string
        getimageforsprite(obj) - returns string
        getsprite(str) - returns object
        getspriteforspritepos(obj) - returns object
 
        TProjectile (TGaniObject):
          angle - float (read only)
          fromplayer - object (read only)
          horiz - boolean (read only)
          params - object (read only)
          speed - float (read only)
          x - float (read only)
          y - float (read only)
          z - float (read only)
          zspeed - float (read only)
 
        TServerHorse (TGaniObject):
          bombpower - integer
          bombs - integer
          bushes - integer
          dir - integer
          type - integer
 
        TServerPlayer (TGaniObject):
          account - string (read only)
          ap - integer
          attached - boolean (read only)
          bombs - integer
          chat - string
          darts - integer
          fullhearts - integer (read only)
          glovepower - integer
          gralats - integer
          guild - string (read only)
          headimg - string
          headset - integer
          hearts - float (read only)
          horseimg - string (read only)
          hp - float (read only)
          id - integer (read only)
          isadmin - boolean (read only)
          ischannel - boolean (read only)
          ischannelopen - boolean (read only)
          ischanneluser - boolean (read only)
          isexternal - boolean (read only)
          isfemale - boolean (read only)
          isignoring - boolean (read only)
          isloggedin - boolean (read only)
          ismale - boolean (read only)
          ismuted - boolean (read only)
          ismuting - boolean (read only)
          language - string (read only)
          languagedomain - string (read only)
          maxhp - integer (read only)
          messagebubble - integer (read only)
          mp - integer
          nick - string
          platform - string (read only)
          playersindex - integer (read only)
          rupees - integer - better use 'gralats'
          shieldimg - string
          shieldpower - integer (read only)
          swordimg - string
          swordpower - integer (read only)
          x - float
          y - float
          isguildpm() - returns boolean
          ismasspm() - returns boolean
          pmswaiting() - returns boolean
          showprofile()
 
          TPlayer (TServerPlayer):
            ap - integer
            chat - string
            freezetime - float
            hearts - float
            horseimg - string
            hp - float
            hurt - boolean (read only)
            hurtdx - float (read only)
            hurtdy - float (read only)
            hurted - boolean (read only)
            hurtpower - float (read only)
            isfemale - boolean (read only)
            ismale - boolean (read only)
            letters - string
            map - boolean (read only)
            nick - string (read only)
            onhorse - boolean (read only)
            online - boolean (read only)
            paused - boolean (read only)
            reading - boolean (read only)
            shieldimg - string
            sprite - integer
            swimming - boolean (read only)
            swordimg - string
            transform - string
            weapon - object (read only)
            weapons - object (read only)
 
          TServerNPC (TServerPlayer):
            actionplayer - integer (read only)
            hearts - float
            height - float (read only)
            horseimg - string
            hp - float
            hurtdx - float
            hurtdy - float
            image - string
            isblocking - boolean
            isblockingprojectiles - boolean
            layer - integer
            npcsindex - integer (read only)
            peltwithblackstone - boolean (read only)
            peltwithbush - boolean (read only)
            peltwithnpc - boolean (read only)
            peltwithsign - boolean (read only)
            peltwithstone - boolean (read only)
            peltwithvase - boolean (read only)
            save - object (read only)
            shieldpower - integer
            sprite - integer
            swordpower - integer
            visible - boolean
            width - float (read only)
            x - float
            y - float
            blockagain()
            blockagainlocal()
            canbecarried()
            canbepulled()
            canbepushed()
            cannotbecarried()
            cannotbepulled()
            cannotbepushed()
            carryobject(str)
            changeimgcolors(int, float, float, float, float)
            changeimgmode(int, int)
            changeimgpart(int, int, int, int, int)
            changeimgvis(int, int)
            changeimgzoom(int, float)
            destroy()
            dontblock()
            dontblocklocal()
            drawaslight()
            drawoverplayer()
            drawunderplayer()
            findimg(int) - returns object
            hide()
            hideimg(int)
            hideimgs(int, int)
            hidelocal()
            hurt(int)
            lay(str)
            message(str)
            move(float, float, float, int)
            setbow(str)
            setcharani(str, str)
            setchargender(str)
            setcoloreffect(float, float, float, float)
            seteffectmode(int)
            setimg(str)
            setimgpart(str, int, int, int, int)
            setshape(int, int, int)
            setshape2(int, int, obj)
            setzoomeffect(float)
            shootarrow(int)
            shootball()
            shootfireball(int)
            shootfireblast(int)
            shootnuke(int)
            show()
            showani(int, float, float, int, str) - returns object
            showani2(int, float, float, float, int, str) - returns object
            showcharacter()
            showimg(int, str, float, float) - returns object
            showimg2(int, str, float, float, float) - returns object
            showlocal()
            showpoly(int, obj) - returns object
            showpoly2(int, obj) - returns object
            showtext(int, float, float, str, str, str) - returns object
            showtext2(int, float, float, float, str, str, str) - returns object
            take(str)
            take2(int)
            takehorse(int)
            throwcarry()
            timereverywhere()
            toweapons(str)
 
            TServerWeapon (TServerNPC):
              isweapon - boolean (read only)
 
      TServerBomb (TLevelObject):
        power - integer
        time - float
 
      TServerCarry (TLevelObject):
 
      TServerChest (TLevelObject):
        isopen - boolean (read only)
        item - string (read only)
 
      TServerExtra (TLevelObject):
        time - float (read only)
        type - integer (read only)
 
      TServerFlying (TLevelObject):
        dir - integer (read only)
        dx - float
        dy - float
        from - integer (read only)
        type - integer (read only)
 
      TServerLeap (TLevelObject):
 
      TServerSign (TLevelObject):
        text - string
 
      TShowImg (TLevelObject):
        alpha - float
        ani - string
        attachoffset - string
        attachtoowner - boolean
        blue - float
        code - string - the old representation as 'font@style@text'
        dimension - integer
        dir - integer
        emitter - object (read only)
        eulerrotation - string
        font - string
        green - float
        image - string
        imageindex - integer (read only)
        layer - integer
        mode - integer - the image drawing mode (0 - add, 1 - transparent, 2 - subtract)
        playerlook - boolean - if the animation should take it's head, body, sword, shield and attr[] from the owner (playerlook), set this to false if you want to set the images yourself by changing showimg.actor.head etc.
        polygon - object
        red - float
        rotation - float
        shape - string
        stretchx - float
        stretchy - float
        style - string
        text - string
        x - float
        y - float
        zoom - float
 
  TDrawingPanel (TGraalVar):
    height - integer (read only)
    parth - integer (read only)
    partw - integer (read only)
    partx - integer (read only)
    party - integer (read only)
    width - integer (read only)
    clearall()
    clearrectangle(int, int, int, int) - x, y, width and height
    drawimage(int, int, str) - x, y, source image
    drawimagerectangle(int, int, str, int, int, int, int) - destination x and y, source image, source x,y,width and height
    drawimagestretched(int, int, int, int, str, int, int, int, int) - destination x,y,width and height, source image, source x,y,width and height
 
  Terraformer (TGraalVar):
    loadgrayscale(int, str) - returns boolean
    loadgreyscale(int, str) - returns boolean
    savegreyscale(int, str) - returns boolean
    setterrain(int) - returns boolean
 
  TFrameDetail (TGraalVar):
    bordercolor - string
    borderenable - string
    bordermovable - string
    borderwidth - integer
    minextent - string
 
  TGaniParam (TGraalVar):
 
  TGraalAni (TGraalVar):
    continuous - boolean
    ganitype - string (read only)
    loop - boolean
    movie - boolean
    setbackto - string
    singledirection - boolean
    addsprite(int) - returns object
    addstep() - returns object
    deletesprite(int)
    deletestep(int)
    getsprite(int) - returns object
    insertstep(int) - returns object
 
  TGraalAniPart (TGraalVar):
    attr - integer
    dx - integer
    dy - integer
    param - integer
    sprite - object
 
  TGraalAniSound (TGraalVar):
    delay - float
    dx - float
    dy - float
    sound - string
 
  TGraalAniSprite (TGraalVar):
    alpha - float
    blue - float
    description - string
    green - float
    height - integer
    image - string
    imagetype - string (read only)
    mode - integer
    red - float
    rotation - float
    spriteindex - integer
    stretchx - float
    stretchy - float
    width - integer
    x - integer
    y - integer
    zoom - float
    addattachment() - returns object
    deleteattachment(int)
    insertattachment(int) - returns object
 
  TGraalAniStep (TGraalVar):
    delay - float
    addpos(int) - returns object
    deletepos(int, int)
    insertpos(int, int) - returns object
 
  TGraalSpriteAttachment (TGraalVar):
    behind - boolean
    dx - integer
    dy - integer
    sprite - object
 
  THTTPRequest (TGraalVar):
    address - string (read only)
    contentlanguage - string (read only)
    contenttype - string (read only)
    downloadcomplete - boolean (read only)
    file - string (read only)
    fulldata - string (read only)
    lastmodified - string (read only)
    port - integer (read only)
    returncode - integer (read only)
    returnmessage - string (read only)
    server - string (read only)
 
  TParticle (TGraalVar):
    angle - float
    lifetime - float
    movementvector - string
    sound - string
    speed - float
    spin - float
    zangle - float
 
  TParticleEmitter (TGraalVar):
    attachposition - boolean
    autorotation - boolean
    checkbelowterrain - boolean
    clippingbox - string
    cliptoscreen - boolean
    continueafterdestroy - boolean
    currentparticlecount - integer (read only)
    delaymax - float
    delaymin - float
    dropemitter - object (read only)
    dropwateremitter - object (read only)
    emissionoffset - string
    emitatterrainheight - boolean
    emitautomatically - boolean
    emittedparticles - integer (read only)
    firstinfront - boolean
    isfrozen - boolean
    maxparticles - integer
    nrofparticles - integer
    particle - object (read only)
    particletypes - integer
    wraptoclippingbox - boolean
    addemitmodifier(str, float, float, str, str, float, float) - returns object
    addglobalmodifier(str, float, float, str, str, float, float) - returns object
    addlocalmodifier(str, float, float, str, str, float, float) - returns object
    advancetime(float)
    emit()
    emitat(str)
    removemodifiers()
    removeparticles()
 
  TParticleModifier (TGraalVar):
    addmod(str, str, float, float)
 
  TServerLevel (TGraalVar):
    compsdead - boolean (read only)
    height - integer (read only)
    isnopkzone - boolean (read only)
    issparringzone - boolean (read only)
    nopkzone - boolean (read only) - same like 'isnopkzone'
    tilelayercount - integer
    width - integer (read only)
    findareanpcs(float, float, float, float) - returns object - returns an array of all npcs at the specified rectangle (x,y,width,height)
    hitcompu(int, int, float, float)
    putbomb(int, float, float)
    putcomp(str, float, float)
    putexplosion(int, float, float)
    putexplosion2(int, int, float, float)
    puthorse(str, float, float)
    putnewcomp(str, float, float, str, int)
    reflectarrow(int)
    removearrow(int)
    removebomb(int)
    removecompus()
    removeexplo(int)
    removehorse(int)
    removeitem(int)
    setz(int, int, int, int, float, float, float, float)
    shoot(float, float, float, float, float, float, str, str) - shoots a projectile with x,y,z,angle,zangle,strength,ani,aniparams
    testbomb(float, float) - returns integer
    testexplo(float, float) - returns integer
    testhorse(float, float) - returns integer
    testitem(float, float) - returns integer
    testnpc(float, float) - returns integer
    testsign(float, float) - returns integer
    tiletype(float, float) - returns integer
 
  TServerLevelLink (TGraalVar):
    destx - float (read only)
    desty - float (read only)
    height - float (read only)
    width - float (read only)
    x - float (read only)
    y - float (read only)
 
  TShowImg_Values (TGraalVar):
    alpha - float
    blue - float
    green - float
    mode - integer - the image drawing mode (0 - add, 1 - transparent, 2 - subtract)
    red - float
    rotation - float
    stretchx - float
    stretchy - float
    zoom - float
 
    TShowImg_Gani (TShowImg_Values):
      actor - object (read only)
 
    TShowImg_Image (TShowImg_Values):
      height - float
      parth - integer
      partw - integer
      partx - integer
      party - integer
      width - float
 
    TShowImg_Shape (TShowImg_Values):
      mounts - object (read only)
      setshapeanimation(str, float, bool) - returns boolean
 
    TShowImg_Text (TShowImg_Values):
      parth - integer
      partw - integer
      partx - integer
      party - integer
 
  TShowImgMount (TGraalVar):
    node - integer
    shape - string
 
  TStaticVar (TGraalVar):
    destroy()
 
  TTilesLayer (TGraalVar):
    alpha - float
    blue - float
    green - float
    layerindex - integer (read only)
    offset - string
    red - float
    x - float
    y - float
    z - float
    updateboard(int, int, int, int)
 
  TUpdatePackage (TGraalVar):
    description - string (read only)
    downloadcomplete - boolean (read only)
    downloadedsize - integer (read only)
    filecount - integer (read only)
    filedownloadedsize - integer (read only)
    filename - string (read only)
    filetotalsize - integer (read only)
    isuninstalled - boolean (read only)
    lastdownloadfile - string (read only)
    localversion - float (read only)
    mode - string (read only)
    name - string (read only)
    parent - object (read only)
    platform - string (read only)
    protectoverwrite - boolean (read only)
    totalsize - integer (read only)
    usechecksum - boolean (read only)
    version - float (read only)
    reinstall() - returns boolean
    uninstall() - returns boolean
    update() - returns boolean
</nowiki>

Latest revision as of 11:55, 13 October 2011

[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

Function 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 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(string) same as 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
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

Object Navigation


GUI Objects

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

Preference Variables

Variable 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