WML RESOURCES by enclave

[enclave]

I often had and still have many questions on "how to" do something in WML...
So I decided that there may be some people who may want to know the results or just use some of codes I was coming across in my works and it may save tons of time I guess..
So I will be posting here codes of abilities and whatever else I may find interesting for others. I hope nobody minds. (You can find a lot more if you download my add-ons and go through them, but we all know it's usually a mess. Here will be separate codes.. no need to look for anything and trying to figure out what it does and why). I hope will be helpful to at least somebody.
Thank you!

[enclave]

Flank abilities.
I wanted to make a code where units surrounded by enemy units would become weaker and get more damage, depending on how many enemy units around.

1) Abilities to become weaker if surrounded by enemy units with ability id=cg_flank

Spoiler:

They go into [unit] following these tags
[modifications]
[object]
silent=yes
[effect]
apply_to=new_ability
[abilities]

Code: Select all

[leadership]
							id=cg_flanked
							name= _ "flanked from 2 sides"
							name_inactive=""
							description=  _ "This unit is flanked. Flanked units from 2 or 3 sides do 20% less damage to any enemy while being surrounded."
							description_inactive=""
							affect_self=yes
							value=-20
					[filter]
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=ne,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					######	
					[or]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=sw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[/or]
				#######
					[or]
					[filter_adjacent]
					adjacent=sw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[/or]
				#######
					[or]
					[filter_adjacent]
					adjacent=sw,se,n
					is_enemy=true
					count=3
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]						
					[not]					
					[filter_adjacent]
					adjacent=s,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=nw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[/or]
				#######
					[or]
					[filter_adjacent]
					adjacent=ne,nw,s
					is_enemy=true
					count=3
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=sw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]					
					[not]					
					[filter_adjacent]
					adjacent=n,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=n,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				######
					[/filter]
						[/leadership]	
						##
						[leadership]
							id=cg_flanked
							name= _ "flanked from 4 sides"
							name_inactive=""
							description=  _ "This unit is flanked. Flanked units from 4 or 5 sides do 30% less damage to any enemy while being surrounded."
							description_inactive=""
							affect_self=yes
							##cumulative=yes
							value=-30
					[filter]
					[filter_adjacent]
					adjacent=s,n,se,nw
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]
					[filter_adjacent]
					adjacent=ne,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
				######
					[or]					
					[filter_adjacent]
					adjacent=se,nw,sw,ne
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]
					[filter_adjacent]
					adjacent=n,s
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				######
					[or]
					[filter_adjacent]
					adjacent=s,n,sw,ne
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=nw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]					
					[/or]
				#######
					[/filter]
						[/leadership]	
						##
						[leadership]
							id=cg_flanked
							name= _ "flanked from 6 sides"
							name_inactive=""
							description=  _ "This unit is flanked. Flanked units from 6 sides do 40% less damage to any enemy while being surrounded."
							description_inactive=""
							affect_self=yes
							##cumulative=yes
							value=-40
					[filter]
					[filter_adjacent]
					adjacent=s,n,se,nw,sw,ne
					is_enemy=true
					count=6
					ability=cg_flank
					[/filter_adjacent]
					[/filter]
						[/leadership]

[/abilities]
[/effect]
[/object]
[/modifications]
[/unit]

To make it work You would also need to add following ability between same tags (id=cg_flank):

Code: Select all

[flank]
							id=cg_flank
							name= _ ""
							name_inactive=""
							description=  _ ""
							description_inactive="this unit is able to flank surround enemies"
						[/flank]

it does nothing, but you need it to make the previous ability to work.

2) Effect that makes enemy units become stronger against surrounded unit. Similar to backstab or charge attack specials.

Spoiler:

it goes into [unit] following these tags
[modifications]
[object]
silent=yes
and you will need to know the name of the attack that you want to apply it (unless you will do it using stored unit array, I believe then you can do it different way, without needing to know name of attack)

Code: Select all

[effect]
				apply_to=attack
				name=club
				[set_specials]
					[damage]
					id=cg_flank
					name= _ "flank on 2 sides"
					description= _ "When units with flank surround enemies from 2 sides (backstab) they do 1.3 times more damage and get 1.2 times less damage in return."
					multiply=1.3
					##apply_to=self
					##active_on=offense
					[filter_self]
					[filter_adjacent]
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					##ability=flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=ne,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
						## ensure that [not] flanked from 3 sides
					[not]					
					[filter_adjacent]
					adjacent=sw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=nw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
				######
					[or]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=sw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
						## ensure that [not] flanked from 3 sides
					[not]					
					[filter_adjacent]
					adjacent=s,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=n,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[/or]
				#######
					[or]
					[filter_adjacent]
					adjacent=sw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
						## ensure that [not] flanked from 3 sides
					[not]					
					[filter_adjacent]
					adjacent=n,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=nw,s
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]							
					[/or]
				#######
					[/filter_adjacent]
					[/filter_self]
		##########################################
					[filter_defender]
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=ne,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
						## ensure that [not] flanked from 3 sides
					[not]					
					[filter_adjacent]
					adjacent=sw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=nw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
				######
					[or]
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=sw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
						## ensure that [not] flanked from 3 sides
					[not]					
					[filter_adjacent]
					adjacent=s,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=n,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[/or]
				#######
					[or]
					[filter_adjacent]
					adjacent=ne,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,n
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=se,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
						## ensure that [not] flanked from 3 sides
					[not]					
					[filter_adjacent]
					adjacent=n,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=nw,s
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[/or]
				#######
					[/filter_defender]
					[/damage]
##########################################################	
					[damage]
					id=cg_flank
					name= _ "flank on 3 sides"
					description= _ "When units with flank surround enemies from 3 sides (eg n,se,sw) they do 1.5 times more damage and get 1.2 times less damage in return."
					multiply=1.5
					##apply_to=self
					##active_on=offense
					[filter_self]
					[filter_adjacent]
					[filter_adjacent]
					adjacent=sw,n,se
					is_enemy=true
					count=3
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]						
					[not]					
					[filter_adjacent]
					adjacent=s,nw
					is_enemy=true
					count=2
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=nw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
				######
					[or]
					[filter_adjacent]
					adjacent=nw,s,ne
					is_enemy=true
					count=3
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=sw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]					
					[not]					
					[filter_adjacent]
					adjacent=n,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=n,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				#######
					[/filter_adjacent]
					[/filter_self]
		##################################
					[filter_defender]
					[filter_adjacent]
					adjacent=se,sw,n
					is_enemy=true
					count=3
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=s,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]						
					[not]					
					[filter_adjacent]
					adjacent=s,nw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
					[not]					
					[filter_adjacent]
					adjacent=nw,ne
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]		
				#######
					[or]
					[filter_adjacent]
					adjacent=ne,nw,s
					is_enemy=true
					count=3
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=sw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]					
					[not]					
					[filter_adjacent]
					adjacent=n,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]	
					[not]					
					[filter_adjacent]
					adjacent=n,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				#######
					[/filter_defender]
					[/damage]
#######################################################
[damage]
					id=cg_flank
					name= _ "flank on 4 sides"
					description= _ "When units with flank surround enemies from 4 sides (double backstab) they do 1.7 times more damage and get 1.3 times less damage in return."
					multiply=1.7
					##apply_to=self
					##active_on=offense
					[filter_self]
					[filter_adjacent]
					[filter_adjacent]
					adjacent=s,n,se,nw
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]
					[filter_adjacent]
					adjacent=ne,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
				######
					[or]					
					[filter_adjacent]
					adjacent=sw,ne,se,nw
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]
					[filter_adjacent]
					adjacent=n,s
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				######
					[or]
					[filter_adjacent]
					adjacent=s,n,sw,ne
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=nw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				######
					[/filter_adjacent]
					[/filter_self]
	##################################
					[filter_defender]
					[filter_adjacent]
					adjacent=s,n,se,nw
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]
					[filter_adjacent]
					adjacent=ne,sw
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
				######
					[or]
					[filter_adjacent]
					adjacent=sw,ne,se,nw
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]
					[filter_adjacent]
					adjacent=n,s
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				######
					[or]
					[filter_adjacent]
					adjacent=s,n,sw,ne
					is_enemy=true
					count=4
					ability=cg_flank
					[/filter_adjacent]
					[not]					
					[filter_adjacent]
					adjacent=nw,se
					is_enemy=true
					count=2
					ability=cg_flank
					[/filter_adjacent]
					[/not]
					[/or]
				######
					[/filter_defender]
					[/damage]
#######################################################
[damage]
					id=cg_flank
					name= _ "flank on 6 sides"
					description= _ "When units with flank surround enemies from all 6 sides they make 2.6 times greater damage and get 1.4 times less damage in return."
					multiply=2.6
					##apply_to=self
					##active_on=offense
					[filter_self]
					[filter_adjacent]
					[filter_adjacent]
					adjacent=s,n,se,nw,ne,sw
					is_enemy=true
					count=6
					ability=cg_flank
					[/filter_adjacent]
					[/filter_adjacent]
					[/filter_self]
		##########################
					[filter_defender]
					[filter_adjacent]
					adjacent=s,n,se,nw,ne,sw
					is_enemy=true
					count=6
					ability=cg_flank
					[/filter_adjacent]
					[/filter_defender]
					[/damage]								
				[/set_specials]
				[/effect]
			

[/object]
[/modifications]
[/unit]

[enclave]

Rage attack special (unit attacks 3 times in a row) - shortened berserk version

Need to put it into [unit] following these tags (need to know name of attack that you want to apply it to, also I assume it can go into [unit_type] tag same as in [unit], but I never tried):

Spoiler:

[modifications]
[object]
silent=yes
[effect]
apply_to=attack
name=club
[set_specials]

Code: Select all

			[berserk]
				id=rage
				name=rage
				description="Unit performs this attack 3 times. Similar to Berserk."
				value=3
			[/berserk]

[/set_specials]
[/effect]
[/object]
[/modifications]
[/unit]

[Eagle_11]

which version of wesnoth are you modding ? because it has been quite a while since [unit] transformed into [unit_type]
besides, you can simply just give the rage spec into the attack's [specials] without having to apply as you did, since you are already putting it into [unit_type]

[enclave]

hi Eagle_11. I'm on 1.12, but I must have mislead you and/or others wit unit and unit type.. I didn't mean to say that unit transforms into unit type was it ever like that?
and I don't know where you found that I put something into unit_type, because I don't use unit_type at all if you use unit_type in 1.12 then people will need to download your add-on to play. Which I don't want because then my mod will lose more than half players, or even 99.9%. So I'm only using [unit] tags, never [unit_type].
Maybe would be better if you could post the code on how to put rage into attack specials in [unit_type], otherwise your post doesn't look helpful to people, but thanks for trying.

[Eagle_11]

Code: Select all

#define WEAPON_SPECIAL_RAGE
    [berserk]
        id=rage
        name=_ "rage"
        description= _ "Unit performs this attack 3 times. Similar to Berserk."
        value=3
    [/berserk]
#enddef

Code: Select all

[unit_type]
...
[attack]
name=club
...
[specials]
     {WEAPON_SPECIAL_RAGE}
[/specials]
...
[/attack]
...
[/unit_type]

You dont need to use [modification] or apply it with an [object] since you already are modifying the unit's .cfg and can tell it directly so.

[enclave]

Some ways to apply image overlays to your units
1) using [unit_overlay] (keep in mind this way image will not rotate depending on where your unit is facing)

Spoiler:

(As example I always used x,y=12,15 so the unit is located at x=12 and y=15 on the map, change the filters according to your needs and positions of units):

Code: Select all

[unit_overlay]
x,y=12,15
image="misc/blank-hex.png~BLIT(terrain\castle\encampment\tall-keep-convex-br.png~CROP(22,43,30,35)~SCALE(30,30),17,40)~BLIT(terrain/castle/encampment/tall-keep-concave-tr.png~CROP(52,54,58,63)~SCALE(39,39)~FL(horiz),21,30)"
[/unit_overlay]

instead can use just image="your_image.png" but make sure it is smaller than size of your unit, or it won't show anything.
so can use SCALE to change size, for example image="your_image.png~SCALE(72,72)"
or you can position it in different side of unit if it is smaller than your unit, but it is best to apply it on top of empty image with BLIT, for example image="misc/blank-hex.png~BLIT(your_image.png~SCALE(22,22),11,33)" where 11 is X pixels to the right from the left corner of your unit, and 33 pixels down from the top of your unit.
maybe its not pixels, idk.. doesnt matter.
More information on this can find here: https://wiki.wesnoth.org/ImagePathFunctionWML
and you may download add-on called "image loading tester" which may help you modify your images

2) same idea (image will not rotate with unit).. different way.. by using {VARIABLE stored_unit.overlays

Spoiler:

first you need to store your unit into array, like so:

Code: Select all

[store_unit]
[filter]
x,y=12,15
[/filter]
variable=stored_unit
[store_unit]

then you need to modify his overlays property.. like so:

Code: Select all

{VARIABLE stored_unit.overlays "misc/blank-hex.png~BLIT(terrain\castle\encampment\tall-keep-convex-br.png~CROP(22,43,30,35)~SCALE(30,30),17,40)~BLIT(terrain/castle/encampment/tall-keep-concave-tr.png~CROP(52,54,58,63)~SCALE(39,39)~FL(horiz),21,30)"}

or simply

Code: Select all

{VARIABLE stored_unit.overlays "your_image.png"}

You can check all available properties of unit by typing "debug" into command line and then in new command line type "inspect" (:debug) (:inspect)

then you need to put the modified unit on map instead of existing one, you can do it like so:

Code: Select all

[unstore_unit]
variable=stored_unit
[/unstore_unit]

3) using [object] and image_mod... the image will rotate with your unit. but it may be more complicated to remove the overlay if you later decide to do so.

Spoiler:

Code: Select all

[object]
silent=yes
[filter]
x,y=12,15
[/filter]
[effect]
apply_to=image_mod
add="BLIT(terrain\castle\encampment\tall-keep-convex-br.png~CROP(22,43,30,35)~SCALE(30,30),17,40)~BLIT(terrain/castle/encampment/tall-keep-concave-tr.png~CROP(52,54,58,63)~SCALE(39,39)~FL(horiz),21,30)"
[/effect]
[/object]

your image should start with "BLIT" and you don't need to use blank hex in this case.. but you can if you wish to do so.
simply add="BLIT(your_image.png,17,40)
I think to remove such image overlay you would have to do something like that:

Code: Select all

[object]
silent=yes
[filter]
x,y=12,15
[/filter]
[effect]
apply_to=image_mod
replace=""
[/effect]
[/object]

but I never tried, I'm only guessing..

Similar way you may try to apply image_overlay like this (but I never tried it and I think image will not follow the unit direction)

Code: Select all

[object]
silent=yes
[filter]
x,y=12,15
[/filter]
[effect]
apply_to=overlay
add="BLIT(terrain\castle\encampment\tall-keep-convex-br.png~CROP(22,43,30,35)~SCALE(30,30),17,40)~BLIT(terrain/castle/encampment/tall-keep-concave-tr.png~CROP(52,54,58,63)~SCALE(39,39)~FL(horiz),21,30)"
[/effect]
[/object]

4) same idea, different way.. by using {VARIABLE and image_mod

Spoiler:

Spoiler:

first you need to store your unit into array, like so:

Code: Select all

[store_unit]
[filter]
x,y=12,15
[/filter]
variable=stored_unit
[store_unit]

then you need to modify his image_mod property.. like so:

Code: Select all

{VARIABLE temp_length $stored_unit.modifications.object.effect.length}
{VARIABLE stored_unit.modifications.object.effect[$cg_temp_arr_length].apply_to image_mod}
{VARIABLE stored_unit.modifications.object.effect[$cg_temp_arr_length].add "BLIT(terrain\castle\encampment\tall-keep-convex-br.png~CROP(22,43,30,35)~SCALE(30,30),17,40)~BLIT(terrain/castle/encampment/tall-keep-concave-tr.png~CROP(52,54,58,63)~SCALE(39,39)~FL(horiz),21,30)"}
{CLEAR_VARIABLE cg_temp_arr_length}

then you need to put the modified unit on map instead of existing one, you can do it like so:

Code: Select all

[unstore_unit]
variable=stored_unit
[/unstore_unit]

This way should NOT be perfect if you plan to add and remove overlays to same units multiple times.. but it will probably work no problem. Except I don't know but I assume the best way to remove such overlay would be with using same method as in my #3 example with [object] or the ideal way would probably be something like this:
store unit by using:

Code: Select all

[store_unit]
[filter]
x,y=12,15
[/filter]
variable=stored_unit
[store_unit]

and then:

Code: Select all

{FOREACH stored_unit.modifications.object.effect i}
[if]
[variable]
name=stored_unit.modifications.object.effect[$i].apply_to
equals="image_mod"
[/variable]
[then]
{CLEAR_VARIABLE stored_unit.modifications.object.effect[$i]}
[/then]
[/if]
{NEXT i}

and then you need to put the modified unit (with cleared variables) on map instead of existing one, you can do it like so:

Code: Select all

[unstore_unit]
variable=stored_unit
[/unstore_unit]

(there are more ways, I believe, including macros and lua instead of WML, but I only listed 4 ways that I personally came across myself)

Thanks for posting rage code Eagle_11, it should help a lot of people.

[enclave]

count down the array.. instead of counting up like "{FOREACH" macro does..
The pure code would be like this:

Spoiler:

Code: Select all

{VARIABLE i $your_array_name.length}
[while]
	[variable]
	name=i
	greater_than=0
	[/variable]
	[do]
	{VARIABLE_OP i add -1}
## your desirable code here.. for example [message] message="$your_array_name[$i].type" [/message] (would list stored array unit types from last to first.
	[/do]
[/while]

Or you could write the following code somewhere to your cfgs:

Spoiler:

Code: Select all

#define FOREACH_COUNTDOWN ARRAY_NAME VARIABLE_COUNTER
{VARIABLE {VARIABLE_COUNTER} ${ARRAY_NAME}.length}
[while]
	[variable]
	name={VARIABLE_COUNTER}
	greater_than=0
	[/variable]
	[do]
	{VARIABLE_OP {VARIABLE_COUNTER} add -1}
#enddef
#define NEXT_COUNTDOWN VARIABLE_COUNTER
	[/do]
	[/while]
	{CLEAR_VARIABLE {VARIABLE_COUNTER}}
#enddef

And then you could just use {FOREACH_COUNTDOWN your_array_name i} and {NEXT_COUNTDOWN i} same way like you normally use {FOREACH} macro..

PS. it may be helpful if you are clearing the variables from array.. like in this example:

Spoiler:

Code: Select all

{FOREACH_COUNTDOWN stored_unit.abilities.resistance i}
					[if]
					[variable]
					name=stored_unit.abilities.resistance[$i].id
					equals="cg_fortified"
					[/variable]
					[then]
					{CLEAR_VARIABLE stored_unit.abilities.resistance[$i]}
					[/then]
					[/if]
{NEXT_COUNTDOWN i}

because if you not doing it upside down then you will have a problem.. since once you clear variable, to the best of my knowledge, they all shift 1 down.. and you will miss half of them

[Astoria]

Since arrays start at index 0, setting the iterator to the length of the array will cause the first iteration to be out of bounds. The maximum index of an array is array.length - 1.

[enclave]

Since arrays start at index 0, setting the iterator to the length of the array will cause the first iteration to be out of bounds. The maximum index of an array is array.length - 1.

it sounds very much like you are right, I mean you are definitely at least half right..
for some reason it worked for me without any error messages (out of bounds), so I guess for Wesnoth it just looks like the first index ($array[array.length]) is empty or equals nothing.. or nil or whatever.
but the truth is that the first index will be outside the boundaries.. quite sure about that now.. well spotted. Thanks very much bumbadadabum!

I have corrected the code, so I believe it should be working perfectly fine now.. Thanks!

[enclave]

Adding some ability to some unit at coordinates x,y=5,3
Here we will try to add LEADERSHIP LVL2

To find some existing abilities just go to your wesnoth folder (Win7 for example C:\Program Files (x86)\Battle for Wesnoth 1.12.1\data\core\macros\) and open the abilities.cfg file using any text editor like word pad or notepad++

So the code follows:

Spoiler:

1) We need to store unit into array using filter with coordinates x=5 y=3

Code: Select all

[store_unit]
[filter]
x=5
y=3
[/filter]
variable=temp_unit
[/store_unit]

2) Now we are saving ability from abilities.cfg into array named "temp_ability"
We can create a macro (more complicated way) or we can just do all in 1 place.. (easy way, but often messy)
We will do it Simple way here:

Code: Select all

[set_variables]
name=temp_ability
mode=replace
[value]
## copy and paste the ability from abilities.cfg here like so:
  [leadership]
        id=leadership
        value=50
        cumulative=no
        name= _ "leadership"
        female_name= _ "female^leadership"
        description= _ "This unit can lead our own units that are next to it, making them fight better.

Adjacent own units of lower level will do more damage in battle. When a unit adjacent to, of a lower level than, and on the same side as a unit with Leadership engages in combat, its attacks do 25% more damage times the difference in their levels."
        affect_self=no
        [affect_adjacent]
            adjacent=n,ne,se,s,sw,nw
            [filter]
                level=0
            [/filter]
        [/affect_adjacent]
    [/leadership]
    [leadership]
        id=leadership
        value=25
        cumulative=no
        affect_self=no
        [affect_adjacent]
            adjacent=n,ne,se,s,sw,nw
            [filter]
                level=1
            [/filter]
        [/affect_adjacent]
    [/leadership]
[/value]
[/set_variables]

3) Now we insert ability array "temp_ability" into our stored unit array "temp_unit" into abilities tag.. so "temp_unit.abilities"

Code: Select all

[set_variables]
name=temp_unit.abilities
mode=insert
[insert_tag]
name=value
variable=temp_ability
[/insert_tag]
[/set_variables]

4) Now we just need to unstore the resulted unit array to the battlefield by

Code: Select all

[unstore_unit]
variable=temp_unit
[/unstore_unit]

Macro way also just in case..:

Spoiler:

1) We need to define the following text somewhere in your cfg files..

Code: Select all

#define CG_SAVE_ABILITY_TO_CONTAINER CONTAINER_NAME
[set_variables]
name={CONTAINER_NAME}
mode=replace
##to_variable={CONTAINER_NAME}
[value]
#enddef

#define CG_SAVE_END
[/value]
[/set_variables]
#enddef

#define INSERT_ARRAY_TO_ARRAY ARRAY_1 TO_ARRAY_2
[set_variables]
name={TO_ARRAY_2}
mode=insert
[insert_tag]
name=value
variable={ARRAY_1}
[/insert_tag]
[/set_variables]
#enddef

#define CG_INSERT_LEADERSHIP_LVL2_ABILITY_INTO_UNIT_ARRAY COORDINATE_X COORDINATE_Y
{CG_SAVE_ABILITY_TO_CONTAINER cg_temp_ability}
    [leadership]
        id=leadership
        value=50
        cumulative=no
        name= _ "leadership"
        female_name= _ "female^leadership"
        description= _ "This unit can lead our own units that are next to it, making them fight better.

Adjacent own units of lower level will do more damage in battle. When a unit adjacent to, of a lower level than, and on the same side as a unit with Leadership engages in combat, its attacks do 25% more damage times the difference in their levels."
        affect_self=no
        [affect_adjacent]
            adjacent=n,ne,se,s,sw,nw
            [filter]
                level=0
            [/filter]
        [/affect_adjacent]
    [/leadership]
    [leadership]
        id=leadership
        value=25
        cumulative=no
        affect_self=no
        [affect_adjacent]
            adjacent=n,ne,se,s,sw,nw
            [filter]
                level=1
            [/filter]
        [/affect_adjacent]
    [/leadership]
{CG_SAVE_END}
[store_unit]
[filter]
x={COORDINATE_X}
y={COORDINATE_Y}
[/filter]
variable=temp_unit
[/store_unit]
{INSERT_ARRAY_TO_ARRAY cg_temp_ability temp_unit.abilities}
[/unstore_unit]
variable=temp_unit
[/unstore_unit]
#enddef

3) and then we just need to add the following line wherever action is taking place and it will look quite tidy in comparison to simple version..

Code: Select all

{CG_INSERT_LEADERSHIP_LVL2_ABILITY_INTO_UNIT_ARRAY 5 3}

for example:

Code: Select all

[event]
name=turn 10
first_time_only=yes
{CG_INSERT_LEADERSHIP_LVL2_ABILITY_INTO_UNIT_ARRAY 5 3}
[/event]

That would add leadership lvl2 ability to any unit standing on x=5 y=3 on turn 10

I hope I didn't do any mistakes while was typing it here.. The code was tested and it worked for me. But I can't guarantee its bug free.. but it should be. Any questions just ask. Hope it helped anyone

[enclave]

Now a funny thing..
Lets say you would like:
a unit that (1) has leadership ability
(2) does NOT have skirmisher ability (replace with whatever ability you like.. eg "cg_need_wake_up")
and (3) spotted an enemy
to (a) say something... (b) remove his leadership ability and (c) destroy spotted unit from map?
I spent lots of time to do it.. I believe there is more simple way, but I found my way.. and who cares.. it works!

The Code:

Spoiler:

(a) If unit does NOT have leadership then you will need to add leadership ability to the unit first (use example in my previous post).. or instead you may want to add some ability that does nothing but has id to be filtered?
1) Store unit to some temp_unit array... lets imagine his coordinates are 5,3.. and he is a king of side 3
You may remove coordinates if you wish to save a king of side 3 no matter where he stands..

Code: Select all

[store_unit]
[filter]
x=5
y=3
canrecruit=yes
side=3
[/filter]
variable=temp_unit
[/store_unit]

2) add dummy ability that does nothing.. but has id to be filtered

Code: Select all

{VARIABLE temp_unit.abilities.blablabla.id cg_sleep}

you may add name and description if you like..

Code: Select all

{VARIABLE temp_unit.abilities.blablabla.name "armaggeddon"}
{VARIABLE temp_unit.abilities.blablabla.description ""}

if you leave blanks "" then it will not show anywhere on unit.. but you will be able to filter it.

3) Unstore the unit.. so it gets the ability

Code: Select all

[unstore_unit]
variable=temp_unit
[/unstore_unit]

4) then you will need a moveto event.. if you want it to work only once then use first_time_only=yes
otherwise use first_time_only=no

Code: Select all

[event]
name=moveto
first_time_only=no
[filter]
x,y=$x1,$y1
[filter_vision]
[enemy_of]
side=$side_number
[/enemy_of]
[/filter_vision]
[filter_location]
radius=12 ## use whatever number you like, but I put 12 because most units move maximum of 10 so 12 should be more 
## than enough.. if you know that your unit max_moves = 5 then I guess you would use 6 as a radius to reduce amount of 
## work that processor will have to do.. so basically the smaller number the faster it will work for every player. 
[filter]
is_enemy=true
ability="cg_sleep"                               ## replace with "leadership" or whatever you like
	[not]
	ability="cg_need_wake_up"          ## replace with "skirmisher" or whatever..
	[/not]
[/filter]
[/filter_location]
[/filter]
	[store_unit]
	[filter]
		[filter_side]
		[enemy_of]
		side=$side_number
		[/enemy_of]
		[/filter_side]
	ability="cg_sleep"                      ## replace with "leadership" or whatever you like
	[not]
	ability="cg_need_wake_up"         ## replace with "skirmisher" or whatever you like
	[/not]
	[filter_location]
		x,y=$x1,$y1
		radius=12                        ## put your radius which you think u need..
	[/filter_location]
	[/filter]
	variable=temp_armaggedon_units
	[/store_unit]
{FOREACH temp_armaggedon_units counter_u}
[store_reachable_locations]
[filter]
x,y=$temp_armaggedon_units[$counter_u].x,$temp_armaggedon_units[$counter_u].y
[/filter]
range=vision
variable=temp_reachable_locations
[/store_reachable_locations]
	{FOREACH temp_reachable_locations counter_o}
	[if]
	[variable]
	name=temp_reachable_locations[$counter_o].x
	equals=$x1
	[/variable]
	[and]
	[variable]
	name=temp_reachable_locations[$counter_o].y
	equals=$y1
	[/variable]	
	[/and]
	[then]
	{CLEAR_VARIABLE temp_armaggedon_units[$counter_u].abilities.leadership} 
## use your ability instead of leadership.. in this example we created blablabla with "cg_sleep" id.. so would need to replace
## leadership with blablabla: {CLEAR_VARIABLE temp_armaggedon_units[$counter_u].abilities.blablabla} 
	[unstore_unit]
	variable=temp_armaggedon_units[$counter_u]
	[/unstore_unit]
[message]
speaker=$temp_armaggedon_units[$counter_u].id
message="You will die now! MUAHAHAHAHA!"
[/message]
[kill]
x,y=$x1,$y1
fire_event=no
animate=yes
[/kill]
	[/then]
	[/if]
	{NEXT counter_o}
{NEXT counter_u}	
{CLEAR_VARIABLE temp_armaggedon_units}
{CLEAR_VARIABLE temp_reachable_locations}
[/event]

I may have done mistakes while I was changing the working code into this dummy code.. But I hope I didn't..
If it doesn't work.. ask questions.. My code obviously wasn't removing leadership.. wasnt making unit kill somebody and didn't have a unit say anything.. My code was used for something completely different and I used 7 as a radius because I think it was sufficient in my case.. Have fun!

[zookeeper]

(b) remove his leadership ability

Surely you should just use [object] [effect] apply_to=remove_ability to do that?

[enclave]

(b) remove his leadership ability

Surely you should just use [object] [effect] apply_to=remove_ability to do that?

it may be a nice way..
I personally think that 1 line looks and works much better..
{CLEAR_VARIABLE temp_armaggedon_units[$counter_u].abilities.leadership}

but maybe you could write full example for somebody who is interested in [object] version?
How would you remove leadership ability via object from unit at x=5, y=3 ?

Thank you!

[zookeeper]

it may be a nice way..
I personally think that 1 line looks and works much better..
{CLEAR_VARIABLE temp_armaggedon_units[$counter_u].abilities.leadership}

but maybe you could write full example for somebody who is interested in [object] version?
How would you remove leadership ability via object from unit at x=5, y=3 ?

Thank you!

Code: Select all

[object]
    silent=yes
    
    [filter]
        x,y=5,3
    [/filter]
    
    [effect]
        apply_to=remove_ability
        
        [abilities]
            [leadership]
                id=leadership
            [/leadership]
        [/abilities]
    [/effect]
[/object]

You can remove abilities via direct variable manipulation like you did, but I think then they might suddenly re-appear when the unit gets unexpectedly rebuilt in some situation. You should generally do things like that with an [object] unless there's a specific reason not to.