solar2d-definitions/config.lua at master · bglogic/solar2d-definitions · 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
return {
    ---This are folders that are to not be included due to being mostly info nad not actual api
    excluded_folders = { "library_ads", "library_facebook", "library_event",
        "library_gameNetwork", "library_index", "library_lfs", "library_socket",
        "library_sqlite3", "type_Boolean", "type_CoronaClass",
        "type_Function", "type_Userdata", "type_Table", "type_String",
        "type_Scene", "type_RoundedRectPath", "type_Object" },
    --These libreares are not global and are required. This does a quick fix for that
    imported_libraries = {
        physics = true,
        composer = true,
        crypto = true,
        json = true,
        licensing = true,
        store = true,
        widget = true
    },
    --- This toggles argument docs generation
    generate_arguments_docs = true,
    generate_class_docs = true,
    -- For some reason the docs list single argument function as multiple arguments. This should fix that
    single_argument_functions = {
        ["widget.newSlider"] = "NewSliderOptions",
        ["widget.newProgressView"] = "NewProgressViewOptions",
        ["widget.newPickerWheel"] = "NewPickerWheelOptions",
        ["widget.newScrollView"] = "NewScrollViewOptions",
        ["widget.newSegmentedControl"] = "NewSegmentedControlOptions",
        ["display.newEmbossedText"] = "NewEmbossedTextOptions",
        ["widget.newTabBar"] = "NewTabBarOptions",
        ["display.newText"] = "NewTextOptions",
        ["display.newMesh"] = "NewMeshOptions"
    },
    -- To have nice autocompletion some manual work is required
    custom_overloads = {
        ["media.playVideo"] = {
            -- original "(path:string, baseSource:Constant?, showControls:boolean, listener:Listener?)",
            "(path:string, showControls:boolean, listener:Listener?)",
            "(path:string, showControls:boolean)",
        },
        ["graphics.newImageSheet"] = {
            -- original (filename:string, baseDir:Constant?, options:table)
            "(filename:string, options:table)"
        },
        ["native.showWebPopup"] = {
            -- original (x:number?, y:number?, width:number?, height:number?, url:string, options:table?)
            "(x:number, y:number, url:string, options:table?)",
            "(x:number, y:number, width:number?, height:number?, url:string, options:table?)",
            "(url:string, options:table?)",
            "(url:string)",

        },
        ["table.insert"] = {
            -- original (t:table, pos:number?, value:any)
            "(t:table, value:any)"
        },
        ["network.download"] = {
            -- original (url:string, method:string, listener:Listener, params:table?, filename:string, baseDirectory:Constant?)
            "(url:string, method:string, listener:Listener, filename:string, baseDirectory:Constant?)",
            "(url:string, method:string, listener:Listener, filename:string)"
        },
        ["GroupObject.insert"] = {
            -- original (index:number?, child:DisplayObject, resetTransform:boolean?)
            "(child:DisplayObject, resetTransform:boolean?)",
            "(child:DisplayObject)",
        },
        ["display.newRoundedRect"] = {
            -- original (parent:GroupObject?, x:number, y:number, width:number, height:number, cornerRadius:number)
            "(x:number, y:number, width:number, height:number, cornerRadius:number)"
        },
        ["display.newImage"] = {
            -- original1 (parent:GroupObject?, filename:string, baseDir:Constant?, x:number?, y:number?)
            -- original2 (parent:GroupObject?, imageSheet:ImageSheet, frameIndex:number, x:number?, y:number?)
            "(filename:string, baseDir:Constant?, x:number?, y:number?)",
            "(filename:string, x:number?, y:number?)",
            "(imageSheet:ImageSheet, frameIndex:number, x:number?, y:number?)",
            "(imageSheet:ImageSheet, frameIndex:number)"
        },
        ["network.upload"] = {
            -- original (url:string, method:string, listener:Listener, params:table?, filename:string, baseDirectory:Constant?, contentType:Constant?)
            "(url:string, method:string, listener:Listener, params:table?, filename:string, baseDirectory:Constant?)",
            "(url:string, method:string, listener:Listener, params:table?, filename:string)",
            "(url:string, method:string, listener:Listener, filename:string, baseDirectory:Constant?, contentType:Constant?)",
            "(url:string, method:string, listener:Listener, filename:string, baseDirectory:Constant?)",
            "(url:string, method:string, listener:Listener, filename:string)",
        },
        ["display.newSprite"] = {
            -- original (parent:GroupObject?, imageSheet:ImageSheet, sequenceData:table)
            "(imageSheet:ImageSheet, sequenceData:table)"
        },
        ["display.newSnapshot"] = {
            -- original (parent:GroupObject?, w:number, h:number)
            "(w:number, h:number)"
        },
        ["display.newPolygon"] = {
            -- original (parent:GroupObject?, x:number, y:number, vertices:Array)
            "(x:number, y:number, vertices:Array)"
        },
        ["display.newImageRect"] = {
            -- original (parent:GroupObject?,filename:string, baseDir:Constant?, width:number, height:number)
            -- original (parent:GroupObject?, imageSheet:ImageSheet, frameIndex:number, width:number, height:number)
            "(imageSheet:ImageSheet, frameIndex:number, width:number, height:number)",
            "(filename:string, baseDir:Constant?, width:number, height:number)",
            "(filename:string, width:number, height:number)"
        },
        ["display.newLine"] = {
            -- original (parent:GroupObject?, x1:number, y1:number,x2:number, y2:number, ...:number?)
            "(x1:number, y1:number,x2:number, y2:number, ...:number?)",
            "(x1:number, y1:number,x2:number, y2:number)"
        },
        ["display.newCircle"] = {
            -- original (parent:GroupObject?, xCenter:number, yCenter:number, radius:number)
            "(xCenter:number, yCenter:number, radius:number)"
        },
        ["display.newRect"] = {
            -- original (parent:GroupObject?,x:number, y:number, width:number, height:number)
            "(x:number, y:number, width:number, height:number)"
        },

        ["display.loadRemoteImage"] = {
            -- original (url:string, method:string, listener:Listener, params:table?, destFilename:string, baseDir:Constant?, x:number?, y:number?)
            "(url:string, method:string, listener:Listener, destFilename:string, baseDir:Constant?, x:number?, y:number?)",
            "(url:string, method:string, listener:Listener, destFilename:string, baseDir:Constant?,)"
        }
    }

}