- Added VR speaker transparency

- Make orb follow VR speakers

Author: dmurfet

src/client/Gui.lua

@@ -8,6 +8,7 @@ local CollectionService = game:GetService("CollectionService")
 local TweenService = game:GetService("TweenService")
 local RunService = game:GetService("RunService")
 local ProximityPromptService = game:GetService("ProximityPromptService")
+local VRService = game:GetService("VRService")
 
 local Players = game:GetService("Players")
 local Config = require(Common.Config)
@@ -24,6 +25,8 @@ local OrbListenOnRemoteEvent = Common.Remotes.OrbListenOn
 local OrbListenOffRemoteEvent = Common.Remotes.OrbListenOff
 local OrbcamOnRemoteEvent = Common.Remotes.OrbcamOn
 local OrbcamOffRemoteEvent = Common.Remotes.OrbcamOff
+local VRSpeakerChalkEquipRemoteEvent = Common.Remotes.VRSpeakerChalkEquip
+local VRSpeakerChalkUnequipRemoteEvent = Common.Remotes.VRSpeakerChalkUnequip
 
 local localPlayer
 
@@ -195,9 +198,10 @@ function Gui.Init()
 
         -- Do not allow Shift-C to turn _off_ orbcam that was turned on
         -- via the topbar button
-        if Gui.Orbcam and not Gui.OrbcamGuiOff then
-            return
-        end
+        if Gui.Orbcam and not Gui.OrbcamGuiOff then return end
+
+        -- Do not allow the shortcut when not attached
+        if Gui.Orb == nil then return end
 
         if Gui.OrbcamIcon:getToggleState() == "selected" then
             Gui.OrbcamIcon:deselect()
@@ -223,11 +227,67 @@ function Gui.Init()
     OrbTweeningStartRemoteEvent.OnClientEvent:Connect(Gui.OrbTweeningStart)
     OrbTweeningStopRemoteEvent.OnClientEvent:Connect(Gui.OrbTweeningStop)
 
+    -- In VR we need to tell other clients when we equip the chalk
+    if VRService.VREnabled then
+        local chalkTool = localPlayer.Backpack:WaitForChild("MetaChalk", 20)
+        if chalkTool ~= nil then
+            chalkTool.Equipped:Connect(function()
+                VRSpeakerChalkEquipRemoteEvent:FireServer()
+            end)
+            chalkTool.Unequipped:Connect(function()
+                VRSpeakerChalkUnequipRemoteEvent:FireServer()
+            end)
+        else
+            print("[MetaOrb] Failed to find MetaChalk tool")
+        end
+    end
+	
+    Gui.HandleVR()
     Gui.CreateTopbarItems()
 
 	print("[Orb] Gui Initialised")
 end
 
+function Gui.MakePlayerTransparent(plr, transparency)
+    if plr == nil then
+        print("[MetaOrb] Passed nil player to MakePlayerTransparent")
+        return
+    end
+
+    if plr.Character == nil then return end
+
+    local character = plr.Character
+
+    for _, desc in ipairs(character:GetDescendants()) do
+		if desc:IsA("BasePart") then
+			desc.Transparency = 1 - (transparency * (1 - desc.Transparency))
+			desc.CastShadow = false
+		end
+	end
+
+    -- origTransparency = 1 - 1/0.2 * (1 - newTransparency)
+end
+
+function Gui.HandleVR()
+    VRSpeakerChalkEquipRemoteEvent.OnClientEvent:Connect(function(speaker)
+		if Gui.Orb == nil then return end
+        if Gui.Orb.Speaker.Value == nil then return end
+        if Gui.Orb.Speaker.Value ~= speaker then return end
+
+        if speaker == localPlayer then return end
+        Gui.MakePlayerTransparent(speaker, 0.2)
+	end)
+
+    VRSpeakerChalkUnequipRemoteEvent.OnClientEvent:Connect(function(speaker)
+		if Gui.Orb == nil then return end
+        if Gui.Orb.Speaker.Value == nil then return end
+        if Gui.Orb.Speaker.Value ~= speaker then return end
+
+        if speaker == localPlayer then return end
+        Gui.MakePlayerTransparent(speaker, 1/0.2)
+	end)
+end
+
 -- We create a part inside the player's head, whose CFrame
 -- is tracked by SetListener
 function Gui.InitEar()
@@ -430,12 +490,32 @@ function Gui.AttachSpeaker(orb)
 
     -- This event fires when the running speed changes
     local humanoid = localPlayer.Character:WaitForChild("Humanoid")
-    Gui.RunningConnection = humanoid.Running:Connect(function(speed)
-        if speed == 0 then
-            -- They were moving and then stood still
-            OrbSpeakerMovedRemoteEvent:FireServer(Gui.Orb)
-        end
-    end)
+    if VRService.VREnabled then
+        local counter = 0
+        local timeTillPositionCheck = 2
+        local playerPosAtLastCheck = localPlayer.Character.PrimaryPart.Position
+
+        Gui.RunningConnection = RunService.Heartbeat:Connect(function(step)
+            counter = counter + step
+            if counter >= timeTillPositionCheck then
+                counter -= timeTillPositionCheck
+                
+                if localPlayer.Character ~= nil and localPlayer.Character.PrimaryPart ~= nil then
+                    if (localPlayer.Character.PrimaryPart.Position - playerPosAtLastCheck).Magnitude > 2 then
+                        OrbSpeakerMovedRemoteEvent:FireServer(Gui.Orb)
+                    end
+                    playerPosAtLastCheck = localPlayer.Character.PrimaryPart.Position
+                end
+            end
+        end)
+    else
+        Gui.RunningConnection = humanoid.Running:Connect(function(speed)
+            if speed == 0 then
+                -- They were moving and then stood still
+                OrbSpeakerMovedRemoteEvent:FireServer(Gui.Orb)
+            end
+        end)
+    end
 end
 
 function Gui.CreateTopbarItems()

src/common/Config.lua

@@ -4,7 +4,7 @@ local Config = {
 	WaypointTag = "metaorb_waypoint",
 	PointOfInterestTag = "metaorb_poi",
 	DataStoreTag = "orb.",
-	Version = "0.7.4",
+	Version = "0.7.6",
 	TweenTime = 5,
 	RopeLength = 10,
 	TransportWaitTime = 10,

src/common/Remotes.model.json

@@ -60,6 +60,14 @@
 		{
 			"Name": "GetAttachments",
 			"ClassName": "RemoteFunction"
+		},
+		{
+			"Name": "VRSpeakerChalkEquip",
+			"ClassName": "RemoteEvent"
+		},
+		{
+			"Name": "VRSpeakerChalkUnequip",
+			"ClassName": "RemoteEvent"
 		}
 	]
 }

src/server/Orb.lua

@@ -21,6 +21,8 @@ local OrbcamOffRemoteEvent = Common.Remotes.OrbcamOff
 local GetOrbcamStatusRemoteFunction = Common.Remotes.GetOrbcamStatus
 local GetListeningStatusRemoteFunction = Common.Remotes.GetListeningStatus
 local GetAttachmentsRemoteFunction = Common.Remotes.GetAttachments
+local VRSpeakerChalkEquipRemoteEvent = Common.Remotes.VRSpeakerChalkEquip
+local VRSpeakerChalkUnequipRemoteEvent = Common.Remotes.VRSpeakerChalkUnequip
 
 local speakerAttachSoundIds = { 7873470625, 7873470425,
 7873469842, 7873470126, 7864771146, 7864770493, 8214755036, 8214754703}
@@ -148,6 +150,14 @@ function Orb.Init()
 		end
 	end)
 
+	VRSpeakerChalkEquipRemoteEvent.OnServerEvent:Connect(function(plr)
+		VRSpeakerChalkEquipRemoteEvent:FireAllClients(plr)
+	end)
+
+	VRSpeakerChalkUnequipRemoteEvent.OnServerEvent:Connect(function(plr)
+		VRSpeakerChalkUnequipRemoteEvent:FireAllClients(plr)
+	end)
+
 	print("[Orb] Server ".. Config.Version .." initialized")
 end
 
@@ -554,7 +564,15 @@ function Orb.PlayAttachSpeakerSound(orb, changeSound)
 end
 
 function Orb.RotateGhostToFaceSpeaker(orb, ghost)
-	if not ghost then return end
+	if ghost == nil then
+		print("[MetaOrb] Passed nil ghost")
+		return
+	end
+
+	if ghost.PrimaryPart == nil then
+		print("[MetaOrb] Ghost has nil primary part")
+		return
+	end
 
 	local speakerPos = Orb.GetSpeakerPosition(orb)
 	if not speakerPos then return end