-
Notifications
You must be signed in to change notification settings - Fork 0
/
EZControls.lua
381 lines (312 loc) · 10.4 KB
/
EZControls.lua
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
-- ezcontrols.lua
-- © 2016 Howard Nguyen
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
-- http://www.apache.org/licenses/LICENSE-2.0
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--------------------------------------------------------------------------------------------------
-- Main Object
--------------------------------------------------------------------------------------------------
local controls = {
_VERSION = '0.4.1',
_DESCRIPTION = 'Callback style controls library for Lua.',
_URL = 'https://github.com/Luminess/EZControls',
states = {},
_keystrokeListeners = {},
currentState = nil
}
--------------------------------------------------------------------------------------------------
-- Dependencies
--------------------------------------------------------------------------------------------------
local rootDir = (...):gsub('%.[^%.]+$', '.')
local dkjson --= require(rootDir .. 'lib.dkjson.dkjson') We're lazy loading but leaving a comment just to show our intent. We lazy load to make dkjson an option dependency.
local ser = require(rootDir .. 'lib.Ser.ser')
local loadstring = loadstring
local type = type
local setmetatable = setmetatable
local ipairs = ipairs
local pairs = pairs
local table = {
insert = table.insert,
remove = table.remove
}
local io = {
open = io.open
}
local love = love
--------------------------------------------------------------------------------------------------
-- Utility Functions
--------------------------------------------------------------------------------------------------
local tableClone
tableClone = function(orig)
return loadstring(ser(orig))()
end
local tableContains = function(t, element)
for _, value in pairs(t) do
if value == element then
return true
end
end
return false
end
local tableConcat = function(t1, t2)
for i=1,#t2 do
t1[#t1+1] = t2[i]
end
return t1
end
local stripTableByKeyName
stripTableByKeyName = function(t, keyName, shouldMutate)
local workingTable = t
if not shouldMutate then
workingTable = tableClone(workingTable)
end
if type(keyName) ~= 'table' then
keyName = {keyName}
end
for k, v in pairs(workingTable) do
for _, keyName in ipairs(keyName) do
if k == keyName then
workingTable[k] = nil
elseif type(v) == 'table' then
stripTableByKeyName(v, {keyName}, true)
end
end
end
return workingTable
end
local stripArrayByValue = function(t, value, shouldMutate)
local workingTable = t
if not shouldMutate then
workingTable = tableClone(workingTable)
end
for i, v in ipairs(workingTable) do
if v == value then
table.remove(workingTable, i)
end
end
return workingTable
end
--------------------------------------------------------------------------------------------------
-- Binding Object
--------------------------------------------------------------------------------------------------
local binding = {--[[
keys = {},
onPressCallbacks = {},
onReleaseCallbacks = {}
]]}
binding.__index = binding
function binding:onPress(function_callback, listenToRepeat)
table.insert(self.onPressCallbacks, {
func = function_callback,
listenToRepeat = listenToRepeat or false
})
end
function binding:onRelease(function_callback)
table.insert(self.onReleaseCallbacks, function_callback)
end
function binding:isDown()
for _, key in ipairs(self.keys) do
if love.keyboard.isDown(key) then
return true
end
end
return false
end
function binding:bind(key)
if type(key) == 'table' then
tableConcat(self.keys, key)
else
table.insert(self.keys, key)
end
end
function binding:bindNext(function_callback)
table.insert(controls._keystrokeListeners, function(key)
self:bind(key)
function_callback(key)
end)
end
function binding:unbind(key)
if type(key) == 'table' then
for _, workingKey in ipairs(key) do
stripArrayByValue(self.keys, workingKey, true)
end
else
stripArrayByValue(self.keys, key, true)
end
end
--------------------------------------------------------------------------------------------------
-- Private Methods
--------------------------------------------------------------------------------------------------
local function createBinding(stateName, bindingName)
local newBinding = setmetatable({
keys = {},
onPressCallbacks = {},
onReleaseCallbacks = {}
}, binding)
if not controls.states[stateName] then
controls.states[stateName] = {}
end
controls.states[stateName][bindingName] = newBinding
return newBinding
end
local function bindingExists(stateName, bindingName)
return (type(controls.states[stateName][bindingName]) == 'table')
end
local function returnBindingOrNew(stateName, bindingName)
local workingBinding, isNew = nil, false
if controls.states[stateName] and bindingExists(stateName, bindingName) then
workingBinding = controls.states[stateName][bindingName]
else
workingBinding = createBinding(stateName, bindingName)
isNew = true
end
return workingBinding, isNew
end
--------------------------------------------------------------------------------------------------
-- Public Methods
--------------------------------------------------------------------------------------------------
function controls.bind(keys, stateName, bindingName)
local workingBinding = (returnBindingOrNew(stateName, bindingName))
workingBinding:bind(keys)
return workingBinding
end
function controls.state(stateName)
local function getBinding(bindingName)
return (returnBindingOrNew(stateName, bindingName))
end
return { binding = getBinding }
end
function controls.serialize()
local states = stripTableByKeyName(controls.states, {'onPressCallbacks', 'onReleaseCallbacks'})
for _, bindings in pairs(states) do
for _, bindingProps in pairs(bindings) do
bindingProps = bindingProps.keys
stripTableByKeyName(bindingProps, 'keys', true)
end
end
return states
end
function controls.parse(t)
for stateName, bindings in pairs(t) do
for bindingName, keys in pairs(bindings) do
controls.bind(keys, stateName, bindingName)
end
end
end
function controls.load(loadPath)
if not dkjson then
dkjson = require(rootDir .. 'lib.dkjson.dkjson')
end
controls.parse(dkjson.decode(io.open(loadPath):read('*all')))
end
function controls.save(savePath)
if not dkjson then
dkjson = require(rootDir .. 'lib.dkjson.dkjson')
end
local keybinds = controls.serialize()
io.open(savePath, 'w+'):write(dkjson.encode(keybinds, { exceptions = function() return true end}))
end
--------------------------------------------------------------------------------------------------
-- Mouse Object
--------------------------------------------------------------------------------------------------
local mouse = {
onMoveCallbacks = {}
}
function mouse:onMove(function_callback)
table.insert(self.onMoveCallbacks, function_callback)
end
-- Simple syntactical sugar.
mouse.leftButton = controls.bind('mouse_1', 'all', 'mouse_l')
mouse.middleButton = controls.bind('mouse_3', 'all', 'mouse_m')
mouse.rightButton = controls.bind('mouse_2', 'all', 'mouse_r')
mouse.mouseWheel = {}
mouse.mouseWheel.up = controls.bind('mouse_wu', 'all', 'mouse_wu') -- TODO: Doesn't work for 0.10.0 Love2D. Replace with love.wheelmoved()
mouse.mouseWheel.down = controls.bind('mouse_wd', 'all', 'mouse_wd')
controls.mouse = mouse
--------------------------------------------------------------------------------------------------
-- Callbacks Handlers
--------------------------------------------------------------------------------------------------
local function onKeyPress(key, isRepeat, x, y)
for i, listener in ipairs(controls._keystrokeListeners) do
listener(key)
table.remove(controls._keystrokeListeners, i)
end
for state, bindings in pairs(controls.states) do
if state == controls.currentState or state == 'all' then
for _, bindingProps in pairs(bindings) do
if tableContains(bindingProps.keys, key) then
for _, callback in ipairs(bindingProps.onPressCallbacks) do
if not (callback.listenToRepeat or isRepeat) then
callback.func(x, y)
end
end
end
end
end
end
end
local function onKeyRelease(key, x, y)
for state, bindings in pairs(controls.states) do
if state == controls.currentState or state == 'all' then
for _, bindingProps in pairs(bindings) do
if tableContains(bindingProps.keys, key) then
for _, callback in ipairs(bindingProps.onReleaseCallbacks) do
callback(x, y)
end
end
end
end
end
end
local function onMouseMove(x, y, deltaX, deltaY) -- TODO: Maybe implement state awareness.
for _, callback in ipairs(mouse.onMoveCallbacks) do
callback(x, y, deltaX, deltaY)
end
end
--------------------------------------------------------------------------------------------------
-- Integrations
--------------------------------------------------------------------------------------------------
if love and not (love.keypressed and love.keyreleased and love.mousepressed and love.mousereleased and love.mousemoved) then
-- Love2D
love.keyboard.setKeyRepeat(true)
function love.keypressed(key, _, isRepeat)
onKeyPress(key, isRepeat)
end
function love.keyreleased(key)
onKeyRelease(key)
end
function love.mousepressed(x, y, button)
onKeyPress('mouse_' .. button, false, x, y)
end
function love.mousereleased(x, y, button)
onKeyRelease('mouse_' .. button, x, y)
end
function love.mousemoved(x, y, deltaX, deltaY)
onMouseMove(x, y, deltaX, deltaY)
end
else
-- Standalone
controls.fire = {}
function controls.fire.keyPressed(key, isRepeat)
onKeyPress(key, isRepeat)
end
function controls.fire.keyReleased(key)
onKeyRelease(key)
end
function controls.fire.mousePressed(x, y, button)
onKeyPress('mouse_' .. button, false, x, y)
end
function controls.fire.mouseReleased(x, y, button)
onKeyRelease('mouse_' .. button, x, y)
end
function controls.fire.mouseMove(x, y, deltaX, deltaY)
onMouseMove(x, y, deltaX, deltaY)
end
end
return controls