Modifier eval - Revision history

Zarqon: updated from documentation in mafia source

2015-06-05T16:01:02Z

updated from documentation in mafia source

← Older revision		Revision as of 16:01, 5 June 2015
Line 15:		Line 15:
	}}\|		}}\|

	function_description= Evaluates an expression in the format used by variable modifiers:		function_description= Evaluates an expression in the format used by variable modifiers. The following was copied from http://sourceforge.net/p/kolmafia/code/HEAD/tree/src/data/modifiers.txt :

	* No spaces are allowed within the expression, except as part of a zone/location name.		* No spaces are allowed within the expression, except as part of a zone/location name.
	* + - * / ( ) have their usual mathematical meaning and precedence.		* + - * / ( ) have their usual mathematical meaning and precedence.
	* ^ is exponentiation, with the highest precedence.		* ^ is exponentiation, with the highest precedence.
	* Functions available: ceil(x) floor(x) sqrt(x) min(x,y) max(x,y)		* Functions available:
	* Location functions: loc(text) zone(text)		** ceil(x) floor(x) sqrt(x) min(x,y) max(x,y) abs(x)
	** These have a value of 1 if the current adventure location or ~~zone~~ contains the specified text, 0 elsewhere.		* Location functions: loc(text) zone(text) env(text)
			** These have a value of 1 if the current adventure location, zone, or environment contains the specified text, 0 elsewhere.
			* Path function: path(text)
			** This has a value of 1 if the player's path matches the text.
	* Familiar function: fam(text)		* Familiar function: fam(text)
	** This has a value of 1 if the player's familiar type contains the text, else 0.		** This has a value of 1 if the player's familiar type contains the text, else 0.
			* Weapon function: mainhand(text)
			** This has a value of 1 if the player's mainhand weapon class (sword, club, etc.) contains the text.
	* Preferences function: pref(text)		* Preferences function: pref(text)
	* ~~There could be at most one~~ of ~~each~~ text function ~~in an expression~~.		** Returns the value of the specified preference
	** This ~~is no longer~~ the ~~case however and multiple~~ of the ~~same~~ text ~~functions should now work properly~~.		* function: pref(text,compare)
	* ~~All upper~~-case letters are ~~reserved for internally-used variables. The available variables are~~:		** Returns 1 if the specified preference is equal to "compare", otherwise 0
	** A - number of Ascensions		* Effect function: effect(text)
	** B - Blood of Wereseal effect		** This returns the number of turns remaining of the effect uniquely matching text.
	** C - Clancy's level		* Resistance function: res(text)
	** D - Drunkenness		** This returns the number of resistance levels for the listed element
	** E - active (nonintrinsic) Effects		* Class function: class(text)
	** F - Fullness		** This has a value of 1 if the player's class matches the text.
	** G - Grimace darkness (0..5)		* Skill function: skill(text)
	** H - Hobo Power		** This has a value of 1 if the player has the skill matching the text.
	** J - 1 on Festival of Jarlsberg, 0 otherwise		* Upper-case letters are varying values:
	** L - player Level		** A - number of Ascensions
	** M - total Moonlight (0..9)		** B - Blood of Wereseal effect
	** R - Reagent potion duration		** C - Clancy's level
	** S - Spleenness		** D - Drunkenness
	** T - Turns remaining of this effect		** E - active (nonintrinsic) Effects
	** U - telescope Upgrades		** F - Fullness
	** W - familiar Weight		** G - Grimace darkness (0..5)
	** X - gender (-1=male, 1=female)		** H - Hobo Power
			** I - Disco Momentum
			** J - 1 on Festival of Jarlsberg, 0 otherwise
			** K - Smithsness
			** L - player Level
			** M - total Moonlight (0..9)
			** N - AudieNce
			** P - Pasta Thrall level
			** R - Reagent potion duration
			** S - Spleenness
			** T - Turns remaining of this effect
			** U - telescope Upgrades
			** W - familiar Weight
			** X - gender (-1=male, 1=female)
			** Y - furY

	* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.		* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.
	\|		\|
Line 51:		Line 71:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This script expands modifier_eval() to include support for user-defined variables. It is ~~extremely~~ complex, but it is extremely useful to anyone who wants to use modifier_eval().\|		description=This script expands modifier_eval() to include support for user-defined variables. It is a bit complex, but it is extremely useful to anyone who wants to use modifier_eval().\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>

Heeheehee: Remove incorrect information.

2013-08-13T16:29:51Z

Remove incorrect information.

← Older revision		Revision as of 16:29, 13 August 2013
Line 26:		Line 26:
	** This has a value of 1 if the player's familiar type contains the text, else 0.		** This has a value of 1 if the player's familiar type contains the text, else 0.
	* Preferences function: pref(text)		* Preferences function: pref(text)
	** This must be used on preferences with a float value ONLY - merely retrieving an integer pref will corrupt it!
	* There could be at most one of each text function in an expression.		* There could be at most one of each text function in an expression.
	** This is no longer the case however and multiple of the same text functions should now work properly.		** This is no longer the case however and multiple of the same text functions should now work properly.

Heeheehee: "special" no longer true -- div-by-zero now throws an error instead of generating NaN (or possibly +/- infinity).

2013-06-07T01:14:50Z

"special" no longer true -- div-by-zero now throws an error instead of generating NaN (or possibly +/- infinity).

← Older revision		Revision as of 01:14, 7 June 2013
Line 81:		Line 81:

	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|
	~~special=Note that modifier_eval '''never''' generates errors - a malformed expression will just print a message, and return an arbitrary value.\|~~
	}}		}}

	[[Category:Math and Numbers]]		[[Category:Math and Numbers]]

Slyz: add all the modifier variables

2012-09-25T20:25:13Z

add all the modifier variables

← Older revision		Revision as of 20:25, 25 September 2012
Line 29:		Line 29:
	* There could be at most one of each text function in an expression.		* There could be at most one of each text function in an expression.
	** This is no longer the case however and multiple of the same text functions should now work properly.		** This is no longer the case however and multiple of the same text functions should now work properly.
	* All upper-case letters are reserved for internally-used variables. The ~~ones likely to be of use in user code~~ are:		* All upper-case letters are reserved for internally-used variables. The available variables are:
	** A - ~~player~~'s ~~ascension count~~		** A - number of Ascensions
	** D - ~~drunkenness~~		** B - Blood of Wereseal effect
	** F - ~~fullness~~		** C - Clancy's level
			** D - Drunkenness
			** E - active (nonintrinsic) Effects
			** F - Fullness
	** G - Grimace darkness (0..5)		** G - Grimace darkness (0..5)
	** L - player ~~level~~		** H - Hobo Power
	** M - total ~~moonlight~~ (0..9)		** J - 1 on Festival of Jarlsberg, 0 otherwise
	** S - ~~spleenness~~		** L - player Level
			** M - total Moonlight (0..9)
			** R - Reagent potion duration
			** S - Spleenness
			** T - Turns remaining of this effect
			** U - telescope Upgrades
			** W - familiar Weight
	** X - gender (-1=male, 1=female)		** X - gender (-1=male, 1=female)
	* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.		* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.

Theraze at 14:44, 16 December 2010

2010-12-16T14:44:29Z

← Older revision		Revision as of 14:44, 16 December 2010
Line 27:		Line 27:
	* Preferences function: pref(text)		* Preferences function: pref(text)
	** This must be used on preferences with a float value ONLY - merely retrieving an integer pref will corrupt it!		** This must be used on preferences with a float value ONLY - merely retrieving an integer pref will corrupt it!
	* There ~~can~~ be at most one of each text function in an expression.		* There could be at most one of each text function in an expression.
			** This is no longer the case however and multiple of the same text functions should now work properly.
	* All upper-case letters are reserved for internally-used variables. The ones likely to be of use in user code are:		* All upper-case letters are reserved for internally-used variables. The ones likely to be of use in user code are:
	** A - player's ascension count		** A - player's ascension count

Bale: A - player's ascension count

2010-12-15T06:23:32Z

A - player's ascension count

← Older revision		Revision as of 06:23, 15 December 2010
Line 29:		Line 29:
	* There can be at most one of each text function in an expression.		* There can be at most one of each text function in an expression.
	* All upper-case letters are reserved for internally-used variables. The ones likely to be of use in user code are:		* All upper-case letters are reserved for internally-used variables. The ones likely to be of use in user code are:
			** A - player's ascension count
	** D - drunkenness		** D - drunkenness
	** F - fullness		** F - fullness

Bale at 05:06, 22 May 2010

2010-05-22T05:06:27Z

← Older revision		Revision as of 05:06, 22 May 2010
Line 5:		Line 5:
	FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Math and Numbers\|~~

	function1={{Function\|		function1={{Function\|
Line 73:		Line 72:
	special=Note that modifier_eval '''never''' generates errors - a malformed expression will just print a message, and return an arbitrary value.\|		special=Note that modifier_eval '''never''' generates errors - a malformed expression will just print a message, and return an arbitrary value.\|
	}}		}}

			[[Category:Math and Numbers]]

Bale: Created page with '{{ #vardefine:name|modifier_eval}}{{ #vardefine:return_type|float}}{{ FunctionPage| name={{#var:name}}| function_category=Math and Numbers| function1={{Function| name={{#var:na…'

2010-05-05T06:42:54Z

Created page with '{{ #vardefine:name|modifier_eval}}{{ #vardefine:return_type|float}}{{ FunctionPage| name={{#var:name}}| function_category=Math and Numbers| function1={{Function| name={{#var:na…'

New page

{{
#vardefine:name|modifier_eval}}{{
#vardefine:return_type|float}}{{

FunctionPage|
name={{#var:name}}|
function_category=Math and Numbers|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|expression}}|
p1desc={{pspan|expression}} is a mathematical expression to be solved.|
}}|

function_description= Evaluates an expression in the format used by variable modifiers:

* No spaces are allowed within the expression, except as part of a zone/location name.
* + - * / ( ) have their usual mathematical meaning and precedence.
* ^ is exponentiation, with the highest precedence.
* Functions available: ceil(x) floor(x) sqrt(x) min(x,y) max(x,y)
* Location functions: loc(text) zone(text)
** These have a value of 1 if the current adventure location or zone contains the specified text, 0 elsewhere.
* Familiar function: fam(text)
** This has a value of 1 if the player's familiar type contains the text, else 0.
* Preferences function: pref(text)
** This must be used on preferences with a float value ONLY - merely retrieving an integer pref will corrupt it!
* There can be at most one of each text function in an expression.
* All upper-case letters are reserved for internally-used variables. The ones likely to be of use in user code are:
** D - drunkenness
** F - fullness
** G - Grimace darkness (0..5)
** L - player level
** M - total moonlight (0..9)
** S - spleenness
** X - gender (-1=male, 1=female)
* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.
 |

code1={{CodeSample|
title=Code Sample|
description=This script expands modifier_eval() to include support for user-defined variables. It is extremely complex, but it is extremely useful to anyone who wants to use modifier_eval().|
code=
<syntaxhighlight>
float eval(string expr, float[string] vars) {
buffer b;
matcher m = create_matcher( "\\b[a-z_][a-zA-Z0-9_]*\\b", expr );
while (m.find()) {
string var = m.group(0);
if (vars contains var) {
m.append_replacement(b, vars[var].to_string());
}
// could implement functions, pref access, etc. here
}
m.append_tail(b);
return modifier_eval(b.to_string());
}

# Everything below this line shows how to make use of eval().
# TESTING:

float[string] v;
v["pi"] = 3.14159265;
v["ten"] = 10;
print(eval("2+3", v));
print(eval("max(pi^ten,ten^pi)", v));
print(eval("sqrt(pi)*L", v));
print(eval("undefined/2", v));

</syntaxhighlight>}}|
special=Note that modifier_eval '''never''' generates errors - a malformed expression will just print a message, and return an arbitrary value.|
}}