Skip to content

Commit

Permalink
Update documentation [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
ME3Tweaks-LEC-Documentation committed Nov 27, 2023
1 parent 2cd535d commit f4817d3
Show file tree
Hide file tree
Showing 77 changed files with 4,272 additions and 4,220 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@
<tr class="memitem:aff886c43ab92304a4af13b14dfb82712"><td class="memItemLeft" align="right" valign="top">static string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_legendary_explorer_core_1_1_packages_1_1_import_entry.html#aff886c43ab92304a4af13b14dfb82712">GetPackageFile</a> (<a class="el" href="namespace_legendary_explorer_core_1_1_packages.html#a386a95aceb8dcc8725a8cb074fd0e6a8">MEGame</a> game, string className)</td></tr>
<tr class="memdesc:aff886c43ab92304a4af13b14dfb82712"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up the class info for the given class and returns which package file should contain it. Use this for the PackageFile attribute on ImportEntries. <a href="class_legendary_explorer_core_1_1_packages_1_1_import_entry.html#aff886c43ab92304a4af13b14dfb82712">More...</a><br /></td></tr>
<tr class="separator:aff886c43ab92304a4af13b14dfb82712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8162fb24d061298449cce153471527e"><td class="memItemLeft" align="right" valign="top">static string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_legendary_explorer_core_1_1_packages_1_1_import_entry.html#af8162fb24d061298449cce153471527e">GetPackageFile</a> (<a class="el" href="class_legendary_explorer_core_1_1_packages_1_1_export_entry.html">ExportEntry</a> entry)</td></tr>
<tr class="memdesc:af8162fb24d061298449cce153471527e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up the class info for the given class and returns which package file should contain it. Use this for the PackageFile attribute on ImportEntries. <a href="class_legendary_explorer_core_1_1_packages_1_1_import_entry.html#af8162fb24d061298449cce153471527e">More...</a><br /></td></tr>
<tr class="separator:af8162fb24d061298449cce153471527e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
Expand Down Expand Up @@ -530,7 +533,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aad73a913254f9024df5ad200
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aff886c43ab92304a4af13b14dfb82712" name="aff886c43ab92304a4af13b14dfb82712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff886c43ab92304a4af13b14dfb82712">&#9670;&#160;</a></span>GetPackageFile()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#aff886c43ab92304a4af13b14dfb82712">&#9670;&#160;</a></span>GetPackageFile() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -573,6 +576,42 @@ <h2 class="memtitle"><span class="permalink"><a href="#aff886c43ab92304a4af13b14
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a id="af8162fb24d061298449cce153471527e" name="af8162fb24d061298449cce153471527e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8162fb24d061298449cce153471527e">&#9670;&#160;</a></span>GetPackageFile() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static string LegendaryExplorerCore.Packages.ImportEntry.GetPackageFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_legendary_explorer_core_1_1_packages_1_1_export_entry.html">ExportEntry</a>&#160;</td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Looks up the class info for the given class and returns which package file should contain it. Use this for the PackageFile attribute on ImportEntries. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">game</td><td></td></tr>
<tr><td class="paramname">className</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a id="ae1f58c632a9de32f10ca2d9b8e4cb581" name="ae1f58c632a9de32f10ca2d9b8e4cb581"></a>
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@
<tr class="memdesc:a617c1d1af05bbc53574994380d9cb6ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread-safe package cache fetch. Can be passed to various methods to help expedite operations by preventing package reopening. If <a class="el" href="class_legendary_explorer_core_1_1_packages_1_1_package_cache.html#accede661db51e02040eaaa098b787005" title="When the PackageCache opens a package, should it always load from disk, or should it acquire one from...">AlwaysOpenFromDisk</a> is true, then packages opened with this method will not use the global <a class="el" href="namespace_legendary_explorer_core.html">LegendaryExplorerCore</a> caching system and will always load from disk if not in this local cache. <a href="class_legendary_explorer_core_1_1_packages_1_1_package_cache.html#a617c1d1af05bbc53574994380d9cb6ae">More...</a><br /></td></tr>
<tr class="separator:a617c1d1af05bbc53574994380d9cb6ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a432bd598b11b1e4c3331935e880ea55f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_legendary_explorer_core_1_1_packages_1_1_package_cache.html#a432bd598b11b1e4c3331935e880ea55f">InsertIntoCache</a> (<a class="el" href="interface_legendary_explorer_core_1_1_packages_1_1_i_m_e_package.html">IMEPackage</a> package)</td></tr>
<tr class="memdesc:a432bd598b11b1e4c3331935e880ea55f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts a package into the the cache, based on its file path. <a href="class_legendary_explorer_core_1_1_packages_1_1_package_cache.html#a432bd598b11b1e4c3331935e880ea55f">More...</a><br /></td></tr>
<tr class="separator:a432bd598b11b1e4c3331935e880ea55f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab996486be0787fb8dca18529c6f82cb1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_legendary_explorer_core_1_1_packages_1_1_package_cache.html#ab996486be0787fb8dca18529c6f82cb1">AddResidentPackage</a> (<a class="el" href="interface_legendary_explorer_core_1_1_packages_1_1_i_m_e_package.html">IMEPackage</a> package)</td></tr>
<tr class="memdesc:ab996486be0787fb8dca18529c6f82cb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes the specified package, if in the cache, not drop when the cache is full. If the cache is uncapped, this does nothing. <a href="class_legendary_explorer_core_1_1_packages_1_1_package_cache.html#ab996486be0787fb8dca18529c6f82cb1">More...</a><br /></td></tr>
Expand Down Expand Up @@ -291,6 +292,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a432bd598b11b1e4c3331935e
</table>
</div><div class="memdoc">

<p>Inserts a package into the the cache, based on its file path. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">package</td><td></td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ab996486be0787fb8dca18529c6f82cb1" name="ab996486be0787fb8dca18529c6f82cb1"></a>
Expand Down
92 changes: 46 additions & 46 deletions nightly/navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,52 +95,52 @@ var NAVTREEINDEX =
"class_legendary_explorer_core_1_1_packages_1_1_cloning_importing_and_relinking_1_1_entry_cloner.html",
"class_legendary_explorer_core_1_1_packages_1_1_entry_tree.html#ab13633c45f7dbcbf0fe7c9224681833c",
"class_legendary_explorer_core_1_1_packages_1_1_import_entry.html#a35f455c8408bf1e7c21a10fb219689cb",
"class_legendary_explorer_core_1_1_packages_1_1_m_e_package_handler.html#aca987fbab3733a0794051f4ef8da0063",
"class_legendary_explorer_core_1_1_packages_1_1_unreal_package_file.html#ab19cea8b557fcc0f46446f7fc837279f",
"class_legendary_explorer_core_1_1_plot_database_1_1_plot_elements_1_1_plot_mod_element.html#a0cb8f05b8e9b71cba322a9263e86da00",
"class_legendary_explorer_core_1_1_save_1_1_profile_int_save_record.html#acf16169913cdec1dd9f2a1813a67238a",
"class_legendary_explorer_core_1_1_sound_1_1_i_s_a_c_t_1_1_i_s_a_c_t_bank.html#aa510787dcacd333e804a08b7bb60d74a",
"class_legendary_explorer_core_1_1_t_l_k_1_1_t_l_k_bit_array.html",
"class_legendary_explorer_core_1_1_textures_1_1_t_f_c_compactor.html#a2b10ee6dd09416f1bd5cc68cd77a2dd0",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_bio_codex_page.html#aa89b05853616c3dae9189d0b7ba592cc",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_bio_squad_combat.html",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_color_vertex_buffer.html#ae4fc8dac5063e523fbc3a8144f82201e",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_fragment_info.html#a0f707483942cfa52301021068e1f9212",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_light_map__1_d.html#a36d70f60e73182fa102a0ce963d15e90",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_material_shader_map.html#a5e28816c2f11841ca14026211a202af5",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_morph_target.html#ad3b19d0873023684350be3357b7465a5",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_s_c_ext.html#a2f46760ab7e4071cdc783d2dfe47ac07",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_s_c_ext.html#ae205eda09f684aa04daab0f725f19598",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_sound_node_wave.html#a9bdbaaabb085e713f2cc02e05d6a75de",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_static_mesh_vertex_buffer.html",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_tree_node.html#aef04bb4687ade4b564dea0a680770d60",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_u_str_property.html",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_wwise_state_management_1_1_custom_transition_time.html#a9af6aa6fe9e446d9687e4830a734d44a",
"class_legendary_explorer_core_1_1_unreal_1_1_classes_1_1_bio2_d_a.html#acc54e4bf6cfa75ef06e52df0a33a25b9",
"class_legendary_explorer_core_1_1_unreal_1_1_d_l_c_package.html#a0531d70e557866e580162da033af7122",
"class_legendary_explorer_core_1_1_unreal_1_1_none_property.html#a8b7efb3d03247e88d2ad06b01642b787",
"class_legendary_explorer_core_1_1_unreal_1_1_object_property.html#a7901dd7512f7ed0e626c836840b23d27",
"class_legendary_explorer_core_1_1_unreal_1_1_str_property.html#ae6304a082357f8aebd6f64700fb6e78c",
"class_legendary_explorer_core_1_1_unreal_1_1_unreal_flags.html#a93717837f7a982013c328e4e478ca1fe",
"class_legendary_explorer_core_1_1_unreal_script_1_1_compiling_1_1_bytecode_writer.html#a09b40d548b27c902c99606184c7f10b1",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_array_symbol_ref.html#aa5f4749ee8accba10038c6583ac4a0e4",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_delegate_comparison.html#a79eb684ee6fb028f9c87ffe47d4d1281",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_expression.html#a727c53f195abf78df28db257a14c17a1",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_new_operator.html#ace5a56538ed4bd0778b050ce607a5fe6",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_string_ref_literal.html#ab86513603a225628be480ec943f631d1",
"class_legendary_explorer_core_1_1_unreal_script_1_1_parsing_1_1_line_lookup.html",
"class_legendary_explorer_core_1_1_unreal_script_1_1_utilities_1_1_keywords.html#ad3a19d932bd8b141b3cc1abd90dfe995",
"dir_cf28c7c3c6180825101a9961baeff32f.html",
"interface_legendary_explorer_core_1_1_gammtek_1_1_i_o_1_1_i_data_stream.html#a504a5ea23946c2ef27b5c83b21cc37af",
"interface_legendary_explorer_core_1_1_gammtek_1_1_paths_1_1_i_variable_path.html",
"interface_legendary_explorer_core_1_1_unreal_script_1_1_analysis_1_1_visitors_1_1_i_a_s_t_visitor.html#a2b8f5710300c19b00f8a2c8084897015",
"namespace_legendary_explorer_core_1_1_shaders.html#a16e2d8e2656133d6e362bcb2260bb05a",
"namespace_legendary_explorer_core_1_1_unreal.html#a4d8cae3037757666fac97ab9b45b5093",
"namespace_legendary_explorer_core_1_1_unreal.html#aa29e450b0e1b6d608babb62dfcbcbb67",
"namespace_legendary_explorer_core_1_1_unreal.html#afa7126d7fc3befc8fb63a140a0e82df2",
"struct_legendary_explorer_core_1_1_sharp_d_x_1_1_color.html#a5492e24bea6637388531591f163d6af0",
"struct_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_morph_target_1_1_morph_vertex.html#a8cf4a55f98799a841c32b1d065646a16",
"struct_legendary_explorer_core_1_1_unreal_1_1_s_f_a_r_unpacker_1_1_d_l_c_entry.html#af556e18196c7eee2224c3a3f502dac6a"
"class_legendary_explorer_core_1_1_packages_1_1_m_e_package_handler.html#ac007f1091e08996f7dc161007d78e69b",
"class_legendary_explorer_core_1_1_packages_1_1_unreal_package_file.html#ab18d26d3917542ba7a95fc8ebcad718f",
"class_legendary_explorer_core_1_1_plot_database_1_1_plot_elements_1_1_plot_mod_element.html#a04f60ac862cd1a4215b172fecc5ba4bc",
"class_legendary_explorer_core_1_1_save_1_1_profile_int_save_record.html#ab9e3ff07ad9348797adb454aec26a99e",
"class_legendary_explorer_core_1_1_sound_1_1_i_s_a_c_t_1_1_i_s_a_c_t_bank.html#a715ffae53e68adbebb7c65abdce96174",
"class_legendary_explorer_core_1_1_t_l_k_1_1_m_e3_talk_files.html#ae009fa6facd5a09eb6ac8b9c57552be0",
"class_legendary_explorer_core_1_1_textures_1_1_t_f_c_compactor.html",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_bio_codex_page.html#aa46e34347cd0f39c4020223edafd5d3f",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_bio_sound_node_wave_streaming_data.html#abf9af81f75f8ba95e21351b4eb1d9688",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_color_vertex_buffer.html#abd711da117c0cdc176afa46028bb5647",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_fragment_info.html#a0d5d694a60c89da41e710d1bf561f397",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_light_map__1_d.html#a27776697f5818c48dc9c525fffe973d9",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_material_shader_map.html#a59b572a92f5be0757ad7b443751fd78f",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_morph_target.html#ac9d3d85515b859e857862bbf57c50420",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_s_c_ext.html#a2f14945cb27551f52037b544c697101e",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_s_c_ext.html#ae1d8e6fcd7543ac82d41b0f7688ac37e",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_sound_node_wave.html#a993b61ea5f8a0bb4c5f068503f7a9321",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_static_mesh_triangle.html#ae1c35d304eb474cbdcf38e67b73950c5",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_tree_node.html#ab777141d3de5d6baa04e4fd00880bd44",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_u_state.html#aeb56760c9fb67f9575c50775bdaa054e",
"class_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_wwise_state_management_1_1_custom_transition_time.html#a4a3d752c7b71777f36f9d79dababb8f5",
"class_legendary_explorer_core_1_1_unreal_1_1_classes_1_1_bio2_d_a.html#ac6155e9a8a5589e9c56706d18eb8458b",
"class_legendary_explorer_core_1_1_unreal_1_1_d_l_c_package.html",
"class_legendary_explorer_core_1_1_unreal_1_1_none_property.html#a65be468297f917436089fdf1aee7a32e",
"class_legendary_explorer_core_1_1_unreal_1_1_object_property.html#a4afbbd1a4c7d9dcffe9b661ccfce7f0a",
"class_legendary_explorer_core_1_1_unreal_1_1_str_property.html#ada00db32be5b91277806007555d486a3",
"class_legendary_explorer_core_1_1_unreal_1_1_unreal_flags.html#a900c716a72336be35d38710c98a2fac7",
"class_legendary_explorer_core_1_1_unreal_script_1_1_compiling_1_1_bytecode_writer.html#a0056af041c5fb09aaf92d9e11dbac41c",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_array_symbol_ref.html#a7eb63b46d87e58ba29eda23fa0b86fdf",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_delegate_comparison.html#a768be0dbe3c981d9c01e168dca34c9e8",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_expression.html#a1275e5e60431d6ffb00200b544a2d3fd",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_new_operator.html#a97576519f7c690d4293780a7a0074492",
"class_legendary_explorer_core_1_1_unreal_script_1_1_language_1_1_tree_1_1_string_ref_literal.html#a6f23c47ff52af5ad1950e326c8b6be1b",
"class_legendary_explorer_core_1_1_unreal_script_1_1_lexing_1_1_script_token.html#aa4d800ece51e166c5fdcda19e3770128",
"class_legendary_explorer_core_1_1_unreal_script_1_1_utilities_1_1_keywords.html#ad1d3b866921127bf18dcc403842d5cd6",
"dir_c603bb43c356135df7d76e972192bce2.html",
"interface_legendary_explorer_core_1_1_gammtek_1_1_i_o_1_1_i_data_stream.html#a418cb2b979d46a65caef4fe96e1624e2",
"interface_legendary_explorer_core_1_1_gammtek_1_1_paths_1_1_i_variable_file_path.html#affa9055613067c83c397097eb3b0210a",
"interface_legendary_explorer_core_1_1_unreal_script_1_1_analysis_1_1_visitors_1_1_i_a_s_t_visitor.html#a256c76306556f5c60d524b2f60d513dd",
"namespace_legendary_explorer_core_1_1_shaders.html",
"namespace_legendary_explorer_core_1_1_unreal.html#a4c53fff7749028651c58ce801265eaf0",
"namespace_legendary_explorer_core_1_1_unreal.html#aa10934b5ce04bd1f026597594c0ca819",
"namespace_legendary_explorer_core_1_1_unreal.html#af9c5db83f75c5d017e22211a3528fdc0",
"struct_legendary_explorer_core_1_1_sharp_d_x_1_1_color.html#a508f2d22cc8d18f48253a7bdce80bf70",
"struct_legendary_explorer_core_1_1_unreal_1_1_binary_converters_1_1_morph_target_1_1_morph_vertex.html#a688c90d88ee865d54c8fd70e779b77e2",
"struct_legendary_explorer_core_1_1_unreal_1_1_s_f_a_r_unpacker_1_1_d_l_c_entry.html#a7dff7362705ba62e1f4317d443ee466c"
];

var SYNCONMSG = 'click to disable panel synchronisation';
Expand Down
Loading

0 comments on commit f4817d3

Please sign in to comment.