• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    Anchor

    Inherits from:

    Anchors enable specific actions for characters upon reaching designated points in the environment, such as sitting down, standing up, or other actions.

    Properties

    Entered

    ClientAndServer
    ReadOnly

    Called when a player's character enters the anchor. Event Parameters: Anchor: the anchor that was entered Character: the character that entered the anchor

    Exited

    ClientAndServer
    ReadOnly

    Called when a player's character exits the anchor. Event Parameters: Anchor: the anchor that was exited Character: the character that exited the anchor

    The transform that a character will move to before entering the anchor.

    enterFromPosition

    ClientOnly
    ReadOnly

    Returns the EnterFrom transform's position if it is set, otherwise returns the default entry position.

    exitTo

    ClientOnly

    The transform that a character will move to when exiting the anchor.

    exitToPosition

    ClientOnly
    ReadOnly

    Returns the ExitTo transform's position if it is set, otherwise returns the default exit position.

    isOccupied

    boolean
    ClientAndServer
    ReadOnly

    Whether the anchor is currently occupied by a character.

    isTappable

    boolean
    ClientOnly

    The tappable state of the anchor. If an anchor is not tappable, the only way a character can be attached to it is using Character:MoveToAnchor or Character:TeleportToAnchor.

    occupant

    ClientAndServer
    ReadOnly

    The character that is currently occupying the anchor.

    Updated 12 days ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.