CameraUI Module Documentation

CameraUI is a client-side Luau module for Roblox that allows you to create and manage UI elements that are rendered in 3D space, attached to the camera. It is intended for use on the client; server-side integration is up to the developer.

Features

• Create 3D UI elements that follow the camera
• Attach custom UI and parts to the camera
• Control position, rotation, size, and transparency of UI elements
• Support for tweening UI elements
• Easy management and cleanup of UI elements

Usage

local CameraUI = require(path.to.CameraUI)

-- Create a new UI measurement controller
local measurement = CameraUI:CreateUIMeasurement()

-- Create a new Camera UI element
local element = CameraUI:CreateUIElement({
    name = "MyElement",
    distanceAway = 10,
    uiElement = myGuiElement, -- Instance of a GuiBase
    customPart = nil,         -- Optional: custom part to use
    customFace = Enum.NormalId.Front, -- Optional: face for SurfaceGui
    position = {X = 0, Y = 0},       -- Optional: initial position
    rotation = {X = 0, Y = 0, Z = 0} -- Optional: initial rotation
})
    

Helpers

CameraUI:CreateUIMeasurement()

Creates a new measurement controller for camera UI.

CameraUI:CreateUIElement(data)

Creates a new camera UI element.
data: Table with the following fields:

• name (string): Name of the UI element
• distanceAway (number): Distance from the camera (min 5, max 20)
• uiElement (GuiBase, optional): The UI to display
• customPart (Part, optional): Custom part to use
• customFace (Enum.NormalId, optional): Face for SurfaceGui
• position (table, optional): {X, Y} offset
• rotation (table, optional): {X, Y, Z} rotation in degrees

Element Methods

• DeleteElement(waitTime): Deletes the element after an optional delay
• GetData(): Returns internal data for the element
• GetPartItself(): Returns the underlying Part
• DisconnectLiver(): Disconnects the RenderStepped connection
• SetCFrame(position): Sets the X, Y offset
• SetRotation(rotation): Sets the rotation (X, Y, Z)
• AddGuiElement(guiElement): Adds a GuiBase to the SurfaceGui
• SetTransparency(value): Sets the part's transparency
• SetSize(size): Sets the part's size (Vector3)
• TweenUIElement(goalCFrame, tweenInfo): Tweens the part to a new CFrame

CameraUI:GetActiveElement(name, data)

Returns the OOP object for the active element with the given name.

Notes

• This module is intended for client-side use only.
• Report bugs on the devforum page.