lzrtag-base 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e1aba4b3577f72ee4c4aca45caca65e157cfa522
-  data.tar.gz: 9582f9f9a6c478c97de4c837ad6eadfb2c44c451
+SHA256:
+  metadata.gz: ecf85ea86bb74b299da65766ec5c0d653416b605863e93ba833970e0db78fbbc
+  data.tar.gz: 460e8d9cdc4b01522e1373efc4a3b3417161e717c8848d4c2abce8fb3c4c7fb8
 SHA512:
-  metadata.gz: a2a6bcaeefeddece09a26ee91e9dd608aa5d8450dc4ff943b23d01ad995f07533cdcc278336b37e92873de1f9cc4ce468e66df5806225e01c8ce23acb18eb313
-  data.tar.gz: f5dea5415de79a54ab9c4d5bd7e81e774daae5498d4b6005c21a68c5d9ddba6f9ca7540b1159f78cffa786507d19d25f52a1d3153320e70c64234db833616f64
+  metadata.gz: 10676d8495f7148b646fc3cc4a4025c2a0f4d37e8c4e75543668fc19d9bad2f8dbffae747393a5670c34f54021833d67ed77d3086dca8f15aca4e1bcadf5698c
+  data.tar.gz: d64f580c72c66e25b13dafa2e8dfcc93cd2cacb6265416caecc1312bc8f794b351bf5254ac579af099c1bac50ba1113dab3e613197d305e7b9aad3a2148841cd

data/README.md

@@ -25,6 +25,7 @@ ruby console. It's a great way to see the immediate effects of various commands
 on the set, and is kinda fun, too.
 
 Let's first start up the console and require the library.
+
 ```IRB
 irb(main):001:0> require 'lzrtag.rb'
 => true

data/docs/EventSymbols.md

@@ -15,6 +15,11 @@ It is only triggered when a game is present.
 *Game class alternative:* Describe per-tick code using the
 "phase" DSL. It allows easy and clean specification of tick code.
 
+###### :slowTick
+Sent in regular intervals (0.5s) as a slower alternative to :gameTick for less
+critical tasks. This for example handles player beacon entering/leaving as well
+as slow timeouts.
+
 ###### :gameStarting
 Triggered when a new game is selected, either in Ruby or via MQTT.  
 Payload is [newGame]
@@ -86,6 +91,22 @@ Payload is [thePlayer, newGun, oldGun]
 *TODO:* The gun number should be replaced by an ID string, when the
 gun configuration is moved to a Filesystem-based one (possibly by loading from JSON)
 
+###### :playerEnteredBeacon
+Triggered once when a player receives a new IR Beacon signal, of a beacon that
+he has not seen for the last 3s, to indicate that the Player entered a new zone.  
+Payload is [thePlayer, beaconID]
+
+###### :playerInBeacon
+Triggered for every single beacon pulse a player receives from a IR Beacon.  
+This can be useful to handle time-continuous beacon interaction, such as being
+healed by a beacon, or a capture point.  
+Payload is [thePlayer, beaconID]
+
+###### :playerLeftBeacon
+Triggered once when a player does not see a beacon ID for at least 3s, indicating
+that the player has left a zone.  
+Payload is [thePlayer, beaconID]
+
 ## Player life signals
 These signals are sent whenever the player's HP count or life status is changed,
 and let the application handle things like scoring damage and kills, and triggering

data/docs/MQTTBranches.md

@@ -1,5 +1,17 @@
 # MQTT Branch setup description
 
+## Game Branches
+
+- Lasertag/Game/Events/Hits
+- Lasertag/Game/Controls/+
+	- SetPhase
+	- SetGame
+- Lasertag/Game/Phase/Valid
+- Lasertag/Game/ParticipatingPlayers
+- Lasertag/Game/KnownGames
+- Lasertag/Game/CurrentGame
+- Lasertag/Game/Phase/Current
+
 ## Weapon Branches
 The weapons are the main unit of the Lasertag system. As such, they use a specific
 branch setup to minimize traffic to them, while making code maintaining easier.
@@ -39,6 +51,7 @@ They are slow-changing configuration parameters for the weapons.
 |Heartbeat|"1" or "0"|Enables/Disables heartbeat of the weapon|Yes|
 |Hit|STR Number|Number, in seconds, to make the gun show that it's hit|No|
 |Vibrate|STR Number|Number, in seconds, for which to make the gun vibrate|No|
+|Reload|"1"|Trigger a gun-side reloading|No|
 
 ### Sound attributes
 
@@ -60,6 +73,7 @@ They all relate to the hardware of the system, such as battery etc.
 |Ping|uint32_t[3]|Battery, free-heap and ping data|No|
 |NSwitch|STR Number|Navigation switch press info (0-3)|No|
 |Gyro|String|Clear string of the pose the gyroscope is reporting|Yes|
+|BeaconDetect|STR Number|Number of the beacon signal that was detected (0-255)|No|
 
 ### Statistics Attributes
 
@@ -70,5 +84,6 @@ They all relate to various game statistics that do not directly influence the ha
 |Key|Data|Descrition|Retained|
 |--|--|--|--|
 |HP|STR Number|Float number, 0  to 100 (or more with shields)|Yes|
-|Ammo|uint32_t[2]|Current and Max ammo of the weapon|Yes|
-|Ammo/Set|STR Number|Give the player some ammo (*WIP*)|No|
+|Ammo|uint32_t[3]|Current Clip ammo, max clip size and reserve ammo|No|
+|Ammo/SetClip|STR Number|Set the amount of ammo in the player's clip|No|
+|Ammo/SetReserve|STR Number| Set the amount of ammo in the player's reserve|No|

data/lib/lzrtag/game/base_game.rb

@@ -17,7 +17,7 @@ module LZRTag
 		#
 		#      hook :dmgHook, LZRTag::Hook::Damager
 		#
-		#      phase :running do |deltaTick|
+		#      phase :starting do |deltaTick|
 		#         puts "I tick!"
 		#      end
 		#
@@ -81,9 +81,9 @@ module LZRTag
 			def initialize(handler)
 				super(handler)
 
-				@hookList = Array.new();
+				@hookList = Hash.new();
 				self.class.get_hooks().each do |hookID, hookData|
-					@hookList << hookData[0].new(@handler, **hookData[1])
+					@hookList[hookID] = hookData[0].new(@handler, **hookData[1])
 				end
 
 				@tickTime = 0.1;
@@ -113,7 +113,7 @@ module LZRTag
 					raise ArgumentError, "Hook needs to be a LZR::Hook!"
 				end
 				raise ArgumentError, "Hook options need to be a hash" unless hookOptions.is_a? Hash
-				get_hooks()[hookID] << [hookType, hookOptions];
+				get_hooks()[hookID] = [hookType, hookOptions];
 			end
 
 			# DSL function to provide a phase tick code to this game
@@ -188,7 +188,7 @@ module LZRTag
 					end
 				end
 
-				@hookList.each do |hook|
+				@hookList.each do |hookID, hook|
 					hook.consume_event(evt, data);
 				end
 			end

data/lib/lzrtag/handler/base_handler.rb

@@ -1,9 +1,11 @@
 
 require 'mqtt/sub_handler'
 
+require 'xasin_logger'
+
 require_relative '../hooks/base_hook.rb'
 
-require_relative '../player/life_player.rb'
+require_relative '../player/stats_player.rb'
 
 module LZRTag
 	module Handler
@@ -20,13 +22,17 @@ module LZRTag
 		#  # Using LZRTag.Handler instead of LZRTag::Handler::Base to fetch the latest handler
 		#  handler = LZRTag.Handler.new(mqttConn);
 		class Base
+			include XasLogger::Mix
+
 			# Returns the MQTT connection
 			attr_reader :mqtt
 
 			# Returns the ID-Table, a Hash of Players and their matched IDs
 			attr_reader :idTable
 
-			def initialize(mqtt, playerClass = Player::Life, clean_on_exit: true)
+			def initialize(mqtt, playerClass = Player::Statistics, clean_on_exit: true)
+				init_x_log("LZRTag Base", nil);
+
 				@mqtt = mqtt;
 
 				@playerClass = playerClass;
@@ -48,6 +54,12 @@ module LZRTag
 					end
 				end
 				@eventThread.abort_on_exception = true;
+				Thread.new do
+					loop do
+						sleep 0.5;
+						send_event(:slowTick);
+					end
+				end
 
 				@mqtt.subscribe_to "Lasertag/Players/#" do |data, topic|
 					dID = topic[0];
@@ -56,6 +68,7 @@ module LZRTag
 							@players[dID] = @playerClass.new(dID, self);
 						}
 						send_event(:playerRegistered, @players[dID]);
+						x_logi("New player registered: #{dID}");
 					end
 
 					@players[dID].on_mqtt_data(data, topic);
@@ -73,7 +86,7 @@ module LZRTag
 					}
 				end
 
-				puts "I LZR::Handler init finished".green
+				x_logi("Initialisation complete");
 			end
 
 			# Send an event into the event loop.
@@ -99,6 +112,10 @@ module LZRTag
 					player = data[0];
 					@idTable[player.id] = nil;
 					player.id = nil;
+				when :slowTick
+					self.each do |pl|
+						pl._tick_connection();
+					end
 				end
 			end
 

data/lib/lzrtag/handler/count_handler.rb

@@ -12,22 +12,30 @@ module LZRTag
 		class Count < HitArb
 			# Returns a Hash with keys 0..7, describing which teams have
 			# how many players
-			attr_reader :teamCount
+			attr_reader :teamMap
 			# Returns a Hash with keys equal to player's brightnesses, describing
 			# how many players have which brightness
-			attr_reader :brightnessCount
+			attr_reader :brightnessMap
+
+			# Returns a hash with keys of beacon numbers, describing
+			# how many players are in which beacon
+			attr_reader :beaconMap
 
 			def initialize(*args, **argHash)
 				super(*args, **argHash);
 
-				@teamCount = Hash.new();
+				@teamMap = Hash.new();
 				7.times do |i|
-					@teamCount[i] = 0;
+					@teamMap[i] = Array.new;
 				end
 
-				@brightnessCount = Hash.new();
+				@brightnessMap = Hash.new();
 				Player::Hardware.getBrightnessKeys().each do |bKey|
-					@brightnessCount[bKey] = 0;
+					@brightnessMap[bKey] = Array.new;
+				end
+
+				@beaconMap = Hash.new() do |h, k|
+					h[k] = Array.new();
 				end
 			end
 
@@ -37,19 +45,32 @@ module LZRTag
 
 				case evtName
 				when :playerRegistered
-					@teamCount[data[0].team] += 1;
-					@brightnessCount[data[0].brightness] += 1;
+					@teamMap[data[0].team] << data[0];
+					@brightnessMap[data[0].brightness] << data[0];
 				when :playerUnregistered
-					@teamCount[data[0].team] -= 1;
-					@brightnessCount[data[0].brightness] -= 1;
+					@teamMap[data[0].team].delete data[0];
+					@brightnessMap[data[0].brightness].delete data[0];
 				when :playerTeamChanged
-					@teamCount[data[1]] -= 1;
-					@teamCount[data[0].team] += 1;
+					@teamMap[data[1]].delete data[0];
+					@teamMap[data[0].team] << data[0];
 				when :playerBrightnessChanged
-					@brightnessCount[data[1]] -= 1;
-					@brightnessCount[data[0].brightness] += 1;
+					@brightnessMap[data[1]].delete data[0];
+					@brightnessMap[data[0].brightness] << data[0];
+				when :playerEnteredBeacon
+					@beaconMap[data[1]] << data[0];
+				when :playerLeftBeacon
+					@beaconMap[data[1]].delete data[0];
 				end
 			end
+
+			def get_team_killcount(team)
+				total = 0;
+				@teamMap[team].each do |pl|
+					total += pl.stats["Kills"];
+				end
+
+				return total;
+			end
 		end
 	end
 end

data/lib/lzrtag/handler/game_handler.rb

@@ -105,7 +105,8 @@ module LZRTag
 							send_event(:gameTick, dT);
 						end
 
-						puts "Stopping current game.".green
+						x_logi("Stopping game!");
+
 						set_phase(:idle);
 						sleep 1;
 						@currentGame = nil;
@@ -122,12 +123,15 @@ module LZRTag
 			# A list of games is published to Lasertag/Game/KnownGames
 			# @param gameTag [String] Cleartext name of the game
 			# @param game [LZRTag::Game::Base] The game class to register
+			# @see start_game
 			def register_game(gameTag, game)
 				raise ArgumentError, "Game Tag must be a string!" unless gameTag.is_a? String
 				raise ArgumentError, "Game must be a LZRTag::Game class" unless game <= LZRTag::Game::Base
 
 				@knownGames[gameTag] = game;
 
+				x_logi("Game registered: #{gameTag}");
+
 				@mqtt.publish_to "Lasertag/Game/KnownGames", @knownGames.keys.to_json, retain: true;
 			end
 
@@ -143,6 +147,10 @@ module LZRTag
 			# This function will take either a String (as registered with register_game),
 			# or a LZRTag::Game::Base class, instantiate it, and start it.
 			# If no fitting game was found, the game is instead stopped.
+			#
+			# @note The first phase that is started by default is :starting, the Game
+			#    class must define at least a phase_prep hook to change the phase and
+			#    configure the game!
 			# @param game [String,LZRTag::Game::Base] The game, or game name, to start
 			def start_game(game = @lastGame)
 				@lastGame = game;
@@ -156,7 +164,7 @@ module LZRTag
 
 				if(gKey = @knownGames.key(game))
 					@mqtt.publish_to "Lasertag/Game/CurrentGame", gKey, retain: true
-					puts "Starting game #{gKey}!".green
+					x_logi("Starting game #{gKey}");
 				else
 					@mqtt.publish_to "Lasertag/Game/CurrentGame", "", retain: true
 				end
@@ -202,7 +210,7 @@ module LZRTag
 
 				raise ArgumentError, "Phase must be valid!" unless allowedPhases.include? nextPhase
 
-				puts "Phase started: #{nextPhase}!".green;
+				x_logi("Starting phase #{nextPhase}");
 
 				oldPhase = @gamePhase
 				send_event(:gamePhaseEnds, oldPhase, nextPhase)
@@ -221,24 +229,24 @@ module LZRTag
 			# @param [Array<LZRTag::Player::Base] Array of active players
 			def gamePlayers=(newPlayers)
 				raise ArgumentError, "Game player list shall be an array!" unless newPlayers.is_a? Array
+				oldGamePlayers = @gamePlayers.dup
 				@gamePlayers = newPlayers.dup;
 
 				@playerNames = Array.new();
 				plNameArray = Array.new();
 				@gamePlayers.each do |pl|
-					plNameArray << pl.deviceID();
+					plNameArray << pl.DeviceID();
 				end
 
-				newPlayers = @gamePlayers - @oldGamePlayers;
+				newPlayers = @gamePlayers - oldGamePlayers;
 				newPlayers.each do |pl|
 					send_event :playerEnteredGame, pl;
 				end
-				oldPlayers = @oldGamePlayers - @gamePlayers;
+				oldPlayers = oldGamePlayers - @gamePlayers;
 				oldPlayers.each do |pl|
 					send_event :playerLeftGame, pl;
 				end
 
-				@oldGamePlayers = @gamePlayers.dup;
 				@mqtt.publish_to "Lasertag/Game/ParticipatingPlayers", plNameArray.to_json(), retain: true
 			end
 

data/lib/lzrtag/handler/hitArb_handler.rb

@@ -22,13 +22,11 @@ module LZRTag
 			def initialize(*data, **options)
 				super(*data, **options);
 
-				@mqtt.subscribe_to "Lasertag/Game/Events" do |data|
+				@mqtt.subscribe_to "Lasertag/Game/Events/Hits" do |data|
 					begin
 						data = JSON.parse(data, symbolize_names: true);
 
-						if(data[:type] == "hit")
-							_handle_hitArb(data);
-						end
+						_handle_hitArb(data);
 					rescue JSON::ParserError
 					end
 				end
@@ -38,6 +36,15 @@ module LZRTag
 				return true;
 			end
 
+			def consume_event(evt, data)
+				super(evt, data)
+				if(evt == :slowTick)
+					self.each do |pl|
+						pl.check_beacons();
+					end
+				end
+			end
+
 			def _handle_hitArb(data)
 				unless  (hitPlayer = get_player(data[:target])) and
 						  (sourcePlayer = get_player(data[:shooterID])) and
@@ -53,9 +60,9 @@ module LZRTag
 				hookList = Array.new();
 				hookList << @hooks;
 				if(@currentGame)
-					hookList << @currentGame.hookList
+					hookList << @currentGame.hookList.values
 				end
-				hookList.flatten
+				hookList.flatten!
 
 				hookList.each do |h|
 					begin

data/lib/lzrtag/hooks/base_hook.rb

@@ -1,4 +1,6 @@
 
+require 'xasin_logger'
+
 module LZRTag
 	module Hook
 =begin
@@ -40,6 +42,8 @@ module LZRTag
 		handler.add_hook(MyHook);
 =end
 		class Base
+			include XasLogger::Mix
+
 			def self.getCBs()
 				@globalCBList ||= Hash.new();
 				return @globalCBList;
@@ -49,10 +53,12 @@ module LZRTag
 				return @globalOptionDescriptions
 			end
 
-			def initialize(handler)
+			def initialize(handler, logName = self)
 				@localCBList = Hash.new();
 
 				@handler = handler
+
+				init_x_log(logName.to_s, nil);
 			end
 
 			# DSL function to describe an option of this hook.

data/lib/lzrtag/hooks/standard_hooks.rb

@@ -7,11 +7,11 @@ module LZRTag
 			attr_accessor :eventWhitelist
 			attr_accessor :eventBlacklist
 
-			def initialize()
-				super();
+			def initialize(handler)
+				super(handler, "DBG");
 
 				@eventWhitelist = Array.new();
-				@eventBlacklist = Array.new();
+				@eventBlacklist = [:slowTick, :gameTick, :playerInBeacon];
 			end
 
 			def consume_event(evtName, data)
@@ -22,7 +22,7 @@ module LZRTag
 					return unless @eventWhitelist.include? evtName
 				end
 
-				puts "Caught event: #{evtName} with data: #{data}";
+				x_logd "Event: #{evtName} with data: #{data}";
 			end
 		end
 
@@ -32,23 +32,35 @@ module LZRTag
 			}
 
 			def initialize(handler, possibleTeams: [1, 2, 3, 4])
-				super(handler);
+				super(handler, "Team Selector");
 
 				@possibleTeams = possibleTeams;
 			end
 
+			def in_phase
+				return @handler.gamePhase == :teamSelect;
+			end
+			def is_selecting(pl)
+				return ([:idle, :teamSelect].include? pl.brightness)
+			end
+
 			on :gamePhaseEnds do |oldPhase, nextPhase|
 				if((oldPhase == :teamSelect) && (nextPhase != :idle))
-					puts "Selecting active players!"
+					x_logi("Selecting active players!");
 
-					@handler.gamePlayers = Array.new();
+					nextPlayers = Array.new();
 					@handler.each do |pl|
-						if(pl.brightness == :active)
-							@handler.gamePlayers << pl;
+						if([:active, :teamSelect].include? pl.brightness)
+							nextPlayers << pl;
+						else
+							pl.team = 0;
+							pl.brightness = :idle;
 						end
 					end
 
-					puts "Game players are: #{@handler.gamePlayers}"
+					@handler.gamePlayers = nextPlayers;
+
+					x_logd("Participating players are: #{@handler.gamePlayers}")
 				end
 			end
 
@@ -58,27 +70,22 @@ module LZRTag
 					@handler.each do |pl|
 						pl.brightness = :idle;
 
-						if(!@possibleTeams.include?(pl.team))
+						unless(@possibleTeams.include?(pl.team))
 							pl.team = @possibleTeams.sample();
 						end
 					end
-				when :idle
-					@handler.each do |pl|
-						pl.brightness = :idle;
-					end
 				end
 			end
 
 			on :poseChanged do |pl, nPose|
-				next if(@handler.gamePhase != :teamSelect)
-				next if(pl.brightness == :active)
+				next unless in_phase
+				next unless is_selecting(pl)
 
 				pl.brightness = (pl.gyroPose == :laidDown) ? :idle : :teamSelect;
 			end
 
 			on :navSwitchPressed do |player, dir|
-				next if(@handler.gamePhase != :teamSelect)
-				next unless [:teamSelect, :idle].include? player.brightness
+				next unless in_phase
 
 				newTeam = @possibleTeams.find_index(player.team) || 0;
 
@@ -92,6 +99,26 @@ module LZRTag
 					player.brightness = :teamSelect
 				end
 			end
+
+			on :playerEnteredBeacon do |pl, beacon|
+				next unless in_phase
+
+				next unless is_selecting(pl)
+				next unless(@possibleTeams.include? beacon)
+
+				pl.team = beacon;
+				pl.brightness = :teamSelect;
+			end
+
+			on :playerLeftBeacon do |pl, beacon|
+				next unless in_phase
+
+				next unless(pl.team == beacon)
+				next unless is_selecting(pl)
+
+				pl.team = 0;
+				pl.brightness = :idle
+			end
 		end
 
 		class Regenerator < Base
@@ -139,7 +166,7 @@ module LZRTag
 			describe_option :dmgPerShot, "Base damage per shot"
 			describe_option :useDamageMultiplier, "Shall shots be adjusted per-gun?"
 			describe_option :friendlyFire, "Shall friendly-fire be enabled"
-			describe_option :hitThreshold, "Limit below dead players will not be hit"
+			describe_option :hitThreshold, "Limit below which dead players will not be hit"
 
 			def initialize(handler, **options)
 				super(handler);
@@ -170,5 +197,33 @@ module LZRTag
 				hitPlayer.hit();
 			end
 		end
+
+		class GunSelector < Base
+			describe_option :phaseFilter, "Which phase to be active during"
+			describe_option :teamFilter,  "Which team to be active for"
+
+			def initialize(handler, **opts)
+				super(handler);
+
+				@phaseFilter = opts[:phaseFilter] || [:running]
+				@teamFilter  = opts[:teamFilter] || (0..7).to_a
+
+				@guns = [1, 2];
+			end
+
+			on :navSwitchPressed do |pl, dir|
+				next unless @phaseFilter.include? @handler.gamePhase
+				next unless @teamFilter.include? pl.team
+
+				if(dir == 1)
+					pl.reload
+				elsif dir == 2
+					pl.gunNo = 3;
+				elsif dir == 3
+					oldInd = @guns.find_index(pl.gunNo) || 0;
+					pl.gunNo = @guns[(1+oldInd) % @guns.length] || 1
+				end
+			end
+		end
 	end
 end

data/lib/lzrtag/player/base_player.rb

@@ -19,6 +19,11 @@ module LZRTag
 			# @return [String] status-string of the player. Should be "OK"
 			attr_reader :status
 
+			attr_reader :connected
+
+			# @return [Time] Time at which the player status was last updated
+			attr_reader :last_status_update
+
 			# @return [Integer] 0..255, shot ID of the player
 			attr_reader   :id
 			# @return [Hash<Time>] Hash of the last few recorded shot times,
@@ -34,11 +39,14 @@ module LZRTag
 				@status = "";
 				@name   = "";
 
+				@last_status_update = Time.at(0);
+				@connected = false;
+
 				@hitIDTimetable = Hash.new(Time.new(0));
 			end
 
 			def _pub_to(key, data, retain: false)
-				@mqtt.publish_to("Lasertag/Players/#{@DeviceID}/#{key}", data, retain: retain);
+				@mqtt.publish_to("Lasertag/Players/#{@DeviceID}/#{key}", data, retain: retain, qos: 1);
 			end
 			private :_pub_to
 
@@ -47,21 +55,38 @@ module LZRTag
 				case topic[1..topic.length].join("/")
 				when "Connection"
 					return if @status == data;
-					oldStatus = @status;
 					@status = data;
-					if(@status == "OK")
-						@handler.send_event(:playerConnected, self);
-					elsif(oldStatus == "OK")
-						@handler.send_event(:playerDisconnected, self);
-					end
+
+					return if @status == "OK"
+					return if @status == ""
+					return if !@connected
+					@connected = false;
+					@handler.send_event(:playerDisconnected, self);
+
 				when "CFG/Name"
 					@name = data;
+				when "Ping"
+					@last_status_update = Time.now();
+
+					if(@status == "OK" && (!@connected))
+						@connected = true
+						@handler.send_event(:playerConnected, self);
+					end
+				end
+			end
+
+			def _tick_connection()
+				return unless @connected
+
+				if((Time.now() - @last_status_update) > 60)
+					@connected = false;
+					@handler.send_event(:playerDisconnected, self);
 				end
 			end
 
 			# @return [Boolean] Whether this player is connected
 			def connected?()
-				return @status == "OK"
+				return @connected
 			end
 
 			# Set the Shot ID of the player.

data/lib/lzrtag/player/hardware_player.rb

@@ -41,16 +41,22 @@ module LZRTag
 			# Especially useful to determine when to revive a player
 			attr_reader :deathChangeTime
 
-			# Current ammo of the weapon.
-			# TODO one day this should be settable. Right now, it's just reading
-			attr_reader :ammo
-			# Maximum ammo the weapon can have with the currently equipped gun.
-			attr_reader :maxAmmo
 			# Number of the current gun.
 			# The application can freely choose which gun profile the set is using,
 			# which influences shot speeds, sounds, reloading, etc.
 			attr_reader :gunNo
 
+			# Current amount of reserve ammo (i.e. clips the player can reload with)
+			# Can be set to -1 to enable infinite reserve ammo (default), or
+			# any other value to give the player limited ammo
+			attr_reader :reserveAmmo
+			# Current ammo in the clip. Can be set to -1 for infinite shots (no
+			# reloading necessary at all), or any other numeric value. Default is
+			# a single clip (gun-dependant)
+			attr_reader :clipAmmo
+			# Size of the clip of the currently equipped gun. Can not be set!
+			attr_reader :clipSize
+
 			# Returns the gyro pose of the set.
 			# This is either:
 			# - :active
@@ -61,6 +67,9 @@ module LZRTag
 			# The :poseChanged event is sent on change with [player, newPose] data
 			attr_reader :gyroPose
 
+			# Returns a Hash of the last timestamps when a beacon was detected
+			attr_reader :beaconTimes
+
 			attr_reader :battery, :ping, :heap
 
 			def self.getBrightnessKeys()
@@ -76,8 +85,10 @@ module LZRTag
 				@dead = false;
 				@deathChangeTime = Time.now();
 
-				@ammo = 0;
-				@maxAmmo = 0;
+				@reserveAmmo = 0;
+				@clipAmmo 	 = 0;
+				@clipSize 	 = 0;
+
 				@gunNo = 0;
 
 				@gyroPose = :unknown;
@@ -85,6 +96,9 @@ module LZRTag
 				@position = {x: 0, y: 0}
 				@zoneIDs  = Hash.new();
 
+				@beaconTimes = Hash.new();
+				@BeaconTimeout = 3;
+
 				@battery = 0; @ping = 0; @heap = 0;
 
 				@BrightnessMap = self.class.getBrightnessKeys();
@@ -120,11 +134,12 @@ module LZRTag
 
 					@handler.send_event(@dead ? :playerKilled : :playerRevived, self);
 				when "Stats/Ammo"
-					return if(data.size != 8)
+					return if(data.size != 12)
 
 					outData = data.unpack("L<*");
-					@ammo = outData[0];
-					@maxAmmo = outData[1];
+					@clipAmmo = outData[0];
+					@clipSize = outData[1];
+					@reserveAmmo = outData[2];
 				when "Position"
 					begin
 						@position = JSON.parse(data, symbolize_names: true);
@@ -135,6 +150,13 @@ module LZRTag
 				when "HW/Gyro"
 					@gyroPose = data.to_sym
 					@handler.send_event(:poseChanged, self, @gyroPose);
+				when "HW/BeaconDetect"
+					beaconID = data.to_i;
+					unless(@beaconTimes[beaconID])
+						@handler.send_event(:playerEnteredBeacon, self, beaconID);
+					end
+					@beaconTimes[beaconID] = Time.now();
+					@handler.send_event(:playerInBeacon, self, beaconID);
 				when "ZoneUpdate"
 					begin
 						data = JSON.parse(data, symbolize_names: true);
@@ -184,13 +206,14 @@ module LZRTag
 
 			def _set_dead(d, player = nil)
 				dead = (d ? true : false);
-				return if @dead == dead;
+				return false if @dead == dead;
 				@dead = dead;
 
 				@deathChangeTime = Time.now();
 
 				_pub_to "CFG/Dead", @dead ? "1" : "0", retain: true;
 				@handler.send_event(@dead ? :playerKilled : :playerRevived, self, player);
+				return true;
 			end
 			def dead=(d)
 				_set_dead(d);
@@ -204,14 +227,19 @@ module LZRTag
 				_set_dead(false, player)
 			end
 
-			def ammo=(n)
-				unless (n.is_a?(Integer) and (n >= 0))
-					raise ArgumentError, "Ammo amount needs to be a positive number!"
+			def reserveAmmo=(n)
+				unless (n.is_a?(Integer))
+					raise ArgumentError, "Ammo amount needs to be a number!"
 				end
 
-				@ammo = n;
+				_pub_to("Stats/Ammo/SetReserve", n);
+			end
+			def clipAmmo=(n)
+				unless (n.is_a?(Integer))
+					raise ArgumentError, "Ammo amount needs to be a number!"
+				end
 
-				_pub_to("Stats/Ammo/Set", n);
+				_pub_to("Stats/Ammo/SetClip", n);
 			end
 
 			def gunNo=(n)
@@ -239,6 +267,20 @@ module LZRTag
 				return @GunDamageMultipliers[number-1] || 1;
 			end
 
+			def reload()
+				_pub_to("CFG/Reload", "1");
+			end
+
+			def check_beacons()
+				bIDs = @beaconTimes.keys;
+				bIDs.each do |bID|
+					if((Time.now() - @beaconTimes[bID]) > @BeaconTimeout)
+						@handler.send_event(:playerLeftBeacon, self, bID);
+						@beaconTimes.delete(bID)
+					end
+				end
+			end
+
 			def clear_all_topics()
 				super();
 

data/lib/lzrtag/player/life_player.rb

@@ -18,7 +18,7 @@ module LZRTag
 
 			# Returns the last time the player was damaged.
 			# This can be useful to apply buffs and other data, as well as
-			# "post-damage regenration delay"
+			# "post-damage regeneration delay"
 			attr_reader :lastDamageTime
 
 			def initialize(*data)
@@ -45,17 +45,21 @@ module LZRTag
 
 				nLife = @life + amount;
 				nLife = @maxLife if(nLife > @maxLife)
-				return if nLife == @life;
+				return 0 if nLife == @life;
 
 				oLife = @life;
 				@life = nLife;
 
-				@handler.send_event(:playerRegenerated, self, @life - oLife, source);
+				lifeDiff = @life - oLife;
+
+				@handler.send_event(:playerRegenerated, self, lifeDiff, source);
 				if(@life == maxLife)
 					@handler.send_event(:playerFullyRegenerated, self, source);
 				end
 
 				_pub_to("Stats/HP", @life.to_s, retain: true);
+
+				return lifeDiff
 			end
 
 			# Damage a player by a given amount with given source.

data/lib/lzrtag/player/stats_player.rb

@@ -0,0 +1,107 @@
+
+require_relative 'life_player.rb'
+
+module LZRTag
+	module Player
+		class Statistics < Life
+			attr_reader :stats
+
+			def initialize(*args)
+				@stats = {
+					"Kills" => 0,
+					"Deaths" => 0,
+					"DamageDone" => 0,
+					"DamageReceived" => 0,
+					"Healed" => 0,
+				}
+
+				super(*args);
+			end
+
+			def _update_stat(key, value)
+				return unless(@stats.keys.include? key);
+				return if(@stats[key] == value);
+
+				@stats[key] = value;
+				_pub_to("Stats/#{key}", value, retain: true);
+			end
+			def _increment_stat(key, value)
+				_update_stat(key, @stats[key] + value);
+			end
+
+			def reset()
+				@stats.keys.each do |k|
+					@stats[k] = 0;
+					_pub_to("Stats/#{k}", 0, retain: true);
+				end
+
+				# super(); // TO DO!
+			end
+
+			def regenerate(*args)
+				healDone = super(*args);
+
+				_increment_stat("Healed", healDone);
+			end
+			def damage_by(*args)
+				dmg_done = super(*args);
+
+				_increment_stat("DamageReceived", dmg_done);
+				args[1]._increment_stat("DamageDone", dmg_done) if(args[1])
+			end
+
+			def _set_dead(d, player = nil)
+				return unless super(d, player);
+				return unless d;
+
+				player._increment_stat("Kills", 1) if(player);
+
+				_increment_stat("Deaths", 1);
+			end
+
+			def ratio_kd()
+				return @stats["Kills"]/([1, @stats["Deaths"]].max);
+			end
+
+
+			def self.print_start_line()
+				stats = ["Kills", "Deaths", "DMG Done", "DMG Rec", "Healed"]
+				sep = "\u2501" * 10;
+
+				puts "\u250F" + sep + ("\u252F" + sep) * (stats.count) + "\u2513";
+				puts "\u2503" + (" %8s \u2502" * (stats.count) + " %8s \u2503") % ["Name", stats].flatten;
+				puts "\u2523" + sep + ("\u253F" + sep)*(stats.count) + "\u252B";
+			end
+
+			def self.print_end_line()
+				stats = ["Kills", "Deaths", "DMG Done", "DMG Rec", "Healed"]
+				sep = "\u2501" * 10;
+
+				puts "\u2517" + sep + ("\u2537" + sep)*(stats.count) + "\u251B";
+			end
+
+			def print_stat_line()
+				outStr = "\u2503 %8s ";
+				strArgs = [@name];
+
+				@stats.each do |key, val|
+					strArgs << val;
+					outStr += "\u2502 %8d ";
+				end
+				outStr += "\u2503";
+
+				puts outStr % strArgs;
+			end
+
+
+
+			def clear_all_topics()
+				super();
+
+				@stats.keys.each do |k|
+					_pub_to("Stats/#{k}", "", retain: true);
+				end
+			end
+		end
+	end
+end

metadata

@@ -1,79 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: lzrtag-base
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Xasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2019-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mqtt-sub_handler
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: xml-simple
+  name: mqtt-sub_handler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: xasin-logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -104,6 +90,7 @@ files:
 - lib/lzrtag/player/effects_player.rb
 - lib/lzrtag/player/hardware_player.rb
 - lib/lzrtag/player/life_player.rb
+- lib/lzrtag/player/stats_player.rb
 homepage: https://github.com/XasWorks/LZRTag/
 licenses:
 - GPL-3.0
@@ -123,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Base classes for Xasin's LZRTag system