SubworldLibrary/SubworldLibrary.xml at master · kernel-panic-codecave/SubworldLibrary · 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
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
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>SubworldLibrary</name>
    </assembly>
    <members>
        <member name="M:SubworldLibrary.SubworldLibrary.Call(System.Object[])">
            <summary>
            Available commands:<br/>"Register", Mod mod, string name, int width, int height, List{GenPass} tasks, Action load = null, Action unload = null, ModWorld modWorld = null, bool saveSubworld = false, bool disablePlayerSaving = false, bool saveModData = false, bool noWorldUpdate = true, UserInterface loadingUI = null, Func{UIState} loadingUIState = null, Func{UIState} votingUI = null, ushort votingDuration = 1800, Action onVotedFor = null<br/>"Enter", string id<br/>"Exit"<br/>"IsActive", string id<br/>"AnyActive", Mod mod<br/>"DrawMenu", bool (optional)<br/>"DrawUnderworldBackground", bool (optional)
            </summary>
            <param name="args"></param>
            <returns></returns>
        </member>
        <member name="P:SubworldLibrary.Subworld.Name">
            <summary>
            Returns the translation key for this subworld.
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.Current">
            <summary>
            Returns the ID of the current subworld, or null if not in a subworld.
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.width">
            <summary>
            The subworld's width. Cannot exceed 8400.
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.height">
            <summary>
            The subworld's height. Cannot exceed 2400.
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.tasks">
            <summary>
            A list of the subworld's generation tasks.
            </summary>
        </member>
        <member name="M:SubworldLibrary.Subworld.Load">
            <summary>
            Called after the subworld has generated or loaded from file.
            </summary>
        </member>
        <member name="M:SubworldLibrary.Subworld.Unload">
            <summary>
            Called when exiting the subworld.
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.modWorld">
            <summary>
            Only the specified ModWorld can update inside the subworld. If set to null, any ModWorld can update. Default: null
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.saveSubworld">
            <summary>
            Whether the subworld should save or not. Default: false
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.disablePlayerSaving">
            <summary>
            Disables player saving while in the subworld. Default: false
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.saveModData">
            <summary>
            Whether ModWorld data should save with the subworld or not. if modWorld is not set to null, only the specified ModWorld's data will save. Default: false
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.noWorldUpdate">
            <summary>
            Completely disables vanilla world updating in the subworld. Default: true
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.loadingUI">
            <summary>
            Change this to your own UserInterface if you want the subworld's custom UI to persist after the subworld loads/unloads. Default: Main.MenuUI
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.loadingUIState">
            <summary>
            Change this if you want the subworld to have a custom loading/unloading UI, instead of the default (UIDefaultSubworldLoad).
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.votingUI">
            <summary>
            Change this if you want the subworld to have a custom voting UI, instead of the default (UIDefaultVoting).
            </summary>
        </member>
        <member name="P:SubworldLibrary.Subworld.votingDuration">
            <summary>
            How long voting to enter or leave the subworld lasts. Default: 1800 (30 seconds)
            </summary>
        </member>
        <member name="M:SubworldLibrary.Subworld.OnVotedFor">
            <summary>
            Called on the server when the subworld is voted for. If overridden, it is no longer immediately entered. Useful for making something like a pre-enter animation.
            </summary>
        </member>
        <member name="M:SubworldLibrary.Subworld.Enter(System.String,System.Boolean)">
            <summary>
            Enters the subworld with the specified ID. If called client-side, the ID is passed on to the server. The voting process is skipped if noVote is set to true.
            </summary>
            <param name="id"></param>
            <param name="noVote"></param>
        </member>
        <member name="M:SubworldLibrary.Subworld.Enter``1(System.Boolean)">
            <summary>
            Enters the specified subworld. If called client-side, the subworld's ID is passed on to the server. The voting process is skipped if noVote is set to true.
            </summary>
            <typeparam name="T"></typeparam>
            <param name="noVote"></param>
        </member>
        <member name="M:SubworldLibrary.Subworld.VoteFor(Terraria.UI.UIMouseEvent,Terraria.UI.UIElement)">
            <summary>
            Casts a vote, and closes the UI. Use this if you're using a custom voting UI.
            </summary>
            <param name="evt"></param>
            <param name="listeningElement"></param>
        </member>
        <member name="M:SubworldLibrary.Subworld.VoteAgainst(Terraria.UI.UIMouseEvent,Terraria.UI.UIElement)">
            <summary>
            Casts a vote, and closes the UI. Use this if you're using a custom voting UI.
            </summary>
            <param name="evt"></param>
            <param name="listeningElement"></param>
        </member>
        <member name="M:SubworldLibrary.Subworld.Exit(System.Boolean)">
            <summary>
            Exits the current subworld. The voting process is skipped if noVote is set to true.
            </summary>
            <param name="noVote"></param>
        </member>
        <member name="M:SubworldLibrary.Subworld.IsActive(System.String)">
            <summary>
            Returns true if the current subworld's ID matches the specified ID.
            </summary>
            <param name="id"></param>
            <returns></returns>
        </member>
        <member name="M:SubworldLibrary.Subworld.IsActive``1">
            <summary>
            Returns true if the specified subworld is currently active.
            </summary>
            <typeparam name="T"></typeparam>
            <returns></returns>
        </member>
        <member name="M:SubworldLibrary.Subworld.AnyActive(Terraria.ModLoader.Mod)">
            <summary>
            Returns true if the current subworld is from the specified mod.
            </summary>
            <param name="mod"></param>
            <returns></returns>
        </member>
        <member name="M:SubworldLibrary.Subworld.AnyActive``1">
            <summary>
            Returns true if the current subworld is from the specified mod.
            </summary>
            <typeparam name="T"></typeparam>
            <returns></returns>
        </member>
        <member name="F:SubworldLibrary.SLWorld.subworld">
            <summary>
            Whether the current world is a subworld or not.
            </summary>
        </member>
        <member name="F:SubworldLibrary.SLWorld.currentSubworld">
            <summary>
            The current subworld.
            </summary>
        </member>
        <member name="P:SubworldLibrary.SLWorld.progress">
            <summary>
            The generation progress of the current subworld, or null if there's no generation going on.
            </summary>
        </member>
        <member name="F:SubworldLibrary.SLWorld.drawUnderworldBackground">
            <summary>
            Whether the Underworld background should draw or not.
            </summary>
        </member>
        <member name="F:SubworldLibrary.SLWorld.drawMenu">
            <summary>
            Whether the main menu should draw or not.
            </summary>
        </member>
        <member name="F:SubworldLibrary.SLWorld.noReturn">
            <summary>
            Whether the Save &amp; Exit button should be visible or not.
            </summary>
        </member>
        <member name="F:SubworldLibrary.SLWorld.origin">
            <summary>
            The location of the main world file.
            </summary>
        </member>
    </members>
</doc>