Kolmafia - User contributions [en]

Your Character

2022-10-02T19:39:31Z

QuietMisdreavus: /* Sign & Path */

{{TOCright}}
==Viewable Info==
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
{{flink|string|my_id|desc=Returns your character ID.}}
{{flink|int|get_clan_id|desc=Returns the ID number of the character's current clan.}}
{{flink|string|get_clan_name|desc=Returns the name of the character's current clan.}}
{{Flink|int|my_ascensions|desc=Returns the number of times your character has ascended.}}
{{flink|class|my_class|desc=Returns your class.}}
{{flink|int|my_level|desc=Returns your level.}}
{{flink|int|my_adventures|desc=Returns the number of adventures you have remaining.}}
{{flink|int|total_turns_played|desc=Returns total turns played since the character was created.}}
{{flink|int|turns_played}}
{{flink|int|my_turncount|desc=Both functions return the number of adventures used this ascension.}}
{{flink|int|my_daycount|desc=Return the number of days used this ascension.}}
{{flink|stat|my_primestat|desc=Returns the main stat of your current class.}}
{{flink|int|my_basestat|stat|desc=Returns your base value in the given stat (or substat).}}
{{flink|int|my_buffedstat|stat|desc=Returns your buffed value in the given stat (or substat).}}
{{flink|boolean|hippy_stone_broken|desc=Reports if your Hippy Stone is currently broken.}}
{{flink|int|pvp_attacks_left|desc=Returns number of PvP attacks remaining.}}
{{flink|int|total_free_rests|desc=Returns the total number of free rests available to your character.}}
{{flink|int [item]|get_campground|desc=Returns a map of your campground items as integers, keyed by item names.}}
{{flink|item|get_dwelling|desc=Returns the item corresponding with your dwelling (the item used to get the dwelling).}}
{{flink|thrall|my_thrall|desc=Returns your current pasta thrall.}}

==Resources==
{{flink|int|my_hp|desc=Returns your current HP.}}
{{flink|int|my_mp|desc=Returns your current MP.}}
{{flink|int|my_maxhp|desc=Returns your current maximum HP.}}
{{flink|int|my_maxmp|desc=Returns your current maximum MP.}}
{{flink|int|my_soulsauce|desc=Returns your current Soulsauce.}}
{{flink|int|my_audience|desc=Returns your current Audience.}}
{{flink|int|my_thunder|desc=Returns your current Thunder.}}
{{flink|int|my_rain|desc=Returns your current Rain.}}
{{flink|int|my_lightning|desc=Returns your current Lightning.}}

==Familiars and Substitutes==
{{flink|familiar|my_familiar|desc=Returns your current familiar.}}
{{flink|int|familiar_weight|familiar|desc=Returns the base weight of the specified familiar.}}
{{flink|boolean|is_familiar_equipment_locked|desc=Returns lock status of familiar equipment.}}
{{flink|void|lock_familiar_equipment|boolean|desc=Locks or Unlocks familiar equipment.}}
{{flink|int|minstrel_level|desc=Reports Clancy's level.}}
{{flink|item|minstrel_instrument|desc=Reports Clancy's equipped item.}}
{{flink|boolean|minstrel_quest|desc=Reports if Clancy has a new quest for you.}}
{{flink|string|my_companion|desc=Returns your current companion.}}

==Hidden Info==
{{flink|string|my_hash|desc=Returns the password hash for your current session.}}
{{flink|stat|current_hit_stat|desc=Returns the stat currently used to calculate to-hit percentage.}}
{{flink|int|buffed_hit_stat|desc=Returns the buffed value of your currently used to-hit stat.}}
{{flink|int|raw_damage_absorption|desc=Returns your current DA total.}}
{{flink|float|damage_absorption_percent|desc=Returns the percentage of damage mitigated by your DA.}}
{{flink|int|damage_reduction|desc=Returns the amount of damage reduction your character currently has.}}
{{flink|float|elemental_resistance|element|desc=Returns the percentage of damage reduction to the given element based on your current resistance to that element.}}
{{flink|float|combat_rate_modifier|desc=Returns the percentage adjustment to your combat rate.}}
{{flink|float|initiative_modifier|desc=Returns the percentage adjustment to your chance of gaining initiative.}}
{{flink|float|experience_bonus|desc=Returns the amount of bonus experience your receive after combat.}}
{{flink|float|meat_drop_modifier|desc=Returns the percentage adjustment to meat drops after combat.}}
{{flink|float|item_drop_modifier|desc=Returns the percentage adjustment to item drops after combat.}}
{{flink|int|monster_level_adjustment|desc=Returns the total +ML you have active, including your sign-specific device.}}
{{flink|stat|stat_bonus_today}}
{{flink|stat|stat_bonus_tomorrow|desc=These two functions report on what stat has a stat-day bonus or $stat[none] if it isn't a stat day.}}
{{flink|int|current_mcd|desc=Returns the current setting of your sign-specific +ML device.}}
{{flink|int|weight_adjustment|desc=Returns the cumulative total of all familiar weight adjustments from all sources.}}
{{flink|boolean|get_ignore_zone_warnings|desc=Returns the value of the KoL option to disable "This area might be too tough for you" warnings.}}
{{flink|string [location] [int]|get_florist_plants|desc=Returns the a map of all plants currently planted in every location.}}

==Sign & Path==
{{flink|boolean|can_eat|desc=Reports on whether your characters path allows food consumption.}}
{{flink|boolean|can_drink|desc=Reports on whether your characters path allows booze consumption}}
{{flink|boolean|can_interact|desc=Reports on whether your character can access the mall, gift packages, etc.}}
{{flink|boolean|in_hardcore|desc=Reports on whether your character is under Hardcore restrictions.}}
{{flink|item|daily_special|desc=Returns the daily special at your sign eatery.}}
{{flink|boolean|in_moxie_sign}}
{{flink|boolean|in_muscle_sign}}
{{flink|boolean|in_mysticality_sign}}
{{flink|boolean|in_bad_moon|desc=These four functions report on the stat gains granted by your character's ascension moon sign.}}
{{flink|path|my_path|desc=The ascension path your character chose.}}
{{flink|int|my_path_id|desc=The number of the ascension path your character chose.}}
{{flink|string|my_sign|desc=The moon sign your character ascended under.}}

==Consumption==
{{flink|int|my_fullness|desc=Returns how full you are.}}
{{flink|int|fullness_limit|desc=Returns your maximum fullness.}}
{{flink|int|my_inebriety|desc=Returns your current drunkenness.}}
{{flink|int|inebriety_limit|desc=Returns your maximum safe drunk (before overdrinking).}}
{{flink|int|my_spleen_use|desc=Returns your current spleen use.}}
{{flink|int|spleen_limit|desc=Returns your spleen limit.}}

==Location Availability==
{{flink|boolean|black_market_available|desc=Returns the availability of the Black Market.}}
{{flink|boolean|canadia_available|desc=Returns the availability of Little Canadia.}}
{{flink|boolean|dispensary_available|desc=Returns the availability of the Knob Dispensary.}}
{{flink|boolean|florist_available|desc=Returns the availability of The Florist Friar's Cottage.}}
{{flink|boolean|gnomads_available|desc=Returns the availability of the Gnomish Gnomad Camp.}}
{{flink|boolean|guild_store_available|desc=Returns the availability of your guild store.}}
{{flink|boolean|hidden_temple_unlocked|desc=Returns the availability of the Hidden Temple.}}
{{flink|boolean|hippy_store_available|desc=Returns the availability of the Hippy Store.}}
{{flink|boolean|knoll_available|desc=Returns the availability of the Degrassi Knoll.}}
{{flink|boolean|white_citadel_available|desc=Returns the availability of White Citadel.}}

==Misc.==
{{Flink|string|eudora|desc=Returns your current Eudora correspondent.}}
{{Flink|boolean|galaktik_cures_discounted|desc=Returns whether Doc's offers you a discount for quest completion.}}
{{Flink|int|is_unrestricted|desc=Checks whether a given game resource is available.}}
{{Flink|int|moon_light|desc=Returns the total lit moon segments.}}
{{Flink|int|moon_phase|desc=Returns the phase (0-15) of the main moons.}}

[[Category:Scripting]]

Proxy Records

2022-10-02T19:33:52Z

QuietMisdreavus:

Proxy records are special records associated with the special [[Data Types|data types]] available to scripters. These records are always available for the special datatypes. The fields in a proxy record are referenced in the same manner as a [[Data_Structures#Records|record]].

==Special Datatypes==

===bounty===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| plural
| string
| ""
|
|-
| type
| string
| ""
|
|-
| kol_internal_type
| string
| ""
|
|-
| number
| int
| 0
|
|-
| image
| string
| ""
|
|-
| monster
| monster
| none
|
|-
| location
| location
| none
|
|}

===class===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| primestat
| stat
| Muscle
|
|}

===coinmaster===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| token
| string
| ""
|
|-
| item
| item
| none
|
|-
| property
| string
| ""
|
|-
| available_tokens
| int
| 0
|
|-
| buys
| boolean
| false
|
|-
| sells
| boolean
| false
|
|}

===effect===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| default
| string
| ""
|
|-
| note
| string
| ""
|
|-
| all
| aggregate
boolean [string] =>
|
|-
| image
| string
| "/images/debug.gif"
|
|-
| descid
| string
| ""
|
|}

===element===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| image
| string
| "circle.gif"
|
|}

===familiar===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| hatchling
| item
| none
|
|-
| image
| string
| "debug.gif"
|
|-
| name
| string
| ""
|
|-
| experience
| int
| 0
|
|-
| charges
| int
| 0
|
|-
| drop_name
| string
| ""
|
|-
| drop_item
| item
| none
|
|-
| drops_today
| int
| 0
|
|-
| drops_limit
| int
| 0
|
|-
| combat
| boolean
| false
|
|-
| physical_damage
| boolean
| false
|
|-
| elemental_damage
| boolean
| false
|
|-
| block
| boolean
| false
|
|-
| delevel
| boolean
| false
|
|-
| hp_during_combat
| boolean
| false
|
|-
| mp_during_combat
| boolean
| false
|
|-
| other_action_during_combat
| boolean
| false
|
|-
| hp_after_combat
| boolean
| false
|
|-
| mp_after_combat
| boolean
| false
|
|-
| other_action_after_combat
| boolean
| false
|
|-
| passive
| boolean
| false
|
|-
| variable
| boolean
| false
|
|}

===item===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| plural
| string
| ""
|
|-
| descid
| string
| ""
|
|-
| image
| string
| ""
|
|-
| smallimage
| string
| ""
|
|-
| levelreq
| int
| 0
|
|-
| quality
| string
| ""
|
|-
| adventures
| string
| ""
|
|-
| muscle
| string
| ""
|
|-
| mysticality
| string
| ""
|
|-
| moxie
| string
| ""
|
|-
| fullness
| int
| 0
|
|-
| inebriety
| int
| 0
|
|-
| spleen
| int
| 0
|
|-
| minhp
| int
| 0
|
|-
| maxhp
| int
| 0
|
|-
| minmp
| int
| 0
|
|-
| maxmp
| int
| 0
|
|-
| dailyusesleft
| int
| 0
|
|-
| notes
| string
| ""
|
|-
| quest
| boolean
| false
|
|-
| gift
| boolean
| false
|
|-
| tradeable
| boolean
| false
|
|-
| discardable
| boolean
| false
|
|-
| combat
| boolean
| false
|
|-
| combat_reusable
| boolean
| false
|
|-
| usable
| boolean
| false
|
|-
| reusable
| boolean
| false
|
|-
| multi
| boolean
| false
|
|-
| fancy
| boolean
| false
|
|-
| candy
| boolean
| false
|
|-
| seller
| coinmaster
| none
|
|-
| buyer
| coinmaster
| none
|
|-
| name_length
| int
| 0
|
|}

===location===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| nocombats
| boolean
| false
|
|-
| combat_percent
| float
| 0.0
|
|-
| zone
| string
| ""
|
|-
| parent
| string
| ""
|
|-
| parentdesc
| string
| ""
|
|-
| environment
| string
| ""
|
|-
| fire_level
| int
| 0
|
|-
| bounty
| bounty
| none
|
|-
| combat_queue
| string
| ""
|
|-
| noncombat_queue
| string
| ""
|
|-
| turns_spent
| int
| 0
|
|-
| kisses
| int
| 0
|
|-
| recommended_stat
| int
| 0
|
|-
| water_level
| int
| 0
|
|-
| wanderers
| boolean
| false
|
|}

===monster===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| base_hp
| int
| 0
| {{f|monster_hp}} (includes modifiers)
|-
| base_attack
| int
| 0
| {{f|monster_attack}} (includes modifiers)
|-
| base_defense
| int
| 0
| {{f|monster_defense}} (includes modifiers)
|-
| raw_hp
| int
| 0
| (excludes modifiers)
|-
| raw_attack
| int
| 0
| (excludes modifiers)
|-
| raw_defense
| int
| 0
| (excludes modifiers)
|-
| base_initiative
| int
| 0
| {{f|monster_initiative}} (includes modifiers)
|-
| raw_initiative
| int
| 0
| (excludes modifiers)
|-
| element attack_element
| element
| none
|
|-
| element defense_element
| element
| none
| {{f|monster_element}}
|-
| physical_resistance
| int
| 0
|
|-
| min_meat
| int
| 0
| (excludes modifiers)
|-
| max_meat
| int
| 0
| (excludes modifiers)
|-
| base_mainstat_exp
| float
| 0.0
| (includes bonus stats from +ML, but not from +stat effects)
|-
| phylum
| phylum
| none
| {{f|monster_phylum}}
|-
| poison
| effect
| none
|
|-
| boss
| boolean
| false
|
|-
| dummy
| boolean
| false
|
|-
| image
| string
| ""
|
|-
| images
| aggregate boolean [string]
|
|
|-
| attributes
| string
| ""
| A compilation of attack, defense, initiative, element, meat drop, and phylum
|-
| random_modifiers
| aggregate boolean [string]
|
| The monster's random modifiers - like those generated in the One Crazy Random Summer path
|-
| manuel_name
| string
| ""
|
|}

===path===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| name
| string
| ""
|
|-
| avatar
| boolean
| false
| Whether this path overrides the character's class
|-
| image
| string
| "blank.gif"
|
|-
| points
| int
| 0
| The number of path points the current character has accumulated, if available
|-
| familiars
| boolean
| true
| Whether the path allows familiars
|}

===phylum===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| image
| string
| none
|
|}

===servant===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| name
| string
| ""
|
|-
| level
| int
| 0
|
|-
| experience
| int
| 0
|
|-
| image
| string
| ""
|
|-
| level1_ability
| string
| ""
|
|-
| level7_ability
| string
| ""
|
|-
| level14_ability
| string
| ""
|
|-
| level21_ability
| string
| ""
|
|}

===skill===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| level
| int
| -1
|
|-
| image
| string
| none
|
|-
| traincost
| int
| 0
|
|-
| class
| class
| none
|
|-
| libram
| boolean
| false
|
|-
| passive
| boolean
| false
|
|-
| buff
| boolean
| false
|
|-
| combat
| boolean
| false
|
|-
| song
| boolean
| false
| Avatar of Boris song
|-
| expression
| boolean
| false
|
|-
| summon
| boolean
| false
|
|-
| permable
| boolean
| true
|
|-
| dailylimit
| int
| -1
|
|-
| timescast
| int
| 0
|
|}

=== slot ===
Slot does not have any fields.

===stat===
Stat does not have any fields.

===thrall===
{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| name
| string
| ""
|
|-
| level
| int
| 0
|
|-
| image
| string
| ""
|
|-
| tinyimage
| string
| ""
|
|-
| skill
| skill
| none
|
|-
| current_modifiers
| string
| ""
|
|}

Category:Deprecated Functions

2022-10-02T19:32:32Z

QuietMisdreavus: Created blank page

Data Types

2022-10-02T19:31:48Z

QuietMisdreavus: /* path */

{{TOCright}}
==Primitive Datatypes==

===void===
Can be thought of better as the absence of a datatype. No value can be assigned to '''void''' nor can a value be returned from a function of datatype '''void'''.

===boolean===
A boolean value is either '''true''' or '''false'''. By default, a boolean variable is set to false.

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 32-bit signed int, meaning it has a maximum value of 2,147,483,647 and a minimum value of -2,147,483,648. The default value of a integer variable is 0.

Be careful when doing math with integers! As with some other strongly-typed languages, numbers are converted to integers at every step of the operation when only integer types are used. For example:
{{
CodeSample|
code=
<syntaxhighlight>
int a = 1;
int b = 2;
print( a / b * 2 );
</syntaxhighlight>}}
Will give the output "0," not "1" as you may expect. Changing either variable to a float type will "correct" this.

===float===

The float data type is a single-precision 32-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].

When assigning to a variable of type float, one should be careful to always enter numbers in decimal form, as unwanted behavior can result from supplying a value that KoLmafia may interpret as an int type without the decimal point.

Note that float is not infinitely precise; it intrinsically rounds off after a certain point. This loss of accuracy is for the sake of storage, but beware of the possibility of small errors compounding from multiple float types.
{{
CodeSample|
description=For instance, try the following code as an example of how rather long post-decimal portions are handled:|
code=
<syntaxhighlight>
float f;
f = 4.9999999;
print( f );
</syntaxhighlight>}}
The default value of a <code>float</code> variable is 0.0.

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight>
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre>
}}

The default value of a string is an empty string, or literally <code>""</code>

When using backticks, you can concatenate expressions into your string using curly braces.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight>
}}

===buffer===

Similar to a string, but more efficient in certain operations, including concatenation and passing as function arguments. For the most part, you can interchange references to strings and buffers. However, you should test all such actions first, as a few functions require a specific datatype to be supplied as a parameter. (Most notably, those listed under [[String Handling Routines#Regular Expressions|Regular Expressions]].)

==Special Datatypes==

Several datatypes are included in KoLmafia to represent common categories within the KoL universe.

Note that while variables of these types are declared in the same way as for Primitive Datatypes; assigning and referencing them is done differently.
{{CodeSample|
description=For example, to declare an item datatype and assign it a value, you would use the following line of code:|
code=
<syntaxhighlight>
item it = $item[ broken skull ];
</syntaxhighlight>}}
The default values of any variable of one of the following types is <code>$''type''[ none ]</code>. For example, the default value of a <code>item</code> variable is <code>$item[ none ]</code>.

===bounty===

([[Bounty#Related Functions|Related Functions]]) ([[Bounty#Proxy Record Fields|Proxy Record Fields]])

These are the non-items that the bounty hunter asks you to retrieve from monsters around the kingdom. There are quite a lot of them (42 in total) so I won't list them all here. You can find more about bounties at the {{kolwiki|The Bounty Hunter Hunter's Shack}}.

===class===

([[Class#Related Functions|Related Functions]]) ([[Class#Proxy Record Fields|Proxy Record Fields]])

Besides $class[ none ], there are six possible values for this datatype:

* Seal Clubber
* Turtle Tamer
* Pastamancer
* Sauceror
* Disco Bandit
* Accordion Thief

===coinmaster===

([[Coinmaster#Related Functions|Related Functions]]) ([[Coinmaster#Proxy Record Fields|Proxy Record Fields]])

All shops that deal with currency other than meat. Known values include:

* {{kolwiki|The Bounty Hunter Hunter's Shack|Bounty Hunter Hunter}}
* {{kolwiki|Mr. Store}}
* {{kolwiki|Hermit}}
* {{kolwiki|The Shore, Inc. Gift Shop}}
* {{kolwiki|The Trapper's Cabin|The Trapper}}
* {{kolwiki|A Vending Machine|Vending Machine}}
* {{kolwiki|The Swagger Shop}}
* {{kolwiki|The Hippy Camp (Wartime)|Dimemaster}}
* {{kolwiki|The Orcish Frat House|Quartersmaster}}
* {{kolwiki|BURT|Bugbear Token}}
* {{kolwiki|Freshwater Fishbonery}}
* {{kolwiki|Big Brother}}
* {{kolwiki|The Terrified Eagle Inn}}
* {{kolwiki|Ticket Redemption Counter|Arcade Ticket Counter}}
* {{kolwiki|Cashier|Game Shoppe}}
* {{kolwiki|Cashier|Game Shoppe Snacks}}
* {{kolwiki|The Isotope Smithery|Isotope Smithery}}
* {{kolwiki|Dollhawker's Emporium}}
* {{kolwiki|The Lunar Lunch-o-Mat|Lunar Lunch-o-Mat}}
* {{kolwiki|Paul's Boutique}}
* {{kolwiki|The Frozen Brogurt Stand}}
* {{kolwiki|Buff Jimmy's Souvenir Shop}}
* {{kolwiki|Taco Dan's Taco Stand}}
* {{kolwiki|You're the Fudge Wizard Now, Dog|Fudge Wand}}
* {{kolwiki|The Neandermall}}
* {{kolwiki|Legitimate Shoe Repair, Inc.}}
* {{kolwiki|warbear black box|Warbear Black Box}}
* {{kolwiki|The Dinsey Company Store}}
* {{kolwiki|Internet Meme Shop}}

===effect===

([[Effect#Related Functions|Related Functions]]) ([[Effect#Proxy Record Fields|Proxy Record Fields]])

Any effect you can be under in KoL, whether from items, skills, or what-have-you, is valid for this datatype.

The full range, besides $effect[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Effects}} page for more information.

===element===

([[Element#Related Functions|Related Functions]]) ([[Element#Proxy Record Fields|Proxy Record Fields]])

Besides $element[ none ], there are seven possible values for this datatype. (Note that "Bad Spelling" is not considered a true element.)
Also note that these names are case-sensitive (referencing $element[ Spooky ] will generate an error).

* cold
* hot
* sleaze
* spooky
* stench
* slime
* supercold

===familiar===

([[Familiar#Related Functions|Related Functions]]) ([[Familiar#Proxy Record Fields|Proxy Record Fields]])

Any familiar available in KoL is valid for this datatype.

The full range, besides $familiar[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Familiars}} page for more information.

===item===

([[Item#Related Functions|Related Functions]]) ([[Item#Proxy Record Fields|Proxy Record Fields]])

Any item in all of KoL is valid for this datatype. Note that unlike most special datatypes, item references can make use of the item ID number.
{{CodeSample|
description=For example, you could assign the item plexiglass pants as follows:|
code=
<syntaxhighlight>
item it = $item[ 1234 ];
</syntaxhighlight>}}
The full range, besides $item[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Items}} page for more information.

===location===

([[Location#Related Functions|Related Functions]]) ([[Location#Proxy Record Fields|Proxy Record Fields]])

Any location one can adventure at in KoL is valid for this datatype.

The full range, besides $location[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Locations}} page for more information.

===monster===

([[Monster#Related Functions|Related Functions]]) ([[Monster#Proxy Record Fields|Proxy Record Fields]])

Any monster you can encounter in KoL is valid for this datatype.

The full range, besides $monster[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Monster Compendium}} page for more information.

===path===

([[Path#Related Functions|Related Functions]]) ([[Path#Proxy Record Fields|Proxy Record Fields]])

Any ascension path you can choose in Valhalla is valid for this datatype. This includes all {{kolwiki|special challenge paths}}, as well as Standard and the dietary restriction paths (Boozetafarian, Teetotaler, Oxygenarian). The "Unrestricted" path and aftercore are represented as $path[ none ].

The full range, besides $path[ none ], is too much to list and keep up with here. See {{kolwiki|Ascension#Paths}} for more information.

===phylum===

([[Phylum#Related Functions|Related Functions]]) ([[Phylum#Proxy Record Fields|Proxy Record Fields]])

Each monster has a {{kolwiki|Phylum}}. Besides $phylum[none], the possible values for this datatype are:

* beast
* bug
* constellation
* construct
* demon
* dude
* elemental
* elf
* fish
* goblin
* hippy
* hobo
* humanoid
* horror
* mer-kin
* orc
* penguin
* pirate
* plant
* slime
* undead
* weird

===servant===

([[Servant#Related Functions|Related Functions]]) ([[Servant#Proxy Record Fields|Proxy Record Fields]])

Servants are unique to the {{kolwiki|Actually Ed the Undying}} path and located {{kolwiki|The Servants' Quarters}}, replacing familiars.

* Assassin
* Belly-Dancer
* Bodyguard
* Cat
* Maid
* Priest
* Scribe

===skill===

([[Skill#Related Functions|Related Functions]]) ([[Skill#Proxy Record Fields|Proxy Record Fields]])

Any skill you can have in KoL, whether permable or not, granted by items, ''etc''., is valid for this datatype.

The full range, besides $skill[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Skills}} page for more information.

===slot===

([[Slot#Related Functions|Related Functions]]) (slot has no proxy record fields)

Besides $slot[ none ], there are 16 possible values for this datatype.

* hat
* back
* weapon
* off-hand
* shirt
* pants
* acc1
* acc2
* acc3
* familiar
* sticker1
* sticker2
* sticker3
* fakehand
* bootspur
* bootskin

===stat===

([[Stat#Related Functions|Related Functions]]) (stat has no proxy record fields)

Besides $stat[ none ], there are six possible values for this datatype (the last three are for referencing sub-stats).

* muscle
* mysticality
* moxie
* submuscle
* submysticality
* submoxie

===thrall===

([[Thrall#Related Functions|Related Functions]]) ([[Thrall#Proxy Record Fields|Proxy Record Fields]])

Pastamancers have the ability to summon {{kolwiki|Pasta Thralls}}.

* Angel Hair Wisp
* Elbow Macaroni
* Lasagmbie
* Penne Dreadful
* Spaghetti Elemental
* Spice Ghost
* Vampieroghi
* Vermincelli

==aggregate==

An aggregate is a complex datatype composed of two or more primitive or special datatypes. For more information, see [[Data Structures]].

==record==

Records are user-defined datatypes that hold as many sub-datatypes as desired. For more information, see the page for [[Data Structures]].

==Plural Typed Constants==

(see http://kolmafia.us/showthread.php?p=15592, from which this section is reproduced)

Plural typed constants allow you to easily do something with a list of specified objects, without having to replicate code or laboriously build up an array of the objects so that you can iterate over it. Here's a quick example:
{{CodeSample|code=<syntaxhighlight>
foreach weapon in $items[star sword, star staff, star crossbow] {
if (available_amount(weapon) > 0) {
equip(weapon);
break;
}
}</syntaxhighlight>}}
The syntax is basically the same as the existing typed constant feature, but with an "s" or "es" after the type name. (The "es" case is there so that you can properly pluralize "class".) The text between the square brackets is interpreted as a comma-separated list of elements, each of which is converted to the specified type as if it were an individual constant. More details:
* The list can span multiple lines.
* Whitespace before or after elements is ignored.
* Completely empty elements are ignored (so that you can leave a comma at the end of the list).
* You can include a comma or closing square bracket in an element by writing it as "\," or "\]".
* All the other escape sequences allowed in strings are possible, such as "\n" (newline), "\t" (tab), and "\uXXXX" (Unicode character value). To put an actual backslash in an element, you have to write it as "\\".

The value generated by a plural constant is of type boolean[type], with the keys being the specified elements, and the boolean value always being true - although you won't normally do anything with the boolean, you'd use a foreach loop to iterate over the keys. You can assign a plural constant to a variable declared as that type, but note that the value differs from a normal map in three important respects:
* Since the expression that generates it is syntactically a constant, the value has to be immutable. If you were allowed to change it in any way, those changes would appear in every future use of the same constant.
* There can be multiple instances of the same key - $ints[1,1,2,3,5,8] is perfectly valid, and will result in the value 1 appearing twice in a foreach loop.
* The keys will appear in the order you wrote them, rather than being sorted alphanumerically as maps usually do.

In addition to being used in a foreach loop, plural constants also efficiently support membership testing via the 'contains' operator. Here's another example:
{{CodeSample|code=<syntaxhighlight>
for hour from 1 to 12 {
print("It's " + hour + " o'clock.");
if ($ints[10, 2, 4] contains hour) {
print("Time to drink a Dr Pepper!");
}
}</syntaxhighlight>}}
(Yes, that example could just as easily have been done with a switch statement.)

Iterating over an empty list is rather pointless, so plural constants with no elements are given a different meaning: they represent every value of the specified type, where this is practical. (The 'none' value, if defined for a given type, is omitted.) The biggest benefit here is $items[], which lets you loop over every defined item, more efficiently than you could otherwise write in a script (since the list is generated once per session and then cached), and without having to hard-code a maximum item ID number in your script. Example:
{{CodeSample|code=<syntaxhighlight>
foreach it in $items[] {
if (autosell_price(it) == 42) print(it);
}</syntaxhighlight>}}
Enumeration of all possible values works with the following types:
* $booleans[] - false and true.
* $items[]
* $locations[]
* $classes[]
* $stats[] - Muscle, Mysticality, Moxie: the substat values are omitted.
* $skills[]
* $effects[]
* $familiars[]
* $slots[] - includes sticker slots and fake hands, which you might not want to consider as normal slots.
* $monsters[]
* $elements[] - includes slime now, and possibly other not-quite-elements like cute in the future.

The remaining types that can be used in plural constants require an explicit list of elements, since there are too many possible values:
* $ints[] - you don't have enough RAM to store a list with 4 billion elements.
* $floats[] - ditto.
* $strings[] - nobody has that much RAM.

==Custom==

===matcher===

A matcher isn't really a datatype so much as it's a class, but it is included here for reference, as it is used much as datatypes are in ASH. It can only be declared through the function {{f|create_matcher}}, using two strings. One is the string to find matches in, the other a regular expression to test against. For more information on using a matcher, see [[Regular Expressions]].

==Notes==

Buffers, aggregates, records and matchers are [https://developer.mozilla.org/en-US/docs/Glossary/Mutable mutable]. All other datatypes are immutable.

[[Category:Scripting]]

Data Types

2022-10-02T19:28:41Z

QuietMisdreavus:

{{TOCright}}
==Primitive Datatypes==

===void===
Can be thought of better as the absence of a datatype. No value can be assigned to '''void''' nor can a value be returned from a function of datatype '''void'''.

===boolean===
A boolean value is either '''true''' or '''false'''. By default, a boolean variable is set to false.

===int===

A whole number (short for "integer"), either positive or negative (or 0). The int used by KoLmafia is a 32-bit signed int, meaning it has a maximum value of 2,147,483,647 and a minimum value of -2,147,483,648. The default value of a integer variable is 0.

Be careful when doing math with integers! As with some other strongly-typed languages, numbers are converted to integers at every step of the operation when only integer types are used. For example:
{{
CodeSample|
code=
<syntaxhighlight>
int a = 1;
int b = 2;
print( a / b * 2 );
</syntaxhighlight>}}
Will give the output "0," not "1" as you may expect. Changing either variable to a float type will "correct" this.

===float===

The float data type is a single-precision 32-bit IEEE 754 floating point. Its range of values is beyond the scope of this discussion, but is specified in [http://java.sun.com/docs/books/jls/third_edition/html/typesValues.html#4.2.3 section 4.2.3 of the Java Language Specification], and a tool to help understand / quickly see how/where imprecisions happen can be found [https://www.h-schmidt.net/FloatConverter/IEEE754.html here].

When assigning to a variable of type float, one should be careful to always enter numbers in decimal form, as unwanted behavior can result from supplying a value that KoLmafia may interpret as an int type without the decimal point.

Note that float is not infinitely precise; it intrinsically rounds off after a certain point. This loss of accuracy is for the sake of storage, but beware of the possibility of small errors compounding from multiple float types.
{{
CodeSample|
description=For instance, try the following code as an example of how rather long post-decimal portions are handled:|
code=
<syntaxhighlight>
float f;
f = 4.9999999;
print( f );
</syntaxhighlight>}}
The default value of a <code>float</code> variable is 0.0.

===string===

A group of characters including, but not limited to: lowercase letters, uppercase characters, numbers, and various control characters. When assigning a value to a string, enclose the desired value in either single quotes (<code>'</code>), double quotes (<code>"</code>) or backticks (<code>`</code>) (note you must use the same quote type on both ends of the string assignment). If you need to include the same character inside of the string itself, you will need to escape it first with a backslash.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = "This is my \"friend\" Pete.";</syntaxhighlight>
|moreinfo=Will result in the following being stored to s:<pre>This is my "friend" Pete</pre>
}}

The default value of a string is an empty string, or literally <code>""</code>

When using backticks, you can concatenate expressions into your string using curly braces.

{{
CodeSample
|description=For example:
|code=<syntaxhighlight>string s = `Hello {my_name()}, you have {$item[lime].item_amount()} lime(s)!`;</syntaxhighlight>
}}

===buffer===

Similar to a string, but more efficient in certain operations, including concatenation and passing as function arguments. For the most part, you can interchange references to strings and buffers. However, you should test all such actions first, as a few functions require a specific datatype to be supplied as a parameter. (Most notably, those listed under [[String Handling Routines#Regular Expressions|Regular Expressions]].)

==Special Datatypes==

Several datatypes are included in KoLmafia to represent common categories within the KoL universe.

Note that while variables of these types are declared in the same way as for Primitive Datatypes; assigning and referencing them is done differently.
{{CodeSample|
description=For example, to declare an item datatype and assign it a value, you would use the following line of code:|
code=
<syntaxhighlight>
item it = $item[ broken skull ];
</syntaxhighlight>}}
The default values of any variable of one of the following types is <code>$''type''[ none ]</code>. For example, the default value of a <code>item</code> variable is <code>$item[ none ]</code>.

===bounty===

([[Bounty#Related Functions|Related Functions]]) ([[Bounty#Proxy Record Fields|Proxy Record Fields]])

These are the non-items that the bounty hunter asks you to retrieve from monsters around the kingdom. There are quite a lot of them (42 in total) so I won't list them all here. You can find more about bounties at the {{kolwiki|The Bounty Hunter Hunter's Shack}}.

===class===

([[Class#Related Functions|Related Functions]]) ([[Class#Proxy Record Fields|Proxy Record Fields]])

Besides $class[ none ], there are six possible values for this datatype:

* Seal Clubber
* Turtle Tamer
* Pastamancer
* Sauceror
* Disco Bandit
* Accordion Thief

===coinmaster===

([[Coinmaster#Related Functions|Related Functions]]) ([[Coinmaster#Proxy Record Fields|Proxy Record Fields]])

All shops that deal with currency other than meat. Known values include:

* {{kolwiki|The Bounty Hunter Hunter's Shack|Bounty Hunter Hunter}}
* {{kolwiki|Mr. Store}}
* {{kolwiki|Hermit}}
* {{kolwiki|The Shore, Inc. Gift Shop}}
* {{kolwiki|The Trapper's Cabin|The Trapper}}
* {{kolwiki|A Vending Machine|Vending Machine}}
* {{kolwiki|The Swagger Shop}}
* {{kolwiki|The Hippy Camp (Wartime)|Dimemaster}}
* {{kolwiki|The Orcish Frat House|Quartersmaster}}
* {{kolwiki|BURT|Bugbear Token}}
* {{kolwiki|Freshwater Fishbonery}}
* {{kolwiki|Big Brother}}
* {{kolwiki|The Terrified Eagle Inn}}
* {{kolwiki|Ticket Redemption Counter|Arcade Ticket Counter}}
* {{kolwiki|Cashier|Game Shoppe}}
* {{kolwiki|Cashier|Game Shoppe Snacks}}
* {{kolwiki|The Isotope Smithery|Isotope Smithery}}
* {{kolwiki|Dollhawker's Emporium}}
* {{kolwiki|The Lunar Lunch-o-Mat|Lunar Lunch-o-Mat}}
* {{kolwiki|Paul's Boutique}}
* {{kolwiki|The Frozen Brogurt Stand}}
* {{kolwiki|Buff Jimmy's Souvenir Shop}}
* {{kolwiki|Taco Dan's Taco Stand}}
* {{kolwiki|You're the Fudge Wizard Now, Dog|Fudge Wand}}
* {{kolwiki|The Neandermall}}
* {{kolwiki|Legitimate Shoe Repair, Inc.}}
* {{kolwiki|warbear black box|Warbear Black Box}}
* {{kolwiki|The Dinsey Company Store}}
* {{kolwiki|Internet Meme Shop}}

===effect===

([[Effect#Related Functions|Related Functions]]) ([[Effect#Proxy Record Fields|Proxy Record Fields]])

Any effect you can be under in KoL, whether from items, skills, or what-have-you, is valid for this datatype.

The full range, besides $effect[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Effects}} page for more information.

===element===

([[Element#Related Functions|Related Functions]]) ([[Element#Proxy Record Fields|Proxy Record Fields]])

Besides $element[ none ], there are seven possible values for this datatype. (Note that "Bad Spelling" is not considered a true element.)
Also note that these names are case-sensitive (referencing $element[ Spooky ] will generate an error).

* cold
* hot
* sleaze
* spooky
* stench
* slime
* supercold

===familiar===

([[Familiar#Related Functions|Related Functions]]) ([[Familiar#Proxy Record Fields|Proxy Record Fields]])

Any familiar available in KoL is valid for this datatype.

The full range, besides $familiar[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Familiars}} page for more information.

===item===

([[Item#Related Functions|Related Functions]]) ([[Item#Proxy Record Fields|Proxy Record Fields]])

Any item in all of KoL is valid for this datatype. Note that unlike most special datatypes, item references can make use of the item ID number.
{{CodeSample|
description=For example, you could assign the item plexiglass pants as follows:|
code=
<syntaxhighlight>
item it = $item[ 1234 ];
</syntaxhighlight>}}
The full range, besides $item[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Items}} page for more information.

===location===

([[Location#Related Functions|Related Functions]]) ([[Location#Proxy Record Fields|Proxy Record Fields]])

Any location one can adventure at in KoL is valid for this datatype.

The full range, besides $location[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Locations}} page for more information.

===monster===

([[Monster#Related Functions|Related Functions]]) ([[Monster#Proxy Record Fields|Proxy Record Fields]])

Any monster you can encounter in KoL is valid for this datatype.

The full range, besides $monster[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Monster Compendium}} page for more information.

===path===

([[Path#Related Functions|Related Functions]]) ([[Path#Proxy Record Fields|Proxy Record Fields]])

Any ascension path you can choose in Valhalla is valid for this datatype. This includes all {{kolwiki|special challenge paths}}, as well as Standard and the dietary restriction paths (Boozetafarian, Teetotaler, Oxygenarian). The "Unrestricted" path and aftercore are represented as $path[ none ].

===phylum===

([[Phylum#Related Functions|Related Functions]]) ([[Phylum#Proxy Record Fields|Proxy Record Fields]])

Each monster has a {{kolwiki|Phylum}}. Besides $phylum[none], the possible values for this datatype are:

* beast
* bug
* constellation
* construct
* demon
* dude
* elemental
* elf
* fish
* goblin
* hippy
* hobo
* humanoid
* horror
* mer-kin
* orc
* penguin
* pirate
* plant
* slime
* undead
* weird

===servant===

([[Servant#Related Functions|Related Functions]]) ([[Servant#Proxy Record Fields|Proxy Record Fields]])

Servants are unique to the {{kolwiki|Actually Ed the Undying}} path and located {{kolwiki|The Servants' Quarters}}, replacing familiars.

* Assassin
* Belly-Dancer
* Bodyguard
* Cat
* Maid
* Priest
* Scribe

===skill===

([[Skill#Related Functions|Related Functions]]) ([[Skill#Proxy Record Fields|Proxy Record Fields]])

Any skill you can have in KoL, whether permable or not, granted by items, ''etc''., is valid for this datatype.

The full range, besides $skill[ none ], is too much to list and keep up with here: please see the Wiki {{kolwiki|Skills}} page for more information.

===slot===

([[Slot#Related Functions|Related Functions]]) (slot has no proxy record fields)

Besides $slot[ none ], there are 16 possible values for this datatype.

* hat
* back
* weapon
* off-hand
* shirt
* pants
* acc1
* acc2
* acc3
* familiar
* sticker1
* sticker2
* sticker3
* fakehand
* bootspur
* bootskin

===stat===

([[Stat#Related Functions|Related Functions]]) (stat has no proxy record fields)

Besides $stat[ none ], there are six possible values for this datatype (the last three are for referencing sub-stats).

* muscle
* mysticality
* moxie
* submuscle
* submysticality
* submoxie

===thrall===

([[Thrall#Related Functions|Related Functions]]) ([[Thrall#Proxy Record Fields|Proxy Record Fields]])

Pastamancers have the ability to summon {{kolwiki|Pasta Thralls}}.

* Angel Hair Wisp
* Elbow Macaroni
* Lasagmbie
* Penne Dreadful
* Spaghetti Elemental
* Spice Ghost
* Vampieroghi
* Vermincelli

==aggregate==

An aggregate is a complex datatype composed of two or more primitive or special datatypes. For more information, see [[Data Structures]].

==record==

Records are user-defined datatypes that hold as many sub-datatypes as desired. For more information, see the page for [[Data Structures]].

==Plural Typed Constants==

(see http://kolmafia.us/showthread.php?p=15592, from which this section is reproduced)

Plural typed constants allow you to easily do something with a list of specified objects, without having to replicate code or laboriously build up an array of the objects so that you can iterate over it. Here's a quick example:
{{CodeSample|code=<syntaxhighlight>
foreach weapon in $items[star sword, star staff, star crossbow] {
if (available_amount(weapon) > 0) {
equip(weapon);
break;
}
}</syntaxhighlight>}}
The syntax is basically the same as the existing typed constant feature, but with an "s" or "es" after the type name. (The "es" case is there so that you can properly pluralize "class".) The text between the square brackets is interpreted as a comma-separated list of elements, each of which is converted to the specified type as if it were an individual constant. More details:
* The list can span multiple lines.
* Whitespace before or after elements is ignored.
* Completely empty elements are ignored (so that you can leave a comma at the end of the list).
* You can include a comma or closing square bracket in an element by writing it as "\," or "\]".
* All the other escape sequences allowed in strings are possible, such as "\n" (newline), "\t" (tab), and "\uXXXX" (Unicode character value). To put an actual backslash in an element, you have to write it as "\\".

The value generated by a plural constant is of type boolean[type], with the keys being the specified elements, and the boolean value always being true - although you won't normally do anything with the boolean, you'd use a foreach loop to iterate over the keys. You can assign a plural constant to a variable declared as that type, but note that the value differs from a normal map in three important respects:
* Since the expression that generates it is syntactically a constant, the value has to be immutable. If you were allowed to change it in any way, those changes would appear in every future use of the same constant.
* There can be multiple instances of the same key - $ints[1,1,2,3,5,8] is perfectly valid, and will result in the value 1 appearing twice in a foreach loop.
* The keys will appear in the order you wrote them, rather than being sorted alphanumerically as maps usually do.

In addition to being used in a foreach loop, plural constants also efficiently support membership testing via the 'contains' operator. Here's another example:
{{CodeSample|code=<syntaxhighlight>
for hour from 1 to 12 {
print("It's " + hour + " o'clock.");
if ($ints[10, 2, 4] contains hour) {
print("Time to drink a Dr Pepper!");
}
}</syntaxhighlight>}}
(Yes, that example could just as easily have been done with a switch statement.)

Iterating over an empty list is rather pointless, so plural constants with no elements are given a different meaning: they represent every value of the specified type, where this is practical. (The 'none' value, if defined for a given type, is omitted.) The biggest benefit here is $items[], which lets you loop over every defined item, more efficiently than you could otherwise write in a script (since the list is generated once per session and then cached), and without having to hard-code a maximum item ID number in your script. Example:
{{CodeSample|code=<syntaxhighlight>
foreach it in $items[] {
if (autosell_price(it) == 42) print(it);
}</syntaxhighlight>}}
Enumeration of all possible values works with the following types:
* $booleans[] - false and true.
* $items[]
* $locations[]
* $classes[]
* $stats[] - Muscle, Mysticality, Moxie: the substat values are omitted.
* $skills[]
* $effects[]
* $familiars[]
* $slots[] - includes sticker slots and fake hands, which you might not want to consider as normal slots.
* $monsters[]
* $elements[] - includes slime now, and possibly other not-quite-elements like cute in the future.

The remaining types that can be used in plural constants require an explicit list of elements, since there are too many possible values:
* $ints[] - you don't have enough RAM to store a list with 4 billion elements.
* $floats[] - ditto.
* $strings[] - nobody has that much RAM.

==Custom==

===matcher===

A matcher isn't really a datatype so much as it's a class, but it is included here for reference, as it is used much as datatypes are in ASH. It can only be declared through the function {{f|create_matcher}}, using two strings. One is the string to find matches in, the other a regular expression to test against. For more information on using a matcher, see [[Regular Expressions]].

==Notes==

Buffers, aggregates, records and matchers are [https://developer.mozilla.org/en-US/docs/Glossary/Mutable mutable]. All other datatypes are immutable.

[[Category:Scripting]]

Template:Deprecated

2022-10-02T19:23:49Z

QuietMisdreavus:

<includeonly>
<div style="border: solid 1px red; margin: 0.2em; padding: 1em; background-color: #fff8dc; text-align: center;">
'''This function is deprecated{{#if: {{mafiaref|}}| in KoLmafia {{{mafiaref}}}}}.'''
{{#if: {{more_info|}}|<p>{{{more_info}}}</p>}}
</div>
[[Category:Deprecated Functions]]
</includeonly>
<noinclude>
This template can be used on a function page (outside of the FunctionPage template) to indicate that the function
is deprecated. The <code>mafiaref</code> parameter can be used to indicate which KoLmafia version the function
was deprecated in. The <code>more_info</code> parameter can be used to provide more details, such as an alternative
function that can be used instead.

==Example==

<pre>
{{Deprecated|
mafiaref=31337|
more_info=Use this other function instead.}}
</pre>

This renders as:

{{Deprecated|
mafiaref=31337|
more_info=Use this other function instead.}}
</noinclude>

Path name to id

2022-10-02T19:23:01Z

QuietMisdreavus:

{{deprecated|mafiaref=r26713|more_info=Use <code>[[to_path]](name).id</code> instead.}}
{{
#vardefine:name|path_name_to_id}}{{
#vardefine:return_type|int}}{{

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|name}}|
p1desc={{Pspan|name}} is the full, exact, case-sensitive name of the path to convert.|
}}|

function_description=Returns the specified path {{pspan|name}} as its {{kolwiki|Paths_by_number|path number}}.|

code1={{CodeSample|
title=Code Samples|
description=Following example shows basic path_name_to_id operations.||
code=
<syntaxhighlight>
string first = "Bees Hate You";
string second = "G-Lover";
string third = "Live. Ascend. Repeat.";

print(first+" gives "+path_name_to_id(first)+".");
print(second+" gives "+path_name_to_id(second)+".");
print(third+" gives "+path_name_to_id(third)+".");
</syntaxhighlight>|
moreinfo=
Gives the following output.
<pre>
Bees Hate You gives 4.
G-Lover gives 33.
Live. Ascend. Repeat. gives 31.
</pre>
}}|

see_also={{SeeAlso|my_path|my_path_id|path_id_to_name}}|
special=Returns -1 if given an incorrect/unknown name. Also, "Unrestricted" and "Aftercore" are not valid inputs for 0. "None" is instead expected.|
}}

[[Category:Datatype Conversions]]

Path id to name

2022-10-02T19:22:10Z

QuietMisdreavus:

{{deprecated|mafiaref=r26713|more_info=Use <code>[[to_path]](id).name</code> instead.}}
{{
#vardefine:name|path_id_to_name}}{{
#vardefine:return_type|string}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|id}}|
p1desc={{Pspan|id}} is the {{kolwiki|Paths_by_number|ID of the path}} to convert|
}}|

function_description=Returns the name of the specified path {{pspan|id}}.|

code1={{CodeSample|
title=Code Samples|
description=Following example shows basic path_id_to_name operations.||
code=
<syntaxhighlight>
int first = 3;
int second = 7;
int third = 24;

print(first+" gives "+path_id_to_name(first)+".");
print(second+" gives "+path_id_to_name(second)+".");
print(third+" gives "+path_id_to_name(third)+".");
</syntaxhighlight>|
moreinfo=
Gives the following output.
<pre>
3 gives Oxygenarian.
7 gives Trendy.
24 gives One Crazy Random Summer.
</pre>
}}|

see_also={{SeeAlso|my_path|my_path_id|path_name_to_id}}|
special=Returns "None" when submitting an ID which doesn't have a known path tied to, such as 5 (never released), or 60 (not yet known). Also, the 3 first unknown paths return "Path {{Pspan|id}}", for internal reasons (as of writing this, for example, 40, 41 and 42 return "Path 40", "Path 41" and "Path 42".|
}}

[[Category:Datatype Conversions]]

My path

2022-10-02T19:20:32Z

QuietMisdreavus:

{{
#vardefine:name|my_path}}{{
#vardefine:return_type|path}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function_description=Returns the path your character chose upon ascension ($path[ none ] when in aftercore).|

code1={{CodeSample|
title=Code Samples|
description=This prints something different based on whether or not you are in a {{kolwiki|Bees Hate You}} ascension path.|
code=<syntaxhighlight>
if(my_path() == $path[Bees Hate You])
print("I'm doing a Bees Hate You run.");
else print("Bees do not hate me, thank goodness.");
</syntaxhighlight>
}}|
see_also={{SeeAlso|my_path_id|path_id_to_name|path_name_to_id|my_sign|knoll_available|canadia_available|gnomads_available}}|
special=This function returns "None" when not logged in.|
}}

[[Category:Your Character]]

My path id

2022-10-02T19:14:48Z

QuietMisdreavus:

{{deprecated|mafiaref=r26713|more_info=Use <code>[[my_path]]().id</code> instead.}}
{{
#vardefine:name|my_path_id}}{{
#vardefine:return_type|int}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function_description=Returns the {{kolwiki|Paths_by_number|ID of the path}} your character chose upon ascension ("0" when in aftercore).|

see_also={{SeeAlso|my_path|path_id_to_name|path_name_to_id|my_sign|knoll_available|canadia_available|gnomads_available}}|
special=This function returns "0" when not logged in.|
}}

[[Category:Your Character]]

Template:Deprecated

2022-10-02T19:05:43Z

QuietMisdreavus: Created page with "<includeonly> <div style="border: solid 1px red; margin: 0.2em; padding: 1em; background-color: #fff8dc; text-align: center;"> '''This function is deprecated{{#if: {{mafiaref|..."

<includeonly>
<div style="border: solid 1px red; margin: 0.2em; padding: 1em; background-color: #fff8dc; text-align: center;">
'''This function is deprecated{{#if: {{mafiaref|}}| in KoLmafia {{{mafiaref}}}}}.'''
{{#if: {{more_info|}}|<p>{{{more_info}}}</p>}}
</div>
</includeonly>
<noinclude>
This template can be used on a function page (outside of the FunctionPage template) to indicate that the function
is deprecated. The <code>mafiaref</code> parameter can be used to indicate which KoLmafia version the function
was deprecated in. The <code>more_info</code> parameter can be used to provide more details, such as an alternative
function that can be used instead.

==Example==

<pre>
{{Deprecated|
mafiaref=31337|
more_info=Use this other function instead.}}
</pre>

This renders as:

{{Deprecated|
mafiaref=31337|
more_info=Use this other function instead.}}
</noinclude>

To path

2022-10-02T18:12:09Z

QuietMisdreavus: Created page with "{{ #vardefine:name|to_path}}{{ #vardefine:return_type|path}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}| retu..."

{{
#vardefine:name|to_path}}{{
#vardefine:return_type|path}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|id}}|
p1desc={{Pspan|id}} is the path ID to convert|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|name}}|
p1desc={{Pspan|name}} is the path name to convert|
}}|

function_description=Returns the specified path {{pspan|name}} or {{pspan|id}} as a path.|

code1={{CodeSample|
title=Code Samples|
description=Following example shows basic to_path operations.||
code=
<syntaxhighlight>
print(to_path("StAnDaRd"), "green");
print(to_path("stand"), "red");
print("");
if (to_path("StAnDaRd") == my_path())
print("I'm in a Standard run!", "green");
else print("I am not in Standard...", "blue");
</syntaxhighlight>|
moreinfo=
It gives the following output (for characters in a Standard ascension).
<pre>
Standard
none

I'm in a Standard run!
</pre>
}}|

}}

[[Category:Datatype Conversions]]

Path

2022-10-02T17:47:56Z

QuietMisdreavus: Created page with "{{DISPLAYTITLE:path}} This data represents the kinds of ascension paths your character can take. In addition to $path[ none ], this includes all the {{kolwiki|special challen..."

{{DISPLAYTITLE:path}}

This data represents the kinds of ascension paths your character can take. In addition to $path[ none ],
this includes all the {{kolwiki|special challenge paths}} available, as well as Standard and the
dietary restriction ascension paths (Boozetafarian, Teetotaler, Oxygenarian).

==Related Functions==

{{Flink|path|to_path|strict_string/int}}
{{Flink|path|my_path}}
{{Flink|int|to_int|path}}
{{Flink|int|my_path_id}}
{{Flink|string|path_id_to_name|int}}
{{Flink|int|path_name_to_id|string}}

==Proxy Record Fields==

Here are the proxy record fields for paths. Proxy records are discussed in more
detail [[Proxy Records|here]].

{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
|- | style="background-color: #F2F2F2"
|-
! Field
! Data type
! Default value
! ASH Accessor Function / Notes
|-
| id
| int
| 0
|
|-
| name
| string
| ""
|
|-
| avatar
| boolean
| false
| Whether this path overrides the character's class
|-
| image
| string
| "blank.gif"
|
|-
| points
| int
| 0
| The number of path points the current character has accumulated, if available
|-
| familiars
| boolean
| true
| Whether the path allows familiars
|}

[[Category:Scripting]] [[Category:Data Types]]