Shared functions pack

[Skyld]

I'm happy to introduce the new clientside shared functions pack. It's a clientside script added to players when they log into Graal, providing new public functions that are available for all servers to use. These are general functions that you might just find handy to speed the scripting process up. It also enables us to provide some new functions quickly without client updates.

Currently the pack just provides a few odd functions, however more will become available in due course. If you have some clientside functions or amendments to existing functions (for instance, new encryption algorithms) that you feel people may benefit from and don't mind sharing, send me them in a forum PM and I'll check them over. If suitable, they might find themselves in this function pack. Similarly if you have any ideas, suggestions or bug reports, just let me know or post them here.

Functions

shared.getfontzoom(size) (contributed by Xzirox)
Returns the font zoom depending upon the text size that is set in the player's F3 options.

shared.hextorgb(string) (contributed by Tig)
Converts the RGB-format hex string into an array of {red, green, blue} values. For instance, "#FF0000" comes out as {1, 0, 0}.

PHP Code:

shared.hextorgb("#FA32BF"); 


shared.rgbtohex(red, green, blue) (contributed by Tig)
Converts the RGB into an RGB-format hex string. Essentially the reverse of the above function.

PHP Code:

shared.rgbtohex(1, 0.4, 0.7); 


shared.encrypt(algorithm, string, key)
Encrypts the string with the given key. There are two algorithms available: ENC_SIMPLE and ENC_SIMPLE_NOBASE64. The first is basically the simple encryption algorithm that I posted a while ago, while the second is the same algorithm but without the base64 conversion (so you get less overhead but stranger output characters at times).

PHP Code:

temp.encrypted = shared.encrypt(ENC_SIMPLE, "test", "foo"); 


shared.decrypt(algorithm, string, key)
Decrypts in exactly the same way that the encryption function above works. Provide the encrypted data as the "string", and use the same key to decrypt.

PHP Code:

temp.encrypted = shared.encrypt(ENC_SIMPLE, "test", "foo");
temp.decrypted = shared.decrypt(ENC_SIMPLE, temp.encrypted, "foo"); 


shared.chat(chat text)
Sets the player's chat text using the privileged setchat function. This means that the chat text works exactly like the chatbar. It interprets things like "showscriptstats" but is set to strip out toalls and toguilds.

PHP Code:

shared.chat("showscriptstats"); 


shared.tan(a)
Provides the missing trigonometry tan() function.

shared.getimgcenter(image name)
Returns an array of {x, y} where the X and Y values correspond to the center of the image relative from the top left of the image.

PHP Code:

shared.getimgcenter("block.png"); 


shared.getdisplayname()
Returns a friendly way of referring to the player on-screen. Guest users will see "Guest User", otherwise the community name/account name are returned instead.

shared.pmswaiting()
Returns an array of player objects from whom there is a PM waiting to be read. This includes external players from other servers.

PHP Code:

for (temp.pl: shared.pmswaiting())
{
  //
} 


shared.roundto(value, places)
Rounds the value to the given number of places.

PHP Code:

shared.roundto(3.14, 0.1); 


Functions as of 20080826

shared.stringmerge(string, chars[])
Returns a reformatted string stripping whitespaces and any other single characters provided in the chars array.

PHP Code:

shared.stringmerge("One, two!", {",", "!"}); 


shared.setconstants_showstats()
Sets globally scoped variables clientside for showstats to replace 0x? values for easier script comprehension (STATS_ASD, STATS_ICONS, STATS_RUPEES, STATS_BOMBS, STATS_ARROWS, STATS_HEARTS, STATS_AP, STATS_MP, STATS_MINIMAP, STATS_INVENTORYNPCS, STATS_PLAYERS, STATS_RIGHTCLICK_PROFILE).

PHP Code:

shared.setconstants_showstats();
showstats(allstats - STATS_BOMBS - STATS_ARROWS); 


A script only needs to run shared.setconstants_showstats() once on the clientside for this to be effective.

shared.setconstants_enablefeatures()
Sets globally scoped variables clientside for enablefeatures to replace 0x? values for easier script comprehension (EF_KEY_M, EF_KEY_P, EF_KEY_Q, EF_KEY_R, EF_KEY_SA, EF_KEY_SD, EF_KEY_TAB, EF_CHATTEXT, EF_HEARTSDISPLAY, EF_NICKNAMES, EF_MINIMAP_PMICONS, EF_RIGHTCLICK_PROFILE, EF_EMOTICONS, EF_KEY_ALT5, EF_KEY_ALT89, EF_F2OUTPUT).

PHP Code:

shared.setconstants_enablefeatures();
enablefeatures(allfeatures - EF_CHATTEXT - EF_NICKNAMES); 


A script only needs to run shared.setconstants_enablefeatures() once on the clientside for this to be effective.

Functions as of 20090530

shared.getAlignmentColor(ap)
Returns an array of {red, green, blue} for the given AP color, allowing you to recreate the default nickname colors.

PHP Code:

shared.getAlignmentColor(player.ap); 


shared.getAlignmentShadowColor(red, green, blue)
Returns an array of {red, green, blue} for the shadow of the given color, allowing you to recreate the default nickname shadows.

PHP Code:

shared.getAlignmentShadowColor(0.75, 0.1, 0.3); 


shared.replacetext(string, search, replace) (contributed by Dusty)
Returns a string. Searches string for search and replaces it with replace.

shared.getSharedFunctions
Returns an array of functions provided by the shared function pack.

Function added Jan 05, 2010

shared.adminMessage(text)
Opens an admin message window that will stay on the player's screen even after serverwarping until the player closes the window.
See: http://forums.graalonline.com/forums...98#post1548498

PHP Code:

shared.adminMessage("You have been disconnected by Tig"); 


[Tigairius]

Awesome. Thank you for this (shared.chat)!

[DrakilorP2P]

Good stuff.

[xXziroXx]

getfontzoom <3

[Programmer]

Thank you!

I've been looking for this kind of (native) support for a long time.

Perhaps you could also implement some of the functions in our (Chompy and I) thread: http://forums.graalonline.com/forums...ad.php?t=79473

[Crow]

I love you. I need somebody to spread rep, I want to rep Skyld for 3 times now D:

[cbk1994]

Very nice! Thank you, Skyld!

Originally Posted by Tigairius

Awesome. Thank you for this (shared.chat)!

I agree, though Stefan finally added a setChat(chat) function to -Serverlist.

[Skyld]

Originally Posted by cbk1994

I agree, though Stefan finally added a setChat(chat) function to -Serverlist.

Not sure whether this will stay (or whether it'll just be changed to call shared.chat()) since I don't think the serverlist is doing as many checks with it for security.

Originally Posted by Programmer

Perhaps you could also implement some of the functions in our (Chompy and I) thread: http://forums.graalonline.com/forums...ad.php?t=79473

Sure can look at it.

[Frankie]

neato!

[cbk1994]

Originally Posted by Skyld

Not sure whether this will stay (or whether it'll just be changed to call shared.chat()) since I don't think the serverlist is doing as many checks with it for security.

I'll change it on Vesporia (am glad I decided to put it in the player class as opposed to calling it each time!)

[TheStan]

Skyld, Stefan, I applaud you. And I applaud those who contributed functions.

[Chompy]

Might take a look at this? http://forums.graalonline.com/forums...ad.php?t=79594
It's an encryption algorithm I made some months ago

And, really nice Skyld :]
Can't wait for more functions to be added

[Inverness]

So why isn't it on login server yet?

[Kristi]

Originally Posted by Programmer

Thank you!

I've been looking for this kind of (native) support for a long time.

Perhaps you could also implement some of the functions in our (Chompy and I) thread: http://forums.graalonline.com/forums...ad.php?t=79473

I made these ages ago (well, one function that handles all of that optimized for graal), JUST WAITING FOR ACCESS TO THE SHARED FUNCTIONS

[Tigairius]

Originally Posted by Kristi

JUST WAITING FOR ACCESS TO THE SHARED FUNCTIONS

I don't see why Skyld can't upload it for you if they're already made.. ?

[Kristi]

Originally Posted by Tigairius

I don't see why Skyld can't upload it for you if they're already made.. ?

That would make my job rather silly

[Cloven]

Originally Posted by Kristi

That would make my job rather silly

Or not..

[Skyld]

Okay, these functions are now available on the main login server, for all players and servers.

[devilsknite1]

I just fell in love / fainted / any other word here. YAY! <3

[Skyld]

Added shared.getAlignmentColor(int ap); and shared.getAlignmentShadowColor(int red, int green, int blue); by request, both returning an array of {red, green, blue}.

[DustyPorViva]

Could you perhaps add my replacetext function(or a better one, as long as one is available)?

http://forums.graalonline.com/forums...ad.php?t=82820

[Skyld]

Originally Posted by DustyPorViva

Could you perhaps add my replacetext function(or a better one, as long as one is available)?

http://forums.graalonline.com/forums...ad.php?t=82820

Added it to shared.replacetext(string, search, replace).

Also added a function called shared.getSharedFunctions() which returns an array of public functions provided by the shared function pack.

[Crow]

Awesome Skyld, thank you!

[Tigairius]

Originally Posted by Skyld

Added shared.getAlignmentColor(int ap); and shared.getAlignmentShadowColor(int red, int green, int blue); by request, both returning an array of {red, green, blue}.

Originally Posted by Skyld

Added it to shared.replacetext(string, search, replace).

Also added a function called shared.getSharedFunctions() which returns an array of public functions provided by the shared function pack.

These things are pretty nice

[DustyPorViva]

Could you also add this?

PHP Code:

function tiles(cx,cy,cw,ch) {
  temp.ctiles = new[0];
  for (temp.i=0;i<cw*ch;i++) {
    ctiles.add(tiles[int(cx+(i%cw)),int(cy+int(i/cw))]);
  }
  return ctiles;
} 


player.chat = tiles(x,y,width,height);
Would return an array of all tiles within the 'blocl' given. I get tired of having to run loops all the time to check a block of tiles.

[DustyPorViva]

The AP shadow function returns 0,0,0 for gold ap, which isn't right.

It should have a check:
if (params[0] == 224 && params[1] == 196 && params[2] == 0) return {255,255,0};

Or something like that.

[fowlplay4]

Couldn't hurt..

PHP Code:

function capitalize(str) {
  return str.charat(0).upper() @ str.substring(1);
} 


[Tigairius]

Added a new clientside function, you can access it like so:

PHP Code:

shared.adminMessage("You have been disconnected because you did not move for more than 30 minutes."); 


It supports html tags as well.

Attached a screenshot of it so you know what it's doing.

Basically, it'll open a window (like so) that will remain open even when changing servers, so, for example, if you wanted to open a window before you serverwarp() someone, it's possible now, and they will see the message even when they're on the login server.

[DustyPorViva]

Yes please?

PHP Code:

function repeat(char,num) {
  temp.output = "";
  for (temp.i=0;i<num;i++) output @= char;
  return output;
} 


I ran into a script earlier that made me wish there was a repeat character function. I think something like this would be useful for anyone who needs to format text.

Also, with these functions are variable names an issue? For example, if I use shared.repeat(" ",5) in a loop that also uses temp.i, is it going to break?

[cbk1994]

Originally Posted by DustyPorViva

Also, with these functions are variable names an issue? For example, if I use shared.repeat(" ",5) in a loop that also uses temp.i, is it going to break?

temp variables are specific to the function, so no.

[DustyPorViva]

Originally Posted by cbk1994

temp variables are specific to the function, so no.

Good point! Completely forgot about that.

[MrOmega]

Hey, I'm getting an error sometimes that 'shared.roundto()' not found. Any thought as to why?

[DustyPorViva]

Originally Posted by MrOmega

Hey, I'm getting an error sometimes that 'shared.roundto()' not found. Any thought as to why?

Are you using it clientside?

[MrOmega]

Originally Posted by DustyPorViva

Are you using it clientside?

Yes

[MrOmega]

sorry for this... but bump, why do I sometimes get this error?

[fowlplay4]

You could try referencing the weapon directly: (@"-Shared").roundto()

Then maybe just make a copy of the function so your code looks a little neater:

PHP Code:

function roundto() {
  return (@"-Shared").roundto();
} 


[ffcmike]

Originally Posted by Skyld

shared.getAlignmentColor(ap)
Returns an array of {red, green, blue} for the given AP color, allowing you to recreate the default nickname colors.

PHP Code:

shared.getAlignmentColor(player.ap); 


shared.getAlignmentShadowColor(red, green, blue)
Returns an array of {red, green, blue} for the shadow of the given color, allowing you to recreate the default nickname shadows.

PHP Code:

shared.getAlignmentShadowColor(0.75, 0.1, 0.3); 


I recently did some testing comparing the time it takes to loop through 0-100 between these shared functions and what we were using to calculate it on Classic.
It turns out that Classic's method was roughly twice as fast as the shared function, though some (wouldn't rule out all) of this time may have been down to the fact that public functions take a little bit longer.

Me/WhiteDragon then decided to try storing all of the values within an array like this:

PHP Code:

//#CLIENTSIDE
function onCreated(){
  this.apv = {
    {64,0,0},
    {128,64,64},
    {133,62,62},
    {138,59,59},
    {143,57,57},
    {148,54,54},
    {153,52,52},
    {158,49,49},
    {163,47,47},
    {168,44,44},
    {173,41,41},
    {178,39,39},
    {183,36,36},
    {188,34,34},
    {194,31,31},
    {199,29,29},
    {204,26,26},
    {209,24,24},
    {214,21,21},
    {219,18,18},
    {224,16,16},
    {229,13,13},
    {234,11,11},
    {239,8,8},
    {244,6,6},
    {249,3,3},
    {255,0,0},
    {255,10,10},
    {255,21,21},
    {255,31,31},
    {255,42,42},
    {255,53,53},
    {255,63,63},
    {255,74,74},
    {255,85,85},
    {255,95,95},
    {255,106,106},
    {255,116,116},
    {255,127,127},
    {255,138,138},
    {255,148,148},
    {255,159,159},
    {255,170,170},
    {255,180,180},
    {255,191,191},
    {255,201,201},
    {255,212,212},
    {255,223,223},
    {255,233,233},
    {255,244,244},
    {255,255,255},
    {255,255,255},
    {255,255,255},
    {255,255,255},
    {255,255,255},
    {255,255,255},
    {230,255,230},
    {205,255,205},
    {179,255,179},
    {154,255,154},
    {128,255,128},
    {128,255,128},
    {116,255,140},
    {103,255,153},
    {90,255,166},
    {77,255,178},
    {64,255,191},
    {52,255,204},
    {39,255,216},
    {26,255,229},
    {13,255,242},
    {0,247,255},
    {0,238,255},
    {0,229,255},
    {0,220,255},
    {0,212,255},
    {0,203,255},
    {0,194,255},
    {0,185,255},
    {0,176,255},
    {0,168,255},
    {0,159,255},
    {0,150,255},
    {0,141,255},
    {0,132,255},
    {0,124,255},
    {0,115,255},
    {0,106,255},
    {0,97,255},
    {0,88,255},
    {0,80,255},
    {0,71,255},
    {0,62,255},
    {0,53,255},
    {0,44,255},
    {0,36,255},
    {0,27,255},
    {0,18,255},
    {0,9,255},
    {0,0,255},
    {231,199,0}
  };
}

public function getAlignmentColors(temp.ap) {
  temp.ac = this.getAlignmentColor(temp.ap);
  if(temp.ap == 100){
    temp.sc = {255, 255, 0};
  }
  else{
    temp.c = 255 * !(temp.ac[0]>191.25 || temp.ac[1]>191.25);
    temp.sc = {temp.c, temp.c, temp.ac[2]};
  } 
  return {temp.ac, temp.sc};
  //Alignment Color, Shadow Color
} 

public function getAlignmentColor(temp.ap) {
  return this.apv[temp.ap];
} 


I guess this would be exchanging some memory and an increased amount of weapon data sent to the client for a save on script time. This turned out to be significantly faster than what we were previously using if the class is joined within the script using it. It is also still slightly faster than our previous method if used as a public function.

[Mark Sir Link]

does shared.getAlignmentShadowColor(r, g, b) even work? What are the expected values? A float 0-1 or an int 0-255?

I have tried

PHP Code:

temp.c = shared.getAlignmentColor(player.ap);
temp.cs = shared.getAlignmentShadowColor(c[0], c[1], c[2]);

temp.c = shared.getAlignmentColor(player.ap);
temp.cs = shared.getAlignmentShadowColor(c[0]/255, c[1]/255, c[2]/255);

temp.cs = shared.getAlignmentShadowColor(player.ap); 


and all are returning an array of {0, 0, 0}

The few times I've gotten it to return something besides that (by first methodology), it returns something entirely wrong, like {0, 0, 255} should the player's AP be 90 (which appears to be a white outline, while the returned is just blue)

seems as if both of these functions need work, I'm not sure why different params are passed to one versus the other anyway

[Crow]

What's wrong with rgbtohex()? shared.rgbtohex(1, 0, 0) returns #0F0000 for me; should be #FF0000 instead. Also, how come rgbtohex() and hextorgb() seem to return more than they should using v6? I always get stuff like "#0F0000 1 0 1" as a return value.

[DrakilorP2P]

Originally Posted by Crow

What's wrong with rgbtohex()? shared.rgbtohex(1, 0, 0) returns #0F0000 for me; should be #FF0000 instead. Also, how come rgbtohex() and hextorgb() seem to return more than they should using v6? I always get stuff like "#0F0000 1 0 1" as a return value.

rgbtohex() returns the wrong hex for me too.