Revision as of 03:47, 27 January 2006

Client Supported Script Features

Settings

$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

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 (read only)
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)
rightmousebutton - boolean (read only)
screenheight - integer (read only)
screenwidth - integer (read only)
scriptedcontrols - boolean (read only)
scriptedplayerlist - boolean (read only)
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
worldclockstopped - boolean
worldhour - integer
worldminute - float
worldminutesofday - float
worldrealsecondsperday - float

Functions

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)
setcursor2(str imagefilename)
synctimeofday(float, float)

Common

Files

extractfilebase(str filepath) - returns string
extractfileext(str filepath) - returns string
extractfilename(str filepath) - returns string
extractfilepath(str filepath) - returns string
fileexists(str filepath) - returns boolean
filesize(str filepath) - returns integer
fileupdate(str filepath) - returns boolean
findfiles(str, int) - returns object
findfirstfile(str) - returns string
findnextfile(str) - returns string
getextension(str filepath) - returns string
reloadfile(str filepath)
requestfiledeletion(str filepath)
requestfilerename(str filepath, str newfilepath)
requestfilesmove(str filepath, str newfilepath)
selectfilefordownload(str filter)
selectfileforupload()

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 string
base64encode(str text) - returns string
checksum(str text) - returns float
contains(str haystack, str needle) - returns boolean, you should probably do haystack.contains(needle) instead
getascii(str character) - returns integer
getstringkeys(str) - returns object
lowercase(str text) - returns string
md5(str tet) - returns 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 string

GUI

addcontrol(obj)
cursoroff()
cursoron()
iscursoron() - returns boolean
popdialog()
pushdialog(obj)
setcontentcontrol(obj)

Graal 2D

addtiledef(str prefix, str tilesetimage, int tilesettype)
addtiledef2(str prefix, str tilesetimage, int x, int y)
attachplayertoobj(int x, int y)
callnpc(int npcindex, params...)
callweapon(int weaponindex, params...)
commandtoserver(str text)
detachplayer()
disabledefmovement()
disablemap()
disablepause()
disableselectweapons()
disableweapons()
enabledefmovement()
enablefeatures(int flags)
enablemap()
enablepause()
enableselectweapons()
enableweapons()
explodebomb(int bombindex)
findani(str) - returns object
findlevel(str levelfilename) - returns object
findplayer(str accountname) - returns object
findplayerbyid(int playerid) - returns object
findweapon(str weaponname) - returns object
freezeplayer(float seconds)
getimgheight(str imagefilename) - returns integer
getimgwidth(str imagefilename) - returns integer
getmapx(str levelname) - returns integer
getmapy(str levelname) - returns integer
gettextheight(float, str, str) - returns integer
gettextwidth(float, str, str, str) - returns integer
getz(float x, float y) - returns 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()
onwall(float x, float y) - returns boolean
onwall2(float x, float y, float width, float height) - returns boolean
onwater(float x, float y) - returns boolean
onwater2(float x, float y, float width, float height) - returns boolean
play(str soundfilename)
play2(str, float, float, float)
playlooped(str soundfilename)
putleaps(int leapstype, float x, float y)
removetiledefs(str prefix)
replaceani(str defaultaniname, str newaniname)
resetfocus()
say(int signindex)
say2(str text)
screenx(float x, float y) - returns integer
screeny(float x, float y) - returns integer
setani(str aniname, str aniparams)
setbeltcolor(str color)
setcoatcolor(str color)
seteffect(float r, float g, float b, float a)
setfocus(float x, float y)
setgender(str gendername)
sethead(str imagefilename)
setletters(str imagefilename)
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)
spyfire(int x, int y)
stopmidi()
stopsound(str soundfilename)
takeplayercarry()
takeplayerhorse()
testplayer(float x, float y) - returns 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) - returns object - updates an array of {rating1,ratingdeviation1, rating2,ratingdeviation2, ...}, init them at 1500 and 350
worldx(float x, float y) - returns float
worldy(float x, float y) - returns float
wraptext(int fontsize, str format, str text) - returns object
wraptext2(int, float, str, str) - returns 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()

Objects

TGraalVar

@@ Line 110: / Line 110: @@
 ==Functions==
 * aindexof(float, obj) - returns integer
-* cursoroff()
-* cursoron()
 * echo(str text)
 * getbasepackage() - returns object
@@ Line 128: / Line 126: @@
 * getupdatepackage(str) - returns object
 * isadminguild(str guildname) - returns boolean
-* iscursoron() - returns boolean
 * isdevicefullscreenonly(str devicename) - returns boolean
 * isobject(str objectname) - returns boolean
@@ Line 207: / Line 204: @@
 ===GUI===
 * addcontrol(obj)
+* cursoroff()
+* cursoron()
+* iscursoron() - returns boolean
 * popdialog()
 * pushdialog(obj)

Creation/Dev/Script/Client: Difference between revisions

Revision as of 03:47, 27 January 2006

Contents

Client Supported Script Features

Settings

Variables

Functions

Common

Files

Math

Matrices

Vectors

Strings

GUI

Graal 2D

Graal 3D

Other

Objects