Remove property - Revision history

Philmasterplus at 11:17, 23 December 2020

2020-12-23T11:17:37Z

← Older revision		Revision as of 11:17, 23 December 2020
Line 1:		Line 1:
	{{		<onlyinclude>{{{{{format\|Function2}}}
	~~#vardefine:~~name\|remove_property~~}}{{~~		\|name=remove_property
	~~#vardefine:~~return_type\|string~~}}{{~~		\|function1.return_type=string
			\|function1.description=Removes or resets a property and returns its previous value.
			\|function1.param1=prop
			\|function1.param1.type=string
			\|function1.param1.description=Property name
			\|function1.param2=global
			\|function1.param2.type=boolean
			\|function1.param2.optional=yes
			\|function1.param2.description=If <code>true</code>, removes a global property. If <code>false</code>, removes a user property. If omitted, this checks both user and global properties.
			\|description=<p>If the property has a default value, it will be reset to its default value instead.</p>

	~~FunctionPage\|~~		<p>This function was added in [https://kolmafia.us/threads/17892-add-a-bunch-of-ash-support-for-doing-interesting-things-with-properties-bool.21586/ r17892].</p>
	~~name={{#var~~:~~name}}\|~~		\|code1={{CodeSample
			\|title=Code Samples
	~~function1={{Function~~\|		\|description=Remove a property named <code>myPref</code> and print its previous value.
	~~name~~={{~~#var:name}}\|~~		\|code=
	~~aggregate={{#var:aggregate}}~~\|		<syntaxhighlight lang="d">
	~~return_type~~=~~{{#var:return_type}}\|~~		print( "Removed myPref, old value was " + remove_property( "myPref" ) );
	~~return_also={{#var:return_also}}~~\|		</syntaxhighlight>
	~~parameter1~~=~~{{Param\|string\|prop}}\|~~		\|moreinfo=
	~~p1desc={{Pspan\|prop}} is the~~ property ~~to remove~~.\|
	}}\|

	~~function2={{Function\|~~
	~~name~~=~~{{#var:name}}\|~~
	~~aggregate~~=~~{{#var:aggregate}}\|~~
	~~return_type={{#var:return_type}}\|~~
	~~return_also={{#var:return_also}}\|~~
	~~parameter1={{Param\|string\|prop}}\|~~
	~~parameter2={{Param\|boolean\|global}}\|~~
	~~p1desc={{Pspan\|prop}} is the property to remove.\|~~
	~~p2desc={{Pspan\|global}} if true~~, ~~look for the property specifically in the global map. If false or not included will look at the user map.\|~~
	~~}}\|~~

	~~function_description=If {{Pspan~~\|~~prop}} is a built-in property, resets to default. Otherwise, removes from the user map, or global if {{Pspan\|global}} is true.~~

	~~The return value is the value the property had prior to being reset.\|~~

	~~see_also~~=~~{{SeeAlso\|Miscellaneous_Functions#Property_Functions}}\|~~
	}}		}}
			\|see_also={{SeeAlso/Property Functions}}
			\|cli_equiv=
			\|more_info=
			\|special=
			\|{{{1\|}}}
			}}</onlyinclude>
	[[Category:Miscellaneous Functions]]		[[Category:Miscellaneous Functions]]

Fredg1: return value

2020-08-20T00:25:22Z

return value

← Older revision		Revision as of 00:25, 20 August 2020
Line 1:		Line 1:
	{{		{{
	#vardefine:name\|remove_property}}{{		#vardefine:name\|remove_property}}{{
	#vardefine:return_type\|~~void~~}}{{		#vardefine:return_type\|string}}{{

	FunctionPage\|		FunctionPage\|
Line 26:		Line 26:
	}}\|		}}\|

	function_description=If {{Pspan\|prop}} is a built-in property, resets to default. Otherwise, removes from the user map, or global if {{Pspan\|global}} is true.\|		function_description=If {{Pspan\|prop}} is a built-in property, resets to default. Otherwise, removes from the user map, or global if {{Pspan\|global}} is true.

			The return value is the value the property had prior to being reset.\|

	see_also={{SeeAlso\|Miscellaneous_Functions#Property_Functions}}\|		see_also={{SeeAlso\|Miscellaneous_Functions#Property_Functions}}\|

Smelltastic: Created page with "{{ #vardefine:name|remove_property}}{{ #vardefine:return_type|void}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate..."

2017-03-21T00:03:42Z

Created page with "{{ #vardefine:name|remove_property}}{{ #vardefine:return_type|void}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate..."

New page

{{
#vardefine:name|remove_property}}{{
#vardefine:return_type|void}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|prop}}|
p1desc={{Pspan|prop}} is the property to remove.|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|prop}}|
parameter2={{Param|boolean|global}}|
p1desc={{Pspan|prop}} is the property to remove.|
p2desc={{Pspan|global}} if true, look for the property specifically in the global map. If false or not included will look at the user map.|
}}|

function_description=If {{Pspan|prop}} is a built-in property, resets to default. Otherwise, removes from the user map, or global if {{Pspan|global}} is true.|

see_also={{SeeAlso|Miscellaneous_Functions#Property_Functions}}|
}}

[[Category:Miscellaneous Functions]]