Wml optimisation - Revision history

Shadowm: Update links to macro-reference.html, other links too

2021-08-24T08:10:02Z

Update links to macro-reference.html, other links too

Octalot: Suggest the [resource] tag for optimising multiple instantiations of macros

2019-02-03T22:17:31Z

Suggest the [resource] tag for optimising multiple instantiations of macros

Trewe: /* The basics */

2014-10-12T14:07:49Z

‎The basics

Xudojnik: Added warning about premature optimisation

2014-10-12T07:20:47Z

Added warning about premature optimisation

Xudojnik: Added a description of common mistake "macros is function"

2014-10-12T06:49:11Z

Added a description of common mistake "macros is function"

Iceiceice at 21:30, 6 April 2014

2014-04-06T21:30:05Z

Iceiceice at 21:23, 6 April 2014

2014-04-06T21:23:33Z

Dunno at 20:07, 3 November 2013

2013-11-03T20:07:01Z

Dugi: /* Further reading */

2013-10-29T19:47:41Z

‎Further reading

Dugi: /* Further reading */ - added a link to advanced optimalisations and hacks

2013-10-29T19:47:06Z

‎Further reading: - added a link to advanced optimalisations and hacks

@@ Line 323: / Line 323: @@
 ==Further reading==
-*[http://wiki.wesnoth.org/Advanced_Optimisations_and_Hacks More complex optimisations] - read this only if you believe you know everything!
+*[[Advanced_Optimisations_and_Hacks|More complex optimisations]] - read this only if you believe you know everything!
-*[http://www.wesnoth.org/macro-reference.xhtml Macro reference]
+*[https://www.wesnoth.org/macro-reference.html Macro reference]
 *[[LuaWML]]
 *[[ConventionsWML]]
 [[Category:WML_Tips]]

@@ Line 178: / Line 178: @@
 This time, making a custom event would be fairly easy, but it would be much less transparent in usage. The code {GENERIC_UNIT 1 Spearman 12 3} is self-explanatory, simple and versatile.
 ==Do not treat macroses as functions==
@@ Line 311: / Line 316: @@
          {GENERIC_UNIT 2 "Spearman" 3 16}
      [/event]
 ==Analogies to "real" programming==

@@ Line 2: / Line 2: @@
 The first thing you need to know: '''If you have no problems with performance, then don't bother'''.
 Any optimisation is supposed to help you in following situations:
-* Game freezes for several seconds after each user action
+* The game freezes for several seconds after each user action
-* Your scenario loading time longer than several minutes
+* Your scenario loading time is longer than several minutes
-* Your add-on codebase larger than 5 megabytes
+* Your add-on codebase is larger than 5 megabytes
 ===What you should know next===
@@ Line 178: / Line 178: @@
 This time, making a custom event would be fairly easy, but it would be much less transparent in usage. The code {GENERIC_UNIT 1 Spearman 12 3} is self-explanatory, simple and versatile.
 ==Do not treat macroses as functions==

@@ Line 1: / Line 1: @@
 ==The basics==
-===What you should know first===
+===What you should know next===
 *[[PreprocessorRef#Preprocessor_directives|Macros]]
 *[[EventWML]]

← Older revision		Revision as of 06:49, 12 October 2014
Line 173:		Line 173:

	This time, making a custom event would be fairly easy, but it would be much less transparent in usage. The code {GENERIC_UNIT 1 Spearman 12 3} is self-explanatory, simple and versatile.		This time, making a custom event would be fairly easy, but it would be much less transparent in usage. The code {GENERIC_UNIT 1 Spearman 12 3} is self-explanatory, simple and versatile.
		+
		+
		+	==Do not treat macroses as functions==
		+	Main advantage of macroses is that they allow you to reuse your code with less effort. But you need to take into account how ''exactly'' they are used by Wesnoth. Look at the example
		+
		+	#define CREATE_REINFORCMENT SIDE
		+	{VARIABLE temp_side {SIDE}}
		+	[variable]
		+	name = temp_side
		+	value = 1
		+	[/variable]
		+	[if]
		+	{VARIABLE_CONDITIONAL temp_side equals 1}
		+	[then]
		+	{GENERIC_UNIT 1 "Walking Corpse" 12 3}
		+	[/then]
		+	[/if]
		+	[if]
		+	{VARIABLE_CONDITIONAL temp_side equals 2}
		+	[then]
		+	{GENERIC_UNIT 2 "Spearman" 3 16}
		+	[/then]
		+	[/if]
		+	{CLEAR_VARIABLE temp_side}
		+	#enddef
		+	[event]
		+	name=turn 10
		+	{CREATE_REINFORCMENT 1}
		+	{CREATE_REINFORCMENT 2}
		+	[/event]
		+
		+	In this example I wanted to create additional units for each side at turn 10. Side 1 is undeads and side 2 is loyalists. Everything looks good, but there is a mistake. When Wesnoth loads scenario, all macroses are substituted with their meaning. This example becomes:
		+
		+	[event]
		+	name="turn 10"
		+	[set_variable]
		+	name="temp_side"
		+	value=1
		+	[/set_variable]
		+	[if]
		+	[variable]
		+	equals=1
		+	name="temp_side"
		+	[/variable]
		+	[then]
		+	[unit]
		+	generate_name=yes
		+	random_gender=yes
		+	random_traits=yes
		+	side=1
		+	type="Walking Corpse"
		+	upkeep="full"
		+	x=12
		+	y=3
		+	[/unit]
		+	[/then]
		+	[/if]
		+	[if]
		+	[variable]
		+	equals=2
		+	name="temp_side"
		+	[/variable]
		+	[then]
		+	# PART 1 BEGINS
		+	[unit]
		+	generate_name=yes
		+	random_gender=yes
		+	random_traits=yes
		+	side=2
		+	type="Spearman"
		+	upkeep="full"
		+	x=3
		+	y=16
		+	[/unit]
		+	# PART 1 ENDS
		+	[/then]
		+	[/if]
		+	[clear_variable]
		+	name="temp_side"
		+	[/clear_variable]
		+	[set_variable]
		+	name="temp_side"
		+	value=2
		+	[/set_variable]
		+	[if]
		+	[variable]
		+	equals=1
		+	name="temp_side"
		+	[/variable]
		+	[then]
		+	# PART 2 BEGINS
		+	[unit]
		+	generate_name=yes
		+	random_gender=yes
		+	random_traits=yes
		+	side=1
		+	type="Walking Corpse"
		+	upkeep="full"
		+	x=12
		+	y=3
		+	[/unit]
		+	# PART 2 ENDS
		+	[/then]
		+	[/if]
		+	[if]
		+	[variable]
		+	equals=2
		+	name="temp_side"
		+	[/variable]
		+	[then]
		+	[unit]
		+	generate_name=yes
		+	random_gender=yes
		+	random_traits=yes
		+	side=2
		+	type="Spearman"
		+	upkeep="full"
		+	x=3
		+	y=16
		+	[/unit]
		+	[/then]
		+	[/if]
		+	[clear_variable]
		+	name="temp_side"
		+	[/clear_variable]
		+	[/event]
		+
		+	Obviously part 1 and part 2 will never happen. It makes conditional check useless while you code becomes more complex. This is very common mistake even in advanced scenarios and add-ons. To avoid this problem, you need to follow the rule: '''Do not make conditional actions based on values of arguments'''. If you need to do this, then you need to think over situation again. In our example it might be:
		+
		+	[event]
		+	name=turn 10
		+	{GENERIC_UNIT 1 "Walking Corpse" 12 3}
		+	{GENERIC_UNIT 2 "Spearman" 3 16}
		+	[/event]

← Older revision		Revision as of 21:30, 6 April 2014
Line 186:		Line 186:
	*[[ConventionsWML]]		*[[ConventionsWML]]

−	[[Category:WML_Tips	+	[[Category:WML_Tips]]

← Older revision		Revision as of 21:23, 6 April 2014
Line 185:		Line 185:
	*[[LuaWML]]		*[[LuaWML]]
	*[[ConventionsWML]]		*[[ConventionsWML]]
		+
		+	[[Category:WML_Tips

@@ Line 1: / Line 1: @@
 ==The basics==
@@ Line 19: / Line 17: @@
 ====Inefficient example====
      #NOTE: remember, this should work alright, but it is not efficient! Imagine if you have much more villages in mind, or you want to spawn more zombies