Difference between revisions of "LuaWML/Sides"
From The Battle for Wesnoth Wiki
< LuaWML
(→wesnoth.is_enemy) |
m (improved documentation of is_enemy) |
||
| Line 29: | Line 29: | ||
Returns true if side A is enemy of side B, false otherwise. | Returns true if side A is enemy of side B, false otherwise. | ||
| − | local enemy_flag = wesnoth.is_enemy(1,3) | + | local enemy_flag = wesnoth.is_enemy(1,3) |
==== wesnoth.set_village_owner ==== | ==== wesnoth.set_village_owner ==== | ||
Revision as of 11:08, 28 June 2010
This page describes the LuaWML functions and helpers for handling sides and villages.
Contents
wesnoth.get_side
Returns the team with given number.
local team = wesnoth.get_side(1) team.gold = team.gold + 50
Teams are proxy tables with the following fields:
- gold, village_gold, base_income: integers (read/write)
- total_income: integer (read only)
- objectives, user_team_name: translatable strings (read/write)
- objectives_changed: boolean (read/write)
- team_name: string (read/write)
- __cfg: WML table (dump)
The metatable of these proxy tables appears as "side".
wesnoth.get_village_owner
Returns the side that owns the village at the given location.
local owned_by_side_1 = wesnoth.get_village_owner(12, 15) == 1
wesnoth.is_enemy
Returns true if side A is enemy of side B, false otherwise.
local enemy_flag = wesnoth.is_enemy(1,3)
wesnoth.set_village_owner
Gives ownership of the village at the given location to the given side (or remove ownership if none).
wesnoth.set_village_owner(12, 15, 1)
helper.all_teams
Returns an iterator over teams that can be used in a for-in loop.
for team in helper.all_teams() do team.gold = 200 end