Skip to main content

PathVisual

Debug view of an agent's path: a ball per step, the last one white. Make one after building the agent and destroy it with the agent. Only agents with a navigator have paths. 

local visual = VluxyAI.Debug.PathVisual.new(agent)

Functions​

new​

</>
PathVisual.new(
agent: Agent,
) → PathVisual

Types

​

interface PathVisualOptions {
Color: Color3?--

Colour of the step balls. Default green.

EndColor: Color3?--

Colour of the last ball. Default white.

Size: number?--

Diameter of a step ball in studs; the last one is twice that. Default 0.5.

}

Destroy​

</>
PathVisual.Destroy(self: PathVisual) → ()

Removes the balls and stops listening.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "agent",
                    "desc": "",
                    "lua_type": "Agent"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "PathVisualOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PathVisual"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 92,
                "path": "lib/Debug/PathVisual.luau"
            }
        },
        {
            "name": "Destroy",
            "desc": "Removes the balls and stops listening.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PathVisual"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 157,
                "path": "lib/Debug/PathVisual.luau"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "PathVisualOptions",
            "desc": "",
            "fields": [
                {
                    "name": "Color",
                    "lua_type": "Color3?",
                    "desc": "Colour of the step balls. Default green."
                },
                {
                    "name": "EndColor",
                    "lua_type": "Color3?",
                    "desc": "Colour of the last ball. Default white."
                },
                {
                    "name": "Size",
                    "lua_type": "number?",
                    "desc": "Diameter of a step ball in studs; the last one is twice that. Default `0.5`."
                }
            ],
            "source": {
                "line": 39,
                "path": "lib/Debug/PathVisual.luau"
            }
        }
    ],
    "name": "PathVisual",
    "desc": "Debug view of an agent's path: a ball per step, the last one white. Make one after building\nthe agent and destroy it with the agent. Only agents with a navigator have paths.\n\n```lua\nlocal visual = VluxyAI.Debug.PathVisual.new(agent)\n```",
    "source": {
        "line": 85,
        "path": "lib/Debug/PathVisual.luau"
    }
}