selene-lib 0.30.0

A library for linting Lua code. You probably want selene instead.
Documentation
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
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
# This is for exclusively Roblox functionality.
# Valid: CFrame.new(), Instance.new(), task.spawn()
# Invalid (put in selene-lib/default_std/luau.yml instead): math.sign(), bit32.countlz()
---
base: luau
name: roblox
globals:
  Axes.new:
    args:
      - type: "..."
    must_use: true
  BrickColor.Black:
    args: []
    must_use: true
  BrickColor.Blue:
    args: []
    must_use: true
  BrickColor.DarkGray:
    args: []
    must_use: true
  BrickColor.Gray:
    args: []
    must_use: true
  BrickColor.Green:
    args: []
    must_use: true
  BrickColor.Red:
    args: []
    must_use: true
  BrickColor.White:
    args: []
    must_use: true
  BrickColor.Yellow:
    args: []
    must_use: true
  BrickColor.new:
    args:
      - type: any
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  BrickColor.palette:
    args:
      - type: number
    must_use: true
  BrickColor.random:
    args: []
    must_use: true
  CatalogSearchParams.new:
    args: []
    must_use: true
  CFrame.Angles:
    args:
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  CFrame.fromAxisAngle:
    args:
      - type:
          display: Vector3
      - type: number
    must_use: true
  CFrame.fromEulerAngles:
    args:
      - type: number
      - type: number
      - type: number
      - required: false
        type:
          display: RotationOrder
    must_use: true
  CFrame.fromEulerAnglesXYZ:
    args:
      - type: number
      - type: number
      - type: number
    must_use: true
  CFrame.fromEulerAnglesYXZ:
    args:
      - type: number
      - type: number
      - type: number
    must_use: true
  CFrame.fromMatrix:
    args:
      - type:
          display: Vector3
      - type:
          display: Vector3
      - type:
          display: Vector3
      - required: false
        type:
          display: Vector3
    must_use: true
  CFrame.fromOrientation:
    args:
      - type: number
      - type: number
      - type: number
    must_use: true
  CFrame.fromRotationBetweenVectors:
    args:
      - type:
          display: Vector3
      - type:
          display: Vector3
    must_use: true
  CFrame.identity:
    property: read-only
  CFrame.lookAlong:
    args:
      - type:
          display: Vector3
      - type:
          display: Vector3
      - required: false
        type:
          display: Vector3
    must_use: true
  CFrame.lookAt:
    args:
      - type:
          display: Vector3
      - type:
          display: Vector3
      - required: false
        type:
          display: Vector3
    must_use: true
  CFrame.new:
    args:
      - required: false
        type: any
      - required: false
        type: any
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Color3.fromHSV:
    args:
      - type: number
      - type: number
      - type: number
    must_use: true
  Color3.fromHex:
    args:
      - type: string
    must_use: true
  Color3.fromRGB:
    args:
      - type: number
      - type: number
      - type: number
    must_use: true
  Color3.new:
    args:
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Color3.toHSV:
    args:
      - type:
          display: Color3
    must_use: true
  ColorSequence.new:
    args:
      - type: any
      - required: false
        type:
          display: Color3
    must_use: true
  ColorSequenceKeypoint.new:
    args:
      - type: number
      - type:
          display: Color3
    must_use: true
  DateTime.fromIsoDate:
    args:
      - type: string
    must_use: true
  DateTime.fromLocalTime:
    args:
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  DateTime.fromUniversalTime:
    args:
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  DateTime.fromUnixTimestamp:
    args:
      - type: number
    must_use: true
  DateTime.fromUnixTimestampMillis:
    args:
      - type: number
    must_use: true
  DateTime.now:
    args: []
    must_use: true
  DebuggerManager:
    args: []
    must_use: true
  DockWidgetPluginGuiInfo.new:
    args:
      - required: false
        type:
          display: InitialDockState
      - required: false
        type: bool
      - required: false
        type: bool
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Enum.GetEnums:
    args: []
    method: true
    must_use: true
  Faces.new:
    args:
      - type: "..."
    must_use: true
  Font.fromEnum:
    args:
      - type:
          display: Font
    must_use: true
  Font.fromName:
    args:
      - type: string
      - required: false
        type:
          display: FontWeight
      - required: false
        type:
          display: FontStyle
    must_use: true
  Font.fromId:
    args:
      - type: number
      - required: false
        type:
          display: FontWeight
      - required: false
        type:
          display: FontStyle
    must_use: true
  Font.new:
    args:
      - type: string
      - required: false
        type:
          display: FontWeight
      - required: false
        type:
          display: FontStyle
    must_use: true
  FloatCurveKey.new:
    args:
      - type: number
      - type: number
      - type:
          display: KeyInterpolationMode
    must_use: true
  Instance.new:
    args:
      - type: string
      - required: false
        type:
          display: Instance
        deprecated:
          message: set the instance's parent separately
    # This is only must_use because we don't allow the second parameter
    must_use: true
  Instance.fromExisting:
    args:
      - type:
          display: Instance
    must_use: true
  NumberRange.new:
    args:
      - type: number
      - required: false
        type: number
    must_use: true
  NumberSequence.new:
    args:
      - type: any
      - required: false
        type: number
    must_use: true
  NumberSequenceKeypoint.new:
    args:
      - type: number
      - type: number
      - required: false
        type: number
    must_use: true
  OverlapParams.new:
    args: []
    must_use: true
  Path2DControlPoint.new:
    args:
      - required: false
        type:
          display: UDim2
      - required: false
        type:
          display: UDim2
      - required: false
        type:
          display: UDim2
    must_use: true
  PathWaypoint.new:
    args:
      - required: false
        type:
          display: Vector3
      - required: false
        type:
          display: PathWaypointAction
      - required: false
        type: string
    must_use: true
  PhysicalProperties.new:
    args:
      - type: any
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Random.new:
    args:
      - required: false
        type: number
    must_use: true
  Ray.new:
    args:
      - type:
          display: Vector3
      - type:
          display: Vector3
    must_use: true
  RaycastParams.new:
    args: []
    must_use: true
  Rect.new:
    args:
      - type: any
      - type: any
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Region3.new:
    args:
      - type:
          display: Vector3
      - type:
          display: Vector3
    must_use: true
  Region3int16.new:
    args:
      - required: false
        type:
          display: Vector3
      - required: false
        type:
          display: Vector3
    must_use: true
  RotationCurveKey.new:
    args:
      - type: number
      - type:
          display: CFrame
      - type:
          display: KeyInterpolationMode
    must_use: true
  TweenInfo.new:
    args:
      - required: false
        type: number
      - required: false
        type:
          display: EasingStyle
      - required: false
        type:
          display: EasingDirection
      - required: false
        type: number
      - required: false
        type: bool
      - required: false
        type: number
    must_use: true
  UDim.new:
    args:
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  UDim2.fromOffset:
    args:
      - required: use UDim2.new() if you want an empty UDim2
        type: number
      - required: false
        type: number
    must_use: true
  UDim2.fromScale:
    args:
      - required: use UDim2.new() if you want an empty UDim2
        type: number
      - required: false
        type: number
    must_use: true
  UDim2.new:
    args:
      - required: false
        type: any
      - required: false
        type: any
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  UserSettings:
    args: []
    must_use: true
  Vector2.new:
    args:
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Vector2.one:
    property: read-only
  Vector2.xAxis:
    property: read-only
  Vector2.yAxis:
    property: read-only
  Vector2.zero:
    property: read-only
  Vector2int16.new:
    args:
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Vector3.FromAxis:
    args:
      - type:
          display: Axis
    must_use: true
  Vector3.FromNormalId:
    args:
      - type:
          display: NormalId
    must_use: true
  Vector3.new:
    args:
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  Vector3.one:
    property: read-only
  Vector3.xAxis:
    property: read-only
  Vector3.yAxis:
    property: read-only
  Vector3.zAxis:
    property: read-only
  Vector3.zero:
    property: read-only
  Vector3int16.new:
    args:
      - required: false
        type: number
      - required: false
        type: number
      - required: false
        type: number
  debug.profilebegin:
    args:
      - type: string
  debug.profileend:
    args: []
  debug.resetmemorycategory:
    args: []
  debug.setmemorycategory:
    args:
      - type: string
  delay:
    args:
      - type: number
      - type: function
  elapsedTime:
    args: []
  require:
    args:
      - type: number
  SharedTable.clear:
    args:
      - type:
          display: SharedTable
  SharedTable.clone:
    args:
      - type:
          display: SharedTable
      - required: false
        type: bool
    must_use: true
  SharedTable.cloneAndFreeze:
    args:
      - type:
          display: SharedTable
      - required: false
        type: bool
    must_use: true
  SharedTable.increment:
    args:
      - type:
          display: SharedTable
      - type: any
      - type: number
  SharedTable.isFrozen:
    args:
      - type:
          display: SharedTable
    must_use: true
  SharedTable.new:
    args:
      - required: false
        type: table
    must_use: true
  SharedTable.size:
    args:
      - type:
          display: SharedTable
    must_use: true
  SharedTable.update:
    args:
      - type:
          display: SharedTable
      - type: any
      - type: function
  settings:
    args: []
  shared:
    property: new-fields
  spawn:
    args:
      - type: function
  task.cancel:
    args:
      - type:
          display: thread
  task.defer:
    args:
      - type: function
      - required: false
        type: "..."
  task.delay:
    args:
      - required: false
        type: number
      - type: function
      - required: false
        type: "..."
  task.desynchronize:
    args: []
  task.spawn:
    args:
      - type: function
      - required: false
        type: "..."
  task.synchronize:
    args: []
  task.wait:
    args:
      - required: false
        type: number
  tick:
    args: []
  time:
    args: []
  utf8.graphemes:
    args:
      - type: string
      - required: false
        type: number
      - required: false
        type: number
    must_use: true
  utf8.nfcnormalize:
    args:
      - type: string
    must_use: true
  utf8.nfdnormalize:
    args:
      - type: string
    must_use: true
  wait:
    args:
      - required: false
        type: number
  warn:
    args:
      - type: any
      - required: false
        type: "..."
  Content.fromObject:
    args:
      - required: true
        type:
            display: Object
    must_use: true
  Content.fromUri:
    args:
      - required: true
        type: string
    must_use: true
  Content.fromAssetId:
    args:
      - required: true
        type: number
  Content.none:
    property: read-only
structs:
  EnumItem:
    Name:
      property: read-only
    Value:
      property: read-only
  Event:
    Connect:
      args:
        - type: function
      method: true
    connect:
      deprecated:
        message: "lowercase methods have been superseded by uppercase ones"
        replace:
          - "Connect(%1)"
      args:
        - type: function
      method: true
    Once:
      args:
        - type: function
      method: true
    Wait:
      args: []
      method: true
    wait:
      deprecated:
        message: "lowercase methods have been superseded by uppercase ones"
        replace:
          - "Wait(%1)"
      args:
        - type: function
      method: true
  Instance:
    "*":
      any: true