Workspace

Summary

Properties

Properties of a Workspace, in the order they appear on Vortex Studio

• ClassName: string
• Name: strings

Methods

Methods of a `Workspace`.

• FindFirstChild: Instance | nil
• GetChildren: { Instance }
• Raycast: RaycastResult | nil
• WaitForChild: Instance

Properties

ClassName

string

The runtime class name of the service.

Name

string

The service name shown by the runtime.

Methods

FindFirstChild()

Instance | nil

workspace:FindFirstChild(name: string)

Returns the first direct child with the supplied name, or nil when none is found.

Parameters

• name: string — the child name to find.

GetChildren()

{ Instance }

Returns the direct children of Workspace.

Raycast()

RaycastResult | nil
Workspace:Raycast(origin: Vector3, direction: Vector3, raycastParams: RaycastParams | nil)
Casts a ray from the specified origin in the specified direction. The function returns a RaycastResult if an eligible object intersects the ray, or nil if no object is hit.

Parameters

• origin: Vector3 — The origin point of the ray.
• direction: Vector3 — The directional vector of the ray.
• raycastParams: An optional object used to specify hit eligibility during the raycast operation.

WaitForChild()

Instance

workspace:WaitForChild(name: string)

Waits for and returns a direct child with the supplied name.

Parameters

• name: string — the child name to wait for.

Testing Notes

The hierarchy observations below were revalidated in Vortex Studio 0.3.4 and may differ in later releases.

0.3.4. A temporary Part can be parented to Workspace, and WaitForChild resolves it. FindFirstChild returns nil and GetChildren omits it.

For existing authored children, repeated GetChildren() calls can return fresh Lua wrapper tables for the same underlying Instance. Do not use a returned wrapper as a persistent table key across frames; use a unique authored name or another stable identifier instead.