-
Notifications
You must be signed in to change notification settings - Fork 0
/
mcm.lua
665 lines (599 loc) · 25.5 KB
/
mcm.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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
---@class ModConfig
local modConfig = {
characterProfile = nil, ---@type PortraitProfile?
}
local settings = require("longod.CustomPortrait.config")
local validator = require("longod.CustomPortrait.validator")
local indent = 16
local spacing = 4
local guidOuterContainer = tes3ui.registerID("CP:OuterContainer")
local guidInnerContainer = tes3ui.registerID("CP:InnerContainer")
local guidButton = tes3ui.registerID("CP:Button")
local guidLabel = tes3ui.registerID("CP:Label")
local guidTextInputLabel = tes3ui.registerID("CP:TextInput")
local guidSlider = tes3ui.registerID("CP:Slider")
local guidContainer = tes3ui.registerID("CP:Container")
local guidBorder = tes3ui.registerID("CP:Border")
local guidImage = tes3ui.registerID("CP:Image")
local guidScrollPane = tes3ui.registerID("CP:ScrollPane")
local guidDivider = tes3ui.registerID("CP:Divider")
---@param parentBlock tes3uiElement
---@return tes3uiElement
local function CreateOuterContainer(parentBlock)
local outerContainer = parentBlock:createBlock({ id = guidOuterContainer })
outerContainer.flowDirection = tes3.flowDirection.topToBottom
outerContainer.widthProportional = 1.0
outerContainer.autoHeight = true
outerContainer.borderAllSides = spacing
outerContainer.borderLeft = indent
return outerContainer
end
---@param parentBlock tes3uiElement
---@return tes3uiElement
local function CreateInnerContainer(parentBlock)
local innerContainer = parentBlock:createBlock({ id = guidInnerContainer })
innerContainer.widthProportional = parentBlock.widthProportional
innerContainer.autoWidth = parentBlock.autoWidth
innerContainer.heightProportional = parentBlock.heightProportional
innerContainer.autoHeight = parentBlock.autoHeight
innerContainer.flowDirection = tes3.flowDirection.leftToRight
-- innerContainer.paddingAllSides = 6
innerContainer.paddingLeft = indent
return innerContainer
end
---@param element tes3uiElement
local function ContentsChanged(element)
if element and element.widget and element.widget.contentsChanged then
local widget = element.widget ---@cast widget tes3uiScrollPane
widget:contentsChanged()
end
end
---@param bool boolean
---@return string
local function GetYesNo(bool)
---@diagnostic disable-next-line: return-type-mismatch
return bool and tes3.findGMST(tes3.gmst.sYes).value or tes3.findGMST(tes3.gmst.sNo).value
end
---@param parentBlock tes3uiElement
---@param text string
---@param bool boolean
---@param callback fun(e: tes3uiEventData) : boolean
---@return tes3uiElement
---@return tes3uiElement
---@return tes3uiElement
---@return tes3uiElement
local function CreateButton(parentBlock, text, bool, callback)
local outer = CreateOuterContainer(parentBlock)
local inner = CreateInnerContainer(outer)
local button = inner:createButton({ id = guidButton, text = GetYesNo(bool) })
button.borderAllSides = 0
button.borderRight = indent
button.paddingAllSides = 2
local label = inner:createLabel({ id = guidLabel, text = text })
label.borderTop = 2 -- fit button
button:register(tes3.uiEvent.mouseClick,
---@param e tes3uiEventData
function(e)
local result = callback(e)
e.source.text = GetYesNo(result)
end)
return outer, inner, button, label
end
---@param parentBlock tes3uiElement
---@param text string
---@return tes3uiElement
---@return tes3uiElement
local function CreateDescription(parentBlock, text)
local block = CreateInnerContainer(parentBlock)
block.paddingLeft = indent * 4
local desc = block:createLabel({ id = guidLabel, text = text })
desc.wrapText = true
desc.color = tes3ui.getPalette(tes3.palette.disabledColor)
return block, desc
end
---@param content tes3uiElement
---@param scrollBar tes3uiElement
---@param profile PortraitProfile
---@param isGlobal boolean
local function CreateProfileSettings(content, scrollBar, profile, isGlobal)
local enableField = nil ---@type tes3uiElement
local pathField = nil ---@type tes3uiElement
local widthField = nil ---@type tes3uiElement
local heightField = nil ---@type tes3uiElement
local cropField = nil ---@type tes3uiElement
local cropValueField = nil ---@type tes3uiElement
local previewFrame = nil ---@type tes3uiElement
local previewImage = nil ---@type tes3uiElement
---@param updateLayout boolean
local function UpdatePreview(updateLayout)
if not validator.IsValidPath(profile.path) then
tes3.messageBox("[Custom Portrait] Invalid Path:\n" .. profile.path)
return
end
local texture = niSourceTexture.createFromPath(profile.path)
if not validator.IsValidTextue(texture) then
tes3.messageBox("[Custom Portrait] Invalid Image:\n" .. profile.path)
return
end
-- simulate character image
local textureWidth = math.max(texture.width, 1)
local textureHeight = math.max(texture.height, 1)
local desiredWidth = math.max(profile.width > 0 and profile.width or textureWidth, 1)
local desiredHeight = math.max(profile.height > 0 and profile.height or textureHeight, 1)
local desiredAspect = desiredWidth / desiredHeight
local widthRatio = desiredWidth / textureWidth
local heightRatio = desiredHeight / textureHeight
local aspectRatio = widthRatio / heightRatio
-- frame settings
local border = previewFrame
local padding = 4
local aspect = 0.5
border.paddingAllSides = padding
border.autoWidth = false
border.autoHeight = false
local imageHeight = math.clamp(desiredHeight, 128, 256) -- limit
local heightScale = imageHeight / desiredHeight
border.height = imageHeight + padding * 2
-- crop
local minWidth = imageHeight * aspect
local maxWidth = math.max(desiredWidth * heightScale, minWidth)
border.width = (math.lerp(minWidth, maxWidth, profile.cropWidth)) + padding * 2
-- scale
local image = previewImage
image.contentPath = profile.path
image.width = imageHeight * aspect
image.height = imageHeight
image.scaleMode = false
image.autoWidth = true
image.autoHeight = true
if aspect > desiredAspect then
-- fit width base
local scale = image.width / textureWidth
image.imageScaleX = scale
image.imageScaleY = scale / aspectRatio
else
-- fit height base
local scale = image.height / textureHeight
image.imageScaleX = scale * aspectRatio
image.imageScaleY = scale
end
if updateLayout then
image:getTopLevelMenu():updateLayout()
ContentsChanged(scrollBar)
end
end
---@param parentBlock tes3uiElement
---@param text string
---@param numeric boolean?
---@param validate fun(text:string): any
---@return tes3uiElement
---@return tes3uiElement
local function CreateInputField(parentBlock, text, numeric, validate)
local border = parentBlock:createThinBorder()
border.widthProportional = 1.0
border.autoHeight = true
border.flowDirection = tes3.flowDirection.leftToRight
local inputField = border:createTextInput({ id = guidTextInputLabel, text = text:trim(), numeric = numeric })
inputField.widthProportional = 1.0
inputField.autoHeight = true
inputField.widget.lengthLimit = nil
inputField.widget.eraseOnFirstKey = false
inputField.borderLeft = 5
inputField.borderBottom = 4
inputField.borderTop = 2
inputField.consumeMouseEvents = false
inputField.wrapText = true
if not validate or validate(inputField.text) ~= nil then
inputField.color = tes3ui.getPalette(tes3.palette.normalOverColor)
else
inputField.color = tes3ui.getPalette(tes3.palette.negativeColor)
end
return border, inputField
end
---@param parentBlock tes3uiElement
---@return tes3uiElement
---@return tes3uiElement
local function CreateInputButton(parentBlock)
local submit = parentBlock:createButton({ id = guidButton, text = mwse.mcm.i18n("Submit") })
submit.borderAllSides = 0
submit.paddingAllSides = 2
local revert = parentBlock:createButton({ id = guidButton, text = "Revert" })
revert.borderAllSides = 0
revert.paddingAllSides = 2
return submit, revert
end
---@param e tes3uiElement
---@param input tes3uiElement
local function RegisterAcquireTextInput(e, input)
e:register(tes3.uiEvent.mouseClick, function()
tes3ui.acquireTextInput(input)
end)
if e.children then
for _, element in ipairs(e.children) do
RegisterAcquireTextInput(element, input)
end
end
end
local _, inner, button = CreateButton(content, "Enable Portrait", profile.enable,
function()
profile.enable = not profile.enable
return profile.enable
end)
enableField = button
if isGlobal then
local _, desc = CreateDescription(inner, "If disabled, the portrait will not be used unless it is individually enabled on a character. In other words, only certain characters can use portraits.")
desc.borderTop = 2
else
local _, desc = CreateDescription(inner, "If disabled, the global portrait is used for the current character.")
desc.borderTop = 2
end
-- text input
do
local outer = CreateOuterContainer(content)
local inner = CreateInnerContainer(outer)
local label = inner:createLabel({ id = guidLabel, text = "Image Path" })
label.minWidth = 96
label.autoWidth = true
label.autoHeight = true
label.borderRight = indent
label.borderTop = 2
---@param text string
---@return boolean
local function Validate(text)
return validator.IsValidPath(text)
end
local border, inputField = CreateInputField(inner, profile.path, false, Validate)
border.borderRight = indent
pathField = inputField
local submit, revert = CreateInputButton(inner)
submit.borderRight = indent
CreateDescription(outer,
"The path of the portrait image from 'Data Files'. Image file format must be DDS, TGA or BMP. " ..
"And the image must have power-of-2 dimensions (i.e. 64, 128, 256, 512, 1024). " ..
"If the aspect ratio does not match that of the image before resizing, shrink or stretch the image, or add margins. It can be adjusted in the settings described below.")
RegisterAcquireTextInput(border, inputField)
local backupPath = profile.path -- when opened mcm
local function Accept()
local text = inputField.text:trim()
if Validate(text) then
profile.path = text
UpdatePreview(true)
else
tes3.messageBox("[Custom Portrait] Invalid Path:\n" .. profile.path)
end
end
inputField:register(tes3.uiEvent.keyEnter,
---@param e tes3uiEventData
function(e)
Accept()
end)
inputField:register(tes3.uiEvent.keyPress,
---@param e tes3uiEventData
function(e)
e.source:forwardEvent(e)
local text = inputField.text:trim()
if Validate(text) then
inputField.color = tes3ui.getPalette(tes3.palette.normalOverColor)
else
inputField.color = tes3ui.getPalette(tes3.palette.negativeColor)
end
inputField:getTopLevelMenu():updateLayout()
end)
submit:register(tes3.uiEvent.mouseClick,
---@param e tes3uiEventData
function(e)
Accept()
end)
revert:register(tes3.uiEvent.mouseClick,
---@param e tes3uiEventData
function(e)
--inputField.text = profile.path
inputField.text = backupPath
local text = inputField.text:trim()
if Validate(text) then
inputField.color = tes3ui.getPalette(tes3.palette.normalOverColor)
else
inputField.color = tes3ui.getPalette(tes3.palette.negativeColor)
end
UpdatePreview(true)
end)
end
-- width height
do
local outer = CreateOuterContainer(content)
local inner = CreateInnerContainer(outer)
---@param text string
---@return any
local function Validate(text)
local number = tonumber(text)
if number ~= nil and number >= 0 then
return number
end
return nil
end
do
local label = inner:createLabel({ id = guidLabel, text = "Width" })
label.minWidth = 96
label.autoWidth = true
label.autoHeight = true
label.borderRight = indent
label.borderTop = 2
local border, inputField = CreateInputField(inner, tostring(profile.width), true, Validate)
border.borderRight = indent
widthField = inputField
RegisterAcquireTextInput(border, inputField)
local function Accept()
local number = Validate(inputField.text:trim())
if number ~= nil then
profile.width = math.floor(number)
inputField.color = tes3ui.getPalette(tes3.palette.normalOverColor)
UpdatePreview(true)
else
inputField.color = tes3ui.getPalette(tes3.palette.negativeColor)
end
inputField:getTopLevelMenu():updateLayout()
end
inputField:register(tes3.uiEvent.keyEnter,
---@param e tes3uiEventData
function(e)
Accept()
end)
inputField:register(tes3.uiEvent.keyPress,
---@param e tes3uiEventData
function(e)
e.source:forwardEvent(e)
Accept()
end)
end
do
local label = inner:createLabel({ id = guidLabel, text = "Height" })
label.minWidth = 96
label.autoWidth = true
label.autoHeight = true
label.borderRight = indent
label.borderTop = 2
local border, inputField = CreateInputField(inner, tostring(profile.height), true, Validate)
heightField = inputField
RegisterAcquireTextInput(border, inputField)
local function Accept()
local number = Validate(inputField.text:trim())
if number ~= nil then
profile.height = math.floor(number)
inputField.color = tes3ui.getPalette(tes3.palette.normalOverColor)
UpdatePreview(true)
else
inputField.color = tes3ui.getPalette(tes3.palette.negativeColor)
end
inputField:getTopLevelMenu():updateLayout()
end
inputField:register(tes3.uiEvent.keyEnter,
---@param e tes3uiEventData
function(e)
Accept()
end)
inputField:register(tes3.uiEvent.keyPress,
---@param e tes3uiEventData
function(e)
e.source:forwardEvent(e)
Accept()
end)
end
CreateDescription(outer,
"Specifies the size of the original image for aspect ratio. " ..
"This can adjust for the change in aspect ratio that occurs when it was changed to power-of-2 dimensions. " ..
"When 0, dimensions are treated as the aspect ratio as is. " ..
"The aspect ratio of the original character image is 1:2.")
end
-- crop
local cropResolution = 1024
do
local outer = CreateOuterContainer(content)
local inner = CreateInnerContainer(outer)
local label = inner:createLabel({ id = guidLabel, text = "Crop Width" })
label.minWidth = 96
label.autoWidth = true
label.autoHeight = true
label.borderRight = indent
label.borderTop = 2 -- fit button
local slider = inner:createSlider({ id = guidSlider, current = profile.cropWidth * cropResolution, step = 1,
jump = 16, max = cropResolution })
slider.widthProportional = 1.0
slider.heightProportional = 1.0
slider.borderRight = indent
slider.borderTop = 4
cropField = slider
local right = inner:createBlock({ id = guidContainer })
right.width = 64
right.autoHeight = true
right.childAlignX = 1.0
local label = right:createLabel({ id = guidLabel, text = string.format("%.3f", profile.cropWidth) })
label.autoWidth = true
label.autoHeight = true
cropValueField = label
CreateDescription(outer,
"The ratio of the portrait width to be cropped. " ..
"If the image is too wide, the usability of the inventory will be impaired.")
---@param e tes3uiEventData
local function OnValueChanged(e)
local val = (slider.widget.current) / cropResolution
label.text = string.format("%.3f", val)
val = math.clamp(val, 0.0, 1.0)
profile.cropWidth = math.clamp(val, 0, 1)
UpdatePreview(true)
end
for _, child in ipairs(slider.children) do
child:register(tes3.uiElementType.mouseClick, OnValueChanged) -- click, drag
child:register(tes3.uiEvent.mouseRelease, OnValueChanged) -- drag
for _, gchild in ipairs(child.children) do
gchild:register(tes3.uiEvent.mouseClick, OnValueChanged) -- click, drag
gchild:register(tes3.uiEvent.mouseRelease, OnValueChanged) -- drag
end
end
-- need to update only value test?
slider:register(tes3.uiEvent.partScrollBarChanged, OnValueChanged)
end
do
local outer = CreateOuterContainer(content)
local inner = CreateInnerContainer(outer)
do
-- test button
local button = inner:createButton({
id = guidButton,
text = "Hide Preview"
})
button.borderAllSides = 0
button.paddingAllSides = 2
button:register(tes3.uiEvent.mouseClick, function(e)
previewFrame.visible = not previewFrame.visible
button.text = previewFrame.visible and "Hide Preview" or "Show Preview"
previewFrame:getTopLevelMenu():updateLayout()
ContentsChanged(scrollBar)
end)
end
do
local right = inner:createBlock({ id = guidContainer })
right.widthProportional = 1.0
right.autoHeight = true
right.childAlignX = 1.0
local button = right:createButton({ id = guidButton, text = "Reset to Default" })
button.borderAllSides = 0
button.paddingAllSides = 2
---@param input tes3uiElement
---@param value string|number
local function SetInputValue(input, value)
if input then
input.text = tostring(value)
input.color = tes3ui.getPalette(tes3.palette.normalOverColor) -- expects always valid
end
end
button:register(tes3.uiEvent.mouseClick,
---@param e tes3uiEventData
function(e)
table.copy(settings.Default().global, profile)
-- feedback values
if enableField then
enableField.text = GetYesNo(profile.enable)
end
SetInputValue(pathField, profile.path)
SetInputValue(widthField, profile.width)
SetInputValue(heightField, profile.height)
cropField.widget.current = profile.cropWidth * cropResolution
cropValueField.text = string.format("%.3f", profile.cropWidth)
UpdatePreview(true)
end)
end
end
-- preview
do
local outer = CreateOuterContainer(content)
local inner = CreateInnerContainer(outer)
local border = inner:createThinBorder({ id = guidBorder })
border.width = 128
border.height = 128
local image = border:createImage({ id = guidImage })
previewFrame = border
previewImage = image
UpdatePreview(false)
end
end
---@param container tes3uiElement
function modConfig.onCreate(container)
local pane = container:createVerticalScrollPane({ id = guidScrollPane })
pane.widthProportional = 1.0
pane.heightProportional = 1.0
local content = pane:getContentElement()
local headerColor = tes3ui.getPalette(tes3.palette.headerColor)
local config = settings.Load()
local characterProfileBlock ---@type tes3uiElement
---comment
---@param element tes3uiElement
---@param visible boolean
local function SetVisibility(element, visible)
if element then
element.visible = visible
if element.children then
for _, child in ipairs(element.children) do
SetVisibility(child, visible)
end
end
end
end
do
local block = CreateOuterContainer(content)
do
local inner = CreateInnerContainer(block)
local label = inner:createLabel({ id = guidLabel, text = "Common Settings" })
label.color = headerColor
inner:createDivider({ id = guidDivider }).widthProportional = 1
end
do
CreateButton(block, "Enable Mod", config.enable,
function()
config.enable = not config.enable
return config.enable
end)
end
do
local _, inner = CreateButton(block, "Use Different Portraits For Each Character", config
.useCharacterProfile,
function()
config.useCharacterProfile = not config.useCharacterProfile
SetVisibility(characterProfileBlock, config.useCharacterProfile)
container:updateLayout()
ContentsChanged(pane)
return config.useCharacterProfile
end)
end
end
-- per character profile...
do
local block = CreateOuterContainer(content)
characterProfileBlock = block
do
local inner = CreateInnerContainer(block)
local label = inner:createLabel({ id = guidLabel, text = "Character Portrait" })
label.color = headerColor
inner:createDivider({ id = guidDivider }).widthProportional = 1
end
if tes3.onMainMenu() then
local outer = CreateOuterContainer(block)
local inner = CreateInnerContainer(outer)
inner:createLabel({ id = guidLabel, text = "Enabled In-Game" }).color = tes3ui.getPalette(tes3.palette
.disabledColor)
else
modConfig.characterProfile = settings:GetCharacterProfile()
if modConfig.characterProfile then
CreateProfileSettings(block, pane, modConfig.characterProfile, false)
end
end
SetVisibility(characterProfileBlock, config.useCharacterProfile)
end
-- global profile
do
local block = CreateOuterContainer(content)
do
local inner = CreateInnerContainer(block)
local label = inner:createLabel({ id = guidLabel, text = "Global Portrait" })
label.color = headerColor
inner:createDivider({ id = guidDivider }).widthProportional = 1
end
CreateProfileSettings(block, pane, config.global, true)
local inner, _ = CreateDescription(block,
"Tips: Click on the armor rating at the bottom of the portrait to toggle to the rendered character image.")
inner.paddingLeft = indent * 2
end
-- needs double update for proportional?
container:getTopLevelMenu():updateLayout()
container:getTopLevelMenu():updateLayout()
ContentsChanged(pane)
end
---@param container tes3uiElement
function modConfig.onClose(container)
mwse.saveConfig(settings.configPath, settings.Load())
-- flush
settings:SetCharacterProfile(modConfig.characterProfile)
modConfig.characterProfile = nil
-- re-init state
settings.showPortrait = true
end
return modConfig