Ferreteria/v0.6/clade/Sys/Events/InputRq/Setting: Difference between revisions

From Woozle Writes Code
< Ferreteria‎ | v0.6‎ | clade‎ | Sys‎ | Events‎ | InputRq
Jump to navigation Jump to search
No edit summary
Line 5: Line 5:
| align=right | {{l/ver/clade|Sys/Events|InputRq}}
| align=right | {{l/ver/clade|Sys/Events|InputRq}}
| &rarr; {{l/ver/clade|Sys\Events\InputRq|Setting}}
| &rarr; {{l/ver/clade|Sys\Events\InputRq|Setting}}
| &rarr; [WFu]{{l/ver/clade/base|InSet}}
|}
|}
==About==
A {{l/ver/clade|Sys\Events\InputRq|Setting}} is an {{l/ver/clade|Sys/Events|InputRq}} whose primary (or only) purpose is to change the value of a setting used by any other {{l/ver/clade|Sys/Events|InputRq}}s that might need it. The value is saved under the Setting's assigned name (NameOfInput()).
==Functions==
==Functions==
===public===
===public===

Revision as of 14:30, 1 September 2025

clade: Sys\Events\InputRq\Setting
Clade Family
InputRq Setting → [WFu]InSet

About

A Setting is an InputRq whose primary (or only) purpose is to change the value of a setting used by any other InputRqs that might need it. The value is saved under the Setting's assigned name (NameOfInput()).

Functions

public

  • function Describe() : string (override)
  • function Go() (override)
  • function NameOfInput() : string

internal

  • function ParseInputString(string $s) : void
    • $s = first value given to the subcommand (e.g. for "cmd:stuff:things", $s will be "stuff")
    • Additional parts (e.g. "things") get sent to ParseInputArgs().
  • function ParseInputArgs(array $arArgs) {} : no code
    • $arArgs = number-based array of additional values (if any) (e.g. for "cmd:stuff:things:more", $arArgs will be [0]=>"things", [1]=>"more)
    • By default, these aren't retained since their meaning is action-dependent. Podlings can override this.