Bindstone - jimdroberts/FishMMO GitHub Wiki

Description

Bindstone interactable, used for setting player respawn points. Inherits from Interactable. Typically displays no title in the UI.


API Access

Properties

  • public override string Title { get; }

    The display title for the bindstone. Returns an empty string, as bindstones do not show a title in the UI.


Basic Usage

Setup

  1. Attach the Bindstone component to an interactable GameObject in your scene.
  2. The bindstone will allow players to set their respawn point when interacted with.
  3. The UI will not display a title for bindstones.

Example

// Example 1: Setting up a Bindstone in the Unity Editor
// 1. Add the Bindstone script to an interactable GameObject.
// 2. The GameObject will now act as a respawn point for players.

// Example 2: Accessing the title in code
var bindstone = GetComponent<Bindstone>();
Debug.Log(bindstone.Title); // Outputs: (empty string)

Best Practices

  • Use Bindstone for objects that set player respawn points without displaying a title in the UI.
  • Extend Bindstone for custom respawn logic or effects if needed.
  • Ensure only one active bindstone is set as the player's respawn point at a time.
⚠️ **GitHub.com Fallback** ⚠️