Location: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Metraxis
No edit summary
 
imported>Fredg1
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Enumerated|Name=location}}
{{DISPLAYTITLE:location}}
 
{{TOCright}}
 
This data type represents any location in KoL in which one can adventure.
 
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.
 
==Related Functions==
 
{{Flink|boolean|adv1|location|int|string}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|monster [int]|get_monsters|location}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}
{{Flink|location|my_location}}
{{Flink|void|set_location|location}}
{{Flink|location|to_location|strict_string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_url|location}}
 
==Proxy Record Fields==
 
Here are the proxy record fields for locations.  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
|-
| nocombats
| boolean
| false
|
|-
| combat_percent
| float
| 0.0
| the chance of getting a combat encounter INCLUDING your combat_rate_modifier()
|-
| zone
| string
| ""
|
|-
| parent
| string
| ""
|
|-
| parentdesc
| string
| ""
|
|-
| environment
| string
| ""
|
|-
| bounty
| bounty
| none
|
|-
| combat_queue
| string
| ""
|
|-
| noncombat_queue
| string
| ""
|
|-
| turns_spent
| int
| 0
|
|-
| kisses
| int
| 0
| {{kolwiki|Dreadsylvania}}
|-
| recommended_stat
| int
| 0
|
|-
| water_level
| int
| 0
| {{kolwiki|Heavy Rains}}
|-
| wanderers
| boolean
| false
| whether wandering monsters can spawn in this zone
|}
 
[[Category:Scripting]] [[Category:Data Types]]

Latest revision as of 21:40, 3 June 2020


This data type represents any location in KoL in which one can adventure.

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

Related Functions

boolean adv1( location, int, string )

boolean adventure( int, location, [string] )

float [monster] appearance_rates( location, [boolean] )

string [location, 3] get_florist_plants()

monster [int] get_monsters( location )

int jump_chance( location, [int], [int] )

location my_location()

void set_location( location )

location to_location( strict_string )

location to_location( int )

string to_url( location )


Proxy Record Fields

Here are the proxy record fields for locations. Proxy records are discussed in more detail here.

Field Data type Default value ASH Accessor Function / Notes
nocombats boolean false
combat_percent float 0.0 the chance of getting a combat encounter INCLUDING your combat_rate_modifier()
zone string ""
parent string ""
parentdesc string ""
environment string ""
bounty bounty none
combat_queue string ""
noncombat_queue string ""
turns_spent int 0
kisses int 0 Dreadsylvania
recommended_stat int 0
water_level int 0 Heavy Rains
wanderers boolean false whether wandering monsters can spawn in this zone