lzrtag-base 1.0.0

data/lib/lzrtag/player/life_player.rb

@@ -0,0 +1,116 @@
+
+require_relative 'effects_player.rb'
+
+module LZRTag
+	module Player
+		class Life < Effects
+
+			# Return the amount of life a player currently has.
+			# This value can not be set directly, but should instead be modified
+			# via {regenerate} and {damage_by}.
+			# It is a number from 0 to maxLife (default 100
+			# Any change in a player's life is send to MQTT, as well as signalled via
+			# :playerRegenerated and :playerHurt events
+			attr_reader :life
+			# Set the maximum amount of life a player has. Can be useful to
+			# introduce tank classes with more life.
+			attr_reader :maxLife
+
+			# 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"
+			attr_reader :lastDamageTime
+
+			def initialize(*data)
+				super(*data);
+
+				@life    = 0;
+				@maxLife = 100;
+
+				@lastDamageTime = Time.at(0);
+
+				regenerate(@maxLife);
+			end
+
+			# Regenerate the player by a given amount.
+			# This function will update the player's life, increasing it
+			# by amount, and will send :playerRegenerated [player, deltaLife]
+			# or :playerFullyRegenerated [player]
+			# if a player's life was increased to the maximum value.
+			# @param amount [Numeric] Amount of life to add
+			def regenerate(amount, source = nil)
+				unless((amount.is_a? Numeric) && amount >= 0)
+					raise ArgumentError, "Amount needs to be a positive number!"
+				end
+
+				nLife = @life + amount;
+				nLife = @maxLife if(nLife > @maxLife)
+				return if nLife == @life;
+
+				oLife = @life;
+				@life = nLife;
+
+				@handler.send_event(:playerRegenerated, self, @life - oLife, source);
+				if(@life == maxLife)
+					@handler.send_event(:playerFullyRegenerated, self, source);
+				end
+
+				_pub_to("Stats/HP", @life.to_s, retain: true);
+			end
+
+			# Damage a player by a given amount with given source.
+			# This function will damage a player by "amount", but will not
+			# decrease a player's life below zero. Instead, it will kill the player.
+			# This function will send out :playerHurt [player, sourcePlayer, deltaLife]
+			# and potentially also :playerKilled
+			# @param amount [Numeric] Amount to damage the player by
+			# @param sourcePlayer [nil, Player::Base] The player this damage originated from - optional
+			def damage_by(amount, sourcePlayer = nil)
+				unless(amount.is_a? Numeric)
+					raise ArgumentError, "Amount needs to be a number!";
+				end
+				unless (sourcePlayer.is_a? Base) or sourcePlayer.nil?
+					raise ArgumentError, "sourcePlayer needs to be a Player::Base!"
+				end
+
+				oLife = @life;
+				nLife = @life - amount;
+				nLife = [0, nLife].max;
+
+				@lastDamageTime = Time.now();
+
+				if(nLife != @life)
+					@life = nLife;
+
+					@handler.send_event :playerHurt, self, sourcePlayer, oLife - @life;
+					_pub_to("Stats/HP", @life.to_s, retain: true);
+
+					kill_by(sourcePlayer) if(nLife <= 0);
+				end
+
+				return oLife - nLife;
+			end
+
+			def maxLife=(newVal)
+				unless(newVal.is_a? Numeric && newVal >= 1)
+					raise ArgumentError, "Amount needs to be a number >= 1!"
+				end
+
+				@maxLife = newVal;
+				if(@life > @maxLife)
+					@life = @maxLife;
+					_pub_to("Stats/HP", @life, retain: true);
+				end
+
+				_pub_to("CFG/MaxLife", @maxLife, retain: true);
+			end
+
+			# @private
+			def clear_all_topics()
+				super();
+				_pub_to("Stats/HP", "", retain: true);
+				_pub_to("CFG/MaxLife", "", retain: true);
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: lzrtag-base
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Xasin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mqtt-sub_handler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- docs/EventSymbols.md
+- docs/MQTTBranches.md
+- lib/lzrtag.rb
+- lib/lzrtag/game/base_game.rb
+- lib/lzrtag/handler/base_handler.rb
+- lib/lzrtag/handler/count_handler.rb
+- lib/lzrtag/handler/game_handler.rb
+- lib/lzrtag/handler/hitArb_handler.rb
+- lib/lzrtag/hooks/base_hook.rb
+- lib/lzrtag/hooks/standard_hooks.rb
+- lib/lzrtag/map/map_set.rb
+- lib/lzrtag/map/map_zone.rb
+- lib/lzrtag/map/myMaps_parser.rb
+- lib/lzrtag/player/base_player.rb
+- lib/lzrtag/player/effects_player.rb
+- lib/lzrtag/player/hardware_player.rb
+- lib/lzrtag/player/life_player.rb
+homepage: https://github.com/XasWorks/LZRTag/
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Base classes for Xasin's LZRTag system
+test_files: []