psu_characters: Parse and validate character options.

Emakefile

@@ -24,3 +24,4 @@
 {'src/egs_patch.erl', [{outdir, "ebin"}]}.
 {'src/egs_proto.erl', [{outdir, "ebin"}]}.
 {'src/psu_appearance.erl', [{outdir, "ebin"}]}.
+{'src/psu_characters.erl', [{outdir, "ebin"}]}.

include/records.hrl

@@ -27,3 +27,7 @@
 -record(metal_appearance, {voicetype, voicepitch, torso, legs, arms, ears, face, headtype, maincolor, lineshieldcolor,
 	eyebrows, eyelashes, eyesgroup, eyes, eyescolory, eyescolorx, bodycolor, subcolor, hairstylecolory, hairstylecolorx,
 	proportion, proportionboxx, proportionboxy, faceboxx, faceboxy}).
+
+-record(options, {textdisplayspeed, sound, musicvolume, soundeffectvolume, vibration, radarmapdisplay,
+	cutindisplay, mainmenucursorposition, camera3y, camera3x, camera1y, camera1x, controller, weaponswap,
+	lockon, brightness, functionkeysetting, buttondetaildisplay}).

src/egs.erl

@@ -21,7 +21,7 @@
 
 -include("include/records.hrl").
 
--define(MODULES, [egs, egs_cron, egs_db, egs_game, egs_login, egs_patch, egs_proto, psu_appearance]).
+-define(MODULES, [egs, egs_cron, egs_db, egs_game, egs_login, egs_patch, egs_proto, psu_appearance, psu_characters]).
 
 %% @doc Start all the application servers. Return the PIDs of the listening processes.
 

src/egs_game.erl

@@ -787,10 +787,14 @@ handle(16#0d04, Data) ->
 
 %% @doc Options changes handler.
 
-handle(16#0d07, << Options/bits >>) ->
+handle(16#0d07, Data) ->
 	log("options changes"),
+	% Translate options into a tuple, validate them and do nothing with it for now
+	Options = psu_characters:options_binary_to_tuple(Data),
+	psu_characters:validate_options(Options),
+	% End of validation
 	User = egs_db:users_select(get(gid)),
-	file:write_file(io_lib:format("save/~s/~b-character.options", [User#users.folder, User#users.charnumber]), Options);
+	file:write_file(io_lib:format("save/~s/~b-character.options", [User#users.folder, User#users.charnumber]), Data);
 
 %% @doc Hit handler.
 %% @todo Finish the work on it.

src/psu_characters.erl

@@ -0,0 +1,65 @@
+%	EGS: Erlang Game Server
+%	Copyright (C) 2010  Loic Hoguin
+%
+%	This file is part of EGS.
+%
+%	EGS is free software: you can redistribute it and/or modify
+%	it under the terms of the GNU 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 General Public License for more details.
+%
+%	You should have received a copy of the GNU General Public License
+%	along with EGS.  If not, see <http://www.gnu.org/licenses/>.
+
+-module(psu_characters).
+-export([options_binary_to_tuple/1, options_tuple_to_binary/1, validate_options/1]).
+
+-include("include/records.hrl").
+
+%% @doc Convert the binary options data into a tuple.
+%%      The few unknown values are probably PS2 or 360 only.
+
+options_binary_to_tuple(Binary) ->
+	<<	TextDisplaySpeed:8, Sound:8, MusicVolume:8, SoundEffectVolume:8, Vibration:8, RadarMapDisplay:8,
+		CutInDisplay:8, MainMenuCursorPosition:8, _:8, Camera3rdY:8, Camera3rdX:8, Camera1stY:8, Camera1stX:8,
+		Controller:8, WeaponSwap:8, LockOn:8, Brightness:8, FunctionKeySetting:8, _:8, ButtonDetailDisplay:8, _:32 >> = Binary,
+	{options, TextDisplaySpeed, Sound, MusicVolume, SoundEffectVolume, Vibration, RadarMapDisplay,
+		CutInDisplay, MainMenuCursorPosition, Camera3rdY, Camera3rdX, Camera1stY, Camera1stX,
+		Controller, WeaponSwap, LockOn, Brightness, FunctionKeySetting, ButtonDetailDisplay}.
+
+%% @doc Convert a tuple of options data into a binary to be sent to clients.
+%% @todo Write the function body!
+
+options_tuple_to_binary(_Tuple) ->
+	{error, todo}.
+
+%% @doc Validate the options data.
+%%      Trigger an exception rather than handling errors.
+
+validate_options(Tuple) ->
+	{options, TextDisplaySpeed, Sound, MusicVolume, SoundEffectVolume, Vibration, RadarMapDisplay,
+		CutInDisplay, MainMenuCursorPosition, Camera3rdY, Camera3rdX, Camera1stY, Camera1stX,
+		Controller, WeaponSwap, LockOn, Brightness, FunctionKeySetting, ButtonDetailDisplay} = Tuple,
+	true = TextDisplaySpeed =< 1,
+	true = Sound =< 1,
+	true = MusicVolume =< 9,
+	true = SoundEffectVolume =< 9,
+	true = Vibration =< 1,
+	true = RadarMapDisplay =< 1,
+	true = CutInDisplay =< 1,
+	true = MainMenuCursorPosition =< 1,
+	true = Camera3rdY =< 1,
+	true = Camera3rdX =< 1,
+	true = Camera1stY =< 1,
+	true = Camera1stX =< 1,
+	true = Controller =< 1,
+	true = WeaponSwap =< 1,
+	true = LockOn =< 1,
+	true = Brightness =< 4,
+	true = FunctionKeySetting =< 1,
+	true = ButtonDetailDisplay =< 2.