Melonity Docs

MiniMap ​

The MiniMap namespace provides helpers for pinging, drawing, and showing icons on the in-game minimap.

Functions ​

Ping(position: Vector, type: Enum.PingType, clientSide?: boolean)void ​

Sends a minimap ping at the specified world position.

  • positionVector - The world position value.
  • typeEnum.PingType - The type.
  • clientSideboolean (optional) - The client side.

DrawLine(start: Vector, end: Vector, clientSide?: boolean)void ​

Draws a minimap line between the specified world positions.

  • startVector - The start position.
  • endVector - The end position.
  • clientSideboolean (optional) - The client side.

BeginLine(start: Vector, clientSide?: boolean)void ​

Begins drawing a minimap line from the specified world position.

  • startVector - The start position.
  • clientSideboolean (optional) - The client side.

ContinueLine(end: Vector, clientSide?: boolean)void ​

Continues the current minimap line to the specified world position.

  • endVector - The end position.
  • clientSideboolean (optional) - The client side.

AddIconByName(handle: MiniMapIconHandle | null, iconName: string, position: Vector, size: number | [number, number], timeInS?: number, color?: Color)MiniMapIconHandle ​

Creates or updates a minimap icon by texture name.

  • handleMiniMapIconHandle | null - The existing minimap icon handle, or null to create a new one.
  • iconNamestring - The icon resource name.
  • positionVector - The world position value.
  • sizenumber | [number, number] - The size value.
  • timeInSnumber (optional) - The duration in seconds.
  • colorColor (optional) - The color value.

Returned:

  • MiniMapIconHandle - The result of the call.

AddIconByImage(handle: MiniMapIconHandle | null, image: Image, position: Vector, size: number | [number, number], timeInS?: number, color?: Color)MiniMapIconHandle ​

Creates or updates a minimap icon by image resource.

  • handleMiniMapIconHandle | null - The existing minimap icon handle, or null to create a new one.
  • imageImage - The image resource to use.
  • positionVector - The world position value.
  • sizenumber | [number, number] - The size value.
  • timeInSnumber (optional) - The duration in seconds.
  • colorColor (optional) - The color value.

Returned:

  • MiniMapIconHandle - The result of the call.