Difference between revisions of "Effect"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
(Redirected page to Datatype Constants#effect)
imported>Aventuristo
(Add to Data Types category)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
#REDIRECT [[Datatype Constants#effect]]
+
{{DISPLAYTITLE:effect}}
 +
 
 +
This data type represents any effect you can be under in KoL, whether from items,
 +
skills, or what-have-you.
 +
 
 +
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.
 +
 
 +
==Related Functions==
 +
 
 +
{{Flink|effect|effect_modifier|string|string}}
 +
{{Flink|effect|effect_modifier|item|string}}
 +
{{Flink|int|have_effect|effect}}
 +
{{Flink|familiar|my_effective_familiar}}
 +
{{Flink|int [effect]|my_effects}}
 +
{{Flink|float|numeric_modifier|effect|string}}
 +
{{Flink|stat|stat_modifier|effect|string}}
 +
{{Flink|effect|to_effect|int}}
 +
{{Flink|effect|to_effect|strict_string}}
 +
{{Flink|effect|to_effect|skill}}
 +
{{Flink|skill|to_skill|effect}}
 +
 
 +
==Proxy Record Fields==
 +
 
 +
Here are the proxy record fields for effects.  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
 +
|-
 +
| default
 +
| string
 +
| ""
 +
|
 +
|-
 +
| note
 +
| string
 +
| ""
 +
|
 +
|-
 +
| all
 +
| aggregate boolean [string]
 +
|
 +
|
 +
|-
 +
| image
 +
| string
 +
| "/images/debug.gif"
 +
|
 +
|-
 +
| descid
 +
| string
 +
| ""
 +
|
 +
|}
 +
 
 +
[[Category:Scripting]] [[Category: Data Types]]

Latest revision as of 00:40, 30 September 2017


This data type represents any effect you can be under in KoL, whether from items, skills, or what-have-you.

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

Related Functions

effect effect_modifier( string, string )

effect effect_modifier( item, string )

int have_effect( effect )

familiar my_effective_familiar()

int [effect] my_effects()

float numeric_modifier( effect, string )

stat stat_modifier( effect, string )

effect to_effect( int )

effect to_effect( strict_string )

effect to_effect( skill )

skill to_skill( effect )


Proxy Record Fields

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

Field Data type Default value ASH Accessor Function / Notes
default string ""
note string ""
all aggregate boolean [string]
image string "/images/debug.gif"
descid string ""