49
edits
m
no edit summary
(Add {{userapi}}) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{userapi}} | {{userapi}} | ||
GetMinimapShape is a function that is declared by the currently running minimap addon to provide information about what shape it is, in case other addons need to deal with the minimap's borders. | GetMinimapShape is a function that is declared by the currently running minimap addon to provide information about what shape it is, in case other addons need to deal with the minimap's borders. | ||
It takes no arguments and returns one of the following strings: | It takes no arguments and returns one of the following strings: | ||
; "ROUND" : standard shape, round. This is to be assumed if an unknown string is returned or if no string is returned or if GetMinimapShape does not exist. | ; "ROUND" | ||
; "SQUARE" : square shape. | : standard shape, round. This is to be assumed if an unknown string is returned or if no string is returned or if GetMinimapShape does not exist. | ||
; "CORNER-TOPLEFT" : square, but with the top-left corner being round. This would normally be put at the bottom-right of the screen. | ; "SQUARE" | ||
; "CORNER-TOPRIGHT" : square, but with the top-right corner being round. This would normally be put at the bottom-left of the screen. | : square shape. | ||
; "CORNER-BOTTOMLEFT" : square, but with the bottom-left corner being round. This would normally be put at the top-right of the screen. | ; "CORNER-TOPLEFT" | ||
; "CORNER-BOTTOMRIGHT" : square, but with the bottom-right corner being round. This would normally be put at the top-left of the screen. | : square, but with the top-left corner being round. This would normally be put at the bottom-right of the screen. | ||
; "SIDE-LEFT" : square on the right side, rounded on the left side. This would normally be put at the right of the screen. | ; "CORNER-TOPRIGHT" | ||
; "SIDE-RIGHT" : square on the left side, rounded on the right side. This would normally be put at the left of the screen. | : square, but with the top-right corner being round. This would normally be put at the bottom-left of the screen. | ||
; "SIDE-TOP" : square on the bottom side, rounded on the top side. This would normally be put at the bottom of the screen. | ; "CORNER-BOTTOMLEFT" | ||
; "SIDE-BOTTOM" : square on the top side, rounded on the bottom side. This would normally be put at the top of the screen. | : square, but with the bottom-left corner being round. This would normally be put at the top-right of the screen. | ||
; "TRICORNER-TOPLEFT" : round, but with the bottom-right corner being square. This would normally be put at the bottom-right of the screen. | ; "CORNER-BOTTOMRIGHT" | ||
; "TRICORNER-TOPRIGHT" : round, but with the bottom-left corner being square. This would normally be put at the bottom-left of the screen. | : square, but with the bottom-right corner being round. This would normally be put at the top-left of the screen. | ||
; "TRICORNER-BOTTOMLEFT" : round, but with the top-right corner being square. This would normally be put at the top-right of the screen. | ; "SIDE-LEFT" | ||
; "TRICORNER-BOTTOMRIGHT" : round, but with the top-left corner being square. This would normally be put at the top-left of the screen. | : square on the right side, rounded on the left side. This would normally be put at the right of the screen. | ||
; "SIDE-RIGHT" | |||
: square on the left side, rounded on the right side. This would normally be put at the left of the screen. | |||
; "SIDE-TOP" | |||
: square on the bottom side, rounded on the top side. This would normally be put at the bottom of the screen. | |||
; "SIDE-BOTTOM" | |||
: square on the top side, rounded on the bottom side. This would normally be put at the top of the screen. | |||
; "TRICORNER-TOPLEFT" | |||
: round, but with the bottom-right corner being square. This would normally be put at the bottom-right of the screen. | |||
; "TRICORNER-TOPRIGHT" | |||
: round, but with the bottom-left corner being square. This would normally be put at the bottom-left of the screen. | |||
; "TRICORNER-BOTTOMLEFT" | |||
: round, but with the top-right corner being square. This would normally be put at the top-right of the screen. | |||
; "TRICORNER-BOTTOMRIGHT" | |||
: round, but with the top-left corner being square. This would normally be put at the top-left of the screen. | |||
It is possible this function will be called once a frame, so it is recommended not to do anything CPU-intensive in calculating the shape. | It is possible this function will be called once a frame, so it is recommended not to do anything CPU-intensive in calculating the shape. | ||
This is currently used by [http://www.wowace.com/wiki/FuBarPlugin-2.0 FuBarPlugin-2.0] to determine position of minimap buttons.<br> | This is currently used by [http://www.wowace.com/wiki/FuBarPlugin-2.0 FuBarPlugin-2.0] to determine position of minimap buttons.<br /> | ||
This is currently used by [http://www.wowace.com/wiki/Cartographer/Notes Cartographer_Notes] to determine edge position of notes on the minimap.<br> | This is currently used by [http://www.wowace.com/wiki/Cartographer/Notes Cartographer_Notes] to determine edge position of notes on the minimap.<br /> | ||
This is currently used by [[MobileMinimapButtons]] to determine position of draggable minimap buttons.<br> | This is currently used by [[MobileMinimapButtons]] to determine position of draggable minimap buttons.<br /> | ||
This is the code currently used by FuBarPlugin-2.0 to determine position on the edge of a minimap: | This is the code currently used by FuBarPlugin-2.0 to determine position on the edge of a minimap: | ||