form_fields()

From KoLMafia
Jump to: navigation, search

Function Syntax

string [string] form_fields()

  • Similiar to form_field(), but returns a map with all the name/value pairs from the relay request being handled. Unlike the form_field() function, this allows iterating over all the fields, and can distinguish a field with a blank value from a nonexistent field. (The exception to this being checkboxes, which return no information when unchecked.)

Used to read form information in User Interface Scripts.

Code Sample

Read the form fields in a UI script for use later.

string [string] fields;
fields = form_fields();
boolean success = count(fields) > 0;

See Also

More Information

See User Interface Scripts for more information.