Skip to content

Commit 2418995

Browse files
Documentation update 564
1 parent 3bfebf9 commit 2418995

26 files changed

Lines changed: 2414 additions & 82 deletions

‎_simulator_2_serialization_8h.html‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ <h3>Contents</h3>
5656
<ul>
5757
<li><a href="#namespaces">Namespaces</a></li>
5858
<li><a href="#nested-classes">Classes</a></li>
59+
<li><a href="#define-members">Defines</a></li>
5960
</ul>
6061
</li>
6162
</ul>
@@ -70,6 +71,10 @@ <h2><a href="#namespaces">Namespaces</a></h2>
7071
<section id="nested-classes">
7172
<h2><a href="#nested-classes">Classes</a></h2>
7273
<dl class="m-doc">
74+
<dt>
75+
class <a href="class_simulator_1_1_i_serializer_database.html" class="m-doc">Simulator::ISerializerDatabase</a>
76+
</dt>
77+
<dd><span></span></dd>
7378
<dt>
7479
class <a href="class_simulator_1_1_i_serializer_stream.html" class="m-doc">Simulator::ISerializerStream</a>
7580
</dt>
@@ -82,6 +87,10 @@ <h2><a href="#nested-classes">Classes</a></h2>
8287
class <a href="class_simulator_1_1_i_serializer_write_stream.html" class="m-doc">Simulator::ISerializerWriteStream</a>
8388
</dt>
8489
<dd><span></span></dd>
90+
<dt>
91+
class <a href="class_simulator_1_1_i_c_o_m_serializer.html" class="m-doc">Simulator::ICOMSerializer</a>
92+
</dt>
93+
<dd><span></span></dd>
8594
<dt>
8695
struct <a href="struct_simulator_1_1_attribute.html" class="m-doc">Simulator::Attribute</a>
8796
</dt>
@@ -98,6 +107,75 @@ <h2><a href="#nested-classes">Classes</a></h2>
98107
class <a href="class_simulator_1_1_xml_serializer.html" class="m-doc">Simulator::XmlSerializer</a>
99108
</dt>
100109
<dd><span></span></dd>
110+
<dt>
111+
class <a href="class_simulator_1_1_c_o_m_serializer.html" class="m-doc">Simulator::COMSerializer</a>
112+
</dt>
113+
<dd><span></span></dd>
114+
<dt>
115+
struct <a href="struct_simulator_1_1_c_o_m_serializer_1_1_i_d_info.html" class="m-doc">Simulator::COMSerializer::IDInfo</a>
116+
</dt>
117+
<dd><span></span></dd>
118+
<dt>
119+
struct <a href="struct_simulator_1_1_c_o_m_serializer_1_1_class_info.html" class="m-doc">Simulator::COMSerializer::ClassInfo</a>
120+
</dt>
121+
<dd><span></span></dd>
122+
<dt>
123+
class <a href="class_simulator_1_1_serializer_database.html" class="m-doc">Simulator::SerializerDatabase</a>
124+
</dt>
125+
<dd><span></span></dd>
126+
<dt>
127+
class <a href="class_simulator_1_1_serializer_read_stream.html" class="m-doc">Simulator::SerializerReadStream</a>
128+
</dt>
129+
<dd><span></span></dd>
130+
<dt>
131+
class <a href="class_simulator_1_1_serializer_write_stream.html" class="m-doc">Simulator::SerializerWriteStream</a>
132+
</dt>
133+
<dd><span></span></dd>
134+
<dt>
135+
class <a href="class_simulator_1_1_serializer_read_stream_private.html" class="m-doc">Simulator::SerializerReadStreamPrivate</a>
136+
</dt>
137+
<dd><span></span></dd>
138+
<dt>
139+
class <a href="class_simulator_1_1_serializer_write_stream_private.html" class="m-doc">Simulator::SerializerWriteStreamPrivate</a>
140+
</dt>
141+
<dd><span></span></dd>
142+
</dl>
143+
</section>
144+
<section id="define-members">
145+
<h2><a href="#define-members">Defines</a></h2>
146+
<dl class="m-doc">
147+
<dt id="a5d7dd00d754bee2e70a17b7f82814745">
148+
<span class="m-doc-wrap-bumper">#define <a href="#a5d7dd00d754bee2e70a17b7f82814745" class="m-doc-self">ISerializerDatabasePtr</a></span>
149+
</dt>
150+
<dd><span></span></dd>
151+
<dt id="a5673ab3991c078bd4de1c642afffe428">
152+
<span class="m-doc-wrap-bumper">#define <a href="#a5673ab3991c078bd4de1c642afffe428" class="m-doc-self">ISerializerReadStreamPtr</a></span>
153+
</dt>
154+
<dd><span></span></dd>
155+
<dt id="a45a3bad4bec3f3967ed6b617475bfbf2">
156+
<span class="m-doc-wrap-bumper">#define <a href="#a45a3bad4bec3f3967ed6b617475bfbf2" class="m-doc-self">ISerializerWriteStreamPtr</a></span>
157+
</dt>
158+
<dd><span></span></dd>
159+
<dt id="a1b7f0f852744b1ce694a0e5c41d42b4c">
160+
<span class="m-doc-wrap-bumper">#define <a href="#a1b7f0f852744b1ce694a0e5c41d42b4c" class="m-doc-self">ICOMSerializerPtr</a></span>
161+
</dt>
162+
<dd><span></span></dd>
163+
<dt id="aed0719da48322e29c33a4e859943f540">
164+
<span class="m-doc-wrap-bumper">#define <a href="#aed0719da48322e29c33a4e859943f540" class="m-doc-self">SerializerDatabasePtr</a></span>
165+
</dt>
166+
<dd><span></span></dd>
167+
<dt id="aa098b73a285da40994cf774ab90f3471">
168+
<span class="m-doc-wrap-bumper">#define <a href="#aa098b73a285da40994cf774ab90f3471" class="m-doc-self">SerializerReadStreamPtr</a></span>
169+
</dt>
170+
<dd><span></span></dd>
171+
<dt id="ae475ce2520cafe339738b3f89747c80d">
172+
<span class="m-doc-wrap-bumper">#define <a href="#ae475ce2520cafe339738b3f89747c80d" class="m-doc-self">SerializerWriteStreamPtr</a></span>
173+
</dt>
174+
<dd><span></span></dd>
175+
<dt id="a6345470485cb57a580820f649c8c80cb">
176+
<span class="m-doc-wrap-bumper">#define <a href="#a6345470485cb57a580820f649c8c80cb" class="m-doc-self">COMSerializerPtr</a></span>
177+
</dt>
178+
<dd><span></span></dd>
101179
</dl>
102180
</section>
103181
</div>

‎annotated.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -991,6 +991,13 @@ <h1>Classes</h1>
991991
<li>class <a href="class_simulator_1_1c_obstacle.html" class="m-doc">cObstacle</a> <span class="m-doc"><span></span></span></li>
992992
<li>class <a href="class_simulator_1_1c_obstacle_manager.html" class="m-doc">cObstacleManager</a> <span class="m-doc"><span></span></span></li>
993993
<li>class <a href="class_simulator_1_1_combatant_killed_message.html" class="m-doc">CombatantKilledMessage</a> <span class="m-doc">Called when a <a href="class_simulator_1_1c_combatant.html" class="m-doc">cCombatant</a> is killed.</span></li>
994+
<li class="m-doc-collapsible collapsed">
995+
<a href="#" onclick="return toggle(this)">class</a> <a href="class_simulator_1_1_c_o_m_serializer.html" class="m-doc">COMSerializer</a> <span class="m-doc"><span></span></span>
996+
<ul class="m-doc">
997+
<li>struct <a href="struct_simulator_1_1_c_o_m_serializer_1_1_class_info.html" class="m-doc">ClassInfo</a> <span class="m-doc"><span></span></span></li>
998+
<li>struct <a href="struct_simulator_1_1_c_o_m_serializer_1_1_i_d_info.html" class="m-doc">IDInfo</a> <span class="m-doc"><span></span></span></li>
999+
</ul>
1000+
</li>
9941001
<li>class <a href="class_simulator_1_1_conversation_resource.html" class="m-doc">ConversationResource</a> <span class="m-doc"><span></span></span></li>
9951002
<li>class <a href="class_simulator_1_1c_ornament.html" class="m-doc">cOrnament</a> <span class="m-doc">Used, among other things, for adventure objects (except pickable ones)</span></li>
9961003
<li>struct <a href="struct_simulator_1_1c_ornament_data.html" class="m-doc">cOrnamentData</a> <span class="m-doc"><span></span></span></li>
@@ -1130,10 +1137,12 @@ <h1>Classes</h1>
11301137
<li>class <a href="class_simulator_1_1_game_noun_status_changed_message.html" class="m-doc">GameNounStatusChangedMessage</a> <span class="m-doc"><span></span></span></li>
11311138
<li>class <a href="class_simulator_1_1_goal_card.html" class="m-doc">GoalCard</a> <span class="m-doc"><span></span></span></li>
11321139
<li>class <a href="class_simulator_1_1_i_city_music.html" class="m-doc">ICityMusic</a> <span class="m-doc"><span></span></span></li>
1140+
<li>class <a href="class_simulator_1_1_i_c_o_m_serializer.html" class="m-doc">ICOMSerializer</a> <span class="m-doc"><span></span></span></li>
11331141
<li>class <a href="class_simulator_1_1_i_game_data_view.html" class="m-doc">IGameDataView</a> <span class="m-doc"><span></span></span></li>
11341142
<li>class <a href="class_simulator_1_1_i_gonzago_subsystem.html" class="m-doc">IGonzagoSubsystem</a> <span class="m-doc"><span></span></span></li>
11351143
<li>class <a href="class_simulator_1_1_i_message_parameters.html" class="m-doc">IMessageParameters</a> <span class="m-doc"><span></span></span></li>
11361144
<li>class <a href="class_simulator_1_1_i_scenario_edit_history_entry.html" class="m-doc">IScenarioEditHistoryEntry</a> <span class="m-doc">A generic entry of undo/redo history in the adventure editor.</span></li>
1145+
<li>class <a href="class_simulator_1_1_i_serializer_database.html" class="m-doc">ISerializerDatabase</a> <span class="m-doc"><span></span></span></li>
11371146
<li>class <a href="class_simulator_1_1_i_serializer_read_stream.html" class="m-doc">ISerializerReadStream</a> <span class="m-doc"><span></span></span></li>
11381147
<li>class <a href="class_simulator_1_1_i_serializer_stream.html" class="m-doc">ISerializerStream</a> <span class="m-doc"><span></span></span></li>
11391148
<li>class <a href="class_simulator_1_1_i_serializer_write_stream.html" class="m-doc">ISerializerWriteStream</a> <span class="m-doc"><span></span></span></li>
@@ -1151,6 +1160,11 @@ <h1>Classes</h1>
11511160
<li>class <a href="class_simulator_1_1_scenario_creature_healed_message.html" class="m-doc">ScenarioCreatureHealedMessage</a> <span class="m-doc">Called when a creature is healed (either by natural heal rate, or using a medkit) in Scenario mode.</span></li>
11521161
<li>class <a href="class_simulator_1_1_scenario_energy_consumed_message.html" class="m-doc">ScenarioEnergyConsumedMessage</a> <span class="m-doc">Called when the player captain consumes energy in Scenario mode.</span></li>
11531162
<li>class <a href="class_simulator_1_1_scheduled_task_listener.html" class="m-doc">ScheduledTaskListener</a> <span class="m-doc">A message listener that, listening to Update messages, executes the given task after a certain time has passed and (optionally) repetaing it periodically.</span></li>
1163+
<li>class <a href="class_simulator_1_1_serializer_database.html" class="m-doc">SerializerDatabase</a> <span class="m-doc"><span></span></span></li>
1164+
<li>class <a href="class_simulator_1_1_serializer_read_stream.html" class="m-doc">SerializerReadStream</a> <span class="m-doc"><span></span></span></li>
1165+
<li>class <a href="class_simulator_1_1_serializer_read_stream_private.html" class="m-doc">SerializerReadStreamPrivate</a> <span class="m-doc"><span></span></span></li>
1166+
<li>class <a href="class_simulator_1_1_serializer_write_stream.html" class="m-doc">SerializerWriteStream</a> <span class="m-doc"><span></span></span></li>
1167+
<li>class <a href="class_simulator_1_1_serializer_write_stream_private.html" class="m-doc">SerializerWriteStreamPrivate</a> <span class="m-doc"><span></span></span></li>
11541168
<li>class <a href="class_simulator_1_1_space_player_data.html" class="m-doc">SpacePlayerData</a> <span class="m-doc"><span></span></span></li>
11551169
<li>class <a href="class_simulator_1_1_space_rare_found_message.html" class="m-doc">SpaceRareFoundMessage</a> <span class="m-doc">Sent when a rare item is found (even if it had already been found before) in Space Stage.</span></li>
11561170
<li>class <a href="class_simulator_1_1_sporepedia.html" class="m-doc">Sporepedia</a> <span class="m-doc"><span></span></span></li>

‎class_default_ref_counted.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,10 +263,18 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
263263
class <a href="class_palettes_1_1_standard_item_u_i.html" class="m-doc">Palettes::StandardItemUI</a>
264264
</dt>
265265
<dd><span></span></dd>
266+
<dt>
267+
class <a href="class_simulator_1_1_c_o_m_serializer.html" class="m-doc">Simulator::COMSerializer</a>
268+
</dt>
269+
<dd><span></span></dd>
266270
<dt>
267271
class <a href="class_simulator_1_1_cinematic_vignette_action_data.html" class="m-doc">Simulator::CinematicVignetteActionData</a>
268272
</dt>
269273
<dd><span></span></dd>
274+
<dt>
275+
class <a href="class_simulator_1_1_serializer_database.html" class="m-doc">Simulator::SerializerDatabase</a>
276+
</dt>
277+
<dd><span></span></dd>
270278
<dt>
271279
class <a href="class_simulator_1_1c_behavior_base.html" class="m-doc">Simulator::cBehaviorBase</a>
272280
</dt>

0 commit comments

Comments
 (0)