FutureProg functions
startcombat
startcombat overload 1
Boolean startcombat(Text reference, Text description, Text gerund, Boolean friendly, Character combatant1, Character combatant2, Text joinprog, Text leaveprog, Text endprog, Text moveprog, Text hitprog)
Available in
- computer function
- computer program
- standard futureprog
Starts a combat that executes progs when various things happen.
| Parameter | Type | Description |
|---|---|---|
reference |
Text |
A unique reference that is passed to each of the progs when executed |
description |
Text |
The description of the combat that appears in COMBAT STATUS |
gerund |
Text |
The gerund used in combat descriptions, e.g. fighting, sparring, boxing, etc. |
friendly |
Boolean |
Whether this combat counts as friendly and uses the spar rules or not |
combatant1 |
Character |
The first combatant |
combatant2 |
Character |
The second combatant |
joinprog |
Text |
A prog to execute when someone joins the combat. It must accept a character (the joiner) and a text parameter (the reference). |
leaveprog |
Text |
A prog to execute when someone leaves the combat. It must accept a character (the leaver) and a text parameter (the reference). |
endprog |
Text |
A prog to execute when the combat ends. It must accept a text parameter (the reference). |
moveprog |
Text |
A prog to execute when someone makes a move in combat. It must accept a character (the attacker), another character (the target) and a text parameter (the reference). |
hitprog |
Text |
A prog to execute when someone hits someone in combat. It must accept a character (the attacker), another character (the target) and a text parameter (the reference). |