@rbxts/touch-button 1.0.0

package/out/client/touch-button.d.ts

@@ -0,0 +1,25 @@
+import { TouchButtonConfig } from '../shared/remotes';
+export declare class TouchButton {
+    private touchBtn;
+    private name;
+    private defaultConfig;
+    private configUpdateScheduled;
+    static configEditingMode: import("@rbxts/charm").Atom<boolean>;
+    static touchButtons: TouchButton[];
+    constructor(options: {
+        name: string;
+        icon: string;
+        size: UDim2;
+        position: UDim2;
+        onPress?: () => void;
+        onRelease?: () => void;
+    });
+    setIcon(icon: string): void;
+    setSize(size: UDim2): void;
+    setPosition(position: UDim2): void;
+    setConfig(config: TouchButtonConfig): void;
+    private scheduleConfigUpdate;
+    private updateConfig;
+    private resetConfigToDefault;
+    destroy(): void;
+}

package/out/client/touch-button.luau

@@ -0,0 +1,292 @@
+-- Compiled with roblox-ts v3.0.0
+local TS = _G[script]
+local observeProperty = TS.import(script, TS.getModule(script, "@rbxts", "roblox-observers").out["observe-property"]).observeProperty
+local _services = TS.import(script, TS.getModule(script, "@rbxts", "services"))
+local Players = _services.Players
+local UserInputService = _services.UserInputService
+local Workspace = _services.Workspace
+local remotes = TS.import(script, script.Parent.Parent, "shared", "remotes").remotes
+local _charm = TS.import(script, TS.getModule(script, "@rbxts", "charm"))
+local atom = _charm.atom
+local effect = _charm.effect
+local Trove = TS.import(script, TS.getModule(script, "@rbxts", "trove").out).Trove
+local localPlayer = Players.LocalPlayer
+local camera = Workspace.CurrentCamera
+local touchGui
+local jumpBtn
+local EDITING_MODE_BUTTON_COLOR = Color3.fromRGB(15, 143, 255)
+local MIN_RESIZE = 40
+-- This is taken from TouchJump.lua in PlayerScripts.
+local function getJumpButtonLayout()
+	local minAxis = math.min(camera.ViewportSize.X, camera.ViewportSize.Y)
+	local isSmallScreen = minAxis <= 500
+	local jumpButtonSize = if isSmallScreen then 70 else 120
+	return {
+		size = UDim2.fromOffset(jumpButtonSize, jumpButtonSize),
+		position = if isSmallScreen then UDim2.new(1, -(jumpButtonSize * 1.5 - 10), 1, -jumpButtonSize - 20) else UDim2.new(1, -(jumpButtonSize * 1.5 - 10), 1, -jumpButtonSize * 1.75),
+	}
+end
+local function getTouchGui()
+	if touchGui and jumpBtn then
+		return { touchGui, jumpBtn }
+	end
+	touchGui = Instance.new("ScreenGui")
+	touchGui.Name = "CustomTouchGui"
+	touchGui.ResetOnSpawn = false
+	touchGui.Parent = localPlayer.PlayerGui
+	jumpBtn = Instance.new("Frame")
+	jumpBtn.Name = "Jump"
+	jumpBtn.BackgroundTransparency = 1
+	observeProperty(camera, "ViewportSize", function()
+		local jumpBtnLayout = getJumpButtonLayout()
+		jumpBtn.Position = jumpBtnLayout.position
+		jumpBtn.Size = jumpBtnLayout.size
+	end)
+	jumpBtn.Parent = touchGui
+	local characterExists = atom(not not localPlayer.Character)
+	local lastInputType = atom(UserInputService:GetLastInputType())
+	effect(function()
+		local charExists = characterExists()
+		local inputType = lastInputType()
+		touchGui.Enabled = (inputType == Enum.UserInputType.Touch) and charExists
+	end)
+	localPlayer.CharacterAdded:Connect(function()
+		characterExists(true)
+	end)
+	localPlayer.CharacterRemoving:Connect(function()
+		characterExists(false)
+	end)
+	UserInputService.LastInputTypeChanged:Connect(lastInputType)
+	return { touchGui, jumpBtn }
+end
+local TouchButton
+do
+	TouchButton = setmetatable({}, {
+		__tostring = function()
+			return "TouchButton"
+		end,
+	})
+	TouchButton.__index = TouchButton
+	function TouchButton.new(...)
+		local self = setmetatable({}, TouchButton)
+		return self:constructor(...) or self
+	end
+	function TouchButton:constructor(options)
+		self.configUpdateScheduled = false
+		self.name = options.name
+		self.defaultConfig = {
+			position = options.position,
+			size = options.size,
+		}
+		local configPromise = remotes.getTouchButtonConfig:request(options.name)
+		local touchBtn = Instance.new("ImageButton")
+		touchBtn.Name = "TouchButton"
+		touchBtn.Active = false
+		touchBtn.Image = "http://www.roblox.com/asset/?id=15340864550"
+		touchBtn.ImageColor3 = Color3.fromRGB(255, 255, 255)
+		touchBtn.ImageTransparency = 0.5
+		touchBtn.AnchorPoint = Vector2.new(0.5, 0.5)
+		touchBtn.BackgroundTransparency = 1
+		touchBtn.Size = UDim2.fromScale(1, 1)
+		local iconImage = Instance.new("ImageLabel")
+		iconImage.Name = "Icon"
+		iconImage.AnchorPoint = Vector2.new(0.5, 0.5)
+		iconImage.BackgroundTransparency = 1
+		iconImage.ImageTransparency = 0.2
+		iconImage.Position = UDim2.fromScale(0.5, 0.5)
+		iconImage.Size = UDim2.fromScale(0.56, 0.56)
+		iconImage.Parent = touchBtn
+		touchBtn.InputBegan:Connect(function(input)
+			if (input.UserInputType ~= Enum.UserInputType.MouseButton1) and (input.UserInputType ~= Enum.UserInputType.Touch) then
+				return nil
+			end
+			if input.UserInputState ~= Enum.UserInputState.Begin then
+				return nil
+			end
+			if TouchButton.configEditingMode() then
+				return nil
+			end
+			touchBtn.ImageColor3 = Color3.fromRGB(200, 200, 200)
+			iconImage.ImageColor3 = Color3.fromRGB(200, 200, 200)
+			local _result = options.onPress
+			if _result ~= nil then
+				_result()
+			end
+			local connection
+			connection = input:GetPropertyChangedSignal("UserInputState"):Connect(function()
+				if input.UserInputState ~= Enum.UserInputState.End then
+					return nil
+				end
+				connection:Disconnect()
+				touchBtn.ImageColor3 = Color3.fromRGB(255, 255, 255)
+				iconImage.ImageColor3 = Color3.fromRGB(255, 255, 255)
+				local _result_1 = options.onRelease
+				if _result_1 ~= nil then
+					_result_1()
+				end
+			end)
+		end)
+		local editingTrove = Trove.new()
+		effect(function()
+			local isEditing = TouchButton.configEditingMode()
+			if isEditing then
+				touchBtn.Active = true
+				touchBtn.ImageColor3 = EDITING_MODE_BUTTON_COLOR
+				iconImage.ImageColor3 = EDITING_MODE_BUTTON_COLOR
+				do
+					local resetBtn = Instance.new("TextButton")
+					resetBtn.Name = "Reset"
+					resetBtn.AnchorPoint = Vector2.new(0.5, 0.5)
+					resetBtn.BackgroundColor3 = Color3.new()
+					resetBtn.BackgroundTransparency = 0.25
+					resetBtn.FontFace = Font.new("rbxasset://fonts/families/GothamSSm.json", Enum.FontWeight.Medium, Enum.FontStyle.Normal)
+					resetBtn.Position = UDim2.fromScale(0.5, 0.5)
+					resetBtn.Size = UDim2.fromOffset(120, 32)
+					resetBtn.Text = "Reset Buttons"
+					resetBtn.TextColor3 = Color3.new(1, 1, 1)
+					resetBtn.TextSize = 16
+					resetBtn.Parent = touchGui
+					editingTrove:add(resetBtn)
+					local UICorner = Instance.new("UICorner")
+					UICorner.CornerRadius = UDim.new(0, 5)
+					UICorner.Parent = resetBtn
+					resetBtn.MouseButton1Click:Connect(function()
+						for _1, touchBtn in TouchButton.touchButtons do
+							touchBtn:resetConfigToDefault()
+						end
+					end)
+				end
+				local resizeBtn = Instance.new("ImageButton")
+				resizeBtn.AnchorPoint = Vector2.new(0.5, 0.5)
+				resizeBtn.BackgroundTransparency = 1
+				resizeBtn.Image = "http://www.roblox.com/asset/?id=101680714548913"
+				resizeBtn.Position = UDim2.fromScale(0.82, 0.82)
+				resizeBtn.Size = UDim2.fromOffset(18, 18)
+				resizeBtn.Parent = touchBtn
+				editingTrove:add(resizeBtn)
+				resizeBtn.InputBegan:Connect(function(input)
+					if (input.UserInputType ~= Enum.UserInputType.MouseButton1) and (input.UserInputType ~= Enum.UserInputType.Touch) then
+						return nil
+					end
+					if input.UserInputState ~= Enum.UserInputState.Begin then
+						return nil
+					end
+					local parentSize = (touchBtn.Parent).AbsoluteSize
+					local initialAbsSize = touchBtn.AbsoluteSize
+					local initialPos = Vector2.new(input.Position.X, input.Position.Y)
+					local moveConn = UserInputService.InputChanged:Connect(function(moveInput)
+						if (moveInput.UserInputType ~= Enum.UserInputType.MouseMovement) and (moveInput.UserInputType ~= Enum.UserInputType.Touch) then
+							return nil
+						end
+						local delta = Vector2.new(moveInput.Position.X, moveInput.Position.Y) - initialPos
+						local maxDelta = math.max(delta.X, delta.Y)
+						local newAbsSize = initialAbsSize.X + maxDelta
+						local finalAbsSize = math.max(MIN_RESIZE, newAbsSize)
+						local finalScale = finalAbsSize / parentSize.X
+						self:setSize(UDim2.fromScale(finalScale, finalScale))
+					end)
+					local endConn
+					endConn = UserInputService.InputEnded:Connect(function(endInput)
+						if (endInput.UserInputType ~= Enum.UserInputType.MouseButton1) and (endInput.UserInputType ~= Enum.UserInputType.Touch) then
+							return nil
+						end
+						moveConn:Disconnect()
+						endConn:Disconnect()
+					end)
+				end)
+				editingTrove:add(touchBtn.InputBegan:Connect(function(input)
+					if (input.UserInputType ~= Enum.UserInputType.MouseButton1) and (input.UserInputType ~= Enum.UserInputType.Touch) then
+						return nil
+					end
+					if input.UserInputState ~= Enum.UserInputState.Begin then
+						return nil
+					end
+					local parentSize = (touchBtn.Parent).AbsoluteSize
+					local initialInputPos = Vector2.new(input.Position.X, input.Position.Y)
+					local initialBtnPos = touchBtn.Position
+					local moveConn = UserInputService.InputChanged:Connect(function(moveInput)
+						if (moveInput.UserInputType ~= Enum.UserInputType.MouseMovement) and (moveInput.UserInputType ~= Enum.UserInputType.Touch) then
+							return nil
+						end
+						local currentPos = Vector2.new(moveInput.Position.X, moveInput.Position.Y)
+						local delta = currentPos - initialInputPos
+						local deltaScale = Vector2.new(delta.X / parentSize.X, delta.Y / parentSize.Y)
+						self:setPosition(UDim2.fromScale(initialBtnPos.X.Scale + deltaScale.X, initialBtnPos.Y.Scale + deltaScale.Y))
+					end)
+					local endConn
+					endConn = UserInputService.InputEnded:Connect(function(endInput)
+						if (endInput.UserInputType ~= Enum.UserInputType.MouseButton1) and (endInput.UserInputType ~= Enum.UserInputType.Touch) then
+							return nil
+						end
+						moveConn:Disconnect()
+						endConn:Disconnect()
+					end)
+				end))
+			else
+				editingTrove:clean()
+				touchBtn.Active = false
+				touchBtn.ImageColor3 = Color3.fromRGB(255, 255, 255)
+				iconImage.ImageColor3 = Color3.fromRGB(255, 255, 255)
+			end
+		end)
+		self.touchBtn = touchBtn
+		self:setIcon(options.icon)
+		self:setSize(options.size)
+		self:setPosition(options.position)
+		configPromise:andThen(function(config)
+			if not config then
+				return nil
+			end
+			self:setConfig(config)
+		end)
+		local _binding = getTouchGui()
+		local _ = _binding[1]
+		local jumpBtn = _binding[2]
+		touchBtn.Parent = jumpBtn
+		local _touchButtons = TouchButton.touchButtons
+		local _self = self
+		table.insert(_touchButtons, _self)
+	end
+	function TouchButton:setIcon(icon)
+		self.touchBtn.Icon.Image = icon
+	end
+	function TouchButton:setSize(size)
+		self.touchBtn.Size = size
+		self:scheduleConfigUpdate()
+	end
+	function TouchButton:setPosition(position)
+		self.touchBtn.Position = position
+		self:scheduleConfigUpdate()
+	end
+	function TouchButton:setConfig(config)
+		self:setPosition(config.position)
+		self:setSize(config.size)
+	end
+	function TouchButton:scheduleConfigUpdate()
+		if self.configUpdateScheduled then
+			return nil
+		end
+		self.configUpdateScheduled = true
+		task.defer(function()
+			self.configUpdateScheduled = false
+			self:updateConfig()
+		end)
+	end
+	function TouchButton:updateConfig()
+		remotes.setTouchButtonConfig:fire(self.name, {
+			position = self.touchBtn.Position,
+			size = self.touchBtn.Size,
+		})
+	end
+	function TouchButton:resetConfigToDefault()
+		self:setConfig(self.defaultConfig)
+	end
+	function TouchButton:destroy()
+		self.touchBtn:Destroy()
+	end
+	TouchButton.configEditingMode = atom(false)
+	TouchButton.touchButtons = {}
+end
+return {
+	TouchButton = TouchButton,
+}

package/out/index.d.ts

@@ -0,0 +1,2 @@
+export { TouchButton } from './client/touch-button';
+export { TouchButtonServer } from './server';

package/out/init.luau

@@ -0,0 +1,6 @@
+-- Compiled with roblox-ts v3.0.0
+local TS = _G[script]
+local exports = {}
+exports.TouchButton = TS.import(script, script, "client", "touch-button").TouchButton
+exports.TouchButtonServer = TS.import(script, script, "server").TouchButtonServer
+return exports

package/out/server/index.d.ts

@@ -0,0 +1,3 @@
+export declare namespace TouchButtonServer {
+    function init(validTouchButtonNames: Set<string>): void;
+}

package/out/server/init.luau

@@ -0,0 +1,115 @@
+-- Compiled with roblox-ts v3.0.0
+local TS = _G[script]
+local _services = TS.import(script, TS.getModule(script, "@rbxts", "services"))
+local DataStoreService = _services.DataStoreService
+local RunService = _services.RunService
+local remotes = TS.import(script, script.Parent, "shared", "remotes").remotes
+local observePlayers = TS.import(script, TS.getModule(script, "@rbxts", "roblox-observers").out["observe-players"]).observePlayers
+local Signal = TS.import(script, TS.getModule(script, "@rbxts", "sleitnick-signal"))
+local entriesCache = {}
+local playerDataLoaded = Signal.new()
+local initialized = false
+local function getDataStoreKeyForPlayer(player)
+	return `Player{player.UserId}`
+end
+local function waitForEntry(player)
+	local _player = player
+	local entry = entriesCache[_player]
+	if not entry then
+		local loadedPlayer
+		local loadedEntry
+		repeat
+			do
+				loadedPlayer, loadedEntry = playerDataLoaded:Wait()
+			end
+		until not (loadedPlayer ~= player)
+		entry = loadedEntry
+	end
+	return entry
+end
+local function serializeEntry(entry)
+	local res = {}
+	for buttonName, props in pairs(entry) do
+		local serializedProps = {}
+		for propKey, propValue in pairs(props) do
+			local serializedProp
+			if typeof(propValue) == "Vector2" then
+				serializedProp = { propValue.X, propValue.Y }
+			elseif typeof(propValue) == "UDim2" then
+				serializedProp = { propValue.X.Scale, propValue.X.Offset, propValue.Y.Scale, propValue.Y.Offset }
+			end
+			serializedProps[propKey] = serializedProp
+		end
+		res[buttonName] = serializedProps
+	end
+	return res
+end
+local function deserializeEntry(entry)
+	local res = {}
+	for buttonName, serializedProps in pairs(entry) do
+		local props = {}
+		for propKey, serializedValue in pairs(serializedProps) do
+			local deserializedProp
+			if #serializedValue == 2 then
+				deserializedProp = Vector2.new(serializedValue[1], serializedValue[2])
+			elseif #serializedValue == 4 then
+				deserializedProp = UDim2.new(serializedValue[1], serializedValue[2], serializedValue[3], serializedValue[4])
+			end
+			props[propKey] = deserializedProp
+		end
+		res[buttonName] = props
+	end
+	return res
+end
+local TouchButtonServer = {}
+do
+	local _container = TouchButtonServer
+	local function init(validTouchButtonNames)
+		local _arg0 = RunService:IsServer()
+		assert(_arg0, "TouchButtonServer can only be initialized from the server")
+		local _arg0_1 = not initialized
+		assert(_arg0_1, "TouchButtonServer already initialized")
+		initialized = true
+		local buttonsStore = DataStoreService:GetDataStore("TouchButtonConfigs")
+		remotes.getTouchButtonConfig:onRequest(function(player, buttonName)
+			local entry = waitForEntry(player)
+			return entry[buttonName]
+		end)
+		remotes.setTouchButtonConfig:connect(function(player, buttonName, config)
+			local _validTouchButtonNames = validTouchButtonNames
+			local _buttonName = buttonName
+			local _arg0_2 = _validTouchButtonNames[_buttonName] ~= nil
+			local _arg1 = `[TOUCH BUTTONS] {buttonName} is not a valid savable TouchButton name`
+			assert(_arg0_2, _arg1)
+			local entry = waitForEntry(player)
+			entry[buttonName] = config
+		end)
+		observePlayers(function(player)
+			local key = getDataStoreKeyForPlayer(player)
+			local suc, entryOrUndefinedOrErr = pcall(function()
+				return buttonsStore:GetAsync(key)
+			end)
+			if not suc then
+				warn(`[TOUCH BUTTONS] Failed to load DataStore entry:`, entryOrUndefinedOrErr)
+				return nil
+			end
+			local entry = if entryOrUndefinedOrErr ~= 0 and entryOrUndefinedOrErr == entryOrUndefinedOrErr and entryOrUndefinedOrErr ~= "" and entryOrUndefinedOrErr then deserializeEntry(entryOrUndefinedOrErr) else {}
+			local _player = player
+			local _entry = entry
+			entriesCache[_player] = _entry
+			playerDataLoaded:Fire(player, entry)
+			return function()
+				local _player_1 = player
+				local entry = entriesCache[_player_1]
+				if not entry then
+					return nil
+				end
+				buttonsStore:SetAsync(key, serializeEntry(entry), { player.UserId })
+			end
+		end)
+	end
+	_container.init = init
+end
+return {
+	TouchButtonServer = TouchButtonServer,
+}

package/out/shared/remotes.d.ts

@@ -0,0 +1,9 @@
+import { Server } from '@rbxts/remo';
+export interface TouchButtonConfig {
+    position: UDim2;
+    size: UDim2;
+}
+export declare const remotes: import("@rbxts/remo").Remotes<{
+    getTouchButtonConfig: import("@rbxts/remo").RemoteBuilder<(buttonName: string) => TouchButtonConfig | undefined, Server>;
+    setTouchButtonConfig: import("@rbxts/remo").RemoteBuilder<(buttonName: string, config: TouchButtonConfig) => void, Server>;
+}>;

package/out/shared/remotes.luau

@@ -0,0 +1,16 @@
+-- Compiled with roblox-ts v3.0.0
+local TS = _G[script]
+local _remo = TS.import(script, TS.getModule(script, "@rbxts", "remo").src)
+local createRemotes = _remo.createRemotes
+local remote = _remo.remote
+local t = TS.import(script, TS.getModule(script, "@rbxts", "t").lib.ts).t
+local remotes = createRemotes({
+	getTouchButtonConfig = remote(t.string).returns(),
+	setTouchButtonConfig = remote(t.string, t.strictInterface({
+		position = t.UDim2,
+		size = t.UDim2,
+	})),
+})
+return {
+	remotes = remotes,
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@rbxts/touch-button",
+  "version": "1.0.0",
+  "description": "",
+  "main": "out/init.lua",
+  "scripts": {
+    "build": "rbxtsc",
+    "watch": "rbxtsc -w",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [],
+  "author": "CriShoux",
+  "license": "ISC",
+  "type": "commonjs",
+  "types": "out/index.d.ts",
+  "files": [
+    "out",
+    "!**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@rbxts/compiler-types": "^3.0.0-types.0",
+    "@rbxts/types": "^1.0.848",
+    "roblox-ts": "^3.0.0",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@rbxts/charm": "^0.10.0",
+    "@rbxts/remo": "^1.5.1",
+    "@rbxts/roblox-observers": "^1.0.7",
+    "@rbxts/services": "^1.5.5",
+    "@rbxts/sleitnick-signal": "^1.0.8",
+    "@rbxts/t": "^3.2.1",
+    "@rbxts/trove": "^1.3.0"
+  }
+}