LuaWML/Sides - Revision history

Celtic Minstrel: Add move notice

2021-02-12T13:31:54Z

Add move notice

2018-06-23T19:15:13Z

2018-06-19T02:40:59Z

2018-05-08T00:13:00Z

‎wesnoth.sides

2018-05-04T22:05:35Z

‎wesnoth.set_side_id: fix arguments order

2018-03-19T18:05:06Z

‎wesnoth.sides

2018-03-19T16:06:25Z

‎wesnoth.sides

2018-03-14T13:41:53Z

2017-11-22T05:48:57Z

Corrected remove_shroud tag name (was clear_shroud)

2017-11-20T11:23:05Z

‎helper.all_teams

← Older revision		Revision as of 13:31, 12 February 2021
Line 1:		Line 1:
		+	{{Template:LuaMove}}
		+
	This page describes the [[LuaWML]] functions and helpers for handling sides and villages.		This page describes the [[LuaWML]] functions and helpers for handling sides and villages.

@@ Line 11: / Line 11: @@
 * '''team_name''': string (read/write)
 * '''is_local''' {{DevFeature1.13|8}}: boolean (read). Whether the side is local. Careless use will cause OOS errors.
-* '''controller''': string (read/write) :
+* '''controller''': string (read/write):
-:''note: As of 1.14.1, the following note is incorrect, but I don't know exactly what the truth is, so I'm leaving it here until somebody who knows the truth edits it. In particular, I observed a networked multiplayer game where both clients displayed both sides' controllers as "human". The behavior may be consistent with the behavior described in [[SideWML]]. - EliDupree''
+:''note: In networked multiplayer, the controller attribute may not be the same on all clients. Be very careful or you'll have OOS errors.''
-:''note: In networked multiplayer, the controller attribute is ambiguous (won't be the same on all clients). Be very careful or you'll have OOS errors.''
+: The only possible values are 'human', 'ai' or 'null'.
 {{DevFeature1.13|8}} Remote and local are no longer differentiated by this field. For example, remote humans will be shown as "human". Use 'is_local' field if you need to differentiate.

@@ Line 12: / Line 12: @@
 * '''is_local''' {{DevFeature1.13|8}}: boolean (read). Whether the side is local. Careless use will cause OOS errors.
 * '''controller''': string (read/write) :
 :''note: In networked multiplayer, the controller attribute is ambiguous (won't be the same on all clients). Be very careful or you'll have OOS errors.''
 : The controller attribute has 6 possible values: human, network, ai, network_ai, null, idle. (Or less, see below.)

@@ Line 34: / Line 34: @@
 * '''scroll_to_leader''': boolean (read/write)
 * '''village_support''': string (read/write)
-* '''flag''': string (read  {{DevFeature1.13|7}}/write)
+* '''flag''': string (read  {{DevFeature1.13|7}}/write) As of 1.14.0 this is not writable.
 * '''flag_icon''': string (read  {{DevFeature1.13|7}}/write)
 * '''defeat_condition''': string (read/write) See description at [[SideWML]], [[ScenarioWML#Scenario_End_Conditions]]

@@ Line 130: / Line 130: @@
 {{DevFeature1.13|7}}
-* '''wesnoth.set_side_id(''side'', ''color'', ''flag'')'''
+* '''wesnoth.set_side_id(''side'', ''flag'', ''color'')'''
 Changes the visual identification of a side. Pass an empty string if you only want to change one of these two attributes.

@@ Line 23: / Line 23: @@
 : This value can only be set to 'human', 'ai' or 'null'.
-{{DevFeature1.13|8}} Both remote and local sides will appear as 'human'. Combine this value with 'is_local' to differentiate "network human" from "local human" if you need to.
+{{DevFeature1.13|8}} Remote and local are no longer differentiated by this field. For example, remote humans will be shown as "human". Use 'is_local' field if you need to differentiate.
 * '''fog''': boolean (read {{DevFeature1.13|7}}/write)
 * '''shroud''': boolean (read  {{DevFeature1.13|7}}/write)

@@ Line 106: / Line 106: @@
   local loc = wesnoth.get_starting_location(1)
   wesnoth.message(string.format("side 1 starts at (%u, %u)", loc[1], loc[2]))
 ==== wesnoth.set_side_id ====

@@ Line 123: / Line 123: @@
 Shrouds the specified hexes. You can pass a shroud_data string (which will be merged with existing shroud), a list of specific locations (where each location is a two-element list of x and y coordinates), or the special string "all" to shroud all hexes.
-==== wesnoth.clear_shroud ====
+==== wesnoth.remove_shroud ====
 {{DevFeature1.13|7}}
-* '''wesnoth.clear_shroud(''side'', ''shroud'')'''
+* '''wesnoth.remove_shroud(''side'', ''shroud'')'''
 Unshrouds the specified hexes. Hexes are specified as with place_shroud, except that a shroud_data string will not work.

@@ Line 191: / Line 191: @@
 * '''helper.all_teams()'''
-Returns an iterator over teams that can be used in a for-in loop.
+Returns an iterator over sides that can be used in a for-in loop.
-  for team in helper.all_teams() do team.gold = 200 end
+Note that the method name "teams" is a historical mistake, currently left out for backwards compatibility. It has no relation to [team] tag.
 [[Category: Lua Reference]]