Difference between revisions of "Voting booth initiatives"

From Kolmafia
Jump to navigation Jump to search
imported>Gausie
m
imported>Gausie
 
Line 1: Line 1:
 
{{
 
{{
 
#vardefine:name|voting_booth_initiatives}}{{
 
#vardefine:name|voting_booth_initiatives}}{{
#vardefine:return_type|string [string]}}{{
+
#vardefine:return_type|boolean [string]}}{{
 
#vardefine:aggregate|yes}}{{
 
#vardefine:aggregate|yes}}{{
  
Line 15: Line 15:
 
p1desc={{pspan|class}} is the class for the seed|
 
p1desc={{pspan|class}} is the class for the seed|
 
parameter2={{Param|int|path}}|
 
parameter2={{Param|int|path}}|
p2desc={{pspan|class}} is the path id for the seed|
+
p2desc={{pspan|path}} is the path id for the seed|
 
parameter3={{Param|int|daycount}}|
 
parameter3={{Param|int|daycount}}|
 
p3desc={{pspan|daycount}} is the daycount for the seed|
 
p3desc={{pspan|daycount}} is the daycount for the seed|
 
}}|
 
}}|
  
function_description=Returns a map of voting initiatives that are available for a given class on a given day of an ascension in a given path|
+
function2={{Function|
 +
name={{#var:name}}|
 +
aggregate={{#var:aggregate}}|
 +
return_type={{#var:return_type}}|
 +
return_also={{#var:return_also}}|
 +
parameter1={{Param|int|class}}|
 +
p1desc={{pspan|class}} is the class id for the seed|
 +
parameter2={{Param|int|path}}|
 +
parameter3={{Param|int|daycount}}|
 +
}}|
 +
 
 +
function_description=Returns a list of voting initiatives that are available for a given class on a given day of an ascension in a given path|
  
 
code1={{CodeSample|
 
code1={{CodeSample|

Latest revision as of 16:26, 23 September 2020

Function Syntax

boolean [string] voting_booth_initiatives(class class ,int path ,int daycount )

  • class is the class for the seed
  • path is the path id for the seed
  • daycount is the daycount for the seed

boolean [string] voting_booth_initiatives(int class ,int path ,int daycount )

  • class is the class id for the seed

Returns a list of voting initiatives that are available for a given class on a given day of an ascension in a given path

Code Sample

The following will tell you the initiatives available to you today without you ever having to visit the booth.

string [string] initiatives = voting_booth_initiative( my_class(), my_path_id(), my_daycount() );
dump( initiatives );