Add player color functions (thegrb93#1604)

* Add Player:getPlayerColor()

* Add player color set/get to holograms

* Condense

* Use DTVar instead of net stream

* Style

lua/entities/starfall_hologram/cl_init.lua

@@ -5,12 +5,20 @@ ENT.IsHologram = true
 ENT.DefaultMaterial = Material( "hunter/myplastic" )
 ENT.Material = ENT.DefaultMaterial
 
+local VECTOR_PLAYER_COLOR_DISABLED = Vector(-1, -1, -1)
+
 function ENT:Initialize()
 	self.clips = {}
 	self.sf_userrenderbounds = false
 	self:SetupBones()
 	self:OnScaleChanged(nil, nil, self:GetScale())
 
+	if self:EntIndex() == -1 then
+		self:SetPlayerColorInternal(VECTOR_PLAYER_COLOR_DISABLED)
+	else
+		self:OnPlayerColorChanged(nil, nil, self:GetPlayerColorInternal())
+	end
+
 	-- Fixes future SetParent calls not keeping offset from the parent
 	self:SetParent(Entity(0))
 	self:SetParent()
@@ -42,6 +50,18 @@ function ENT:OnScaleChanged(name, old, scale)
 	end
 end
 
+function ENT:OnPlayerColorChanged(name, old, color)
+	if color == VECTOR_PLAYER_COLOR_DISABLED then
+		self.GetPlayerColor = nil -- The material proxy will break if this is not removed when disabling player color.
+	else
+		-- Having this function is what causes player color to actually be applied.
+		-- https://github.com/garrynewman/garrysmod/blob/master/garrysmod/lua/matproxy/player_color.lua
+		function self:GetPlayerColor()
+			return color
+		end
+	end
+end
+
 function ENT:Draw(flags)
 	local selfTbl = self:GetTable()
 	if self:GetColor().a ~= 255 then

lua/entities/starfall_hologram/init.lua

@@ -2,6 +2,8 @@ AddCSLuaFile("cl_init.lua")
 AddCSLuaFile("shared.lua")
 include("shared.lua")
 
+local VECTOR_PLAYER_COLOR_DISABLED = Vector(-1, -1, -1)
+
 function ENT:Initialize()
 	self.BaseClass.Initialize()
 	self:SetSolid(SOLID_NONE)
@@ -14,6 +16,7 @@ function ENT:Initialize()
 	self.clipdata = ""
 
 	self:SetScale(Vector(1,1,1))
+	self:SetPlayerColorInternal(VECTOR_PLAYER_COLOR_DISABLED)
 	self:SetSuppressEngineLighting(false)
 
 	self.updateClip = false
@@ -42,9 +45,10 @@ function ENT:Think()
 			clipdata:writeInt16(v.entity and v.entity:EntIndex() or 0)
 		end
 		self.clipdata = clipdata:getString()
-		
+
 		self:TransmitClips()
 	end
+
 	if self.AutomaticFrameAdvance then
 		self:NextThink(CurTime())
 		return true

lua/entities/starfall_hologram/shared.lua

@@ -10,12 +10,12 @@ ENT.AdminSpawnable  = false
 ENT.IsSFHologram = true
 
 function ENT:SetupDataTables()
-
 	self:NetworkVar( "Vector", 0, "Scale" )
+	self:NetworkVar( "Vector", 1, "PlayerColorInternal" )
 	self:NetworkVar( "Bool", 0, "SuppressEngineLighting" )
 
-	if ( CLIENT ) then
+	if CLIENT then
 		self:NetworkVarNotify( "Scale", self.OnScaleChanged )
+		self:NetworkVarNotify( "PlayerColorInternal", self.OnPlayerColorChanged )
 	end
-
 end

lua/starfall/libs_sh/hologram.lua

@@ -57,6 +57,8 @@ local ang_meta, awrap, aunwrap = instance.Types.Angle, instance.Types.Angle.Wrap
 local vec_meta, vwrap, vunwrap = instance.Types.Vector, instance.Types.Vector.Wrap, instance.Types.Vector.Unwrap
 local mtx_meta, mwrap, munwrap = instance.Types.VMatrix, instance.Types.VMatrix.Wrap, instance.Types.VMatrix.Unwrap
 
+local VECTOR_PLAYER_COLOR_DISABLED = Vector(-1, -1, -1)
+
 local getent
 instance:AddHook("initialize", function()
 	getent = instance.Types.Entity.GetEntity
@@ -304,6 +306,35 @@ else
 	end
 end
 
+--- Sets the player color of a hologram
+-- The part of the model that is colored is determined by the model itself, and is different for each model
+-- The format is Vector(r,g,b), and each color should be between 0 and 1
+-- @shared
+-- @param Vector? color The player color to use, or nil to disable
+function hologram_methods:setPlayerColor(color)
+	local holo = getholo(self)
+
+	checkpermission(instance, holo, "hologram.setRenderProperty")
+
+	color = color ~= nil and vunwrap(color) or VECTOR_PLAYER_COLOR_DISABLED
+
+	holo:SetPlayerColorInternal(color)
+end
+
+--- Gets the player color of a hologram
+-- The part of the model that is colored is determined by the model itself, and is different for each model
+-- The format is Vector(r,g,b), and each color should be between 0 and 1
+-- @shared
+-- @return Vector? color The player color to use, or nil if disabled
+function hologram_methods:getPlayerColor()
+	local holo = getholo(self)
+	local color = holo:GetPlayerColorInternal()
+
+	if color == VECTOR_PLAYER_COLOR_DISABLED then return nil end
+
+	return vwrap(color)
+end
+
 --- Updates a clip plane
 -- @shared
 -- @param number index Whatever number you want the clip to be

lua/starfall/libs_sh/players.lua

@@ -462,6 +462,15 @@ function player_methods:getWeaponColor()
 	return vwrap(getply(self):GetWeaponColor())
 end
 
+--- Returns a player's color
+-- The part of the model that is colored is determined by the model itself, and is different for each model
+-- The format is Vector(r,g,b), and each color should be between 0 and 1
+-- @shared
+-- @return Vector The color
+function player_methods:getPlayerColor()
+	return vwrap(getply(self):GetPlayerColor())
+end
+
 --- Returns the entity that the player is standing on
 -- @shared
 -- @return Entity Ground entity
@@ -657,7 +666,7 @@ if SERVER then
 		ply.sf_say_cd = CurTime() + 0.5
 		ply:Say(text, teamOnly)
 	end
-	
+
 	--- Sets the armor of the player.
 	-- @server
 	-- @param number newarmor New armor value.
@@ -667,7 +676,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetArmor(val)
 	end
-		
+
 	--- Sets the maximum armor for player. You can still set a player's armor above this amount with Player:setArmor.
 	-- @server
 	-- @param number newmaxarmor New max armor value.
@@ -677,7 +686,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetMaxArmor(val)
 	end
-	
+
 	--- Sets Crouched Walk Speed
 	-- @server
 	-- @param number newcwalkspeed New Crouch Walk speed, This is a multiplier from 0 to 1.
@@ -687,7 +696,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetCrouchedWalkSpeed(math.Clamp(val,0,1))
 	end
-	
+
 	--- Sets Duck Speed
 	-- @server
 	-- @param number newduckspeed New Duck speed, This is a multiplier from 0 to 1.
@@ -697,7 +706,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetDuckSpeed(math.Clamp(val,0.005,0.995))
 	end
-	
+
 	--- Sets UnDuck Speed
 	-- @server
 	-- @param number newunduckspeed New UnDuck speed, This is a multiplier from 0 to 1.
@@ -707,7 +716,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetUnDuckSpeed(math.Clamp(val,0.005,0.995))
 	end
-	
+
 	--- Sets Ladder Climb Speed, probably unstable
 	-- @server
 	-- @param number newladderclimbspeed New Ladder Climb speed.
@@ -717,7 +726,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetLadderClimbSpeed(math.max(val,0))
 	end
-	
+
 	--- Sets Max Speed
 	-- @server
 	-- @param number newmaxspeed New Max speed.
@@ -727,7 +736,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetMaxSpeed(math.max(val,0))
 	end
-	
+
 	--- Sets Run Speed ( +speed )
 	-- @server
 	-- @param number newrunspeed New Run speed.
@@ -737,7 +746,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetRunSpeed(math.max(val,0))
 	end
-	
+
 	--- Sets Slow Walk Speed ( +walk )
 	-- @server
 	-- @param number newslowwalkspeed New Slow Walk speed.
@@ -747,7 +756,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetSlowWalkSpeed(math.max(val,0))
 	end
-	
+
 	--- Sets Walk Speed
 	-- @server
 	-- @param number newwalkspeed New Walk speed.
@@ -757,7 +766,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetWalkSpeed(math.max(val,0))
 	end
-	
+
 	--- Sets Jump Power
 	-- @server
 	-- @param number newjumppower New Jump Power.
@@ -767,7 +776,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetJumpPower(math.max(val,0))
 	end
-	
+
 	--- Sets Step Size
 	-- @server
 	-- @param number newstepsize New Step Size.
@@ -777,7 +786,7 @@ if SERVER then
 		checkvalidnumber(val)
 		ent:SetStepSize(math.max(val,0))
 	end
-	
+
 	--- Sets Friction
 	-- @server
 	-- @param number newfriction New Friction.