Skip to main content

PointWorld

This item only works when running on the client. Client

Points the player at something in the 3D world: a beam from their character, a floating icon above the target, and optionally an outline around a whole model. 

Step.new(3, {
	PointWorld.to(questGiverRoot),
})

Unlike FocusUI, this action never ends the step on its own. Pair it with a Custom action watching for arrival, or with a dialog the player dismisses once they get there.

Functions​

to​

constructor
</>
PointWorld.to(
target: BasePart,--

What to point at

options: PointWorldOptions?--

Which pieces to draw, and from where

) → Action

Types

​

interface PointWorldOptions {
From: BasePart?--

Where the beam starts. Defaults to the local HumanoidRootPart

Outline: Instance?--

Model or part to highlight

Beam: boolean?--

Set false to skip the beam

Icon: boolean?--

Set false to skip the floating icon

}

Guides the player toward a part.

The default

A beam from the player's HumanoidRootPart to the target, plus a floating icon above it:

PointWorld.to(fountainPart)

The icon only appears if you configured one in the tutorial's Pointer config; there is no built-in image.

Highlighting a whole building

Outline takes any instance, so pass the model rather than the one part the beam aims at:

PointWorld.to(shopModel.PrimaryPart, { Outline = shopModel })

Turning pieces off

-- Outline only, no beam and no icon.
PointWorld.to(chest.PrimaryPart, { Outline = chest, Beam = false, Icon = false })
CAUTION

The beam needs a character. If the player is dead or still loading when the step opens, the beam is skipped rather than erroring, and it does not retry.

Show raw api
{
    "functions": [
        {
            "name": "to",
            "desc": "Guides the player toward a part.\n\n### The default\n\nA beam from the player's `HumanoidRootPart` to the target, plus a floating icon above it:\n\n```lua\nPointWorld.to(fountainPart)\n```\n\nThe icon only appears if you configured one in the tutorial's `Pointer` config; there is no\nbuilt-in image.\n\n### Highlighting a whole building\n\n`Outline` takes any instance, so pass the model rather than the one part the beam aims at:\n\n```lua\nPointWorld.to(shopModel.PrimaryPart, { Outline = shopModel })\n```\n\n### Turning pieces off\n\n```lua\n-- Outline only, no beam and no icon.\nPointWorld.to(chest.PrimaryPart, { Outline = chest, Beam = false, Icon = false })\n```\n\n:::caution\nThe beam needs a character. If the player is dead or still loading when the step opens, the beam\nis skipped rather than erroring, and it does not retry.\n:::",
            "params": [
                {
                    "name": "target",
                    "desc": "What to point at",
                    "lua_type": "BasePart"
                },
                {
                    "name": "options",
                    "desc": "Which pieces to draw, and from where",
                    "lua_type": "PointWorldOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Action"
                }
            ],
            "function_type": "static",
            "tags": [
                "constructor"
            ],
            "source": {
                "line": 80,
                "path": "src/Actions/PointWorld.luau"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "PointWorldOptions",
            "desc": "",
            "fields": [
                {
                    "name": "From",
                    "lua_type": "BasePart?",
                    "desc": "Where the beam starts. Defaults to the local HumanoidRootPart"
                },
                {
                    "name": "Outline",
                    "lua_type": "Instance?",
                    "desc": "Model or part to highlight"
                },
                {
                    "name": "Beam",
                    "lua_type": "boolean?",
                    "desc": "Set false to skip the beam"
                },
                {
                    "name": "Icon",
                    "lua_type": "boolean?",
                    "desc": "Set false to skip the floating icon"
                }
            ],
            "source": {
                "line": 32,
                "path": "src/Actions/PointWorld.luau"
            }
        }
    ],
    "name": "PointWorld",
    "desc": "Points the player at something in the 3D world: a beam from their character, a floating icon\nabove the target, and optionally an outline around a whole model.\n\n```lua\nStep.new(3, {\n\tPointWorld.to(questGiverRoot),\n})\n```\n\nUnlike [FocusUI], this action never ends the step on its own. Pair it with a [Custom] action\nwatching for arrival, or with a dialog the player dismisses once they get there.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 18,
        "path": "src/Actions/PointWorld.luau"
    }
}