Difference between revisions of "Notify"

From Kolmafia
Jump to navigation Jump to search
imported>Zarqon
m (linked comments)
imported>Zarqon
(added "script" command info)
Line 3: Line 3:
 
The notify command is a special ASH command which sends a kmail to the specified player saying:
 
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 <C:Program FilesKoL mafiascriptsscriptname.ash>. Thanks for writing this script!</blockquote>
+
<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.
 
Its intended purpose is for script authors to get feedback on who is using their scripts.
Line 12: Line 12:
  
 
The proper syntax is [[notify]] ''playername'';
 
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:
 +
 +
[[script]] "scriptname";
 +
[[notify]] ''playername'';
  
 
Note that no parentheses or quotes are necessary.
 
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 [[abort error]].  Only [[comments]] and whitespace can safely precede it.
+
The [[notify]] command must be the first command in the script, or attempting to run the script will generate an [[abort error]].  Only the script command, [[comments]], and whitespace can safely precede it.
  
 
Do not use [[notify]] for [[consult scripts]] -- you cannot send kmail during combat.
 
Do not use [[notify]] for [[consult scripts]] -- you cannot send kmail during combat.
Line 26: Line 31:
  
 
<code>
 
<code>
   [[comments|# ------------------------------------------------------------------------------------------]]
+
   [[comments|# ----------------------------------------------------------------------------------]]
   [[comments|# EatDrink.ash by dj_d]]
+
   [[comments|# EatDrink.ash]]
 +
  [[comments|# by]]
 +
  [[comments|# dj_d]]
 
   [[comments|# ]]
 
   [[comments|# ]]
 
   [[comments|# inspired by reportConsumables.ash, by Sandiman]]
 
   [[comments|# inspired by reportConsumables.ash, by Sandiman]]
   [[comments|# ------------------------------------------------------------------------------------------]]
+
   [[comments|# ----------------------------------------------------------------------------------]]
   [[notify]] dj_d;
+
 
 
+
  [[script]] "EatDrink.ash"
   [[import]] <value.ash>;
+
   [[notify]] "dj_d";
 +
 
 +
   [[import]] <zlib.ash>;
 
    
 
    
   [[string]] EATDRINK_VERSION = "1.0";
+
   [[string]] EATDRINK_VERSION = "2.4";
 
   ...
 
   ...
 
</code>
 
</code>
  
 
[[Category:Ash Functions | notify]]
 
[[Category:Ash Functions | notify]]

Revision as of 15:04, 3 October 2009

notify playername

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

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

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 the notify command

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:

script "scriptname"; notify playername;

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 abort error. Only the script command, comments, and whitespace can safely precede it.

Do not use notify for 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:

 # ----------------------------------------------------------------------------------
 # 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";
 ...