GNUI/main.lua at v3.x · lua-gods/GNUI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
---@diagnostic disable: undefined-field
--[[______  __
  / ____/ | / / By: GNamimates
 / / __/  |/ / GNUI vF3.4.3
/ /_/ / /|  / A high level UI library for figura.
\____/_/ |_/ Stable Release: https://github.com/lua-gods/GNUI, Unstable Pre-release: https://github.com/lua-gods/GNs-Avatar-3/blob/main/libraries/gnui.lua]]

--[[ NOTES
Everything is in one file to make sure it is possible to load this script from a config file,
allowing me to put as much as I want without worrying about storage space.
]]

---@class GNUIAPI
local api = {}

---@alias GNUI.any GNUI.Box|GNUI.Box|GNUI.Canvas

local config = require("./config") ---@type GNUI.Config
local s = require("./nineslice") ---@type Nineslice
local ca = require("./primitives.canvas") ---@type GNUI.Canvas
local bx = require("./primitives.box") ---@type GNUI.Box


---Creates a new Box.
---A canvas can be given as a parameter to automatically add child it to that
---@param parent GNUI.Box?
---@return GNUI.Box
api.newBox = function (parent)
  local new = bx.new()
  if parent then parent:addChild(new) end
  return new
end


---@param autoInputs boolean? # true when the canvas should capture the inputs from the screen.
---@return GNUI.Canvas
api.newCanvas = function (autoInputs)return ca.new(autoInputs) end


---@param texture Texture?
---@param borderTop number?
---@param borderRight number?
---@param borderBottom number?
---@param borderLeft number?
---@param UVx1 number?
---@param UVy1 number?
---@param UVx2 number?
---@param UVy2 number?
---@param expandTop number?
---@param expandRight number?
---@param expandBottom number?
---@param expandLeft number?
---@return Nineslice
api.newNineslice = function (texture,UVx1,UVy1,UVx2,UVy2,borderLeft,borderTop,borderRight,borderBottom,expandTop,expandRight,expandBottom,expandLeft)
  local new = s.new()
  if texture then new:setTexture(texture) end
  if borderLeft then new:setBorderLeft(borderLeft) end
  if borderTop then new:setBorderTop(borderTop) end
  if borderRight then new:setBorderRight(borderRight) end
  if borderBottom then new:setBorderBottom(borderBottom) end
  if UVx1 and UVy1 and UVx2 and UVy2 then new:setUV(UVx1,UVy1,UVx2,UVy2) end
  if expandTop then new:setExpandTop(expandTop) end
  if expandRight then new:setExpandRight(expandRight) end
  if expandBottom then new:setExpandBottom(expandBottom) end
  if expandLeft then new:setExpandLeft(expandLeft) end
  return new
end


local screenCanvas
---Gets a canvas for the screen. Quick startup for putting UI elements onto the screen.
---@return GNUI.Canvas
function api.getScreenCanvas()
  if not screenCanvas then
   screenCanvas = api.newCanvas(true)
   models:addChild(screenCanvas.ModelPart)
   screenCanvas.ModelPart:setParentType("HUD")

   local lastWindowSize = vec(0,0)
   events.WORLD_RENDER:register(function (delta)
    local windowSize = client:getScaledWindowSize()

    if windowSize.x ~= lastWindowSize.x
    or windowSize.y ~= lastWindowSize.y then
      lastWindowSize = windowSize
      screenCanvas:setDimensions(0,0,windowSize.x,windowSize.y)
    end
   end)
  end
  return screenCanvas
end


---Enables debug mode for the soon to be created boxes. will not enable debug mode on exiting boxes.
function api.debugMode()
  config.debug_mode = true
end
api.showBoundingBoxes = api.debugMode

if host:isHost() then
---@param sound Minecraft.soundID
---@param pitch number?
---@param volume number?
function api.playSound(sound,pitch,volume)
		sounds[sound]:pos(client:getCameraPos():add(client:getCameraDir())):pitch(pitch or 1):volume(volume or 1):attenuation(9999):play()
	end
else
	api.playSound = function (sound,pitch,volume)end
end

return api