New Lua functions.

[mentos987]

I have some requests listed here in order of perceived importance:

• 1. --Edit: This feature does already exist. --
  Spoiler:

  Sound handler similar to what is done with -- local Animation=wesnoth.units.create_animator()
  This game lacks any control over the sounds that are currently playing. I would like to, at the very least, be able to mute a sound prematurely.
  This would enable narration among other things.

• 2. A function to place a "halo"-type multihex image that is layered above the tiles but underneath the units would enable modders to create a lot more beauty.

• 3. ~ROTATE and ~SCALE for wesnoth.interface.add_hex_overlay() is currently very taxing for the CPU and cause a lot of lag. Would be nice if they where optimized. Or if we could preload the animation for later use.

[Ravana]

1 sounds useful.

2 has nothing to do with Lua functions.

3 I got impression if it difficult to improve performance.

[mentos987]

2 has nothing to do with Lua functions.

I am not loooking for a specific image. I am looking for a function to place a multihex image above the terrain layer but below the unit layer. Much like how halos work.

I want a new option for this Lua function: wesnoth.interface.add_hex_overlay(x, y, {x = x, y = y, halo = "data/add-ons/addon/images/folder/pic01.png"})

Where "halo" is the layer, I want the option of a third layer.

[Shiki]

I think World Conquest does use this functionality actually. Setting sth. undocumented like z-index.

[Celtic_Minstrel]

For 1 you could look into the sound source functionality. It might be able to do what you want, but I'm not sure.

For 3, yes, we would like to use the GPU for IPFs, but we're not quite there yet. Compiling IPFs down into shader code is possible and would probably greatly boost performance for things using a lot of IPFs, not to mention reducing the size of the image cache…

[mentos987]

I think World Conquest does use this functionality actually. Setting sth. undocumented like z-index.

Are you refering to the 2nd point? I scanned the files of World Conquest but didn't find much, not that I know what to look for.

[mentos987]

For 1 you could look into the sound source functionality. It might be able to do what you want, but I'm not sure.

Do you mean wesnoth.audio.sources ? If I understand that correctly it handles sources that can play sound files. Not any sounds that are actively playing.
The reason why this is so important for narration is that if the player skips dialogue we want to cancel the voiceover.

[mentos987]

For 3, yes, we would like to use the GPU for IPFs, but we're not quite there yet.

That is fine, this is not a major issue.

[Celtic_Minstrel]

Do you mean wesnoth.audio.sources ? If I understand that correctly it handles sources that can play sound files. Not any sounds that are actively playing.
The reason why this is so important for narration is that if the player skips dialogue we want to cancel the voiceover.

The intended use-case for sound sources is to support spatialized sound that can fade away as you move further away from it. However, it's entirely possible to use it for other things, and I think there's a pretty good chance that it could do what you want. In fact, I think they've been used for narration before by other people.

That said, there should probably be a function to stop a non-source sound as well… it just doesn't come up much because they're usually used for short sound effects.

[mentos987]

The intended use-case for sound sources is to support spatialized sound that can fade away as you move further away from it. However, it's entirely possible to use it for other things, and I think there's a pretty good chance that it could do what you want. In fact, I think they've been used for narration before by other people.

I did not dig deep into this subject but I talked to several modders and they said it is not possible. The workaround that other mods uses is to run the narration as music and to run a "silent track" to mute the narration. A very clunky solution with a lot of issues.

(I have not tested this) I think that the effects "sound that can fade away as you move further away from it" only changes the initial setup of a sound and its repetition. I do not think you can stop any sound that is playing, unless it is playing on repeat, in which case you can only prevent it from repeating.

[Celtic_Minstrel]

I do not think you can stop any sound that is playing, unless it is playing on repeat, in which case you can only prevent it from repeating.

You can remove a sound source from the map. If it still continues to play after you do that, then that's clearly a bug.

[mentos987]

You can remove a sound source from the map. If it still continues to play after you do that, then that's clearly a bug.

Just tested it and I was wrong. You can instantly cancel a playing sound by using:

Spoiler:

wesnoth.audio.sources["windy"] = {locations={79,92}, sounds={"data/add-ons/Town_of_Arnsreach/sounds/windy.wav"}, loop=-1, range=50, fade_range=66, chance=100, delay=0, check_fogged=false, check_shrouded=false}

then:

Spoiler:

wesnoth.audio.sources["windy"] = nil

My apologies

An added fade out option to this function would be nice, for those that wants to suddenly stop the sound.