Skip to content

Commit 459cea3

Browse files
committed
update overlays docs
1 parent 508b2d4 commit 459cea3

File tree

1 file changed

+0
-18
lines changed

1 file changed

+0
-18
lines changed

docs/Scaleforms/MinimapOverlays.md

-18
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,6 @@ Main.MinimapOverlays
1919
ScaleformUI.Scaleforms.MinimapOverlays
2020
```
2121

22-
## ⚠️⚠️ Due to the nature of the Minimap Overlay Scaleform, being loaded as a file and not as a streamed scaleform, the only way you're able to use the Overlays is by calling an export to load the overlays metatable
23-
24-
```lua
25-
local overlays = exports.ScaleformUI_Lua:GetMinimapOverlays()
26-
27-
-- you can then call the functions by doing
28-
overlays:AddSizedOverlayToMap(textureDict, textureName, x, y, rotation, width, height, alpha, centered)
29-
overlays:AddScaledOverlayToMap(textureDict, textureName, x, y, rotation, xScale, yScale, alpha, centered)
30-
overlays:AddAreaOverlay(coordsTable, hasOutline, color)
31-
overlays:SetOverlayColor(overlayId, color)
32-
overlays:HideOverlay(overlayId, hide)
33-
overlays:SetOverlayAlpha(overlayId, alpha)
34-
overlays:SetOverlayPosition(overlayId, position)
35-
overlays:SetOverlaySizeOrScale(overlayId, width, height)
36-
overlays:RemoveOverlayFromMinimap(overlayId)
37-
overlays:ClearAll()
38-
```
39-
4022
## Functions
4123

4224
```c#

0 commit comments

Comments
 (0)