« back to all changes in this revision
Viewing changes to src/mudlet-lua/mudlet-lua-doc/files/GUIUtils.html
- browse files at revision 406
- compare with another revision
- download diff
- download tarball
- view history from revision 406
- Committer: Vadim Peretokin
- Date: 2010-08-28 18:10:10 UTC
- Revision ID: vadi@vadi-laptop-20100828181010-bew8lo0qqqdxajmu
Added missing files.
- files added:
- src/Makefile
- src/mudlet-lua
- src/mudlet-lua/lua
- src/mudlet-lua/lua/geyser
- src/mudlet-lua/lua/luadoc
- src/mudlet-lua/lua/luadoc/doclet
- src/mudlet-lua/lua/luadoc/doclet/html
- src/mudlet-lua/lua/luadoc/taglet
- src/mudlet-lua/lua/luadoc/taglet/standard
- src/mudlet-lua/mudlet-lua-doc
- src/mudlet-lua/mudlet-lua-doc/files
- src/mudlet-lua/mudlet-lua-doc/files/geyser
- src/tmp
added
removed
src/mudlet-lua/mudlet-lua-doc/files/GUIUtils.html
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
<html>
4
<head>
5
<title>Reference</title>
6
<link rel="stylesheet" href="../luadoc.css" type="text/css" />
7
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
8
</head>
9
10
<body>
11
<div id="container">
12
13
<div id="product">
14
<div id="product_logo"></div>
15
<div id="product_name"><big><b></b></big></div>
16
<div id="product_description"></div>
17
</div> <!-- id="product" -->
18
19
<div id="main">
20
21
<div id="navigation">
22
23
24
<h1>LuaDoc</h1>
25
<ul>
26
27
<li><a href="../index.html">Index</a></li>
28
29
</ul>
30
31
32
<!-- Module list -->
33
34
35
36
<!-- File list -->
37
38
<h1>Files</h1>
39
<ul>
40
41
<li>
42
<a href="../files/CoreMudlet.html">CoreMudlet.lua</a>
43
</li>
44
45
<li>
46
<a href="../files/DB.html">DB.lua</a>
47
</li>
48
49
<li>
50
<a href="../files/DebugTools.html">DebugTools.lua</a>
51
</li>
52
53
<li><strong>GUIUtils.lua</strong></li>
54
55
<li>
56
<a href="../files/Logging.html">Logging.lua</a>
57
</li>
58
59
<li>
60
<a href="../files/LuaGlobal.html">LuaGlobal.lua</a>
61
</li>
62
63
<li>
64
<a href="../files/Other.html">Other.lua</a>
65
</li>
66
67
<li>
68
<a href="../files/StringUtils.html">StringUtils.lua</a>
69
</li>
70
71
<li>
72
<a href="../files/TableUtils.html">TableUtils.lua</a>
73
</li>
74
75
<li>
76
<a href="../files/geyser/Geyser.html">geyser/Geyser.lua</a>
77
</li>
78
79
<li>
80
<a href="../files/geyser/GeyserColor.html">geyser/GeyserColor.lua</a>
81
</li>
82
83
<li>
84
<a href="../files/geyser/GeyserContainer.html">geyser/GeyserContainer.lua</a>
85
</li>
86
87
<li>
88
<a href="../files/geyser/GeyserGauge.html">geyser/GeyserGauge.lua</a>
89
</li>
90
91
<li>
92
<a href="../files/geyser/GeyserGeyser.html">geyser/GeyserGeyser.lua</a>
93
</li>
94
95
<li>
96
<a href="../files/geyser/GeyserLabel.html">geyser/GeyserLabel.lua</a>
97
</li>
98
99
<li>
100
<a href="../files/geyser/GeyserMiniConsole.html">geyser/GeyserMiniConsole.lua</a>
101
</li>
102
103
<li>
104
<a href="../files/geyser/GeyserReposition.html">geyser/GeyserReposition.lua</a>
105
</li>
106
107
<li>
108
<a href="../files/geyser/GeyserSetConstraints.html">geyser/GeyserSetConstraints.lua</a>
109
</li>
110
111
<li>
112
<a href="../files/geyser/GeyserTests.html">geyser/GeyserTests.lua</a>
113
</li>
114
115
<li>
116
<a href="../files/geyser/GeyserUtil.html">geyser/GeyserUtil.lua</a>
117
</li>
118
119
<li>
120
<a href="../files/geyser/GeyserWindow.html">geyser/GeyserWindow.lua</a>
121
</li>
122
123
</ul>
124
125
126
127
128
129
</div> <!-- id="navigation" -->
130
131
<div id="content">
132
133
<h1>File <code>GUIUtils.lua</code></h1>
134
135
136
137
138
139
140
141
<h2>Functions</h2>
142
<table class="function_list">
143
144
<tr>
145
<td class="name" nowrap><a href="#PadHexNum">PadHexNum</a> (incString)</td>
146
<td class="summary">Pads a hex number to ensure a minimum of 2 digits.</td>
147
</tr>
148
149
<tr>
150
<td class="name" nowrap><a href="#RGB2Hex">RGB2Hex</a> (red, green, blue)</td>
151
<td class="summary">Converts an RGB value into an HTML compliant(label usable) HEX number.</td>
152
</tr>
153
154
<tr>
155
<td class="name" nowrap><a href="#bg">bg</a> (colorName)</td>
156
<td class="summary">Sets current background color to a named color.</td>
157
</tr>
158
159
<tr>
160
<td class="name" nowrap><a href="#cecho">cecho</a> (...)</td>
161
<td class="summary">Echo string with embedded color name information.</td>
162
</tr>
163
164
<tr>
165
<td class="name" nowrap><a href="#cinsertText">cinsertText</a> (...)</td>
166
<td class="summary">Inserts string with embedded color name information.</td>
167
</tr>
168
169
<tr>
170
<td class="name" nowrap><a href="#color_table">color_table</a> ()</td>
171
<td class="summary">The <i>color_table table</i> holds definition of color names.</td>
172
</tr>
173
174
<tr>
175
<td class="name" nowrap><a href="#createConsole">createConsole</a> (consoleName, fontSize, charsPerLine, numberOfLines, Xpos, Ypos)</td>
176
<td class="summary">Make a new console window with ease.</td>
177
</tr>
178
179
<tr>
180
<td class="name" nowrap><a href="#createGauge">createGauge</a> (gaugeName, width, height, Xpos, Ypos, gaugeText, color1, color2, color3)</td>
181
<td class="summary">Make your very own customized gauge with this function.</td>
182
</tr>
183
184
<tr>
185
<td class="name" nowrap><a href="#decho">decho</a> (...)</td>
186
<td class="summary">Echo string with embedded decimal color information.</td>
187
</tr>
188
189
<tr>
190
<td class="name" nowrap><a href="#deselect">deselect</a> ()</td>
191
<td class="summary">Clears the current selection in the main window or miniConsole window.</td>
192
</tr>
193
194
<tr>
195
<td class="name" nowrap><a href="#dinsertText">dinsertText</a> (...)</td>
196
<td class="summary">Inserts string with embedded decimal color information.</td>
197
</tr>
198
199
<tr>
200
<td class="name" nowrap><a href="#fg">fg</a> (colorName)</td>
201
<td class="summary">Sets current foreground color to a named color.</td>
202
</tr>
203
204
<tr>
205
<td class="name" nowrap><a href="#gagLine">gagLine</a> ()</td>
206
<td class="summary">Function will gag the whole line.</td>
207
</tr>
208
209
<tr>
210
<td class="name" nowrap><a href="#gaugesTable">gaugesTable</a> ()</td>
211
<td class="summary">The <i>gaugesTable table</i>.</td>
212
</tr>
213
214
<tr>
215
<td class="name" nowrap><a href="#getRGB">getRGB</a> (colorName)</td>
216
<td class="summary">Get RGB component from color name.</td>
217
</tr>
218
219
<tr>
220
<td class="name" nowrap><a href="#handleWindowResizeEvent">handleWindowResizeEvent</a> ()</td>
221
<td class="summary">Default resizeEvent handler function.</td>
222
</tr>
223
224
<tr>
225
<td class="name" nowrap><a href="#hecho">hecho</a> (...)</td>
226
<td class="summary">Echo string with embedded hex color information.</td>
227
</tr>
228
229
<tr>
230
<td class="name" nowrap><a href="#hinsertText">hinsertText</a> (...)</td>
231
<td class="summary">Inserts string with embedded hex color information.</td>
232
</tr>
233
234
<tr>
235
<td class="name" nowrap><a href="#moveGauge">moveGauge</a> (gaugeName, newX, newY)</td>
236
<td class="summary">Move a custom gauge.</td>
237
</tr>
238
239
<tr>
240
<td class="name" nowrap><a href="#prefix">prefix</a> (what, func, fg, bg, window)</td>
241
<td class="summary">Prefixes text at the beginning of the current line when used in a trigger.</td>
242
</tr>
243
244
<tr>
245
<td class="name" nowrap><a href="#replaceAll">replaceAll</a> (word, what)</td>
246
<td class="summary">Replaces all occurrences of what in the current line with <i>with</i>.</td>
247
</tr>
248
249
<tr>
250
<td class="name" nowrap><a href="#replaceLine">replaceLine</a> (what)</td>
251
<td class="summary">Replace the whole with a string you'd like.</td>
252
</tr>
253
254
<tr>
255
<td class="name" nowrap><a href="#replaceWildcard">replaceWildcard</a> (what, replacement)</td>
256
<td class="summary">Replaces the given wildcard (as a number) with the given text.</td>
257
</tr>
258
259
<tr>
260
<td class="name" nowrap><a href="#resizeGauge">resizeGauge</a> (gaugeName, width, height)</td>
261
<td class="summary"><b><u>TODO</u></b> resizeGauge(gaugeName, width, height) </td>
262
</tr>
263
264
<tr>
265
<td class="name" nowrap><a href="#setGauge">setGauge</a> (gaugeName, currentValue, maxValue, gaugeText)</td>
266
<td class="summary">Use this function when you want to change the gauges look according to your values.</td>
267
</tr>
268
269
<tr>
270
<td class="name" nowrap><a href="#setGaugeStyleSheet">setGaugeStyleSheet</a> (gaugeName, css, cssback)</td>
271
<td class="summary"><b><u>TODO</u></b> setGaugeStyleSheet(gaugeName, css, cssback) </td>
272
</tr>
273
274
<tr>
275
<td class="name" nowrap><a href="#setGaugeText">setGaugeText</a> (gaugeName, gaugeText, color1, color2, color3)</td>
276
<td class="summary">Set the text on a custom gauge.</td>
277
</tr>
278
279
<tr>
280
<td class="name" nowrap><a href="#showColors">showColors</a> (...)</td>
281
<td class="summary">Prints out a formatted list of all available named colors, optional arg specifies number of columns to print in, defaults to 3 </td>
282
</tr>
283
284
<tr>
285
<td class="name" nowrap><a href="#suffix">suffix</a> (what, func, fg, bg, window)</td>
286
<td class="summary">Suffixes text at the end of the current line when used in a trigger.</td>
287
</tr>
288
289
<tr>
290
<td class="name" nowrap><a href="#xEcho">xEcho</a> (style, insert, win, str)</td>
291
<td class="summary">Generic color echo and insert function (allowing hecho, decho, cecho, hinsertText, dinsertText and cinsertText).</td>
292
</tr>
293
294
</table>
295
296
297
298
299
300
301
<br/>
302
<br/>
303
304
305
306
307
<h2><a name="functions"></a>Functions</h2>
308
<dl class="function">
309
310
311
312
<dt><a name="PadHexNum"></a>
313
<b><big>PadHexNum </big></b>(incString)</dt>
314
<dd>
315
316
Pads a hex number to ensure a minimum of 2 digits.
317
318
319
320
<br/>
321
322
323
<b>Parameters</b>
324
<ul>
325
326
<li>
327
incString:
328
</li>
329
330
</ul>
331
332
333
334
<b>Usage:</b>
335
<ul>
336
<li>Following command will returns "F0". <pre> PadHexNum("F")
337
</pre>
338
</ul>
339
340
341
342
343
344
345
</dd>
346
347
348
349
350
<dt><a name="RGB2Hex"></a>
351
<b><big>RGB2Hex </big></b>(red, green, blue)</dt>
352
<dd>
353
354
Converts an RGB value into an HTML compliant(label usable) HEX number. This function is colorNames aware and can take any defined global color as its first argument.
355
356
357
358
<br/>
359
360
361
<b>Parameters</b>
362
<ul>
363
364
<li>
365
red:
366
</li>
367
368
<li>
369
green:
370
</li>
371
372
<li>
373
blue:
374
</li>
375
376
</ul>
377
378
379
380
<b>Usage:</b>
381
<ul>
382
<li>Both following commands will returns "FFFFFF". <pre> RGB2Hex(255,255,255)
383
RGB2Hex("white")
384
</pre>
385
</ul>
386
387
388
389
390
391
<b>See also:</b>
392
<ul>
393
394
<li><b>MISSING LINK: 'showColor'</b>
395
396
</ul>
397
398
399
</dd>
400
401
402
403
404
<dt><a name="bg"></a>
405
<b><big>bg </big></b>(colorName)</dt>
406
<dd>
407
408
Sets current background color to a named color.
409
410
411
412
<br/>
413
414
415
<b>Parameters</b>
416
<ul>
417
418
<li>
419
colorName:
420
</li>
421
422
</ul>
423
424
425
426
<b>Usage:</b>
427
<ul>
428
<li>Set background color to magenta. <pre> bg("magenta")
429
</pre>
430
</ul>
431
432
433
434
435
436
<b>See also:</b>
437
<ul>
438
439
<li><a href='GUIUtils.html#fg'>fg</a>
440
441
<li><a href='GUIUtils.html#showColors'>showColors</a>
442
443
</ul>
444
445
446
</dd>
447
448
449
450
451
<dt><a name="cecho"></a>
452
<b><big>cecho </big></b>(...)</dt>
453
<dd>
454
455
Echo string with embedded color name information.
456
457
458
459
<br/>
460
461
462
<b>Parameters</b>
463
<ul>
464
465
<li>
466
...:
467
</li>
468
469
</ul>
470
471
472
473
<b>Usage:</b>
474
<ul>
475
<li>Consider following example: <pre> cecho("<green>green text <blue>blue text <red>red text")
476
</pre>
477
</ul>
478
479
480
481
482
483
<b>See also:</b>
484
<ul>
485
486
<li><a href='GUIUtils.html#xEcho'>xEcho</a>
487
488
<li><a href='GUIUtils.html#cinsertText'>cinsertText</a>
489
490
</ul>
491
492
493
</dd>
494
495
496
497
498
<dt><a name="cinsertText"></a>
499
<b><big>cinsertText </big></b>(...)</dt>
500
<dd>
501
502
Inserts string with embedded color name information.
503
504
505
506
<br/>
507
508
509
<b>Parameters</b>
510
<ul>
511
512
<li>
513
...:
514
</li>
515
516
</ul>
517
518
519
520
521
522
523
524
<b>See also:</b>
525
<ul>
526
527
<li><a href='GUIUtils.html#xEcho'>xEcho</a>
528
529
<li><a href='GUIUtils.html#cecho'>cecho</a>
530
531
</ul>
532
533
534
</dd>
535
536
537
538
539
<dt><a name="color_table"></a>
540
<b><big>color_table </big></b>()</dt>
541
<dd>
542
543
The <i>color_table table</i> holds definition of color names. These are intended to be used in conjunction with fg() and bg() colorizer functions.
544
545
546
547
<br/>
548
549
550
551
552
553
554
555
556
<b>See also:</b>
557
<ul>
558
559
<li><a href='GUIUtils.html#showColors'>showColors</a>
560
561
<li><a href='GUIUtils.html#bg'>bg</a>
562
563
<li><a href='GUIUtils.html#fg'>fg</a>
564
565
</ul>
566
567
568
</dd>
569
570
571
572
573
<dt><a name="createConsole"></a>
574
<b><big>createConsole </big></b>(consoleName, fontSize, charsPerLine, numberOfLines, Xpos, Ypos)</dt>
575
<dd>
576
577
Make a new console window with ease. The default background is black and text color white. If you wish to change the color you can easily do this when updating your text or manually somewhere, using setFgColor() and setBackgroundColor().
578
579
580
581
<br/>
582
583
584
<b>Parameters</b>
585
<ul>
586
587
<li>
588
consoleName:
589
</li>
590
591
<li>
592
fontSize:
593
</li>
594
595
<li>
596
charsPerLine:
597
</li>
598
599
<li>
600
numberOfLines:
601
</li>
602
603
<li>
604
Xpos:
605
</li>
606
607
<li>
608
Ypos:
609
</li>
610
611
</ul>
612
613
614
615
<b>Usage:</b>
616
<ul>
617
<li>This will create a miniconsole window that has a font size of 8pt, will display 80 characters in width, hold a maximum of 20 lines and be place at 200x400 of your Mudlet window. <pre> createConsole("myConsoleWindow", 8, 80, 20, 200, 400)
618
</pre>
619
</ul>
620
621
622
623
624
625
626
</dd>
627
628
629
630
631
<dt><a name="createGauge"></a>
632
<b><big>createGauge </big></b>(gaugeName, width, height, Xpos, Ypos, gaugeText, color1, color2, color3)</dt>
633
<dd>
634
635
Make your very own customized gauge with this function.
636
637
638
639
<br/>
640
641
642
<b>Parameters</b>
643
<ul>
644
645
<li>
646
gaugeName:
647
</li>
648
649
<li>
650
width:
651
</li>
652
653
<li>
654
height:
655
</li>
656
657
<li>
658
Xpos:
659
</li>
660
661
<li>
662
Ypos:
663
</li>
664
665
<li>
666
gaugeText:
667
</li>
668
669
<li>
670
color1:
671
</li>
672
673
<li>
674
color2:
675
</li>
676
677
<li>
678
color3:
679
</li>
680
681
</ul>
682
683
684
685
<b>Usage</b>
686
<ul>
687
688
<li>This would make a gauge at that's 300px width, 20px in height, located at Xpos and Ypos and is green. <pre> createGauge("healthBar", 300, 20, 30, 300, nil, 0, 255, 0)
689
</pre>
690
691
<li>The second example is using the same names you'd use for something like fg() or bg(). <pre> createGauge("healthBar", 300, 20, 30, 300, nil, "green")
692
</pre>
693
694
<li>Finally we'll add some text to our gauche. <pre> createGauge("healthBar", 300, 20, 30, 300, "Now with some text", "green")
695
</pre>
696
697
</ul>
698
699
700
701
702
703
704
</dd>
705
706
707
708
709
<dt><a name="decho"></a>
710
<b><big>decho </big></b>(...)</dt>
711
<dd>
712
713
Echo string with embedded decimal color information. <br/><br/> Color changes can be made using the format <FR,FG,FB:BR,BG,BB> where each field is a number from 0 to 255. The background portion can be omitted using <FR,FG,FB> or the foreground portion can be omitted using <:BR,BG,BB>.
714
715
716
717
<br/>
718
719
720
<b>Parameters</b>
721
<ul>
722
723
<li>
724
...:
725
</li>
726
727
</ul>
728
729
730
731
<b>Usage:</b>
732
<ul>
733
<li>Print red test on green background. <pre> decho("<255,0,0:0,255,0>test")
734
</pre>
735
</ul>
736
737
738
739
740
741
<b>See also:</b>
742
<ul>
743
744
<li><a href='GUIUtils.html#xEcho'>xEcho</a>
745
746
<li><a href='GUIUtils.html#dinsertText'>dinsertText</a>
747
748
</ul>
749
750
751
</dd>
752
753
754
755
756
<dt><a name="deselect"></a>
757
<b><big>deselect </big></b>()</dt>
758
<dd>
759
760
Clears the current selection in the main window or miniConsole window. <br/> (Note: <i>deselect(windowName)</i> is implemented in Core Mudlet.)
761
762
763
764
<br/>
765
766
767
768
769
<b>Usage</b>
770
<ul>
771
772
<li>Clear selection in main window. <pre> deselect()
773
</pre>
774
775
<li>Clear selection in myMiniConsole window. <pre> deselect("myMiniConsole")
776
</pre>
777
778
</ul>
779
780
781
782
783
784
785
</dd>
786
787
788
789
790
<dt><a name="dinsertText"></a>
791
<b><big>dinsertText </big></b>(...)</dt>
792
<dd>
793
794
Inserts string with embedded decimal color information.
795
796
797
798
<br/>
799
800
801
<b>Parameters</b>
802
<ul>
803
804
<li>
805
...:
806
</li>
807
808
</ul>
809
810
811
812
813
814
815
816
<b>See also:</b>
817
<ul>
818
819
<li><a href='GUIUtils.html#xEcho'>xEcho</a>
820
821
<li><a href='GUIUtils.html#decho'>decho</a>
822
823
</ul>
824
825
826
</dd>
827
828
829
830
831
<dt><a name="fg"></a>
832
<b><big>fg </big></b>(colorName)</dt>
833
<dd>
834
835
Sets current foreground color to a named color.
836
837
838
839
<br/>
840
841
842
<b>Parameters</b>
843
<ul>
844
845
<li>
846
colorName:
847
</li>
848
849
</ul>
850
851
852
853
<b>Usage:</b>
854
<ul>
855
<li>Set foreground color to black. <pre> fg("black")
856
</pre>
857
</ul>
858
859
860
861
862
863
<b>See also:</b>
864
<ul>
865
866
<li><a href='GUIUtils.html#bg'>bg</a>
867
868
<li><a href='GUIUtils.html#showColors'>showColors</a>
869
870
</ul>
871
872
873
</dd>
874
875
876
877
878
<dt><a name="gagLine"></a>
879
<b><big>gagLine </big></b>()</dt>
880
<dd>
881
882
Function will gag the whole line. <b>Use deleteLine() instead.</b>
883
884
885
886
<br/>
887
888
889
890
891
892
893
894
895
896
</dd>
897
898
899
900
901
<dt><a name="gaugesTable"></a>
902
<b><big>gaugesTable </big></b>()</dt>
903
<dd>
904
905
The <i>gaugesTable table</i>. First we need to make this table which will be used later to store important data in.
906
907
908
909
<br/>
910
911
912
913
914
915
916
917
918
919
</dd>
920
921
922
923
924
<dt><a name="getRGB"></a>
925
<b><big>getRGB </big></b>(colorName)</dt>
926
<dd>
927
928
Get RGB component from color name.
929
930
931
932
<br/>
933
934
935
<b>Parameters</b>
936
<ul>
937
938
<li>
939
colorName:
940
</li>
941
942
</ul>
943
944
945
946
<b>Usage:</b>
947
<ul>
948
<li>Following will display "0.255.0" on your screen. <pre> local red, green, blue = getRGB("green")
949
echo(red .. "." .. green .. "." .. blue )
950
</pre>
951
</ul>
952
953
954
955
956
957
958
</dd>
959
960
961
962
963
<dt><a name="handleWindowResizeEvent"></a>
964
<b><big>handleWindowResizeEvent </big></b>()</dt>
965
<dd>
966
967
Default resizeEvent handler function. Overwrite this function to make a custom event handler if the main window is being resized. <br/><br/> The standard implementation of this function does nothing. However, this function gets called whenever the main window is being manually resized. You can overwrite this function in your own scripts to handle window resize events yourself and e.g. adjust the screen position and size of your mini console windows, labels or other relevant GUI elements in your scripts that depend on the size of the main Window. To override this function you can simply put a function with the same name in one of your scripts thus overwriting the original empty implementation of this function. <pre> function handleWindowResizeEvent()
968
-- determine the size of your screen
969
WindowWidth=0;
970
WindowHeight=0;
971
WindowWidth, WindowHeight = getMainWindowSize();
972
-- move mini console "sys" to the far right side of the screen whenever the screen gets resized
973
moveWindow("sys",WindowWidth-300,0)
974
end
975
</pre>
976
977
978
979
<br/>
980
981
982
983
984
985
986
987
988
989
</dd>
990
991
992
993
994
<dt><a name="hecho"></a>
995
<b><big>hecho </big></b>(...)</dt>
996
<dd>
997
998
Echo string with embedded hex color information. <br/><br/> Color changes can be made within the string using the format |cFRFGFB,BRBGBB where FR is the foreground red value, FG is the foreground green value, FB is the foreground blue value, BR is the background red value, etc., BRBGBB is optional. |r can be used within the string to reset the colors to default.
999
1000
1001
1002
<br/>
1003
1004
1005
<b>Parameters</b>
1006
<ul>
1007
1008
<li>
1009
...:
1010
</li>
1011
1012
</ul>
1013
1014
1015
1016
1017
1018
1019
1020
<b>See also:</b>
1021
<ul>
1022
1023
<li><a href='GUIUtils.html#xEcho'>xEcho</a>
1024
1025
<li><a href='GUIUtils.html#hinsertText'>hinsertText</a>
1026
1027
</ul>
1028
1029
1030
</dd>
1031
1032
1033
1034
1035
<dt><a name="hinsertText"></a>
1036
<b><big>hinsertText </big></b>(...)</dt>
1037
<dd>
1038
1039
Inserts string with embedded hex color information.
1040
1041
1042
1043
<br/>
1044
1045
1046
<b>Parameters</b>
1047
<ul>
1048
1049
<li>
1050
...:
1051
</li>
1052
1053
</ul>
1054
1055
1056
1057
1058
1059
1060
1061
<b>See also:</b>
1062
<ul>
1063
1064
<li><a href='GUIUtils.html#xEcho'>xEcho</a>
1065
1066
<li><a href='GUIUtils.html#hecho'>hecho</a>
1067
1068
</ul>
1069
1070
1071
</dd>
1072
1073
1074
1075
1076
<dt><a name="moveGauge"></a>
1077
<b><big>moveGauge </big></b>(gaugeName, newX, newY)</dt>
1078
<dd>
1079
1080
Move a custom gauge.
1081
1082
1083
1084
<br/>
1085
1086
1087
<b>Parameters</b>
1088
<ul>
1089
1090
<li>
1091
gaugeName:
1092
</li>
1093
1094
<li>
1095
newX:
1096
</li>
1097
1098
<li>
1099
newY:
1100
</li>
1101
1102
</ul>
1103
1104
1105
1106
<b>Usage:</b>
1107
<ul>
1108
<li>This would move the health bar gauge to the location 1200, 400. <pre> moveGauge("healthBar", 1200, 400)
1109
</pre>
1110
</ul>
1111
1112
1113
1114
1115
1116
<b>See also:</b>
1117
<ul>
1118
1119
<li><a href='GUIUtils.html#createGauge'>createGauge</a>
1120
1121
</ul>
1122
1123
1124
</dd>
1125
1126
1127
1128
1129
<dt><a name="prefix"></a>
1130
<b><big>prefix </big></b>(what, func, fg, bg, window)</dt>
1131
<dd>
1132
1133
Prefixes text at the beginning of the current line when used in a trigger.
1134
1135
1136
1137
<br/>
1138
1139
1140
<b>Parameters</b>
1141
<ul>
1142
1143
<li>
1144
what:
1145
</li>
1146
1147
<li>
1148
func:
1149
</li>
1150
1151
<li>
1152
fg:
1153
</li>
1154
1155
<li>
1156
bg:
1157
</li>
1158
1159
<li>
1160
window:
1161
</li>
1162
1163
</ul>
1164
1165
1166
1167
<b>Usage:</b>
1168
<ul>
1169
<li>Prefix the hours, minutes and seconds onto our prompt even though Mudlet has a button for that. <pre> prefix(os.date("%H:%M:%S "))
1170
</pre>
1171
</ul>
1172
1173
1174
1175
1176
1177
<b>See also:</b>
1178
<ul>
1179
1180
<li><a href='GUIUtils.html#suffix'>suffix</a>
1181
1182
</ul>
1183
1184
1185
</dd>
1186
1187
1188
1189
1190
<dt><a name="replaceAll"></a>
1191
<b><big>replaceAll </big></b>(word, what)</dt>
1192
<dd>
1193
1194
Replaces all occurrences of what in the current line with <i>with</i>.
1195
1196
1197
1198
<br/>
1199
1200
1201
<b>Parameters</b>
1202
<ul>
1203
1204
<li>
1205
word:
1206
</li>
1207
1208
<li>
1209
what:
1210
</li>
1211
1212
</ul>
1213
1214
1215
1216
<b>Usage:</b>
1217
<ul>
1218
<li>This will replace all occurrences of John with the word Doe. <pre> replaceAll("John", "Doe")
1219
</pre>
1220
</ul>
1221
1222
1223
1224
1225
1226
1227
</dd>
1228
1229
1230
1231
1232
<dt><a name="replaceLine"></a>
1233
<b><big>replaceLine </big></b>(what)</dt>
1234
<dd>
1235
1236
Replace the whole with a string you'd like.
1237
1238
1239
1240
<br/>
1241
1242
1243
<b>Parameters</b>
1244
<ul>
1245
1246
<li>
1247
what:
1248
</li>
1249
1250
</ul>
1251
1252
1253
1254
1255
1256
1257
1258
<b>See also:</b>
1259
<ul>
1260
1261
<li><a href='CoreMudlet.html#deleteLine'>deleteLine</a>
1262
1263
</ul>
1264
1265
1266
</dd>
1267
1268
1269
1270
1271
<dt><a name="replaceWildcard"></a>
1272
<b><big>replaceWildcard </big></b>(what, replacement)</dt>
1273
<dd>
1274
1275
Replaces the given wildcard (as a number) with the given text.
1276
1277
1278
1279
<br/>
1280
1281
1282
<b>Parameters</b>
1283
<ul>
1284
1285
<li>
1286
what:
1287
</li>
1288
1289
<li>
1290
replacement:
1291
</li>
1292
1293
</ul>
1294
1295
1296
1297
<b>Usage:</b>
1298
<ul>
1299
<li>Replace "goodbye" with "hello" on a trigger of "^You wave (goodbye)\.$" <pre> replaceWildcard(2, "hello")
1300
</pre> Is equivalent to doing: <pre> selectString(matches[2], 1)
1301
replace("hello")
1302
</pre>
1303
</ul>
1304
1305
1306
1307
1308
1309
1310
</dd>
1311
1312
1313
1314
1315
<dt><a name="resizeGauge"></a>
1316
<b><big>resizeGauge </big></b>(gaugeName, width, height)</dt>
1317
<dd>
1318
1319
<b><u>TODO</u></b> resizeGauge(gaugeName, width, height)
1320
1321
1322
1323
<br/>
1324
1325
1326
<b>Parameters</b>
1327
<ul>
1328
1329
<li>
1330
gaugeName:
1331
</li>
1332
1333
<li>
1334
width:
1335
</li>
1336
1337
<li>
1338
height:
1339
</li>
1340
1341
</ul>
1342
1343
1344
1345
1346
1347
1348
1349
1350
</dd>
1351
1352
1353
1354
1355
<dt><a name="setGauge"></a>
1356
<b><big>setGauge </big></b>(gaugeName, currentValue, maxValue, gaugeText)</dt>
1357
<dd>
1358
1359
Use this function when you want to change the gauges look according to your values. Typical usage would be in a prompt with your current health or whatever value, and throw in some variables instead of the numbers.
1360
1361
1362
1363
<br/>
1364
1365
1366
<b>Parameters</b>
1367
<ul>
1368
1369
<li>
1370
gaugeName:
1371
</li>
1372
1373
<li>
1374
currentValue:
1375
</li>
1376
1377
<li>
1378
maxValue:
1379
</li>
1380
1381
<li>
1382
gaugeText:
1383
</li>
1384
1385
</ul>
1386
1387
1388
1389
<b>Usage</b>
1390
<ul>
1391
1392
<li>In that example, we'd change the looks of the gauge named healthBar and make it fill to half of its capacity. The height is always remembered. <pre> setGauge("healthBar", 200, 400)
1393
</pre>
1394
1395
<li>Change the text on your gauge. <pre> setGauge("healthBar", 200, 400, "some text")
1396
</pre>
1397
1398
</ul>
1399
1400
1401
1402
1403
1404
1405
</dd>
1406
1407
1408
1409
1410
<dt><a name="setGaugeStyleSheet"></a>
1411
<b><big>setGaugeStyleSheet </big></b>(gaugeName, css, cssback)</dt>
1412
<dd>
1413
1414
<b><u>TODO</u></b> setGaugeStyleSheet(gaugeName, css, cssback)
1415
1416
1417
1418
<br/>
1419
1420
1421
<b>Parameters</b>
1422
<ul>
1423
1424
<li>
1425
gaugeName:
1426
</li>
1427
1428
<li>
1429
css:
1430
</li>
1431
1432
<li>
1433
cssback:
1434
</li>
1435
1436
</ul>
1437
1438
1439
1440
1441
1442
1443
1444
1445
</dd>
1446
1447
1448
1449
1450
<dt><a name="setGaugeText"></a>
1451
<b><big>setGaugeText </big></b>(gaugeName, gaugeText, color1, color2, color3)</dt>
1452
<dd>
1453
1454
Set the text on a custom gauge.
1455
1456
1457
1458
<br/>
1459
1460
1461
<b>Parameters</b>
1462
<ul>
1463
1464
<li>
1465
gaugeName:
1466
</li>
1467
1468
<li>
1469
gaugeText: An empty gaugeText will clear the text entirely.
1470
</li>
1471
1472
<li>
1473
color1: Colors are optional and will default to 0,0,0(black) if not passed as args.
1474
</li>
1475
1476
<li>
1477
color2:
1478
</li>
1479
1480
<li>
1481
color3:
1482
</li>
1483
1484
</ul>
1485
1486
1487
1488
<b>Usage</b>
1489
<ul>
1490
1491
<li> <pre> setGaugeText("healthBar", "HP: 100%", 40, 40, 40)
1492
</pre>
1493
1494
<li> <pre> setGaugeText("healthBar", "HP: 100%", "red")
1495
</pre>
1496
1497
</ul>
1498
1499
1500
1501
1502
1503
<b>See also:</b>
1504
<ul>
1505
1506
<li><a href='GUIUtils.html#createGauge'>createGauge</a>
1507
1508
</ul>
1509
1510
1511
</dd>
1512
1513
1514
1515
1516
<dt><a name="showColors"></a>
1517
<b><big>showColors </big></b>(...)</dt>
1518
<dd>
1519
1520
Prints out a formatted list of all available named colors, optional arg specifies number of columns to print in, defaults to 3
1521
1522
1523
1524
<br/>
1525
1526
1527
<b>Parameters</b>
1528
<ul>
1529
1530
<li>
1531
...:
1532
</li>
1533
1534
</ul>
1535
1536
1537
1538
<b>Usage</b>
1539
<ul>
1540
1541
<li>Print list in 3 columns by default. <pre> showColors()
1542
</pre>
1543
1544
<li>Print list in 2 columns. <pre> showColors(2)
1545
</pre>
1546
1547
</ul>
1548
1549
1550
1551
1552
1553
<b>See also:</b>
1554
<ul>
1555
1556
<li><a href='GUIUtils.html#color_table'>color_table</a>
1557
1558
</ul>
1559
1560
1561
</dd>
1562
1563
1564
1565
1566
<dt><a name="suffix"></a>
1567
<b><big>suffix </big></b>(what, func, fg, bg, window)</dt>
1568
<dd>
1569
1570
Suffixes text at the end of the current line when used in a trigger.
1571
1572
1573
1574
<br/>
1575
1576
1577
<b>Parameters</b>
1578
<ul>
1579
1580
<li>
1581
what:
1582
</li>
1583
1584
<li>
1585
func:
1586
</li>
1587
1588
<li>
1589
fg:
1590
</li>
1591
1592
<li>
1593
bg:
1594
</li>
1595
1596
<li>
1597
window:
1598
</li>
1599
1600
</ul>
1601
1602
1603
1604
1605
1606
1607
1608
<b>See also:</b>
1609
<ul>
1610
1611
<li><a href='GUIUtils.html#prefix'>prefix</a>
1612
1613
</ul>
1614
1615
1616
</dd>
1617
1618
1619
1620
1621
<dt><a name="xEcho"></a>
1622
<b><big>xEcho </big></b>(style, insert, win, str)</dt>
1623
<dd>
1624
1625
Generic color echo and insert function (allowing hecho, decho, cecho, hinsertText, dinsertText and cinsertText).
1626
1627
1628
1629
<br/>
1630
1631
1632
<b>Parameters</b>
1633
<ul>
1634
1635
<li>
1636
style: Hex, Decimal or Color
1637
</li>
1638
1639
<li>
1640
insert: boolean flag to determine echo/insert behaviour
1641
</li>
1642
1643
<li>
1644
win: windowName optional
1645
</li>
1646
1647
<li>
1648
str: text with embedded color information
1649
</li>
1650
1651
</ul>
1652
1653
1654
1655
1656
1657
1658
1659
<b>See also:</b>
1660
<ul>
1661
1662
<li><a href='GUIUtils.html#cecho'>cecho</a>
1663
1664
<li><a href='GUIUtils.html#decho'>decho</a>
1665
1666
<li><a href='GUIUtils.html#hecho'>hecho</a>
1667
1668
<li><a href='GUIUtils.html#cinsertText'>cinsertText</a>
1669
1670
<li><a href='GUIUtils.html#dinsertText'>dinsertText</a>
1671
1672
<li><a href='GUIUtils.html#hinsertText'>hinsertText</a>
1673
1674
</ul>
1675
1676
1677
</dd>
1678
1679
1680
</dl>
1681
1682
1683
1684
1685
1686
1687
1688
</div> <!-- id="content" -->
1689
1690
</div> <!-- id="main" -->
1691
1692
<div id="about">
1693
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
1694
</div> <!-- id="about" -->
1695
1696
</div> <!-- id="container" -->
1697
</body>
1698
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1