Zlib - Revision history

Philmasterplus: /* String Functions */ Update equals()

2021-07-28T06:21:25Z

String Functions: Update equals()

← Older revision		Revision as of 06:21, 28 July 2021
Line 28:		Line 28:
	p2desc={{pspan\|s2}} is the string to compare with {{pspan\|s1}}.\|		p2desc={{pspan\|s2}} is the string to compare with {{pspan\|s1}}.\|
	}}		}}
	~~Since~~ string ~~comparisons in ASH using~~ == and != are case-~~insensitive~~, this function ~~allows you to strictly compare two strings, including case sensitivity~~.		Compares two strings case-sensitively.

			Note: This function was invented when string comparison operators (<code>==</code> and <code>!=</code>) were case-insensitive. As of [https://kolmafia.us/threads/16180-when-parsing-a-bounty-object-in-ash-make-case-insensitive-string-compariso.18981/ r16180], ASH strings are compared case-sensitively, which makes this function no longer necessary.

	{{HideLink\|vprint}}{{Function\|		{{HideLink\|vprint}}{{Function\|

Zarqon: added kadrop()

2018-08-31T16:19:15Z

added kadrop()

← Older revision		Revision as of 16:19, 31 August 2018
Line 121:		Line 121:
	name=list_contains\|		name=list_contains\|
	return_type=boolean\|		return_type=boolean\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|needle}}\|		parameter2={{Param\|string\|needle}}\|
	}}		}}
Line 127:		Line 127:
	name=list_contains\|		name=list_contains\|
	return_type=boolean\|		return_type=boolean\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|needle}}\|		parameter2={{Param\|string\|needle}}\|
	parameter3={{Param\|string\|glue}}\|		parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|~~list~~}} is a glue-delimited string list such as returned by join().\|		p1desc={{pspan\|stringlist}} is a glue-delimited string list such as returned by join().\|
	p2desc={{pspan\|needle}} is the entry to check for.\|		p2desc={{pspan\|needle}} is the entry to check for.\|
	p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|		p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|
Line 139:		Line 139:
	name=list_add\|		name=list_add\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|add}}\|		parameter2={{Param\|string\|add}}\|
	}}		}}
Line 145:		Line 145:
	name=list_add\|		name=list_add\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|add}}\|		parameter2={{Param\|string\|add}}\|
	parameter3={{Param\|string\|glue}}\|		parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|~~list~~}} is a glue-delimited string list such as returned by join() above.\|		p1desc={{pspan\|stringlist}} is a glue-delimited string list such as returned by join() above.\|
	p2desc={{pspan\|add}} is the entry to add to the list.\|		p2desc={{pspan\|add}} is the entry to add to the list.\|
	p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|		p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|
Line 157:		Line 157:
	name=list_remove\|		name=list_remove\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|del}}\|		parameter2={{Param\|string\|del}}\|
	}}		}}
Line 163:		Line 163:
	name=list_remove\|		name=list_remove\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|del}}\|		parameter2={{Param\|string\|del}}\|
	parameter3={{Param\|string\|glue}}\|		parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|~~list~~}} is a glue-delimited string list such as returned by join() above.\|		p1desc={{pspan\|stringlist}} is a glue-delimited string list such as returned by join() above.\|
	p2desc={{pspan\|del}} is the entry to remove from the list.\|		p2desc={{pspan\|del}} is the entry to remove from the list.\|
	p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|		p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|
Line 438:		Line 438:
	}}		}}
	Returns the brain dropped by {{pspan\|patient}} in Zombiecore. All five types of brains are properly accounted for, as well as monsters that drop no brains. Will always return $item[none] outside of Zombiecore.		Returns the brain dropped by {{pspan\|patient}} in Zombiecore. All five types of brains are properly accounted for, as well as monsters that drop no brains. Will always return $item[none] outside of Zombiecore.

			{{HideLink\|kadrop}}{{Function\|
			name=kadrop\|
			return_type=float\|
			parameter1={{Param\|monster\|m}}\|
			p1desc={{pspan\|m}} is the monster under inquiry\|
			}}
			Returns the amount of ka dropped by {{pspan\|m}} as Ed the Undying, accounting for priest servants and the crown of Ed. Will always return 0 outside of Edcore.

	{{HideLink\|is_goal}}{{Function\|		{{HideLink\|is_goal}}{{Function\|

Zarqon: Kmail message now includes items/meat gain

2017-05-14T15:54:47Z

Kmail message now includes items/meat gain

← Older revision		Revision as of 15:54, 14 May 2017
Line 583:		Line 583:
	int fromid; // sender's playerid (0 for npc's)		int fromid; // sender's playerid (0 for npc's)
	int azunixtime; // KoL server's unix timestamp		int azunixtime; // KoL server's unix timestamp
	string message; // ~~message (not~~ including items/meat)		string message; // including items/meat gained
	int[item] items; // items included in the message		int[item] items; // items included in the message
	int meat; // meat included in the message		int meat; // meat included in the message
Line 606:		Line 606:
	<syntaxhighlight>		<syntaxhighlight>
	boolean no_penpal(kmessage m) {		boolean no_penpal(kmessage m) {
	if (m.fromname == "Your Pen Pal") ~~return true;~~		return (m.fromname == "Your Pen Pal");
	~~return false~~;
	}		}
	process_kmail("no_penpal");		process_kmail("no_penpal");

Zarqon: Added getvar() and updated settings description to reflect new behavior regarding defaults

2017-05-14T10:02:31Z

Added getvar() and updated settings description to reflect new behavior regarding defaults

← Older revision		Revision as of 10:02, 14 May 2017
Line 290:		Line 290:
	name=setvar\|		name=setvar\|
	return_type=void\|		return_type=void\|
	parameter1={{Param\|string\|~~name~~}}\|		parameter1={{Param\|string\|varname}}\|
	parameter2={{Param\|mixed\|dfault}}\|		parameter2={{Param\|mixed\|dfault}}\|
	p1desc={{pspan\|name}} is the name of the setting\|		p1desc={{pspan\|name}} is the name of the setting\|
	~~p1desc~~={{pspan\|dfault}} can be any primitive or ASH type (e.g. item, effect, coinmaster, etc.), but not an array, map, or record.\|		p2desc={{pspan\|dfault}} can be any primitive or ASH type (e.g. item, effect, coinmaster, etc.), but not an array, map, or record.\|
	}}		}}
	This function ensures that a ZLib script setting called {{pspan\|name}} exists. If not, it ~~creates~~ it and ~~sets it to~~ {{pspan\|dfault}}. If the setting ~~already exists~~, it normalizes it to the ~~same~~ type as {{pspan\|dfault}}, but otherwise does nothing. Note that this function is for initializing ~~settings~~, not for editing existing settings. That is done by calling ZLib in the CLI.		This function ensures that a ZLib script setting called {{pspan\|name}} exists. If not, it adds it and the default value specified in {{pspan\|dfault}} to vars_defaults.txt. Also, if the setting has been changed from its default value, it normalizes the value according to the type of {{pspan\|dfault}}, but otherwise does nothing. Note that this function is for initializing defaults, not for editing existing settings. That is done by calling ZLib in the CLI or running a setting editor tool such as Prefref Plus.

			{{HideLink\|getvar}}{{Function\|
			name=getvar\|
			return_type=string\|
			parameter1={{Param\|string\|varname}}\|
			p1desc={{pspan\|name}} is the setting to retrieve the value of\|
			}}
			This function returns the value of the specified script setting. Authors are encouraged to use this rather than a direct vars[] lookup, since values which have not been changed from the default will eventually not be present in vars[].

	==== For Users ====		==== For Users ====

	* Script settings are now all saved in one place, separate from mafia properties. I've read more than one post wishing that script-defined settings and mafia properties would be separate. This provides a solution.		* Script settings are now all saved in one place, separate from mafia properties. I've read more than one post wishing that script-defined settings and mafia properties would be separate. This provides a solution.
	* Script settings are independent from scripts. This means that you will no longer need to edit scripts to adjust your settings. Further, when you download a script update, the script will still use your saved settings and you won't need to reset them!		* Script settings are independent from scripts. This means that you will no longer need to edit scripts to adjust your settings. Further, when you download a script update, the script will still use your saved settings and you won't need to reset them.
	* To see all of your current settings, type "zlib vars" in the CLI. You can also type "zlib <whatever>" to see a list of current settings and values containing <whatever>. To change a setting, type "zlib settingname = value". If you're adjusting threshold, you can use "up" or "down" as the value to adjust your threshold relatively. This is almost exactly as convenient as mafia ~~settings~~ (possibly more so since you don't need to open a text file to find setting names!).		* To see all of your current settings, type "zlib vars" in the CLI. You can also type "zlib <whatever>" to see a list of current settings and values containing <whatever>. To change a setting, type "zlib settingname = value". If you're adjusting threshold, you can use "up" or "down" as the value to adjust your threshold relatively. This is almost exactly as convenient as mafia properties (possibly more so since you don't need to open a text file to find setting names!).
	* If for some reason you prefer to open a text file, ZLib settings are stored in a file called vars_myname.txt in your data directory.		* If for some reason you prefer to open a text file, all ZLib setting default values are stored in vars_defaults.txt in your data directory. Your character's ZLib settings that have been changed from default are stored in a file called vars_myname.txt in your data directory.
	* Scripts that use Zlib script settings will ~~only create these~~ settings when you run them for the first time. Attempting to edit a nonexisting setting won't work, so you'll need to run a script once (then, usually, mash the ESC key before it actually does anything) before you can configure it. Script documentation should tell you which settings to change to get your desired behavior.		* Scripts that use Zlib script settings will initialize the settings -- saving their default value and type in vars_defaults.txt -- when you run them for the first time. Attempting to edit a nonexisting setting won't work, so you'll need to run a script once (then, usually, mash the ESC key before it actually does anything) before you can configure it. Script documentation should tell you which settings to change to get your desired behavior.

	==== For Script Authors ====		==== For Script Authors ====

			* Use setvar() to initialize a setting that your script will reference. To reference the setting, use getvar() and convert from string to whichever type the setting is supposed to be. Accessing vars[] or vardefaults[] directly is not recommended, as a value may exist in one but not the other, or both.
	* Script settings may now be used across scripts, in exactly the same way that mafia properties are. Basically, this works almost exactly like mafia properties, except that new settings can only be created by setvar() or manually editing the file ("zlib nonexistentsetting = value" will fail).		* Script settings may now be used across scripts, in exactly the same way that mafia properties are. Basically, this works almost exactly like mafia properties, except that new settings can only be created by setvar() or manually editing the file ("zlib nonexistentsetting = value" will fail).
	* Settings are only stored if you run a script that defines/uses them. So your settings file will not contain any extraneous unused settings.		* Settings are only stored if you run a script that defines/uses them. So your settings file will not contain any extraneous unused settings.
	* Script authors can now test for a setting's existence, which means you can check to see if a user has used a given script. It's almost as good as a script_exists() function. This can allow scripts to work together with other scripts, if they exist!		* Script authors can now test for a setting's existence in vardefaults[], which means you can check to see if a user has used a given script. It's almost as good as a script_exists() function. This can allow scripts to work together with other scripts, if they exist!
	* Scripts with overlapping or related functionality can be designed to access a single shared setting, in much the same way that my scripts have until now all shared a "threshold" mafia setting. Changing a single setting can now change the behavior of every script that accesses that setting.		* Scripts with overlapping or related functionality can be designed to access a single shared setting, in much the same way that my scripts have until now all shared a "threshold" mafia setting. Changing a single setting can now change the behavior of every script that accesses that setting.
	* Settings are intended to be set only by users, not scripts. If you want a persistent variable that a script will use, consider static variables. However, there may be cases where a script needs to edit a setting (i.e. a relay script specifically for editing settings). To alter a setting, change the map entry directly with vars["propertyToChange"] = newValue, followed by updatevars() to update the map with the new setting. If you don't use updatevars(), the change will not stick.		* Settings are intended to be set only by users, not scripts. If you want a persistent variable that a script will use, consider static variables. However, there may be cases where a script needs to edit a setting (i.e. a relay script specifically for editing settings). To alter a setting, change the map entry directly with vars["propertyToChange"] = newValue, followed by updatevars() to update the map with the new setting. If you don't use updatevars(), the change will not stick.
Line 315:		Line 324:
	==== Functional Details ====		==== Functional Details ====

	When importing ZLib, it loads a map of your script settings from vars_myname.txt. ~~It is a basic string[string] map called vars.~~ To access a script setting within an ASH script, use ~~vars[varname]. To check if a setting exists you can simply use if~~ (~~vars contains~~ varname).		When importing ZLib, it loads the setting defaults from vars_defaults.txt and a map of your script settings that have been changed from vars_myname.txt. To access a script setting within an ASH script, use getvar(varname).

	When a script calls setvar("threshold",4), ZLib checks to see if a ~~variable~~ called "threshold" already exists ~~in vars~~. If so, since dfault is an integer, it ensures that the value is an integer using normalize() (saving changes if necessary), but unless normalization changed the value, nothing else happens. If "threshold" does not exist ~~in vars~~, it ~~creates it~~, ~~sets it~~ to 4, and saves ~~the updated map~~ back to ~~vars_myname~~.txt.		When a script calls setvar("threshold",4), ZLib checks to see if a setting called "threshold" already exists. If so, since dfault is an integer, it ensures that the value is an integer using normalize() (saving changes if necessary), but unless normalization changed the value, nothing else happens. If "threshold" does not exist, it initializes its default value to 4, its type to int, and saves those defaults back to vars_defaults.txt. The setting may now be accessed by getvar() or edited using ZLib in the CLI.

	==== Choosing Setting Names ====		==== Choosing Setting Names ====
Line 339:		Line 348:
	setvar("ocw_m_default","");		setvar("ocw_m_default","");
	</syntaxhighlight>}}		</syntaxhighlight>}}
	Those settings which are specific to OCW are prefixed with "ocw_" so as to be found together in the settings file. However, some of the settings are usable across scripts, and are not so prefixed. For example, the "defaultoutfit" ~~will be~~ used by nearly all of my adventuring scripts that swap outfits, so no prefix is given.		Those settings which are specific to OCW are prefixed with "ocw_" so as to be found together in the settings file. However, some of the settings are usable across scripts, and are not so prefixed. For example, the "defaultoutfit" is used by nearly all of my adventuring scripts that swap outfits, so no prefix is given.

	== Adventuring Functions ==		== Adventuring Functions ==

Zarqon: a bit more dissuasion for scripts editing settings

2016-08-15T03:11:03Z

a bit more dissuasion for scripts editing settings

← Older revision		Revision as of 03:11, 15 August 2016
Line 311:		Line 311:
	* Script authors can now test for a setting's existence, which means you can check to see if a user has used a given script. It's almost as good as a script_exists() function. This can allow scripts to work together with other scripts, if they exist!		* Script authors can now test for a setting's existence, which means you can check to see if a user has used a given script. It's almost as good as a script_exists() function. This can allow scripts to work together with other scripts, if they exist!
	* Scripts with overlapping or related functionality can be designed to access a single shared setting, in much the same way that my scripts have until now all shared a "threshold" mafia setting. Changing a single setting can now change the behavior of every script that accesses that setting.		* Scripts with overlapping or related functionality can be designed to access a single shared setting, in much the same way that my scripts have until now all shared a "threshold" mafia setting. Changing a single setting can now change the behavior of every script that accesses that setting.
	* ~~To change~~ a setting ~~after setvar~~() ~~within ash use:~~ vars["propertyToChange"] = newValue; followed by: updatevars(); to update the map with the new setting. If you don't use updatevars(), the change will not stick.		* Settings are intended to be set only by users, not scripts. If you want a persistent variable that a script will use, consider static variables. However, there may be cases where a script needs to edit a setting (i.e. a relay script specifically for editing settings). To alter a setting, change the map entry directly with vars["propertyToChange"] = newValue, followed by updatevars() to update the map with the new setting. If you don't use updatevars(), the change will not stick.

	==== Functional Details ====		==== Functional Details ====

Zarqon: redundant "more information" section removed

2016-08-15T03:06:33Z

redundant "more information" section removed

← Older revision		Revision as of 03:06, 15 August 2016
Line 663:		Line 663:
	}}		}}
	Sends a kmail to player {{pspan\|recipient}}, returning true if the kmail is successfully sent. Handles splitting the {{pspan\|message}} into multiple messages if the number of item types in {{pspan\|goodies}} is too large. Returns the result of send_gift() if the intended {{pspan\|recipient}} is unable to receive the {{pspan\|message}} due to being in HC or somesuch. Note that you can also specify the {{pspan\|inside_note}} to be used inside gifts in that case. Use "\n" to specify a new line in the {{pspan\|message}}.		Sends a kmail to player {{pspan\|recipient}}, returning true if the kmail is successfully sent. Handles splitting the {{pspan\|message}} into multiple messages if the number of item types in {{pspan\|goodies}} is too large. Returns the result of send_gift() if the intended {{pspan\|recipient}} is unable to receive the {{pspan\|message}} due to being in HC or somesuch. Note that you can also specify the {{pspan\|inside_note}} to be used inside gifts in that case. Use "\n" to specify a new line in the {{pspan\|message}}.

	~~== More Information ==~~
	~~<p>See the thread for ZLib on the mafia forum [http://kolmafia.us/showthread.php?2072 here].</p>~~

	[[Category:Scripting]][[Category:ASH Function Libraries]]		[[Category:Scripting]][[Category:ASH Function Libraries]]

Zarqon: even here I forget parentheses

2016-08-15T02:51:42Z

even here I forget parentheses

← Older revision		Revision as of 02:51, 15 August 2016
Line 104:		Line 104:
	p1desc={{pspan\|mixvar}} is the string to normalize\|		p1desc={{pspan\|mixvar}} is the string to normalize\|
	p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|		p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|
	p3desc={{pspan\|glue}} is only relevant for lists of a type. You can specify the delimiter (which could be necessary if dealing with list entries that have commas in them. Defaults to ", ".\|		p3desc={{pspan\|glue}} is only relevant for lists of a type. You can specify the delimiter (which could be necessary if dealing with list entries that have commas in them). Defaults to ", ".\|
	}}		}}
	Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".		Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".

Zarqon: optional glue parameter added to normalized()

2016-08-15T02:48:24Z

optional glue parameter added to normalized()

← Older revision		Revision as of 02:48, 15 August 2016
Line 96:		Line 96:
	parameter1={{Param\|string\|mixvar}}\|		parameter1={{Param\|string\|mixvar}}\|
	parameter2={{Param\|string\|type}}\|		parameter2={{Param\|string\|type}}\|
			}}{{Function\|
			name=normalized\|
			return_type=string\|
			parameter1={{Param\|string\|mixvar}}\|
			parameter2={{Param\|string\|type}}\|
			parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|mixvar}} is the string to normalize\|		p1desc={{pspan\|mixvar}} is the string to normalize\|
	p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|		p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|
			p3desc={{pspan\|glue}} is only relevant for lists of a type. You can specify the delimiter (which could be necessary if dealing with list entries that have commas in them. Defaults to ", ".\|
	}}		}}
	Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".		Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".

Zarqon: formatting

2016-08-15T02:44:27Z

formatting

← Older revision		Revision as of 02:44, 15 August 2016
Line 359:		Line 359:
	This function, originally created to check whether items were allowed in the Bees Hate You path (hence the name), has been expanded to an all-purpose check to see whether something is acceptable in your current path. For example, in a Trendy path, or any of the newer paths that have similar restrictions, outdated items would not be_good. Likewise, during Bees Hate You, a familiar containing a 'b' would not be_good. In Fistcore, anything you hold in your hands is not allowed. In an Avatar of Boris run, your normal permed skills are not active. And so forth.		This function, originally created to check whether items were allowed in the Bees Hate You path (hence the name), has been expanded to an all-purpose check to see whether something is acceptable in your current path. For example, in a Trendy path, or any of the newer paths that have similar restrictions, outdated items would not be_good. Likewise, during Bees Hate You, a familiar containing a 'b' would not be_good. In Fistcore, anything you hold in your hands is not allowed. In an Avatar of Boris run, your normal permed skills are not active. And so forth.

	{{Function\|		{{HideLink\|qprop}}{{Function\|
	name=qprop\|		name=qprop\|
	return_type=boolean\|		return_type=boolean\|

Zarqon: added qprop()

2016-08-15T02:43:30Z

added qprop()

@@ Line 358: / Line 358: @@
 }}
 This function, originally created to check whether items were allowed in the Bees Hate You path (hence the name), has been expanded to an all-purpose check to see whether something is acceptable in your current path.  For example, in a Trendy path, or any of the newer paths that have similar restrictions, outdated items would not be_good.  Likewise, during Bees Hate You, a familiar containing a 'b' would not be_good.  In Fistcore, anything you hold in your hands is not allowed.  In an Avatar of Boris run, your normal permed skills are not active.  And so forth.
 {{HideLink|mall_val}}{{Function|

← Older revision		Revision as of 16:19, 31 August 2018
Line 121:		Line 121:
	name=list_contains\|		name=list_contains\|
	return_type=boolean\|		return_type=boolean\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|needle}}\|		parameter2={{Param\|string\|needle}}\|
	}}		}}
Line 127:		Line 127:
	name=list_contains\|		name=list_contains\|
	return_type=boolean\|		return_type=boolean\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|needle}}\|		parameter2={{Param\|string\|needle}}\|
	parameter3={{Param\|string\|glue}}\|		parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|~~list~~}} is a glue-delimited string list such as returned by join().\|		p1desc={{pspan\|stringlist}} is a glue-delimited string list such as returned by join().\|
	p2desc={{pspan\|needle}} is the entry to check for.\|		p2desc={{pspan\|needle}} is the entry to check for.\|
	p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|		p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|
Line 139:		Line 139:
	name=list_add\|		name=list_add\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|add}}\|		parameter2={{Param\|string\|add}}\|
	}}		}}
Line 145:		Line 145:
	name=list_add\|		name=list_add\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|add}}\|		parameter2={{Param\|string\|add}}\|
	parameter3={{Param\|string\|glue}}\|		parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|~~list~~}} is a glue-delimited string list such as returned by join() above.\|		p1desc={{pspan\|stringlist}} is a glue-delimited string list such as returned by join() above.\|
	p2desc={{pspan\|add}} is the entry to add to the list.\|		p2desc={{pspan\|add}} is the entry to add to the list.\|
	p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|		p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|
Line 157:		Line 157:
	name=list_remove\|		name=list_remove\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|del}}\|		parameter2={{Param\|string\|del}}\|
	}}		}}
Line 163:		Line 163:
	name=list_remove\|		name=list_remove\|
	return_type=string\|		return_type=string\|
	parameter1={{Param\|string\|~~list~~}}\|		parameter1={{Param\|string\|stringlist}}\|
	parameter2={{Param\|string\|del}}\|		parameter2={{Param\|string\|del}}\|
	parameter3={{Param\|string\|glue}}\|		parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|~~list~~}} is a glue-delimited string list such as returned by join() above.\|		p1desc={{pspan\|stringlist}} is a glue-delimited string list such as returned by join() above.\|
	p2desc={{pspan\|del}} is the entry to remove from the list.\|		p2desc={{pspan\|del}} is the entry to remove from the list.\|
	p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|		p3desc={{pspan\|glue}} is optional (defaults to ", ") and represents the delimiter for the list.\|
Line 438:		Line 438:
	}}		}}
	Returns the brain dropped by {{pspan\|patient}} in Zombiecore. All five types of brains are properly accounted for, as well as monsters that drop no brains. Will always return $item[none] outside of Zombiecore.		Returns the brain dropped by {{pspan\|patient}} in Zombiecore. All five types of brains are properly accounted for, as well as monsters that drop no brains. Will always return $item[none] outside of Zombiecore.

			{{HideLink\|kadrop}}{{Function\|
			name=kadrop\|
			return_type=float\|
			parameter1={{Param\|monster\|m}}\|
			p1desc={{pspan\|m}} is the monster under inquiry\|
			}}
			Returns the amount of ka dropped by {{pspan\|m}} as Ed the Undying, accounting for priest servants and the crown of Ed. Will always return 0 outside of Edcore.

	{{HideLink\|is_goal}}{{Function\|		{{HideLink\|is_goal}}{{Function\|

← Older revision		Revision as of 02:51, 15 August 2016
Line 104:		Line 104:
	p1desc={{pspan\|mixvar}} is the string to normalize\|		p1desc={{pspan\|mixvar}} is the string to normalize\|
	p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|		p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|
	p3desc={{pspan\|glue}} is only relevant for lists of a type. You can specify the delimiter (which could be necessary if dealing with list entries that have commas in them. Defaults to ", ".\|		p3desc={{pspan\|glue}} is only relevant for lists of a type. You can specify the delimiter (which could be necessary if dealing with list entries that have commas in them). Defaults to ", ".\|
	}}		}}
	Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".		Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".

← Older revision		Revision as of 02:48, 15 August 2016
Line 96:		Line 96:
	parameter1={{Param\|string\|mixvar}}\|		parameter1={{Param\|string\|mixvar}}\|
	parameter2={{Param\|string\|type}}\|		parameter2={{Param\|string\|type}}\|
			}}{{Function\|
			name=normalized\|
			return_type=string\|
			parameter1={{Param\|string\|mixvar}}\|
			parameter2={{Param\|string\|type}}\|
			parameter3={{Param\|string\|glue}}\|
	p1desc={{pspan\|mixvar}} is the string to normalize\|		p1desc={{pspan\|mixvar}} is the string to normalize\|
	p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|		p2desc={{pspan\|type}} is the datatype to normalize to, which can be any primitive type or any typed constant. You can also specify "list of <type>", for a comma-delimited list of the given type.\|
			p3desc={{pspan\|glue}} is only relevant for lists of a type. You can specify the delimiter (which could be necessary if dealing with list entries that have commas in them. Defaults to ", ".\|
	}}		}}
	Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".		Returns {{pspan\|mixvar}}, normalized to the specified KoLmafia {{pspan\|type}}. For example, normalized("badger", "familiar") would return "Astral Badger". It can also normalize comma-delimited lists of any of these types if you specify "list of <type>" for {{pspan\|type}}. For example, normalized("bloop, dair go, possess", "list of monster") would return "Blooper, Dairy Goat, Possessed Silverware Drawer".