Introduce egs_items_db for items database management.

ebin/egs.app

@@ -8,6 +8,7 @@
 		egs_sup,
 		egs_conf,
 		egs_seasons,
+		egs_items_db,
 		egs_game_server,
 		egs_login_server,
 		egs_exit_mon,

include/records.hrl

@@ -128,3 +128,24 @@
 %% @doc Hit response data.
 
 -record(hit_response, {type, user, exp, damage, targethp, targetse, events}).
+
+%% @doc Items.
+
+-record(psu_element, {type, percent}).
+-record(psu_pa, {type, level}).
+
+-record(psu_item, {name, rarity, buy_price, sell_price, data}).
+-record(psu_clothing_item, {appearance, type, manufacturer, overlap, gender, colors}).
+-record(psu_consumable_item, {max_quantity, pt_diff, status_effect, action, target, use_condition, item_effect}).
+-record(psu_parts_item, {appearance, type, manufacturer, overlap, gender}).
+-record(psu_special_item, {}).
+-record(psu_striking_weapon_item, {pp, atp, ata, atp_req, shop_element, hand, max_upgrades, attack_label,
+	attack_sound, hitbox_a, hitbox_b, hitbox_c, hitbox_d, nb_targets, effect, model}).
+-record(psu_trap_item, {max_quantity, effect, type}).
+
+-record(psu_clothing_item_variables, {color}).
+-record(psu_consumable_item_variables, {quantity}).
+-record(psu_parts_item_variables, {}).
+-record(psu_special_item_variables, {}).
+-record(psu_striking_weapon_item_variables, {is_active=0, slot=0, current_pp, max_pp, element, pa=#psu_pa{type=0, level=0}}).
+-record(psu_trap_item_variables, {quantity}).

src/egs_char_select.erl

@@ -21,7 +21,6 @@
 -export([keepalive/1, info/2, cast/3, raw/3, event/2]).
 
 -include("include/records.hrl").
--include("include/psu/items.hrl").
 
 %% @doc Send a keepalive.
 keepalive(#state{socket=Socket}) ->

src/egs_game.erl

@@ -384,7 +384,7 @@ event({item_equip, ItemIndex, TargetGID, TargetLID, A, B}, #state{gid=GID}) ->
 			psu_game:send(<< 16#01050300:32, 0:64, TargetGID:32/little, 0:64, 16#00011300:32, GID:32/little, 0:64,
 				TargetGID:32/little, TargetLID:32/little, ItemIndex:8, 1:8, Category:8, A:8, B:32/little >>);
 		{ItemID, Variables} when element(1, Variables) =:= psu_striking_weapon_item_variables ->
-			#psu_item{data=Constants} = proplists:get_value(ItemID, ?ITEMS),
+			#psu_item{data=Constants} = egs_items_db:read(ItemID),
 			#psu_striking_weapon_item{attack_sound=Sound, hitbox_a=HitboxA, hitbox_b=HitboxB,
 				hitbox_c=HitboxC, hitbox_d=HitboxD, nb_targets=NbTargets, effect=Effect, model=Model} = Constants,
 			<< Category:8, _:24 >> = << ItemID:32 >>,
@@ -396,7 +396,7 @@ event({item_equip, ItemIndex, TargetGID, TargetLID, A, B}, #state{gid=GID}) ->
 				TargetGID:32/little, TargetLID:32/little, ItemIndex:8, 1:8, Category:8, A:8, B:32/little,
 				SoundInt:32/little, HitboxA:16, HitboxB:16, HitboxC:16, HitboxD:16, SoundType:4, NbTargets:4, 0:8, Effect:8, Model:8 >>);
 		{ItemID, Variables} when element(1, Variables) =:= psu_trap_item_variables ->
-			#psu_item{data=#psu_trap_item{effect=Effect, type=Type}} = proplists:get_value(ItemID, ?ITEMS),
+			#psu_item{data=#psu_trap_item{effect=Effect, type=Type}} = egs_items_db:read(ItemID),
 			<< Category:8, _:24 >> = << ItemID:32 >>,
 			Bin = case Type of
 				damage   -> << Effect:8, 16#0c0a05:24, 16#20140500:32, 16#0001c800:32, 16#10000000:32 >>;
@@ -529,7 +529,7 @@ event({npc_shop_buy, ShopItemIndex, QuantityOrColor}, State=#state{gid=GID}) ->
 	ShopID = egs_user_model:shop_get(GID),
 	ItemID = lists:nth(ShopItemIndex + 1, proplists:get_value(ShopID, ?SHOPS)),
 	log("npc shop ~p buy itemid ~8.16.0b quantity/color+1 ~p", [ShopID, ItemID, QuantityOrColor]),
-	#psu_item{name=Name, rarity=Rarity, buy_price=BuyPrice, sell_price=SellPrice, data=Constants} = proplists:get_value(ItemID, ?ITEMS),
+	#psu_item{name=Name, rarity=Rarity, buy_price=BuyPrice, sell_price=SellPrice, data=Constants} = egs_items_db:read(ItemID),
 	Variables = case element(1, Constants) of
 		psu_clothing_item ->
 			if	QuantityOrColor >= 1, QuantityOrColor =< 10 ->

src/egs_items_db.erl

@@ -0,0 +1,79 @@
+%% @author Loïc Hoguin <essen@dev-extend.eu>
+%% @copyright 2010 Loïc Hoguin.
+%% @doc EGS items database.
+%%
+%%	This file is part of EGS.
+%%
+%%	EGS is free software: you can redistribute it and/or modify
+%%	it under the terms of the GNU Affero General Public License as
+%%	published by the Free Software Foundation, either version 3 of the
+%%	License, or (at your option) any later version.
+%%
+%%	EGS is distributed in the hope that it will be useful,
+%%	but WITHOUT ANY WARRANTY; without even the implied warranty of
+%%	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+%%	GNU Affero General Public License for more details.
+%%
+%%	You should have received a copy of the GNU Affero General Public License
+%%	along with EGS.  If not, see <http://www.gnu.org/licenses/>.
+
+-module(egs_items_db).
+-behavior(gen_server).
+-export([start_link/0, stop/0, read/1, reload/0]). %% API.
+-export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). %% gen_server.
+
+%% Use the module name for the server's name.
+-define(SERVER, ?MODULE).
+
+-include("include/records.hrl").
+-include("priv/items.hrl").
+
+%% API.
+
+%% @spec start_link() -> {ok,Pid::pid()}
+start_link() ->
+	gen_server:start_link({local, ?SERVER}, ?MODULE, [], []).
+
+%% @spec stop() -> stopped
+stop() ->
+	gen_server:call(?SERVER, stop).
+
+%% @spec read(ItemID) -> term() | undefined
+read(ItemID) ->
+	gen_server:call(?SERVER, {read, ItemID}).
+
+%% @spec reload() -> ok
+reload() ->
+	gen_server:cast(?SERVER, reload).
+
+%% gen_server.
+
+init([]) ->
+	error_logger:info_report("egs_items_db started"),
+	{ok, undefined}.
+
+handle_call({read, ItemID}, _From, State) ->
+	{reply, proplists:get_value(ItemID, ?ITEMS), State};
+
+handle_call(stop, _From, State) ->
+	{stop, normal, stopped, State};
+
+handle_call(_Request, _From, State) ->
+	{reply, ignored, State}.
+
+%% @doc Compile this file here and let the reloader reload the code properly.
+handle_cast(reload, State) ->
+	compile:file(?FILE, [verbose, report_errors, report_warnings, {outdir, "ebin/"}]),
+	{noreply, State};
+
+handle_cast(_Msg, State) ->
+	{noreply, State}.
+
+handle_info(_Info, State) ->
+	{noreply, State}.
+
+terminate(_Reason, _State) ->
+	ok.
+
+code_change(_OldVsn, State, _Extra) ->
+	{ok, State}.

src/egs_sup.erl

@@ -55,6 +55,7 @@ init([]) ->
 	LoginProcs = [{{egs_login_server, Port}, {egs_login_server, start_link, [Port]}, permanent, 5000, worker, dynamic} || Port <- LoginPorts],
 	OtherProcs = [
 		{egs_seasons, {egs_seasons, start_link, []}, permanent, 5000, worker, dynamic},
+		{egs_items_db, {egs_items_db, start_link, []}, permanent, 5000, worker, dynamic},
 		{egs_user_model, {egs_user_model, start_link, []}, permanent, 5000, worker, dynamic},
 		{egs_game_server, {egs_game_server, start_link, [GamePort]}, permanent, 5000, worker, dynamic}
 	],

src/egs_user_model.erl

@@ -27,7 +27,6 @@
 -define(TABLE, ?MODULE).
 
 -include("include/records.hrl").
--include("include/psu/items.hrl").
 -include_lib("stdlib/include/qlc.hrl").
 
 %% @spec do(Q) -> Record
@@ -166,7 +165,7 @@ handle_call({item_add, GID, ItemID, Variables}, _From, State) ->
 	Inventory = Character#characters.inventory,
 	Inventory2 = case Variables of
 		#psu_consumable_item_variables{quantity=Quantity} ->
-			#psu_item{data=#psu_consumable_item{max_quantity=MaxQuantity}} = proplists:get_value(ItemID, ?ITEMS),
+			#psu_item{data=#psu_consumable_item{max_quantity=MaxQuantity}} = egs_items_db:read(ItemID),
 			{ItemID, #psu_consumable_item_variables{quantity=Quantity2}} = case lists:keyfind(ItemID, 1, Inventory) of
 				false -> New = true, {ItemID, #psu_consumable_item_variables{quantity=0}};
 				Tuple -> New = false, Tuple
@@ -176,7 +175,7 @@ handle_call({item_add, GID, ItemID, Variables}, _From, State) ->
 				lists:keystore(ItemID, 1, Inventory, {ItemID, #psu_consumable_item_variables{quantity=Quantity3}})
 			end;
 		#psu_trap_item_variables{quantity=Quantity} ->
-			#psu_item{data=#psu_trap_item{max_quantity=MaxQuantity}} = proplists:get_value(ItemID, ?ITEMS),
+			#psu_item{data=#psu_trap_item{max_quantity=MaxQuantity}} = egs_items_db:read(ItemID),
 			{ItemID, #psu_trap_item_variables{quantity=Quantity2}} = case lists:keyfind(ItemID, 1, Inventory) of
 				false -> New = true, {ItemID, #psu_trap_item_variables{quantity=0}};
 				Tuple -> New = false, Tuple
@@ -236,7 +235,7 @@ handle_cast({item_qty_add, GID, ItemIndex, QuantityDiff}, State) ->
 	{ItemID, Variables} = lists:nth(ItemIndex + 1, Inventory),
 	case Variables of
 		#psu_trap_item_variables{quantity=Quantity} ->
-			#psu_item{data=#psu_trap_item{max_quantity=MaxQuantity}} = proplists:get_value(ItemID, ?ITEMS),
+			#psu_item{data=#psu_trap_item{max_quantity=MaxQuantity}} = egs_items_db:read(ItemID),
 			Quantity2 = Quantity + QuantityDiff,
 			if	Quantity2 =:= 0 ->
 					Inventory2 = string:substr(Inventory, 1, ItemIndex) ++ string:substr(Inventory, ItemIndex + 2);

src/psu/psu_game.erl

@@ -23,7 +23,6 @@
 -include("include/records.hrl").
 -include("include/maps.hrl").
 -include("include/missions.hrl").
--include("include/psu/items.hrl").
 -include("include/psu/npc.hrl").
 
 %% @doc Load and send the character information to the client.
@@ -226,7 +225,7 @@ send_010a(ItemsList) ->
 build_010a_list([], Acc) ->
 	iolist_to_binary(lists:reverse(Acc));
 build_010a_list([ItemID|Tail], Acc) ->
-	#psu_item{name=Name, rarity=Rarity, buy_price=SellPrice, data=Data} = proplists:get_value(ItemID, ?ITEMS),
+	#psu_item{name=Name, rarity=Rarity, buy_price=SellPrice, data=Data} = egs_items_db:read(ItemID),
 	UCS2Name = << << X:8, 0:8 >> || X <- Name >>,
 	NamePadding = 8 * (46 - byte_size(UCS2Name)),
 	RarityBin = Rarity - 1,
@@ -364,18 +363,18 @@ build_0a0a_item_variables([{ItemID, Variables}|Tail], N, Acc) ->
 	build_0a0a_item_variables(Tail, N + 1, [build_item_variables(ItemID, N, Variables)|Acc]).
 
 build_item_variables(ItemID, ItemUUID, #psu_clothing_item_variables{color=ColorNb}) ->
-	#psu_item{rarity=Rarity, data=#psu_clothing_item{colors=ColorsBin}} = proplists:get_value(ItemID, ?ITEMS),
+	#psu_item{rarity=Rarity, data=#psu_clothing_item{colors=ColorsBin}} = egs_items_db:read(ItemID),
 	RarityInt = Rarity - 1,
 	ColorInt = if ColorNb < 5 -> ColorNb; true -> 16#10 + ColorNb - 5 end,
 	Bits = ColorNb * 8,
 	<< _Before:Bits, ColorA:4, ColorB:4, _After/bits >> = ColorsBin,
 	<< 0:32, ItemUUID:32/little, ItemID:32, 0:88, RarityInt:8, ColorA:8, ColorB:8, ColorInt:8, 0:72 >>;
 build_item_variables(ItemID, ItemUUID, #psu_consumable_item_variables{quantity=Quantity}) ->
-	#psu_item{rarity=Rarity, data=#psu_consumable_item{max_quantity=MaxQuantity, action=Action}} = proplists:get_value(ItemID, ?ITEMS),
+	#psu_item{rarity=Rarity, data=#psu_consumable_item{max_quantity=MaxQuantity, action=Action}} = egs_items_db:read(ItemID),
 	RarityInt = Rarity - 1,
 	<< 0:32, ItemUUID:32/little, ItemID:32, Quantity:32/little, MaxQuantity:32/little, 0:24, RarityInt:8, Action:8, 0:88 >>;
 build_item_variables(ItemID, ItemUUID, #psu_parts_item_variables{}) ->
-	#psu_item{rarity=Rarity} = proplists:get_value(ItemID, ?ITEMS),
+	#psu_item{rarity=Rarity} = egs_items_db:read(ItemID),
 	RarityInt = Rarity - 1,
 	<< 0:32, ItemUUID:32/little, ItemID:32, 0:88, RarityInt:8, 0:96 >>;
 %% @todo Handle rank, rarity and hands properly.
@@ -402,7 +401,7 @@ build_item_variables(ItemID, ItemUUID, #psu_special_item_variables{}) ->
 	end,
 	<< 0:32, ItemUUID:32/little, ItemID:32, 0:24, 16#80:8, 0:56, 16#80:8, 0:32, Action/binary, 0:32 >>;
 build_item_variables(ItemID, ItemUUID, #psu_trap_item_variables{quantity=Quantity}) ->
-	#psu_item{rarity=Rarity, data=#psu_trap_item{max_quantity=MaxQuantity}} = proplists:get_value(ItemID, ?ITEMS),
+	#psu_item{rarity=Rarity, data=#psu_trap_item{max_quantity=MaxQuantity}} = egs_items_db:read(ItemID),
 	RarityInt = Rarity - 1,
 	<< 0:32, ItemUUID:32/little, ItemID:32, Quantity:32/little, MaxQuantity:32/little, 0:24, RarityInt:8, 0:96 >>.
 
@@ -411,7 +410,7 @@ build_0a0a_item_constants([], Acc) ->
 	Padding = 34560 - 8 * byte_size(Bin),
 	<< Bin/binary, 0:Padding >>;
 build_0a0a_item_constants([{ItemID, _Variables}|Tail], Acc) ->
-	#psu_item{name=Name, rarity=Rarity, sell_price=SellPrice, data=Data} = proplists:get_value(ItemID, ?ITEMS),
+	#psu_item{name=Name, rarity=Rarity, sell_price=SellPrice, data=Data} = egs_items_db:read(ItemID),
 	UCS2Name = << << X:8, 0:8 >> || X <- Name >>,
 	NamePadding = 8 * (46 - byte_size(UCS2Name)),
 	<< Category:8, _:24 >> = << ItemID:32 >>,