Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle positional sounds initating from a player's spot #1257

Merged
merged 1 commit into from
Jan 2, 2024
Merged

Handle positional sounds initating from a player's spot #1257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 38 additions & 5 deletions mods/ctf/ctf_combat/ctf_ranged/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,36 @@ function ctf_ranged.can_use_gun(player, name)
return true
end

--- Play ephemeral sound on the spot of a player.
-- @param user ObjectRef: The player object.
-- @param sound_name str: The name of the sound to be played.
-- @param spec? table: The SimpleSoundSpec of the sound. Some fields are overriden.
local function play_player_positional_sound(user, sound_name, spec)
-- This function handles positional sounds that are
-- supposed to be heared equally on both left and right channel
-- by the user, while being heared at the position of the player
-- by other players.
-- Such a mechanism is mainly used on gunshot sounds,
-- so the ephemeral flag is set.

-- The spec table is copied as a base for the SimpleSoundSpec.
-- If not supplied, one is created without any customizations.

local user_name = user:get_player_name()

-- Two copies of SimpleSoundSpec

local non_user_spec = spec and table.copy(spec) or {}
non_user_spec.pos = user:get_pos()
non_user_spec.exclude_player = user_name

local user_spec = spec and table.copy(spec) or {}
user_spec.to_player = user_name

minetest.sound_play(sound_name, non_user_spec, true)
minetest.sound_play(sound_name, user_spec, true)
end

function ctf_ranged.simple_register_gun(name, def)
minetest.register_tool(rawf.also_register_loaded_tool(name, {
description = def.description,
Expand All @@ -100,18 +130,21 @@ function ctf_ranged.simple_register_gun(name, def)
groups = {ranged = 1, [def.type] = 1, tier = def.tier or 1, not_in_creative_inventory = 1},
on_use = function(itemstack, user)
if not ctf_ranged.can_use_gun(user, name) then
minetest.sound_play("ctf_ranged_click", {pos = user:get_pos()}, true)
play_player_positional_sound(user, "ctf_ranged_click")
return
end

local result = rawf.load_weapon(itemstack, user:get_inventory())

local sound_name
if result:get_name() == itemstack:get_name() then
minetest.sound_play("ctf_ranged_click", {pos = user:get_pos()}, true)
sound_name = "ctf_ranged_click"
else
minetest.sound_play("ctf_ranged_reload", {pos = user:get_pos()}, true)
sound_name = "ctf_ranged_reload"
end

play_player_positional_sound(user, sound_name)

return result
end,
},
Expand All @@ -124,7 +157,7 @@ function ctf_ranged.simple_register_gun(name, def)
loaded_def.on_secondary_use = def.on_secondary_use
loaded_def.on_use = function(itemstack, user)
if not ctf_ranged.can_use_gun(user, name) then
minetest.sound_play("ctf_ranged_click", {pos = user:get_pos()}, true)
play_player_positional_sound(user, "ctf_ranged_click")
return
end

Expand Down Expand Up @@ -159,7 +192,7 @@ function ctf_ranged.simple_register_gun(name, def)
rays = rawf.spread_bulletcast(def.bullet, spawnpos, endpos, true, true)
end

minetest.sound_play(def.fire_sound, {pos = user:get_pos()}, true)
play_player_positional_sound(user, def.fire_sound)

for _, ray in pairs(rays) do
process_ray(ray, user, look_dir, def)
Expand Down
Loading