Creation/Dev/Script/Client

Client Supported Script Features

Settings

Name	Type	Description
$camera::movementspeed	float
$pref::audio::choosenvoicecodec	integer
$pref::audio::microactivatebyvolume	boolean
$pref::audio::microactivationlevel	integer
$pref::audio::microinputdevice	integer
$pref::audio::microon	boolean
$pref::audio::microvolumefactor	integer
$pref::audio::midivolume	integer
$pref::audio::mp3volume	integer
$pref::audio::radiovolume	integer
$pref::audio::reversestereo	boolean
$pref::audio::sfxvolume	integer
$pref::audio::voicevolume	integer
$pref::graal::allowglobalpms	boolean
$pref::graal::automapping	boolean
$pref::graal::defaultfontsize	integer
$pref::graal::dontconnectlevels	boolean
$pref::graal::dontloadlistheads	boolean
$pref::graal::dontsavepasswords	boolean
$pref::graal::dontsavepms	boolean
$pref::graal::fixedport	boolean
$pref::graal::fixedudpport	integer
$pref::graal::language	string
$pref::graal::limitnicknames	boolean
$pref::graal::loadbuddylistfromserver	boolean
$pref::graal::nicknamelimit	integer
$pref::graal::nomassmessages	boolean
$pref::graal::notoalls	boolean
$pref::graal::noudp	boolean
$pref::graal::showyourselfonbuddylists	boolean
$pref::input::mousesensitivity	float
$pref::interior::lockarrays	boolean
$pref::terrain::enabledetails	boolean
$pref::video::detailfactor	float
$pref::video::fogdistance	float
$pref::video::fullscreenmode	string
$pref::video::screenshotformat	string
$pref::video::visibledistance	float
$pref::video::windowmode	string
$scenelighting::lightingprogress	float (read only)

Variables

Name	Type	Description
allfeatures	integer (read only)	A bitflag of all features currently enabled
allplayerscount	integer (read only)
allstats	integer (read only)	A bitflag of all stats currently enabled
canspin	boolean (read only)
carriesblackstone	boolean (read only)
carriesbush	boolean (read only)	True if the player is carrying a bush
carriesnpc	boolean (read only)	True if the player is carrying an NPC.
carriessign	boolean (read only)	True if a player is carrying a sign.
carriesstone	boolean (read only)	True if a player is carrying a stone.
carriesvase	boolean (read only)	True if a player is carrying a vase.
downloadfile	string (read only)	Name of the file currently being downloaded
downloadpos	integer (read only)
downloadsize	integer (read only)	Size of the file being downloaded
editingmission	boolean
emoticonchar	string (read only)
focusx	float (read only)
focusy	float (read only)
graalversion	float (read only)	Graal version
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 (read only)
middlemousebutton	boolean (read only)
mousebuttons	integer (read only)
mousescreenx	integer	X coordinate of the mouse on the GUI layer
mousescreeny	integer	Y coordinate of the mouse on the GUI layer
mousewheeldelta	integer (read only)
mousex	float	X coordinate of the mouse on the tile layer
mousey	float	Y coordinate of the mouse on the tile layer
musiclen	integer (read only)
musicpos	integer (read only)
rightmousebutton	boolean (read only)
screenheight	integer (read only)	Height of the Graal window
screenwidth	integer (read only)	Width of the Graal window
scriptedcontrols	boolean (read only)
scriptedplayerlist	boolean (read only)
selectedlistplayers	object
selectedsword	integer
selectedweapon	integer
servername	string (read only)	Name of the current server
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)	An array of weapon objects
weaponsenabled	boolean	Are weapons enabled? (Player can trigger onWeaponFired...)
worldclockstopped	boolean
worldhour	integer
worldminute	float
worldminutesofday	float
worldrealsecondsperday	float

Functions

Note: Currently this doesn't list the functions which are optimized at compile time, see Starting Guide: Standard functions for those.

• aindexof(float, obj) - returns integer
• echo(str text)
• getbasepackage() - returns object
• getdisplaydevicelist() - returns string
• getdownloadedupdatepackagesize() - returns integer
• getdownloadingpackage() - returns object
• getdownloadingpackagescount() - returns integer
• gethttprequest(str, int, str) - returns THTTPRequest object
• getkeycode(str keyname) - returns integer
• getpackagesdownloadcomplete() - returns boolean
• getpackagesdownloaded() - returns boolean
• getplatform() - returns string
• getresolutionlist(str) - returns string
• getservername() - returns string
• gettotalupdatepackagesize() - returns integer
• getupdatepackage(str) - returns object
• isadminguild(str guildname) - returns boolean
• isdevicefullscreenonly(str devicename) - returns boolean
• isobject(str objectname) - returns boolean
• keydown(int keycode) - returns boolean
• keydown2(int keycode, bool ignorecase) - returns boolean
• keyname(int keycode) - returns string
• opengraalurl(str url)
• openurl(str url)
• openurl2(str url, int width, int height)
• requesthttp(str, int, str) - returns THTTPRequest object
• requestmysql(str, str, str, str, str) - returns object
• requesttext(str, str)
• requesturl(str url) - returns THTTPRequest object
• savelog(str text)
• sendrpgmessage(str text)
• sendtext(str, str, params...)
• sendtorc(str text)
• serverwarp(str serverunixname)
• synctimeofday(float, float)

Common

Files

• extractfilebase(str filepath) - returns string, '/an/example/path/and/file' would return '/an/example/path/and/'
• extractfileext(str filepath) - returns string, 'filename.ext' would return '.ext'
• extractfilename(str filepath) - returns string, '/an/example/path/and/file' would return 'file'
• extractfilepath(str filepath) - returns string, '/an/example/path/and/file' would return '/an/example/path/and/'
• fileexists(str filepath) - returns boolean, checks if a file exists
• filesize(str filepath) - returns integer, returns the size of a file
• fileupdate(str filepath) - returns boolean
• findfiles(str, int) - returns object
• findfirstfile(str) - returns string
• findnextfile(str) - returns string
• getextension(str filepath) - returns string, 'filename.ext' would return '.ext'
• reloadfile(str filepath)
• requestfiledeletion(str filepath), requests a file to be deleted on the server
• requestfilerename(str filepath, str newfilepath), requests a file to be renamed on the server
• requestfilesmove(str filepath, str newfilepath), requests a file to be moved on the server
• selectfilefordownload(str filter)
• selectfileforupload()

Watch the TGraalVar object for loading and saving of files (loadlines etc.)

Math

• degtorad(float value) - returns float
• radtodeg(float value) - returns float

Matrices

• matrixcreate(str, str) - returns string
• matrixcreatefromeuler(str) - returns string
• matrixmulpoint(str, str) - returns string
• matrixmultiply(str, str) - returns string
• matrixmulvector(str, str) - returns string

Vectors

• 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

Strings

• base64decode(str text) - returns decoded string
• base64encode(str text) - returns encoded string
• checksum(str text) - returns checksum float
• contains(str haystack, str needle) - returns boolean, you should probably do haystack.contains(needle) instead
• getascii(str character) - returns ascii value integer
• getstringkeys(str) - returns object
• lowercase(str text) - returns lowercased string
• md5(str tet) - returns md5 hash string
• randomstring(str) - returns string
• strcmp(str text1, str text2) - returns integer
• strequals(str text1, str text2) - returns boolean, you probably should do text1.equals(text2) instead
• uppercase(str text) - returns uppercased stringg

GUI

• addcontrol(obj)
• cursoroff()
• cursoron()
• iscursoron() - returns boolean
• popdialog()
• pushdialog(obj)
• setcontentcontrol(obj)
• setcursor2(str imagefilename)

Graal 2D

Name	Type	Description
addtiledef(str tilesetimage, str prefix, int tilesettype)		Sets the tileset image for levels beginning with the specified prefix. Tileset type 0 is for pics1.png style tilesets. Tileset type 1 is for the new tileset format (Era's tiles for example)
addtiledef2(str tilesetimage, str prefix, int x, int y)		Replaces a section of the tileset (x, y) image for levels beginning with the specified prefix.
attachplayertoobj(int objtype, int id)		Attaches a player to the specified object. Using attachpayertoobj(0, id); the player will be attached to the current NPC.
callnpc(int npcindex, params...)
callweapon(int weaponindex, params...)
commandtoserver(str text)
detachplayer()		Puts the player back on the level (after using attachplayertoobj).
disabledefmovement()		Disables the default movement.
disablemap()		Disables the default map
disablepause()		Disables pausing.
disableselectweapons()		Disables the default Q menu.
disableweapons()		Disables weapons.
enabledefmovement()		Enables default movement
enablefeatures(int flags)		Enable/disable client features Flags can consist of: Value Description 1 M key (map) 2 P key (pause) 4 Q key (weapon select) 8 R key (show ratings) 0x10 S+A key combination for dropping items 0x20 S+D key combination for switching weapons 0x40 TAB key (if disabled then you cannot switch to the chat field with TAB) 0x80 Display of chat text 0x100 Display of the hearts over player heads 0x200 Display of nicknames 0x400 Toall/PM-icons on the minimap 0x800 Right-click on players opens their profile 0x1000 Emoticons (disable it if you want to do other stuff with control+keys) 0x2000 Alt+5 for making snapshots (deprecated) 0x4000 Alt+8/9 for zooming (deprecated) 0x8000 The logframe where savelog stuff is added allfeatures All of the previously stated feature flags enabled
enablemap()		Enables default map.
enablepause()		Enables pausing.
enableselectweapons()		Enables default Q menu.
enableweapons()		Enables weapons.
explodebomb(int bombindex)		Explodes a bomb with the specified index.
findani(str)	object
findlevel(str levelfilename)	object
findplayer(str accountname)	object
findplayerbyid(int playerid)	object
findweapon(str weaponname)	object
freezeplayer(float seconds)		Freezes player for a specific amount of time.
getimgheight(str imagefilename)	integer	Returns the height (in pixels) of an image.
getimgwidth(str imagefilename)	integer	Returns the width (in pixels) of an image.
getmapx(str levelname)	integer
getmapy(str levelname)	integer
gettextheight(float, str, str)	integer
gettextwidth(float, str, str, str)	integer
getz(float x, float y)	float
hideplayer(float seconds)
hidesword(float seconds)
hitnpc(int, float, float, float)
hitobjects(float, float, float)
hitplayer(int, float, float, float)
lay2(str extraname, float x, float y)
loadmap(str mapfilename)
noplayerkilling()		Disables killing of other players.
onwall(float x, float y)	boolean	Returns true if the specified x and y is a blocking tile.
onwall2(float x, float y, float width, float height)	boolean
onwater(float x, float y)	boolean	Returns true if the specified x and y is water.
onwater2(float x, float y, float width, float height)	boolean
play(str soundfilename)		Plays the specified sound file.
play2(str soundfilename, float x, float y, float volume)		Plays the specified sound file at location x, y with the specified volume. Volume should be between 0 and 1, if volume is set to 1 default volume is used (depending on how far away the player is).
playlooped(str soundfilename)		Plays the specified sound file in a loop until stopsound() is called.
playlooped2(str soundfile, float x, float y, float volume)		Plays the specified sound file at location x, y with the specified volume in a loop until stopsound() is called. Volume should be between 0 and 1, if volume is set to 1 default volume is used (depending on how far away the player is).
putleaps(int leapstype, float x, float y)
removetiledefs(str prefix)		Remove tile definitions set by addtiledef and addtiledef2 for the specified prefix.
replaceani(str defaultaniname, str newaniname)
resetfocus()		Sets the screen focus to the player.
say(int signindex)
say2(str text)
screenx(float x, float y)	integer
screeny(float x, float y)	integer
setani(str aniname, str aniparams)		Sets the gani of a player.
setbeltcolor(str color)
setcoatcolor(str color)
seteffect(float r, float g, float b, float a)
setfocus(float x, float y)		Sets the screen focus to the specified x and y.
setgender(str gendername)		Sets the gender of a player.
sethead(str imagefilename)		Sets the head of a player
setletters(str imagefilename)		Sets the image to use for sign background and text.
setmap(str, str, float, float)
setminimap(str, str, float, float)
setmusicvolume(float, float)
setplayerdir(str)
setshield(str imagefilename, int shieldpower)
setshoecolor(str color)
setshootparams(str params)
setskincolor(str color)
setsleevecolor(str color)
setsword(str imagefilename, int swordpower)
showstats(int statsflag)		With this you can show/hide parts of the status bar / game Examples: // Shows all showstats(allstats); // Enable everything except minimap showstats(allstats & ~0x100); // Enable everything except AP and MP bars showstats(allstats & ~(0x40 | 0x80)); // Enable only players and right-click profile showstats(0x400 | 0x800); // Hides all showstats(0); Flags can consist of: Value Description 1 ASD 2 Icons (for rupees, bombs, arrows) 4 Rupees count 8 Bombs count 0x10 Arrows count 0x20 Hearts 0x40 Alignment (ap) bar 0x80 Magic points (mp) bar 0x100 Minimap (you can only hide it, you can't show it when the player pressed Alt+3) 0x200 Inventory NPCs 0x400 Players 0x800 Right-click on players opens their profile allstats All of the previously stated stats flags enabled
spyfire(int length, int power)		Shoots a line of fire in the direction of the player with the specified tile length, and fire power (1 - bomb, 2 - super bomb, 3 - jolt bomb).
stopmidi()
stopsound(str soundfilename)		Stop playing a sound started by playlooped
takeplayercarry()
takeplayerhorse()
testplayer(float x, float y)	integer
triggeraction(float x, float y, str dest, params...)
triggerserver(str dest, str params)
updateboard(int x, int y, int width, int height)
updateratings(obj)	object	Updates an array of {rating1,ratingdeviation1, rating2,ratingdeviation2, ...}, init them at 1500 and 350. Example: newratings = updateratings({winner.rating,winner.ratingd,loser.rating,loser.ratingd}); winner.rating = newratings[0]; winner.ratingd = newratings[1]; loser.rating = newratings[2]; loser.ratingd = newratings[3];
worldx(float x, float y) - returns float
worldy(float x, float y) - returns float
wraptext(int fontsize, str format, str text)	object
wraptext2(int, float, str, str)	object

Graal 3D

• addmaterialmapping(str, str) - returns boolean
• getboxcenter(str) - returns string
• getdatablocktypes() - returns object
• getobjectat(float, float) - returns object
• getobjectatmouse() - returns object
• getobjectbyray(str, str) - returns object
• getsurfacetype(float, float) - returns string
• lightscene() - returns boolean
• mapshapeanimation(str, str, str, float) - returns boolean
• setfogcolors(obj)
• setinteriorrendermode(int)
• setshadowdetaillevel(float)
• setskybandcolors(obj)
• setskybandsizes(obj)
• setsuncolors(obj)
• setterrainrendermode(int)
• updateterrain()
• updatevisibledistance()

Other

• adventure_installgraal(str, bool, bool)
• adventure_openexternaloptions() - returns boolean
• adventure_openexternalpm(obj) - returns boolean
• adventure_openserverlist()
• adventure_quit()
• adventure_savegraaloptions()
• adventure_selectpath(str) - returns object
• adventure_setaccountname(str)
• adventure_setchat(str)
• adventure_setnickname(str)
• adventure_setpassword(str)
• adventure_startofflinemode()
• adventure_updateaccountfield()
• adventure_updatemicroactivationlevel()
• adventure_updatemidivolume()
• adventure_updatemp3volume()
• adventure_updateplayermuted()
• adventure_updateplayerprofile(bool, str, str, int, str, str, str, str, str, str)
• adventure_updateradiovolume()

(these functions are only available to privileged scripts from the Login server)

Classes / Object Types

• TGraalVar
  • ActionMap
  • GuiControl
    • EditManager
    • GuiArrayCtrl
      • GuiTextListCtrl
      • GuiTreeViewCtrl
    • GuiBackgroundCtrl
    • GuiBitmapBorderCtrl
    • GuiBitmapButtonCtrl
    • GuiBitmapCtrl
      • GuiCrossHairHud
      • GuiMapOverviewCtrl
    • GuiButtonBaseCtrl
      • GuiBorderButtonCtrl
      • GuiButtonCtrl
      • GuiCheckBoxCtrl
        • GuiRadioCtrl
    • GuiChunkedBitmapCtrl
    • GuiContextMenuCtrl
    • GuiDrawingPanel
    • GuiFlash
    • GuiFrameSetCtrl
    • GuiGraal3DCtrl
    • GuiGraalCtrl
    • GuiMenuCtrl
    • GuiMLTextCtrl
      • GuiMLTextEditCtrl
        • GuiPMEditCtrl
      • GuiPMCtrl
      • GuiPMHistoryCtrl
    • GuiMouseEventCtrl
    • GuiPlayerView
    • GuiProgressCtrl
    • GuiScrollCtrl
    • GuiShapeNameHud
    • GuiShowImgCtrl
    • GuiSliderCtrl
    • GuiTabCtrl
    • GuiTextCtrl
      • GuiBubbleTextCtrl
      • GuiPopUpEditCtrl
      • GuiPopUpMenuCtrl
      • GuiTextEditCtrl
        • GuiTextEditSliderCtrl
      • GuiWindowCtrl
    • TerrainEditor
    • WorldEditor
  • GuiControlProfile
  • GuiCursor
  • GuiTabCtrlEntry
  • GuiTextListEntry
  • GuiTreeViewNode
  • MissionArea
  • ShapeBaseHitBox
  • ShapeImageState
  • SimObject
    • SceneObject
      • AudioEmitter
      • FractalTree
      • fxFoliageReplicator
      • fxGrassReplicator
      • fxShapeReplicator
      • fxSunLight
      • GameBase
        • DynamicShapeReplicator
          • DynamicGrass
          • DynamicGrassReplicator
        • Explosion
        • fxLight
        • Lightning
        • ParticleEmitter
        • ParticleEmitterNode
        • PathedInterior
        • Precipitation
        • Projectile
        • ShapeBase
          • AdvancedCamera
          • Camera
          • MissionMarker
          • PathCamera
          • Player
            • AIPlayer
          • StaticShape
          • Vehicle
            • FlyingVehicle
            • HoverVehicle
            • WheeledVehicle
        • SpawnSphere
        • Splash
        • Trigger
        • TSStatic
          • Item
      • InteriorInstance
      • Marker
      • Shape3ds
      • Sky
      • TerrainBlock
      • twSurfaceReference
      • volumeLight
      • WaterBlock
    • SimDataBlock
      • AudioDescription
      • AudioProfile
      • DecalData
      • GameBaseData
        • DebrisData
        • ExplosionData
        • fxLightData
        • ItemData
        • LightningData
        • ParticleEmitterData
        • ParticleEmitterNodeData
        • PathedInteriorData
        • PrecipitationData
        • ProjectileData
        • ShapeBaseData
          • AdvancedCameraData
          • CameraData
          • MissionMarkerData
          • PlayerData
          • StaticShapeData
          • VehicleData
            • FlyingVehicleData
            • HoverVehicleData
            • WheeledVehicleData
        • ShapeBaseImageData
        • SplashData
        • TriggerData
      • ParticleData
      • TSShapeConstructor
      • WheeledVehicleSpring
      • WheeledVehicleTire
    • SimGroup
      • GameConnection
    • Sun
  • TDrawableObject
    • TBaddy
    • TLevelObject
      • TExplosion
      • TGaniObject
        • TProjectile
        • TServerHorse
        • TServerPlayer
          • TPlayer
          • TServerNPC
            • TServerWeapon
      • TServerBomb
      • TServerCarry
      • TServerChest
      • TServerExtra
      • TServerFlying
      • TServerLeap
      • TServerSign
      • TShowImg
  • TDrawingPanel
  • Terraformer
  • TFrameDetail
  • TGaniParam
  • TGraalAni
  • TGraalAniPart
  • TGraalAniSound
  • TGraalAniSprite
  • TGraalAniStep
  • TGraalSpriteAttachment
  • THTTPRequest
  • TParticle
  • TParticleEmitter
  • TParticleModifier
  • TServerLevel
  • TServerLevelLink
  • TShowImg_Values
    • TShowImg_Gani
    • TShowImg_Image
    • TShowImg_Shape
    • TShowImg_Text
  • TShowImgMount
  • TStaticVar
  • TUpdatePackage