Difference between revisions of "Datatype Conversions"

From Kolmafia
Jump to navigation Jump to search
imported>Efilnikufecin
(See discussion thread on kolmafia.us)
imported>Fredg1
(path_id_to_name and path_name_to_id)
 
(24 intermediate revisions by 8 users not shown)
Line 1: Line 1:
== Data Type Conversions ==
+
<p>These functions will convert one type of data to another.</p>
 +
{{flink|boolean|to_boolean|any|desc=Converts any datatype to a boolean.}}
 +
{{flink|bounty|to_bounty|string|desc=Converts a string to a bounty.}}
 +
{{flink|class|to_class|string|desc=Converts a string to a class.}}
 +
{{flink|effect|to_effect|int}}
 +
{{flink|effect|to_effect|string}}
 +
{{flink|effect|to_effect|skill|desc=Converts an int, string or skill to an effect.}}
 +
{{flink|element|to_element|string|desc=Converts a string to an element.}}
 +
{{flink|familiar|to_familiar|int}}
 +
{{flink|familiar|to_familiar|string|desc=Converts an int or a string to a familiar.}}
 +
{{flink|float|to_float|any|desc=Converts from any datatype to a float.}}
 +
{{flink|int|path_name_to_id|string}}
 +
{{flink|int|to_int|any|desc=Converts from any datatype to an int.}}
 +
{{flink|item|to_item|string}}
 +
{{flink|item|to_item|int}}
 +
{{flink|item|to_item|string|int|desc=Converts an int or a string to an item (optionally allowing plural strings with both parameters).}}
 +
{{flink|location|to_location|string|desc=Converts a string to a location.}}
 +
{{flink|monster|to_monster|string|desc=Converts a string to a monster.}}
 +
{{flink|phylum|to_phylum|string|desc=Converts a string to a phylum.}}
 +
{{flink|string|to_plural|item|desc=Converts an item into the string value of its plural.}}
 +
{{flink|skill|to_skill|int}}
 +
{{flink|skill|to_skill|string}}
 +
{{flink|skill|to_skill|effect|desc=Converts an int, string or effect to a skill.}}
 +
{{flink|slot|to_slot|item}}
 +
{{flink|slot|to_slot|string|desc=Converts an item or string to a slot.}}
 +
{{flink|stat|to_stat|string|desc=Converts a string to a stat.}}
 +
{{flink|string|path_id_to_name|int}}
 +
{{flink|string|to_string|any|desc=Converts any datatype to a string.}}
 +
{{flink|thrall|to_thrall|string}}
 +
{{flink|thrall|to_thrall|int|desc=Converts a string or int to a thrall.}}
 +
== Historical note ==
 +
ASH did not originally support polymorphic functions, so it was not possible to have (for example) a single '''to_string(any)''' function that worked on any datatype.  Instead, there were separate '''int_to_string(int)''', '''item_to_string(item)''', etc. functions.  You may see these used in older scripts, and in fact they still work.  The rule is that if a function name is not otherwise defined anywhere, and it ends with one of the modern type conversion function names shown above, it is treated as a call to the modern function.  No check is made to verify that the chopped-off portion of the old function name actually matches the type of its parameter.
  
These functions will convert 1 type of data to another.
+
[[Category:Scripting]]
 
 
<p><strong>string to_string( variable )</strong><br />
 
Converts in-game variables to printable counterparts. The print command will cast non-string values properly now, but these are still useful for building URLs and setting properties.<br />
 
accepts: boolean, int, float, item, zodiac, location, familiar, class, stat, skill, effect, slot, element, monster</p>
 
 
 
<p><strong>int to_int( variable )</strong><br />
 
Converts the ASH-based object into the number that will be recognized by the KoL server. Needed when you&#8217;re building raw URLs from time to time.<br />
 
accepts: String, float, item, zodiac, location, familiar, skill, effect, slot, element, monster<br />
 
may accept: boolean,  class, stat</p>
 
 
 
<p><strong>boolean to_boolean( variable )</strong><br />
 
Converts the ASH-based object into boolean.<br />
 
Accepts: String<br />
 
may accept: Int</p>
 
 
 
<p><strong>float to_float( variable )</strong><br />
 
Converts the ASH-based object into a float.<br />
 
Accepts: String<br />
 
may accept: int</p>
 
 
 
<p><strong>item to_item( variable )</strong><br />
 
Converts the ASH-based object into an item.<br />
 
Accepts: string, int
 
</p>
 
 
 
<p><strong>location to_location( variable )</strong><br />
 
Converts the ASH-based object into a location.<br />
 
Accepts: string
 
</p>
 
 
 
<p><strong>familiar to_familiar( variable )</strong><br />
 
Converts the ASH-based object into a familiar.<br />
 
Accepts: string, int
 
</p>
 
 
 
<p><strong>skill to_skill( variable )</strong><br />
 
Converts the ASH-based object into a skill.<br />
 
Accepts: string, int, effect
 
</p>
 
 
 
<p><strong>effect to_effect( variable )</strong><br />
 
Converts the ASH-based object into an effect.<br />
 
Accepts: string, int, skill
 
</p>
 
 
 
<p><strong>slot to_slot( variable )</strong><br />
 
Converts the ASH-based object into a slot.<br />
 
Accepts: item
 
</p>
 
 
 
<p><strong>monster to_monster( variable )</strong><br />
 
Converts the ASH-based object into a monster.<br />
 
Accepts: string
 
</p>
 

Latest revision as of 00:14, 8 June 2020

These functions will convert one type of data to another.

boolean to_boolean( any )

Converts any datatype to a boolean.

bounty to_bounty( string )

Converts a string to a bounty.

class to_class( string )

Converts a string to a class.

effect to_effect( int )

effect to_effect( string )

effect to_effect( skill )

Converts an int, string or skill to an effect.

element to_element( string )

Converts a string to an element.

familiar to_familiar( int )

familiar to_familiar( string )

Converts an int or a string to a familiar.

float to_float( any )

Converts from any datatype to a float.

int path_name_to_id( string )

int to_int( any )

Converts from any datatype to an int.

item to_item( string )

item to_item( int )

item to_item( string, int )

Converts an int or a string to an item (optionally allowing plural strings with both parameters).

location to_location( string )

Converts a string to a location.

monster to_monster( string )

Converts a string to a monster.

phylum to_phylum( string )

Converts a string to a phylum.

string to_plural( item )

Converts an item into the string value of its plural.

skill to_skill( int )

skill to_skill( string )

skill to_skill( effect )

Converts an int, string or effect to a skill.

slot to_slot( item )

slot to_slot( string )

Converts an item or string to a slot.

stat to_stat( string )

Converts a string to a stat.

string path_id_to_name( int )

string to_string( any )

Converts any datatype to a string.

thrall to_thrall( string )

thrall to_thrall( int )

Converts a string or int to a thrall.

Historical note

ASH did not originally support polymorphic functions, so it was not possible to have (for example) a single to_string(any) function that worked on any datatype. Instead, there were separate int_to_string(int), item_to_string(item), etc. functions. You may see these used in older scripts, and in fact they still work. The rule is that if a function name is not otherwise defined anywhere, and it ends with one of the modern type conversion function names shown above, it is treated as a call to the modern function. No check is made to verify that the chopped-off portion of the old function name actually matches the type of its parameter.