--!
nonstrict
------------------------------------------------------------------------
-- Freecam
-- Cinematic free camera for spectating and video production.
------------------------------------------------------------------------
local pi = [Link]
local abs = [Link]
local clamp = [Link]
local exp = [Link]
local rad = [Link]
local sign = [Link]
local sqrt = [Link]
local tan = [Link]
local ContextActionService = game:GetService("ContextActionService")
local Players = game:GetService("Players")
local RunService = game:GetService("RunService")
local StarterGui = game:GetService("StarterGui")
local UserInputService = game:GetService("UserInputService")
local Workspace = game:GetService("Workspace")
local Settings = UserSettings()
local GameSettings = [Link]
local LocalPlayer = [Link]
if not LocalPlayer then
Players:GetPropertyChangedSignal("LocalPlayer"):Wait()
LocalPlayer = [Link]
end
local Camera = [Link]
Workspace:GetPropertyChangedSignal("CurrentCamera"):Connect(function()
local newCamera = [Link]
if newCamera then
Camera = newCamera
end
end)
local FFlagUserExitFreecamBreaksWithShiftlock
do
local success, result = pcall(function()
return
UserSettings():IsUserFeatureEnabled("UserExitFreecamBreaksWithShiftlock")
end)
FFlagUserExitFreecamBreaksWithShiftlock = success and result
end
local FFlagUserShowGuiHideToggles
do
local success, result = pcall(function()
return UserSettings():IsUserFeatureEnabled("UserShowGuiHideToggles")
end)
FFlagUserShowGuiHideToggles = success and result
end
------------------------------------------------------------------------
local FREECAM_ENABLED_ATTRIBUTE_NAME = "FreecamEnabled"
local TOGGLE_INPUT_PRIORITY = [Link]
local INPUT_PRIORITY = [Link]
local FREECAM_MACRO_KB = {[Link], [Link].P}
local NAV_GAIN = [Link](1, 1, 1)*64
local PAN_GAIN = [Link](0.75, 1)*8
local FOV_GAIN = 300
local PITCH_LIMIT = rad(90)
local VEL_STIFFNESS = 1.5
local PAN_STIFFNESS = 1.0
local FOV_STIFFNESS = 4.0
------------------------------------------------------------------------
local Spring = {} do
Spring.__index = Spring
function [Link](freq, pos)
local self = setmetatable({}, Spring)
self.f = freq
self.p = pos
self.v = pos*0
return self
end
function Spring:Update(dt, goal)
local f = self.f*2*pi
local p0 = self.p
local v0 = self.v
local offset = goal - p0
local decay = exp(-f*dt)
local p1 = goal + (v0*dt - offset*(f*dt + 1))*decay
local v1 = (f*dt*(offset*f - v0) + v0)*decay
self.p = p1
self.v = v1
return p1
end
function Spring:Reset(pos)
self.p = pos
self.v = pos*0
end
end
------------------------------------------------------------------------
local cameraPos = [Link]()
local cameraRot = [Link]()
local cameraFov = 0
local velSpring = [Link](VEL_STIFFNESS, [Link]())
local panSpring = [Link](PAN_STIFFNESS, [Link]())
local fovSpring = [Link](FOV_STIFFNESS, 0)
------------------------------------------------------------------------
local Input = {} do
local thumbstickCurve do
local K_CURVATURE = 2.0
local K_DEADZONE = 0.15
local function fCurve(x)
return (exp(K_CURVATURE*x) - 1)/(exp(K_CURVATURE) - 1)
end
local function fDeadzone(x)
return fCurve((x - K_DEADZONE)/(1 - K_DEADZONE))
end
function thumbstickCurve(x)
return sign(x)*clamp(fDeadzone(abs(x)), 0, 1)
end
end
local gamepad = {
ButtonX = 0,
ButtonY = 0,
DPadDown = 0,
DPadUp = 0,
ButtonL2 = 0,
ButtonR2 = 0,
Thumbstick1 = [Link](),
Thumbstick2 = [Link](),
}
local keyboard = {
W = 0,
A = 0,
S = 0,
D = 0,
E = 0,
Q = 0,
U = 0,
H = 0,
J = 0,
K = 0,
I = 0,
Y = 0,
Up = 0,
Down = 0,
LeftShift = 0,
RightShift = 0,
}
local mouse = {
Delta = [Link](),
MouseWheel = 0,
}
local NAV_GAMEPAD_SPEED = [Link](1, 1, 1)
local NAV_KEYBOARD_SPEED = [Link](1, 1, 1)
local PAN_MOUSE_SPEED = [Link](1, 1)*(pi/64)
local PAN_GAMEPAD_SPEED = [Link](1, 1)*(pi/8)
local FOV_WHEEL_SPEED = 1.0
local FOV_GAMEPAD_SPEED = 0.25
local NAV_ADJ_SPEED = 0.75
local NAV_SHIFT_MUL = 0.25
local navSpeed = 1
function [Link](dt)
navSpeed = clamp(navSpeed + dt*([Link] -
[Link])*NAV_ADJ_SPEED, 0.01, 4)
local kGamepad = [Link](
thumbstickCurve(gamepad.Thumbstick1.X),
thumbstickCurve(gamepad.ButtonR2) -
thumbstickCurve(gamepad.ButtonL2),
thumbstickCurve(-gamepad.Thumbstick1.Y)
)*NAV_GAMEPAD_SPEED
local kKeyboard = [Link](
keyboard.D - keyboard.A + keyboard.K - keyboard.H,
keyboard.E - keyboard.Q + keyboard.I - keyboard.Y,
keyboard.S - keyboard.W + keyboard.J - keyboard.U
)*NAV_KEYBOARD_SPEED
local shift = UserInputService:IsKeyDown([Link]) or
UserInputService:IsKeyDown([Link])
return (kGamepad + kKeyboard)*(navSpeed*(shift and NAV_SHIFT_MUL or 1))
end
function [Link](dt)
local kGamepad = [Link](
thumbstickCurve(gamepad.Thumbstick2.Y),
thumbstickCurve(-gamepad.Thumbstick2.X)
)*PAN_GAMEPAD_SPEED
local kMouse = [Link]*PAN_MOUSE_SPEED
[Link] = [Link]()
return kGamepad + kMouse
end
function [Link](dt)
local kGamepad = ([Link] - [Link])*FOV_GAMEPAD_SPEED
local kMouse = [Link]*FOV_WHEEL_SPEED
[Link] = 0
return kGamepad + kMouse
end
do
local function Keypress(action, state, input)
keyboard[[Link]] = state == [Link]
and 1 or 0
return [Link]
end
local function GpButton(action, state, input)
gamepad[[Link]] = state == [Link]
and 1 or 0
return [Link]
end
local function MousePan(action, state, input)
local delta = [Link]
[Link] = [Link](-delta.y, -delta.x)
return [Link]
end
local function Thumb(action, state, input)
gamepad[[Link]] = [Link]
return [Link]
end
local function Trigger(action, state, input)
gamepad[[Link]] = [Link].z
return [Link]
end
local function MouseWheel(action, state, input)
mouse[[Link]] = -[Link].z
return [Link]
end
local function Zero(t)
for k, v in pairs(t) do
t[k] = v*0
end
end
function [Link]()
ContextActionService:BindActionAtPriority("FreecamKeyboard",
Keypress, false, INPUT_PRIORITY,
[Link].W, [Link].U,
[Link].A, [Link].H,
[Link].S, [Link].J,
[Link].D, [Link].K,
[Link].E, [Link].I,
[Link].Q, [Link].Y,
[Link], [Link]
)
ContextActionService:BindActionAtPriority("FreecamMousePan",
MousePan, false, INPUT_PRIORITY, [Link])
ContextActionService:BindActionAtPriority("FreecamMouseWheel",
MouseWheel, false, INPUT_PRIORITY, [Link])
ContextActionService:BindActionAtPriority("FreecamGamepadButton",
GpButton, false, INPUT_PRIORITY, [Link], [Link])
ContextActionService:BindActionAtPriority("FreecamGamepadTrigger",
Trigger, false, INPUT_PRIORITY, [Link].ButtonR2, [Link].ButtonL2)
ContextActionService:BindActionAtPriority("FreecamGamepadThumbstick", Thumb,
false, INPUT_PRIORITY, [Link].Thumbstick1, [Link].Thumbstick2)
end
function [Link]()
navSpeed = 1
Zero(gamepad)
Zero(keyboard)
Zero(mouse)
ContextActionService:UnbindAction("FreecamKeyboard")
ContextActionService:UnbindAction("FreecamMousePan")
ContextActionService:UnbindAction("FreecamMouseWheel")
ContextActionService:UnbindAction("FreecamGamepadButton")
ContextActionService:UnbindAction("FreecamGamepadTrigger")
ContextActionService:UnbindAction("FreecamGamepadThumbstick")
end
end
end
------------------------------------------------------------------------
local function StepFreecam(dt)
local vel = velSpring:Update(dt, [Link](dt))
local pan = panSpring:Update(dt, [Link](dt))
local fov = fovSpring:Update(dt, [Link](dt))
local zoomFactor = sqrt(tan(rad(70/2))/tan(rad(cameraFov/2)))
cameraFov = clamp(cameraFov + fov*FOV_GAIN*(dt/zoomFactor), 1, 120)
cameraRot = cameraRot + pan*PAN_GAIN*(dt/zoomFactor)
cameraRot = [Link](clamp(cameraRot.x, -PITCH_LIMIT, PITCH_LIMIT),
cameraRot.y%(2*pi))
local cameraCFrame =
[Link](cameraPos)*[Link](cameraRot.x, cameraRot.y,
0)*[Link](vel*NAV_GAIN*dt)
cameraPos = cameraCFrame.p
[Link] = cameraCFrame
[Link] = cameraCFrame
[Link] = cameraFov
end
local function CheckMouseLockAvailability()
local devAllowsMouseLock = [Link]
local devMovementModeIsScriptable =
[Link] ==
[Link]
local userHasMouseLockModeEnabled = [Link] ==
[Link]
local userHasClickToMoveEnabled = [Link] ==
[Link]
local MouseLockAvailable = devAllowsMouseLock and userHasMouseLockModeEnabled
and not userHasClickToMoveEnabled and not devMovementModeIsScriptable
return MouseLockAvailable
end
------------------------------------------------------------------------
local PlayerState = {} do
local mouseBehavior
local mouseIconEnabled
local cameraType
local cameraFocus
local cameraCFrame
local cameraFieldOfView
local screenGuis = {}
local coreGuis = {
Backpack = true,
Chat = true,
Health = true,
PlayerList = true,
}
local setCores = {
BadgesNotificationsActive = true,
PointsNotificationsActive = true,
}
-- Save state and set up for freecam
function [Link]()
for name in pairs(coreGuis) do
coreGuis[name] =
StarterGui:GetCoreGuiEnabled([Link][name])
StarterGui:SetCoreGuiEnabled([Link][name], false)
end
for name in pairs(setCores) do
setCores[name] = StarterGui:GetCore(name)
StarterGui:SetCore(name, false)
end
local playergui = LocalPlayer:FindFirstChildOfClass("PlayerGui")
if playergui then
for _, gui in pairs(playergui:GetChildren()) do
if gui:IsA("ScreenGui") and [Link] then
screenGuis[#screenGuis + 1] = gui
[Link] = false
end
end
end
cameraFieldOfView = [Link]
[Link] = 70
cameraType = [Link]
[Link] = [Link]
cameraCFrame = [Link]
cameraFocus = [Link]
mouseIconEnabled = [Link]
[Link] = false
if FFlagUserExitFreecamBreaksWithShiftlock and
CheckMouseLockAvailability() then
mouseBehavior = [Link]
else
mouseBehavior = [Link]
end
[Link] = [Link]
end
-- Restore state
function [Link]()
for name, isEnabled in pairs(coreGuis) do
StarterGui:SetCoreGuiEnabled([Link][name], isEnabled)
end
for name, isEnabled in pairs(setCores) do
StarterGui:SetCore(name, isEnabled)
end
for _, gui in pairs(screenGuis) do
if [Link] then
[Link] = true
end
end
[Link] = cameraFieldOfView
cameraFieldOfView = nil
[Link] = cameraType
cameraType = nil
[Link] = cameraCFrame
cameraCFrame = nil
[Link] = cameraFocus
cameraFocus = nil
[Link] = mouseIconEnabled
mouseIconEnabled = nil
[Link] = mouseBehavior
mouseBehavior = nil
end
end
local function StartFreecam()
if FFlagUserShowGuiHideToggles then
script:SetAttribute(FREECAM_ENABLED_ATTRIBUTE_NAME, true)
end
local cameraCFrame = [Link]
cameraRot = [Link](cameraCFrame:toEulerAnglesYXZ())
cameraPos = cameraCFrame.p
cameraFov = [Link]
velSpring:Reset([Link]())
panSpring:Reset([Link]())
fovSpring:Reset(0)
[Link]()
RunService:BindToRenderStep("Freecam", [Link],
StepFreecam)
[Link]()
end
local function StopFreecam()
if FFlagUserShowGuiHideToggles then
script:SetAttribute(FREECAM_ENABLED_ATTRIBUTE_NAME, false)
end
[Link]()
RunService:UnbindFromRenderStep("Freecam")
[Link]()
end
------------------------------------------------------------------------
do
local enabled = false
local function ToggleFreecam()
if enabled then
StopFreecam()
else
StartFreecam()
end
enabled = not enabled
end
local function CheckMacro(macro)
for i = 1, #macro - 1 do
if not UserInputService:IsKeyDown(macro[i]) then
return
end
end
ToggleFreecam()
end
local function HandleActivationInput(action, state, input)
if state == [Link] then
if [Link] == FREECAM_MACRO_KB[#FREECAM_MACRO_KB] then
CheckMacro(FREECAM_MACRO_KB)
end
end
return [Link]
end
ContextActionService:BindActionAtPriority("FreecamToggle",
HandleActivationInput, false, TOGGLE_INPUT_PRIORITY,
FREECAM_MACRO_KB[#FREECAM_MACRO_KB])
if FFlagUserShowGuiHideToggles then
script:SetAttribute(FREECAM_ENABLED_ATTRIBUTE_NAME, enabled)
script:GetAttributeChangedSignal(FREECAM_ENABLED_ATTRIBUTE_NAME):Connect(function()
local attributeValue =
script:GetAttribute(FREECAM_ENABLED_ATTRIBUTE_NAME)
if typeof(attributeValue) ~= "boolean" then
script:SetAttribute(FREECAM_ENABLED_ATTRIBUTE_NAME,
enabled)
return
end
-- If the attribute's value and `enabled` var don't match, pick
attribute value as
-- source of truth
if attributeValue ~= enabled then
if attributeValue then
StartFreecam()
enabled = true
else
StopFreecam()
enabled = false
end
end
end)
end
end