Skip to content

Commit 0a922c7

Browse files
committed
Added logo & preliminary warning to API reference
1 parent e80381c commit 0a922c7

File tree

238 files changed

+2811
-454
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

238 files changed

+2811
-454
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,4 +258,7 @@ paket-files/
258258

259259
# Python Tools for Visual Studio (PTVS)
260260
__pycache__/
261-
*.pyc
261+
*.pyc
262+
263+
# Docs
264+
docs/LastBuild.log

Docs.shfbproj

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,34 @@
2929
<HelpFileVersion>1.0.0.0</HelpFileVersion>
3030
<RootNamespaceContainer>False</RootNamespaceContainer>
3131
<NamespaceGrouping>False</NamespaceGrouping>
32-
<Preliminary>False</Preliminary>
32+
<Preliminary>True</Preliminary>
3333
<SdkLinkTarget>Blank</SdkLinkTarget>
3434
<NamingMethod>MemberName</NamingMethod>
3535
<ContentPlacement>AboveNamespaces</ContentPlacement>
3636
<SourceCodeBasePath>MLAPI\</SourceCodeBasePath>
3737
<WarnOnMissingSourceContext>False</WarnOnMissingSourceContext>
3838
<DocumentationSources>
3939
<DocumentationSource sourceFile="MLAPI\bin\Debug\MLAPI.dll" />
40-
<DocumentationSource sourceFile="MLAPI\bin\Debug\MLAPI.xml" /></DocumentationSources>
40+
<DocumentationSource sourceFile="MLAPI\bin\Debug\MLAPI.xml" />
41+
</DocumentationSources>
4142
<MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, TypeParameter, AutoDocumentDispose</MissingTags>
4243
<HeaderText>
4344
</HeaderText>
45+
<FooterText>
46+
</FooterText>
47+
<TransformComponentArguments>
48+
<Argument Key="logoFile" Value="MLAPI_Logo.png" />
49+
<Argument Key="logoHeight" Value="" />
50+
<Argument Key="logoWidth" Value="600" />
51+
<Argument Key="logoAltText" Value="" />
52+
<Argument Key="logoPlacement" Value="right" />
53+
<Argument Key="logoAlignment" Value="right" />
54+
<Argument Key="maxVersionParts" Value="" />
55+
<Argument Key="defaultLanguage" Value="cs" />
56+
<Argument Key="includeEnumValues" Value="true" />
57+
<Argument Key="baseSourceCodeUrl" Value="https://github.com/TwoTenPvP/MLAPI/" />
58+
<Argument Key="requestExampleUrl" Value="" />
59+
</TransformComponentArguments>
4460
</PropertyGroup>
4561
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
4662
the build. The others are optional common platform types that may appear. -->

docs/WebKI.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,8 +325,8 @@
325325
<HelpKINode Title="OnLostOwnership method" Url="html/M_MLAPI_MonoBehaviours_Core_NetworkedBehaviour_OnLostOwnership.htm" />
326326
<HelpKINode Title="OnServerStarted field" Url="html/F_MLAPI_MonoBehaviours_Core_NetworkingManager_OnServerStarted.htm" />
327327
<HelpKINode Title="OwnedObjects field" Url="html/F_MLAPI_NetworkedClient_OwnedObjects.htm" />
328-
<HelpKINode Title="ownerClientId property" Url="html/P_MLAPI_MonoBehaviours_Core_NetworkedBehaviour_ownerClientId.htm" />
329328
<HelpKINode Title="OwnerClientId property" Url="html/P_MLAPI_MonoBehaviours_Core_NetworkedObject_OwnerClientId.htm" />
329+
<HelpKINode Title="ownerClientId property" Url="html/P_MLAPI_MonoBehaviours_Core_NetworkedBehaviour_ownerClientId.htm" />
330330
<HelpKINode Title="param0 field" Url="html/F_MLAPI_MonoBehaviours_Prototyping_NetworkedAnimator_param0.htm" />
331331
<HelpKINode Title="param1 field" Url="html/F_MLAPI_MonoBehaviours_Prototyping_NetworkedAnimator_param1.htm" />
332332
<HelpKINode Title="param2 field" Url="html/F_MLAPI_MonoBehaviours_Prototyping_NetworkedAnimator_param2.htm" />

docs/WebTOC.xml

Lines changed: 50 additions & 50 deletions
Large diffs are not rendered by default.

docs/fti/FTI_100.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"destroys":[5373954,8847361,10027009,13041666],"deregisters":[5570561,6881281,6946817,10092545,13172737,13500417,13631489,13697025,13762561],"dictionary":[11010049,12517379,13434881],"data":[720897,3473409,5636099,5832707,5898243,6094851,6356995,6422531,6553603,6684675,6750211,7077891,7602179,7798787,8060931,8519683,8912897,13893633],"defined":[5636098,5832706,5898242,6094850,6356994,6422530,6553602,6684674,6750210,7077890,7602178,7798786,8060930,8519682],"delay":[131074,196609,458753,524289,851969,1703937,13500417,13631489,13697026,13762561],"defaultplayerprefab":[393217,655362,13434881],"diffie":[720897,5242881,13893633],"driftcorrectionpercentage":[131073,2162690,13697025],"decrypts":[4980737,8388609,12058625],"deregistermessagehandler":[5570562,6881281,6946817,10092545,13172737,13500417,13631489,13697025,13762561],"destroypool":[5373953,10027010,13041665],"description":[65537,131073,196609,327681,393217,458753,524289,589825,720897,4456449,4587521,4915201,4980737,5308417,5373953,5767169,6881281,6946817,8585217,9043969,9306113,9502721,9633793,9895937,9961473,10092545,10158081,10289153,10354689,10485761,10551297,10682369,11010049,11468801,11665409,11796481,11927553,12058625,12124161,12320769,12451841,12648450,12713985,12976129,13041665,13172737,13238276,13303812,13369345,13434884,13500420,13565955,13631492,13697028,13762564,13828099,13893635],"destroy":[5373953,8847362,13041665],"duplicates":[5308417,11599873,12976129],"deregister":[5505025,5570562],"disconnects":[393217,1245185,13434881],"decrypt":[4980737,8388610,12058625],"decided":[720897,4259841,13893633],"degrees":[458753,2228225,13762561],"dontdestroyonload":[393217,917505,13434881],"destination":[131073,1966081,13697025],"decide":[720897,3473409,13893633],"dontdestroy":[393217,917506,13434881],"different":[720897,4718593,13893633],"documentation":[1376257,1507329,1638401,1769473,2031617,2097153,5701634,7536642,7864322,8126465,8454145,8781826,9175042,9240577,9764865,10747905],"destroypoolobject":[5373953,8847362,13041665],"duplicate":[11599873],"default":[1,393217,655361,13434881],"dll":[655361,786433,851969,917505,983041,1048577,1114113,1179649,1245185,1310721,1376257,1441793,1507329,1572865,1638401,1703937,1769473,1835009,1900545,1966081,2031617,2162689,2097153,2228225,2293761,2359297,2424833,2490369,2555905,2621441,2686977,2752513,2818049,2883585,2949121,3014657,3080193,3145729,3211265,3276801,3342337,3407873,3473409,3538945,3604481,3670017,3735553,3801089,3866625,3997697,4063233,4128769,4194305,4259841,4325377,4390913,4521985,4653057,4718593,4784129,4849665,5046273,5111809,5177345,5242881,5439489,5505025,5570561,5636097,5701633,5832705,5898241,5963777,6029313,6094849,6160385,6225921,6291457,6356993,6422529,6488065,6553601,6619137,6684673,6750209,6815745,7012353,7077889,7208961,7143425,7274497,7340033,7405569,7471105,7536641,7602177,7667713,7733249,7798785,7864321,7929857,7995393,8060929,8126465,8192001,8257537,8323073,8388609,8454145,8519681,8650753,8716289,8781825,8847361,8912897,8978433,9109505,9175041,9240577,9371649,9568257,9699329,9764865,9830401,10027009,10223617,10420225,10616833,10747905,10813441,10878977,10944513,11075585,11141121,11206657,11272193,11337729,11403265,11534337,11599873,11730945,11862017,11993089,12058625,12189697,12255233,12386305,12517377,12582913,12648449,12713985,12779521,12845057,12910593,12976129,13041665,13107201,13238273,13303809,13434881,13500417,13565953,13631489,13697025,13762561,13828097,13893633],"decrypted":[8388609],"distance":[458754,2949121,3276801,13762562]}
1+
{"destroys":[5308418,8912897,8978433,13107202],"deregisters":[6553601,9764865,10092545,12320769,13565953,13631489,13762561,13828097,13893633],"dictionary":[10747905,10813443,13697025],"data":[327681,3211265,5636099,6356995,7143427,7208963,7471107,7536643,7798787,8323075,8454147,8716289,9306115,9371651,9830403,10354691,11468803,12517377],"defined":[5636098,6356994,7143426,7208962,7471106,7536642,7798786,8323074,8454146,9306114,9371650,9830402,10354690,11468802],"delay":[131073,196609,262146,1179649,1245185,2424833,13631490,13762561,13828097,13893633],"defaultplayerprefab":[720897,851970,13697025],"diffie":[327681,4849665,12517377],"driftcorrectionpercentage":[262145,1572866,13631489],"decrypts":[4587521,11927553,12189697],"deregistermessagehandler":[6553602,9764865,10092545,12320769,13565953,13631489,13762561,13828097,13893633],"destroypool":[5308417,8912898,13107201],"description":[131073,196609,262145,327681,393217,458753,524289,720897,1179649,3538945,4587521,4718593,4784129,4915201,5046273,5308417,5439489,6225921,7667713,7733249,8847361,9109505,9175041,9502721,9633793,9699329,9764865,9895937,9961473,10092545,10158081,10485761,10747905,10878977,11403268,11665411,11730945,11862017,11927553,12058625,12124161,12255233,12320769,12517379,12582914,12648449,12845057,12976129,13107201,13303811,13434884,13565953,13631492,13697028,13762564,13828100,13893636],"destroy":[5308417,8978434,13107201],"duplicates":[5046273,8519681,12648449],"deregister":[5570561,6553602],"disconnects":[720897,1900545,13697025],"decrypt":[4587521,11927553,12189698],"decided":[327681,6881281,12517377],"degrees":[1179649,2359297,13893633],"dontdestroyonload":[655361,720897,13697025],"destination":[262145,1769473,13631489],"decide":[327681,3211265,12517377],"dontdestroy":[655362,720897,13697025],"different":[327681,4521985,12517377],"documentation":[131073,196609,262145,327681,393217,458753,524289,589825,655361,720897,786433,851969,917505,983042,1048577,1114114,1179649,1245185,1310722,1376257,1441793,1507329,1572865,1638402,1703937,1769473,1835009,1900545,1966081,2031617,2097153,2162689,2228226,2293762,2359297,2424833,2490369,2555905,2621441,2686977,2818049,2883585,2949121,3014657,3080193,3145729,3211265,3276801,3342337,3407873,3473409,3538945,3604481,3670017,3735553,3801089,3866625,3932161,3997697,4063233,4128769,4194305,4259841,4325377,4390913,4456449,4521985,4587521,4653057,4718593,4784129,4849665,4915201,4980737,5046273,5111809,5177345,5242881,5308417,5373953,5439489,5505025,5570561,5636097,5701633,5767169,5832705,5898241,5963777,6029313,6094849,6160387,6225921,6291457,6356993,6422529,6488065,6553601,6619137,6684673,6750209,6815745,6881281,6946817,7012353,7077889,7143425,7208961,7274497,7340033,7405569,7471105,7536641,7602178,7667713,7733249,7798785,7864321,7929857,7995393,8060930,8126465,8192003,8257539,8323073,8388609,8454145,8519681,8585219,8650753,8716289,8781825,8847361,8912897,8978433,9043969,9109505,9175041,9306113,9371649,9437187,9502721,9568258,9633793,9699329,9764865,9830401,9895937,9961473,10027009,10092545,10158081,10223617,10289153,10354689,10420225,10485761,10551297,10616833,10682369,10747905,10813441,10878977,10944513,11010049,11075585,11141121,11206657,11272193,11337729,11403265,11468801,11534337,11599873,11665409,11730945,11796481,11862017,11927553,11993089,12058625,12124161,12189697,12255233,12320769,12386305,12451842,12517377,12582913,12648449,12713985,12779521,12845057,12910593,12976129,13041665,13107201,13172737,13238274,13303809,13369345,13434881,13500417,13565953,13631489,13697025,13762561,13828097,13893633],"destroypoolobject":[5308417,8978434,13107201],"duplicate":[8519681],"default":[1,720897,851969,13697025],"dll":[589825,655361,786433,851969,917505,983041,1048577,1114113,1245185,1310721,1376257,1441793,1507329,1572865,1638401,1703937,1769473,1835009,1900545,1966081,2031617,2097153,2162689,2228225,2293761,2359297,2424833,2490369,2555905,2621441,2686977,2818049,2883585,2949121,3014657,3080193,3145729,3211265,3276801,3342337,3407873,3473409,3604481,3670017,3735553,3801089,3866625,3932161,3997697,4063233,4128769,4194305,4259841,4325377,4390913,4456449,4521985,4653057,4849665,4980737,5111809,5177345,5242881,5373953,5505025,5570561,5636097,5701633,5767169,5832705,5898241,5963777,6029313,6094849,6160385,6291457,6356993,6422529,6488065,6553601,6619137,6684673,6750209,6815745,6881281,6946817,7012353,7077889,7143425,7208961,7274497,7340033,7405569,7471105,7536641,7602177,7798785,7864321,7929857,7995393,8060929,8126465,8192001,8257537,8323073,8388609,8454145,8519681,8585217,8650753,8716289,8781825,8912897,8978433,9043969,9306113,9437185,9371649,9568257,9830401,10027009,10223617,10289153,10354689,10420225,10551297,10616833,10682369,10813441,10944513,11010049,11075585,11141121,11206657,11272193,11337729,11403265,11468801,11534337,11599873,11665409,11796481,11927553,11993089,12124161,12189697,12386305,12451841,12517377,12582913,12648449,12713985,12779521,12910593,13041665,13107201,13172737,13238273,13303809,13369345,13434881,13500417,13631489,13697025,13762561,13828097,13893633],"decrypted":[12189697],"distance":[1179650,2490369,2555905,13893634]}

docs/fti/FTI_101.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"examples":[720897,3538945,13893633],"emptied":[720897,5111809,13893633],"encoded":[4980738,8388609,9109506,12058626],"events":[720897,3538945,13893633],"enabled":[131073,458753,524289,1441793,1835009,2686977,10158081,10289153,10551297,11010049,11468801,11927553,12451841,13238273,13434881,13500417,13565953,13631490,13697026,13762562],"enablesceneswitching":[720897,3014658,13893633],"estimated":[4915201,9830401,12320769,12648449],"encrypted":[720897,4194305,4980737,9109507,12058625,13893633],"exposes":[65537,131073,196609,327681,393217,458753,524289,589825,720897,4456449,4587521,4980737,5308417,5373953,5767169,6881281,6946817,8585217,9633793,10092545,10158081,10289153,10354689,10485761,10551297,11010049,11468801,11796481,11927553,12058625,12451841,12648449,12713985,12976129,13041665,13172737,13238273,13303809,13369345,13434881,13500417,13565953,13631489,13697025,13762561,13828097,13893633],"encryptedbuffer":[8388610],"exchange":[720899,4128769,4653057,5242881,13893635],"extent":[720897,3997697,13893633],"encrypts":[4980737,9109505,12058625],"expectedchunkscount":[8716290,11599874],"encryptedchannels":[720897,4194306,13893633],"encryption":[589825,720897,2752513,3735553,9961473,12058625,13828097,13893633],"equals":[4456449,4587521,6881281,6946817,8585217,10092545,10354689,11796481,13172737,13238273,13303809,13369345,13434881,13500417,13565953,13631489,13697025,13762561,13828097,13893633],"enable":[458753,720899,2359297,3014657,3735553,5242881,13762561,13893635],"encrypt":[4980737,9109506,12058625],"enableencryption":[720897,3735554,13893633],"expected":[8716289,11599873],"error":[3932162],"eventtickrate":[720897,3538946,13893633],"enableproximity":[131073,458753,524289,1441794,1835010,2686978,13631489,13697025,13762561],"entered":[9437185],"executing":[10158083,10289155,10944513,11206657,11927555,12386305,12451843,13500419,13631491,13697027,13762563]}
1+
{"examples":[327681,7405569,12517377],"emptied":[327681,4390913,12517377],"encoded":[4587522,8781826,11927554,12189697],"events":[327681,7405569,12517377],"enabled":[196609,262145,1179649,1507329,2097153,2883585,9633793,9699329,9895937,9961473,10747905,10878977,11730945,13303809,13434881,13631490,13697025,13762561,13828098,13893634],"enablesceneswitching":[327681,4194306,12517377],"estimated":[4784129,9175041,10289153,12582913],"encrypted":[327681,4259841,4587521,8781827,11927553,12517377],"exposes":[131073,196609,262145,327681,393217,458753,524289,720897,1179649,3538945,4587521,4718593,4915201,5046273,5308417,5439489,6225921,7733249,9502721,9633793,9699329,9764865,9895937,9961473,10092545,10747905,10878977,11403265,11665409,11730945,11862017,11927553,12058625,12124161,12320769,12517377,12582913,12648449,13107201,13303809,13434881,13565953,13631489,13697025,13762561,13828097,13893633],"encryptedbuffer":[12189698],"exchange":[327683,3407873,3866625,4849665,12517379],"extent":[327681,4456449,12517377],"encrypts":[4587521,8781825,11927553],"expectedchunkscount":[8519682,12910594],"encryptedchannels":[327681,4259842,12517377],"encryption":[327681,458753,2818049,4128769,7667713,11665409,11927553,12517377],"equals":[3538945,4718593,4915201,6225921,7733249,9764865,10092545,11403265,11665409,12058625,12320769,12517377,13303809,13434881,13565953,13631489,13697025,13762561,13828097,13893633],"enable":[327683,1179649,2162689,4128769,4194305,4849665,12517379,13893633],"encrypt":[4587521,8781826,11927553],"enableencryption":[327681,4128770,12517377],"expected":[8519681,12910593],"error":[2752514],"eventtickrate":[327681,7405570,12517377],"enableproximity":[196609,262145,1179649,1507330,2097154,2883586,13631489,13828097,13893633],"example":[589825,655361,786433,851969,917505,983041,1048577,1114113,1245185,1310721,1376257,1441793,1507329,1572865,1638401,1703937,1769473,1835009,1900545,1966081,2031617,2097153,2162689,2228225,2293761,2359297,2424833,2490369,2555905,2621441,2686977,2818049,2883585,2949121,3014657,3080193,3145729,3211265,3276801,3342337,3407873,3473409,3604481,3670017,3735553,3801089,3866625,3932161,3997697,4063233,4128769,4194305,4259841,4325377,4390913,4456449,4521985,4653057,4849665,4980737,5111809,5177345,5242881,5373953,5505025,5570561,5636097,5701633,5767169,5832705,5898241,5963777,6029313,6094849,6160385,6291457,6356993,6422529,6488065,6553601,6619137,6684673,6750209,6815745,6881281,6946817,7012353,7077889,7143425,7208961,7274497,7340033,7405569,7471105,7536641,7602177,7798785,7864321,7929857,7995393,8060929,8126465,8192001,8257537,8323073,8388609,8454145,8519681,8585217,8650753,8716289,8781825,8912897,8978433,9043969,9306113,9437185,9371649,9568257,9830401,10027009,10223617,10289153,10354689,10420225,10551297,10616833,10682369,10813441,10944513,11010049,11075585,11141121,11206657,11272193,11337729,11403265,11468801,11534337,11599873,11665409,11796481,11927553,11993089,12124161,12189697,12386305,12451841,12517377,12582913,12648449,12713985,12779521,12910593,13041665,13107201,13172737,13238273,13303809,13369345,13434881,13500417,13631489,13697025,13762561,13828097,13893633],"entered":[9240577],"executing":[9633795,9961475,10027009,10420225,10878979,11141121,11730947,13631491,13762563,13828099,13893635]}

docs/fti/FTI_102.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"finalize":[4456449,4587521,6881281,6946817,8585217,10092545,10354689,11796481,13172737,13238273,13303809,13369345,13434881,13500417,13565953,13631489,13697025,13762561,13828097,13893633],"fields":[65538,131074,196610,327682,393218,458754,524290,589826,720898,13238273,13303809,13434881,13500417,13631489,13697025,13762561,13828097,13893633],"follow":[1],"flooding":[720897,4063233,13893633],"following":[65537,131073,196609,327681,393217,458753,524289,589825,720897,4456449,4587521,4980737,5308417,5373953,5767169,6881281,6946817,8585217,9633793,10092545,10158081,10289153,10354689,10485761,10551297,11010049,11468801,11796481,11927553,12058625,12451841,12648449,12713985,12976129,13041665,13172737,13238273,13303809,13369345,13434881,13500417,13565953,13631489,13697025,13762561,13828097,13893633],"first":[4980738,8388609,9109505,12058626],"frame":[720897,3538945,13893633],"float":[851969,1703937,2162689,2228225,2293761,2490369,2555905,2949121,3211265,3276801,4521985,10223617,12255233],"field":[655362,786434,851970,917506,983042,1048578,1114114,1179650,1245186,1310722,1376258,1441794,1507330,1572866,1638402,1703938,1769474,1835010,1900546,1966082,2031618,2162690,2097154,2228226,2293762,2359298,2424834,2490370,2555906,2621442,2686978,2752514,2818050,2883586,2949122,3014658,3080194,3145730,3211266,3276802,3342338,3407874,3473410,3538946,3604482,3670018,3735554,3801090,3866626,3997698,4063234,4128770,4194306,4259842,4325378,4390914,4521986,4653058,4718594,4784130,4849666,5111810,5242882]}
1+
{"finalize":[3538945,4718593,4915201,6225921,7733249,9764865,10092545,11403265,11665409,12058625,12320769,12517377,13303809,13434881,13565953,13631489,13697025,13762561,13828097,13893633],"fields":[131074,196610,262146,327682,393218,458754,524290,720898,1179650,11403265,11665409,12517377,13434881,13631489,13697025,13762561,13828097,13893633],"follow":[1],"flooding":[327681,3276801,12517377],"following":[131073,196609,262145,327681,393217,458753,524289,720897,1179649,3538945,4587521,4718593,4915201,5046273,5308417,5439489,6225921,7733249,9502721,9633793,9699329,9764865,9895937,9961473,10092545,10747905,10878977,11403265,11665409,11730945,11862017,11927553,12058625,12124161,12320769,12517377,12582913,12648449,13107201,13303809,13434881,13565953,13631489,13697025,13762561,13828097,13893633],"first":[4587522,8781825,11927554,12189697],"frame":[327681,7405569,12517377],"float":[1245185,1376257,1572865,1703937,2359297,2424833,2490369,2555905,3670017,3735553,6946817,7077889,11010049],"field":[589826,655362,786434,851970,917506,983042,1048578,1114114,1245186,1310722,1376258,1441794,1507330,1572866,1638402,1703938,1769474,1835010,1900546,1966082,2031618,2097154,2162690,2228226,2293762,2359298,2424834,2490370,2555906,2621442,2686978,2818050,2883586,2949122,3014658,3080194,3145730,3211266,3276802,3342338,3407874,3473410,3604482,3670018,3735554,3801090,3866626,3932162,3997698,4063234,4128770,4194306,4259842,4325378,4390914,4456450,4521986,4653058,4849666,6881282,6946818,7405570,8388610]}

0 commit comments

Comments
 (0)