Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add different place sound for nodes
  • Loading branch information
PilzAdam committed Mar 29, 2013
1 parent 7d9329e commit 5e7e034
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 8 deletions.
4 changes: 4 additions & 0 deletions doc/lua_api.txt
Expand Up @@ -1514,6 +1514,9 @@ Item definition (register_node, register_craftitem, register_tool)
^ Otherwise should be name of node which the client immediately places
on ground when the player places the item. Server will always update
actual result to client in a short moment.
sound = {
place = <SimpleSoundSpec>,
}

on_place = func(itemstack, placer, pointed_thing),
^ Shall place item and return the leftover itemstack
Expand Down Expand Up @@ -1581,6 +1584,7 @@ Node definition (register_node)
footstep = <SimpleSoundSpec>,
dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
dug = <SimpleSoundSpec>,
place = <SimpleSoundSpec>,
},

on_construct = func(pos),
Expand Down
2 changes: 2 additions & 0 deletions games/minimal/mods/default/init.lua
Expand Up @@ -659,6 +659,8 @@ function default.node_sound_dirt_defaults(table)
{name="", gain=0.5}
--table.dug = table.dug or
-- {name="default_dirt_break", gain=0.5}
table.place = table.place or
{name="default_grass_footstep", gain=0.5}
default.node_sound_defaults(table)
return table
end
Expand Down
1 change: 1 addition & 0 deletions src/clientserver.h
Expand Up @@ -87,6 +87,7 @@ SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed);
TOCLIENT_DELETE_PARTICLESPAWNER
PROTOCOL_VERSION 18:
damageGroups added to ToolCapabilities
sound_place added to ItemDefinition
*/

#define LATEST_PROTOCOL_VERSION 18
Expand Down
8 changes: 3 additions & 5 deletions src/game.cpp
Expand Up @@ -2394,11 +2394,6 @@ void the_game(
}
}

// We can't actually know, but assume the sound of right-clicking
// to be the sound of placing a node
soundmaker.m_player_rightpunch_sound.gain = 0.5;
soundmaker.m_player_rightpunch_sound.name = "default_place_node";

/*
Handle digging
*/
Expand Down Expand Up @@ -2617,6 +2612,9 @@ void the_game(
<<") - Position not loaded"<<std::endl;
}
}while(0);

// Read the sound
soundmaker.m_player_rightpunch_sound = def.sound_place;
}
}
}
Expand Down
30 changes: 27 additions & 3 deletions src/itemdef.cpp
Expand Up @@ -75,6 +75,7 @@ ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
}
groups = def.groups;
node_placement_prediction = def.node_placement_prediction;
sound_place = def.sound_place;
return *this;
}

Expand Down Expand Up @@ -107,13 +108,17 @@ void ItemDefinition::reset()
tool_capabilities = NULL;
}
groups.clear();
sound_place = SimpleSoundSpec();

node_placement_prediction = "";
}

void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
{
writeU8(os, 1); // version
if(protocol_version <= 17)
writeU8(os, 1); // version
else
writeU8(os, 2); // version
writeU8(os, type);
os<<serializeString(name);
os<<serializeString(description);
Expand All @@ -137,6 +142,11 @@ void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
writeS16(os, i->second);
}
os<<serializeString(node_placement_prediction);
if(protocol_version > 17){
//serializeSimpleSoundSpec(sound_place, os);
os<<serializeString(sound_place.name);
writeF1000(os, sound_place.gain);
}
}

void ItemDefinition::deSerialize(std::istream &is)
Expand All @@ -146,7 +156,7 @@ void ItemDefinition::deSerialize(std::istream &is)

// Deserialize
int version = readU8(is);
if(version != 1)
if(version != 1 && version != 2)
throw SerializationError("unsupported ItemDefinition version");
type = (enum ItemType)readU8(is);
name = deSerializeString(is);
Expand All @@ -171,10 +181,24 @@ void ItemDefinition::deSerialize(std::istream &is)
int value = readS16(is);
groups[name] = value;
}
if(version == 1){
// We cant be sure that node_placement_prediction is send in version 1
try{
node_placement_prediction = deSerializeString(is);
}catch(SerializationError &e) {};
// Set the old default sound
sound_place.name = "default_place_node";
sound_place.gain = 0.5;
} else if(version == 2) {
node_placement_prediction = deSerializeString(is);
//deserializeSimpleSoundSpec(sound_place, is);
sound_place.name = deSerializeString(is);
sound_place.gain = readF1000(is);
}
// If you add anything here, insert it primarily inside the try-catch
// block to not need to increase the version.
try{
node_placement_prediction = deSerializeString(is);

}catch(SerializationError &e) {};
}

Expand Down
2 changes: 2 additions & 0 deletions src/itemdef.h
Expand Up @@ -26,6 +26,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
#include <iostream>
#include <set>
#include "itemgroup.h"
#include "sound.h"
class IGameDef;
struct ToolCapabilities;

Expand Down Expand Up @@ -66,6 +67,7 @@ struct ItemDefinition
// May be NULL. If non-NULL, deleted by destructor
ToolCapabilities *tool_capabilities;
ItemGroupList groups;
SimpleSoundSpec sound_place;

// Client shall immediately place this node when player places the item.
// Server will update the precise end result a moment later.
Expand Down
8 changes: 8 additions & 0 deletions src/scriptapi_item.cpp
Expand Up @@ -96,6 +96,14 @@ ItemDefinition read_item_definition(lua_State *L, int index,
read_groups(L, -1, def.groups);
lua_pop(L, 1);

lua_getfield(L, index, "sounds");
if(lua_istable(L, -1)){
lua_getfield(L, -1, "place");
read_soundspec(L, -1, def.sound_place);
lua_pop(L, 1);
}
lua_pop(L, 1);

// Client shall immediately place this node when player places the item.
// Server will update the precise end result a moment later.
// "" = no prediction
Expand Down

0 comments on commit 5e7e034

Please sign in to comment.