Difference between revisions of "User:Dlr365"

From The Battle for Wesnoth Wiki
Line 5: Line 5:
 
==== Implementation ====
 
==== Implementation ====
 
* The following keys are valid:
 
* The following keys are valid:
** '''endlevel''' : this key specifies if the level should be ended.  Can be either ''yes'' or ''no''.  Defaults to ''yes''.  The following keys may be used if ''endlevel=yes'':
+
** '''endlevel''' : this key specifies if the level should be ended.  Can be either ''yes'' or ''no''.  Defaults to ''yes''. '''CURRENT IMPLEMENTATION DOES NOT ALLOW ''endlevel=no''!''' The following keys may be used if ''endlevel=yes'':
 
*** '''next_scenario''' : the ID of the next scenario that is to be played.  Default specified in ''[scenario]'' tag.
 
*** '''next_scenario''' : the ID of the next scenario that is to be played.  Default specified in ''[scenario]'' tag.
 
*** '''default_result''' : sides who are not given specific results are issued this result.  Defaults to ''defeat''.
 
*** '''default_result''' : sides who are not given specific results are issued this result.  Defaults to ''defeat''.
  
 
* The following tags are valid:
 
* The following tags are valid:
** '''[victory]''' : issues victory to the specified sides.  Valid keys:
+
** '''[victory]''' : issues victory to the specified sides.  Can have either zero or one ''[victory]'' tag per ''[results]'' tag.  Valid keys:
 
*** '''side''' : the side to be given victory.  All teammates of the given side will also be given victory.  If not included, the ''[victory]'' tag is ignored.
 
*** '''side''' : the side to be given victory.  All teammates of the given side will also be given victory.  If not included, the ''[victory]'' tag is ignored.
 
*** '''bonus''' : whether the sides specified in this ''[victory]'' tag should get bonus gold.  Can be either ''yes'' or ''no''.  Defaults to ''no''.
 
*** '''bonus''' : whether the sides specified in this ''[victory]'' tag should get bonus gold.  Can be either ''yes'' or ''no''.  Defaults to ''no''.
 
*** '''carryover_percentage''' : Amount of gold carried over into the next scenario.  Defaults to 80%.
 
*** '''carryover_percentage''' : Amount of gold carried over into the next scenario.  Defaults to 80%.
 
*** '''carryover_add''' : if ''true'' the gold will be added to the starting gold the next scenario, if ''false'' the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is ''false''.
 
*** '''carryover_add''' : if ''true'' the gold will be added to the starting gold the next scenario, if ''false'' the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is ''false''.
** '''[defeat]''' : issues defeat to the specified sides.  Valid keys:
+
** '''[defeat]''' : issues defeat to the specified sides.  Can have either zero or one ''[defeat]'' tag per ''[results]'' tag.  Valid keys:
 
*** '''side''' : the side to be given defeat.  Each ''[defeat]'' tag may include multiple ''side'' keys.  If not included, the ''[defeat]'' tag is ignored.
 
*** '''side''' : the side to be given defeat.  Each ''[defeat]'' tag may include multiple ''side'' keys.  If not included, the ''[defeat]'' tag is ignored.
 +
 +
* If neither a ''[victory]'' nor ''[defeat]'' tag is specified, then all sides are issued ''default_result''.
  
 
==== Notes ====
 
==== Notes ====
 
* out of sync problems in MP with bonus gold?
 
* out of sync problems in MP with bonus gold?
* when someone is issued defeat in MP (when there is 3 or more teams), could they become an observer? or just get dropped & then have to rejoin?
+
* TODO : allow comma-delimited lists for ''side'' in ''[defeat]'' tags
* TODO : allow comma-delimited lists for '''side'''
+
* TODO : allow ''endlevel=no'' (may require server-side changes...)
 +
** when someone is issued defeat in MP (when there is 3 or more teams), could they become an observer?

Revision as of 05:31, 27 March 2008

Works in Progress

[result] -- new DirectActionWML

This tag would allow scenario authors to issue victory/defeat to specific sides from within events, without the scenario necessarily ending (if it makes sense for it to continue).

Implementation

  • The following keys are valid:
    • endlevel : this key specifies if the level should be ended. Can be either yes or no. Defaults to yes. CURRENT IMPLEMENTATION DOES NOT ALLOW endlevel=no! The following keys may be used if endlevel=yes:
      • next_scenario : the ID of the next scenario that is to be played. Default specified in [scenario] tag.
      • default_result : sides who are not given specific results are issued this result. Defaults to defeat.
  • The following tags are valid:
    • [victory] : issues victory to the specified sides. Can have either zero or one [victory] tag per [results] tag. Valid keys:
      • side : the side to be given victory. All teammates of the given side will also be given victory. If not included, the [victory] tag is ignored.
      • bonus : whether the sides specified in this [victory] tag should get bonus gold. Can be either yes or no. Defaults to no.
      • carryover_percentage : Amount of gold carried over into the next scenario. Defaults to 80%.
      • carryover_add : if true the gold will be added to the starting gold the next scenario, if false the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is false.
    • [defeat] : issues defeat to the specified sides. Can have either zero or one [defeat] tag per [results] tag. Valid keys:
      • side : the side to be given defeat. Each [defeat] tag may include multiple side keys. If not included, the [defeat] tag is ignored.
  • If neither a [victory] nor [defeat] tag is specified, then all sides are issued default_result.

Notes

  • out of sync problems in MP with bonus gold?
  • TODO : allow comma-delimited lists for side in [defeat] tags
  • TODO : allow endlevel=no (may require server-side changes...)
    • when someone is issued defeat in MP (when there is 3 or more teams), could they become an observer?