Search Results for

    Show / Hide Table of Contents

    Interface IMinimapIcon

    Minimap Icon to display something on the minimap.

    Namespace: nickmaltbie.MinimapTools.Icon
    Assembly: cs.temp.dll.dll
    Syntax
    public interface IMinimapIcon

    Methods

    CreateIcon(IMinimap, RectTransform)

    Create an icon to represent this object on the minimap.

    Declaration
    GameObject CreateIcon(IMinimap minimap, RectTransform minimapTransform)
    Parameters
    Type Name Description
    IMinimap minimap

    Reference to minimap this icon will be added to, useful for scaling and manipulating the icon

    RectTransform minimapTransform

    Transform of the parent minimap this is being added to.

    Returns
    Type Description
    GameObject

    The newly created icon for this object.

    GetIconRotation()

    Get the rotation of the object in world space.

    Declaration
    Quaternion GetIconRotation()
    Returns
    Type Description
    Quaternion

    The current rotation of the object in world space.

    GetWorldSize()

    If this element scales with the map size, this will scale the element to be larger or smaller based on its world size.

    Declaration
    Vector2 GetWorldSize()
    Returns
    Type Description
    Vector2

    Size of the object in world units.

    GetWorldSpace()

    Get the location of this object in world space.

    Declaration
    Vector3 GetWorldSpace()
    Returns
    Type Description
    Vector3

    Position of the object in world space.

    RotateWithMap()

    Should the element rotate with the map.

    Declaration
    bool RotateWithMap()
    Returns
    Type Description
    Boolean

    True if the element should rotate with the map, false otherwise.

    ScaleWithMap()

    Should the icon scale with the map scale.

    Declaration
    bool ScaleWithMap()
    Returns
    Type Description
    Boolean

    If true, will scale with the map, if false will not scale with the map.

    In This Article
    Back to top MinimapTools Documentation