Actions


Core

Update

Tells the extension that it should update the display. Not needed if the extension is set to auto-update.



Set Auto-Update Flag

Parameters:
State - 0 or 1

If set to 1 the displayed will be atuomatically updated every frame loop.




Set Minimap Type

Parameters:
Type - 0 or 1

If set to 0 the minimap will act as a normal map and if set to 1 it will act as a radar.




Map

Set Working Zone

Parameters:
X Position - Integer
Y Position - Integer
Width - Integer
Height - Integer

Tell the minimap what zone of the frame to work in. This action has no effect if the minimap is set to act as a radar.


Radar

Set Reference Position and Radius

Parameters:
X Position - Integer
Y Position - Integer
Radius - Integer

Tell the radar where it's located. The Radius parameter is how many pixels around the centerpoint that objects will be displayed on the radar.




Set Reference Angle

Parameters:
Angle - Integer (0-360)

This options is nice if the radar is used in first person shooter games and such as it will rotate the minimap according to this angle.




Set Reference to Object

Parameters:
Reference Object - Active Object
Radius - Integer
Use Reference Angle - 0 or 1

This action will automate the above two functions by using the position of an active object instead. If the third parameter is set to 1 it will use the active objects angle as reference angle.


Appearance

Set Shape

Parameters:
Shape - 0 or 1

If parameter is set to 0 the shape will be set to rectangle and if it's set to 1 the shape will be set to ellipse.




Set Size

Parameters:
Width - Integer
Height - Integer

Sets the size of the minimap.




Set Transpareny Flag

Parameters:
Transparent - 0 or 1

If set to 1 the minimap will be rendered with transparent background.




Set Background Color

Parameters:
Background Color - Color

Sets the color of the background. Has no effect if the transprency flag is set to 1.




Set Border Size

Parameters:
Size - Integer

Sets the with of the border. If it's set to 0 border will be disabled. Border can never be thicker than 1/4 of the minimaps width/height.




Set Border Color

Parameters:
Border Color - Color

Sets the color of the border. Has no effect if the border is disabled.


Drawing

Map Coordinates

Draw Line

Parameters:
Start X - Integer
Start Y - Integer
End X - Integer
End Y - Integer
Line Width - Integer
Color - Color

Draws a line on the minimap using map coordinates.




Draw Rectangle

Parameters:
X - Integer
Y - Integer
Width - Integer
Height - Integer
Line Width - Integer
Color - Color

Draws a rectangle on the minimap using map coordinates.




Draw Ellipse

Parameters:
X - Integer
Y - Integer
Width - Integer
Height - Integer
Line Width - Integer
Color - Color

Draws a ellipse on the minimap using map coordinates.




Blit Image

Parameters:
X - Integer
Y - Integer
Image ID - Integer

Blits an image from the image bank on the minimap using map coordinates.



World Coordinates

Draw Line

Parameters:
Start X - Integer
Start Y - Integer
End X - Integer
End Y - Integer
Line Width - Integer
Color - Color

Draws a line on the minimap using world coordinates.




Draw Rectangle

Parameters:
X - Integer
Y - Integer
Width - Integer
Height - Integer
Line Width - Integer
Color - Color

Draws a rectangle on the minimap using world coordinates.




Draw Ellipse

Parameters:
X - Integer
Y - Integer
Width - Integer
Height - Integer
Line Width - Integer
Color - Color

Draws a ellipse on the minimap using world coordinates.




Blit Image

Parameters:
X - Integer
Y - Integer
Image ID - Integer

Blits an image from the image bank on the minimap using world coordinates.


Objects

Link Object for Drawing

Parameters:
Object - Active Object
Flag Setting - Integer (-1 to 31)
Visibility Setting - 0 or 1
Shape - Integer
Size - Integer
Color - Integer

Registeres an object for drawing on the minimap. The flag setting specifies allows you control over when the object is rendered, if this value is set to -1 it has no effect otherwise it will check to see if the matching flag is on before drawing the object on the minimap. The visibility setting allows you to disable drawing on the map if the object is invisible.
Available Shapes:
0 - Pixel
1 - Filled Square
2 - Filled Circle
3 - Oulined Square
4 - Oulined Circle
5 - Cross
6 - Plus




Link Object for Blitting (Image)

Parameters:
Object - Active Object
Flag Setting - Integer (-1 to 31)
Visibility Setting - 0 or 1
Image ID - Integer

Same as above but will use an image from the image bank when drawing to the minimap.




Unlink Object from Drawing

Parameters:
Object - Active Object

Unregisteres an object from being drawed on the minimap.