Interface IMinimap
Minimap for managing state.
Namespace: nickmaltbie.MinimapTools.Minimap
Assembly: cs.temp.dll.dll
Syntax
public interface IMinimapProperties
PixelsPerUnit
Number of pixels per unit of the minimap size.
Declaration
float PixelsPerUnit { get; }Property Value
| Type | Description |
|---|---|
| Single | Returns the number of pixels per unit for sizing the minimap. |
Methods
AddIcon(IMinimapIcon)
Add an icon to the minimap.
Declaration
bool AddIcon(IMinimapIcon minimapIcon)Parameters
| Type | Name | Description |
|---|---|---|
| IMinimapIcon | minimapIcon | Icon to add to the minimap. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the object was added successfully, false otherwise. |
GetMinimapPosition(Vector3)
Translates a position from world space to normalized minimap space.
Declaration
Vector2 GetMinimapPosition(Vector3 worldPosition)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | worldPosition | Position of the object in world space. |
Returns
| Type | Description |
|---|---|
| Vector2 | Normalized minimap position, will scale positions within the minimap to between (0,0) and (1,1). |
GetRotation()
Get the rotation of the minimap with respect to the vertical axis.
Declaration
float GetRotation()Returns
| Type | Description |
|---|---|
| Single | Rotation of the minimap in degrees. |
GetSize()
Get the size of the minimap texture in pixels.
Declaration
Vector2Int GetSize()Returns
| Type | Description |
|---|---|
| Vector2Int | Vector2Int of the width and height of the minimap. |
GetWorldBounds()
Get the world bounds for the minimap.
Declaration
IMinimapShape GetWorldBounds()Returns
| Type | Description |
|---|---|
| IMinimapShape | World bound that the minimap represents. |
MapAxisHoriz()
Direction of the axis horizontal along the minimap plane.
Declaration
Vector3 MapAxisHoriz()Returns
| Type | Description |
|---|---|
| Vector3 | Horizontal directional vector. |
MapAxisVert()
Direction of the vertical axis along the minimap plane.
Declaration
Vector3 MapAxisVert()Returns
| Type | Description |
|---|---|
| Vector3 | Vertical direction vector. |
MapNormal()
Get the normal vector for the plane of this minimap.
Declaration
Vector3 MapNormal()Returns
| Type | Description |
|---|---|
| Vector3 | Vector normal to the minimap plane. |
RemoveIcon(IMinimapIcon)
Remove an icon from the minimap.
Declaration
bool RemoveIcon(IMinimapIcon minimapIcon)Parameters
| Type | Name | Description |
|---|---|---|
| IMinimapIcon | minimapIcon | Icon to remove to the minimap. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the object was removed successfully, false otherwise. |