wesnoth/data/utils/scenario-utils.cfg
Eric S. Raymond b704c056f4 Add documentation for all but two of the utility macros.
Put all documentation comments in a standard form that can be

mechanically extracted.  Move some macsos to the deprecated.cfg file.
2007-04-16 05:19:33 +00:00

94 lines
2.4 KiB
INI

# Utility macros for scenario-objectivew control.
# These macros don't depend on any others. Please don't change this.
#define SET_OBJECTIVES SIDE SUMMARY NOTE CONDITIONS
# Sets the objectives for a given player
# Side 0 means every player. Does not affect gameplay,
# except that it tells the player what the objectives of a scenario are.
#
# For example, we could set the objective for all players to: "survive for
# 3 turns" wuth this:
# {SET_OBJECTIVES 0 "Survive for 3 turns" () ()}
#
[objectives]
side = {SIDE}
summary = {SUMMARY}
note = {NOTE}
{CONDITIONS}
[/objectives]
#enddef
#define VICTORY_CONDITION DESCRIPTION
# Used in conjunction with SET_OBJECTIVES this sets a victory condition
# (marked green).
#
# For example we could tell player 2 to win by killing all other players
# {SET_OBJECTIVES 0 "Kill eachother." (
# {VICTORY_CONDITION "Kill all other players."}
# )}
#
[objective]
condition = "win"
description = {DESCRIPTION}
[/objective]
#enddef
#define DEFEAT_CONDITION DESCRIPTION
# Used in conjunction with SET_OBJECTIVES this sets a defeat condition
# (marked red).
#
# For example we could tell all players that they lose if they die.
# {SET_OBJECTIVES 0 "Survive." (
# {DEFEAT_CONDITION "Death of your leader."}
# )}
#
[objective]
condition = "lose"
description = {DESCRIPTION}
[/objective]
#enddef
#define SIDE_PLAYER SIDE TEAM DESCRIPTION GOLD INCOME SIDE_PARMS
# Defines a multiplayer side in a scenario that is controllable by the player.
#
# For example we can set side 1 to be a player belonging to team "Good Guys"
# starting with 200g and no income:
# {SIDE_PLAYER 1 "Good Guys" "Good Guy #1" 200 -2 ()}
[side]
description={DESCRIPTION}
side={SIDE}
team_name={TEAM}
canrecruit=1
controller=human
gold={GOLD}
income={INCOME}
{SIDE_PARMS}
[/side]
#enddef
#define SIDE_COMPUTER SIDE TEAM DESCRIPTION GOLD INCOME SIDE_PARMS AI_PARMS
# Defines a multiplayer side in a scenario that is controllad by the computer.
#
# For example, we can set side 4 to be a computer belonging to team "Evil Guys"
# starting with 666g and no 99 income.
# We also make it more aggressive:
# {SIDE_COMPUTER 4 "Evil Guys" "Evil One" 666 99 (
# aggression=0.95
# )}
#
[side]
description={DESCRIPTION}
side={SIDE}
team_name={TEAM}
canrecruit=1
controller=ai
allow_player=no
gold={GOLD}
income={INCOME}
{SIDE_PARMS}
[ai]
{AI_PARMS}
[/ai]
[/side]
#enddef