Notify

2010-06-21T05:15:30Z

115.93.43.194:

{{#customtitle:notify}}
[[notify]] ''playername''

The notify command is a special ASH command which sends a kmail to the specified player saying:

<blockquote>I have opted to let you know that I have chosen to run <scriptname.ash>. Thanks for writing this script!</blockquote>

Its intended purpose is for script authors to get feedback on who is using their scripts.

Mafia will send a notify kmail only once per filename per character. After sending the initial kmail, only clearing the global settings file or renaming the script (including moving it to another folder) will cause the notify command to send a second kmail about that script.

==Using Notify==

The proper syntax is [[notify]] ''playername'';

You can also specify the scriptname to be used in the notification by using the script command before the notify command, as follows:
{{CodeSample|
code=
<syntaxhighlight>
script "scriptname";
notify playername;
</syntaxhighlight>}}
Note that no parentheses or quotes are necessary.

The [[notify]] command must be the first command in the script, or attempting to run the script will generate an [[ASH Errors#abort|abort error]]. Only the script command, [[comments]], and whitespace can safely precede it.

Do not use [[notify]] for [[In-combat Consulting|consult scripts]] -- you cannot send kmail during combat.

[[notify]] cannot be used from the CLI using the "ash" command.

==Example==

The following is taken from the top of dj_d's EatDrink.ash:

{{CodeSample|
code=
<syntaxhighlight>
# ----------------------------------------------------------------------------------
# EatDrink.ash]]
# by]]
# dj_d]]
# ]]
# inspired by reportConsumables.ash, by Sandiman]]
# ----------------------------------------------------------------------------------

script "EatDrink.ash"
notify "dj_d";

import <zlib.ash>;

string EATDRINK_VERSION = "2.4";
</syntaxhighlight>}}

[[Category:Miscellaneous ASH Features]]

Relay Override Scripting

2010-04-01T03:44:22Z

115.93.43.194: added more information, qualified some assertions

This is a means of changing KoL's web pages so that the user sees something different. There are two kinds of relay override scripts. The first is simply known as an Relay Script. The second is a User Interface script.

=Relay Script=
For a simple Relay Script, there are several basic rules:
#The name of the script must be the same as the page it is overriding, except with an ash extension instead of a php extension. For users who have enabled relay override scripts, mafia will automatically call xyz.ash every time the relay browser attempts to visit xyz.php.
#Unless the script is displaying entirely new content, it should first load the unmodified page from KoL using the command [[visit_url|visit_url()]] with no parameters.
#Then the contents of the page can be modified with [[replace_string|replace_string()]] or other string manipulation functions.
#Finally, the modified page is written with the [[write|write()]] command.
 

Here is an example of a relay script. This will modify shore.php to reveal items that are needed for the level 6 tower monster. The script must be named shore.php in order to modify the correct page.
<div style="margin-bottom: 1em; border: dashed 1px green; padding: 1em; margin:0px 20px;"><syntaxhighlight>
// This script will only work if it is named shore.ash
void main() {
buffer results;
// Get the basic shore page
append(results, visit_url());

// This will modify the Dude Ranch text if a stick of dynamite is needed
void dynamite() {
if(available_amount($item[stick of dynamite]) < 1)
replace_string(results, "Distant Lands Dude Ranch Adventure",
"Distant Lands Dude Ranch Adventure"
+" (stick of dynamite needed)");
}

// This will modify the Paradise Island text if a tropical orchid is needed
void orchid() {
if(available_amount($item[tropical orchid]) < 1)
replace_string(results, "Tropical Paradise Island Getaway",
"Tropical Paradise Island Getaway"
+" (tropical orchid needed)");
}

// This will modify the Ski Resort text if a barbed-wire fence is needed
void fence() {
if(available_amount($item[barbed-wire fence]) < 1)
replace_string(results, "Large Donkey Mountain Ski Resort",
"Large Donkey Mountain Ski Resort"
+" (barbed-wire fence needed)");
}

// Only do this if the character has no access to the mall
if(!can_interact()) {
// If the character has a level 7 telescope, only check for the necessary item
if(get_property("telescopeUpgrades") == "7")
switch(get_property("telescope7")) {
case "see a wooden beam":
dynamite(); break;
case "see a formidable stinger":
orchid(); break;
case "see a pair of horns":
fence(); break;
}
// Check for all three items
else {
dynamite();
orchid();
fence();
}
}

// Write the modified page to the web browser
write(results);
}
</syntaxhighlight></div>
 

=User Interface Script=
More information will be added later. In the meantime, here are two links:
* http://kolmafia.us/showthread.php?3771-Scripts-with-user-interfaces
* http://kolmafia.us/showthread.php?3842-Form-of...HTML!

Kolmafia - User contributions [en]

Notify

Relay Override Scripting