Skip to content

Commit 48caa1e

Browse files
EmandMEmandM
committed
Fix SceneMap serialization
1 parent ab9bc6f commit 48caa1e

File tree

3 files changed

+197
-142
lines changed

3 files changed

+197
-142
lines changed

‎com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs‎

Lines changed: 1 addition & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -3079,123 +3079,6 @@ private void ProcessDeferredCreateObjectMessages()
30793079
DeferredObjectCreationList.Clear();
30803080
}
30813081

3082-
/// <summary>
3083-
/// The scene map type <see cref="SceneMap"/>.
3084-
/// </summary>
3085-
public enum MapTypes
3086-
{
3087-
/// <summary>
3088-
/// Denotes the server to client scene map type.
3089-
/// </summary>
3090-
ServerToClient,
3091-
/// <summary>
3092-
/// Denotes the client to server scene map type.
3093-
/// </summary>
3094-
ClientToServer
3095-
}
3096-
3097-
/// <summary>
3098-
/// Provides the status of a loaded scene
3099-
/// </summary>
3100-
public struct SceneMap : INetworkSerializable
3101-
{
3102-
/// <summary>
3103-
/// The scene mapping type <see cref="MapTypes"/>.
3104-
/// </summary>
3105-
public MapTypes MapType;
3106-
/// <summary>
3107-
/// The <see cref="UnityEngine.SceneManagement.Scene"/> struct of the scene mapped.
3108-
/// </summary>
3109-
public Scene Scene;
3110-
/// <summary>
3111-
/// When true, the scene is present.
3112-
/// </summary>
3113-
public bool ScenePresent;
3114-
/// <summary>
3115-
/// The name of the scene
3116-
/// </summary>
3117-
public string SceneName;
3118-
3119-
#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
3120-
/// <summary>
3121-
/// The scene's server handle (a.k.a network scene handle)
3122-
/// </summary>
3123-
/// <remarks>
3124-
/// This is deprecated in favor of ServerSceneHandle
3125-
/// </remarks>
3126-
[Obsolete("Int representation of a SceneHandle is deprecated, please use SceneHandle instead. (UnityUpgradable) -> ServerSceneHandle")]
3127-
#else
3128-
/// <summary>
3129-
/// The scene's server handle (a.k.a network scene handle)
3130-
/// </summary>
3131-
#endif
3132-
public int ServerHandle;
3133-
3134-
#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
3135-
/// <summary>
3136-
/// The mapped handled. This could be the ServerHandle or LocalHandle depending upon context (client or server).
3137-
/// </summary>
3138-
/// <remarks>
3139-
/// This is deprecated in favor of MappedLocalSceneHandle
3140-
/// </remarks>
3141-
[Obsolete("Int representation of a SceneHandle is deprecated, please use SceneHandle instead. (UnityUpgradable) -> MappedLocalSceneHandle")]
3142-
#else
3143-
/// <summary>
3144-
/// The mapped handled. This could be the ServerHandle or LocalHandle depending upon context (client or server).
3145-
/// </summary>
3146-
#endif
3147-
public int MappedLocalHandle;
3148-
3149-
#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
3150-
/// <summary>
3151-
/// The local handle of the scene.
3152-
/// </summary>
3153-
/// <remarks>
3154-
/// This is deprecated in favor of LocalSceneHandle
3155-
/// </remarks>
3156-
[Obsolete("Int representation of a SceneHandle is deprecated, please use SceneHandle instead. (UnityUpgradable) -> LocalSceneHandle")]
3157-
#else
3158-
/// <summary>
3159-
/// The local handle of the scene.
3160-
/// </summary>
3161-
#endif
3162-
public int LocalHandle;
3163-
3164-
#if SCENE_MANAGEMENT_SCENE_HANDLE_AVAILABLE
3165-
/// <summary>
3166-
/// The scene's server handle (a.k.a network scene handle)
3167-
/// </summary>
3168-
public SceneHandle ServerSceneHandle;
3169-
/// <summary>
3170-
/// The mapped handled. This could be the ServerSceneHandle or LocalSceneHandle depending upon context (client or server).
3171-
/// </summary>
3172-
public SceneHandle MappedLocalSceneHandle;
3173-
/// <summary>
3174-
/// The local handle of the scene.
3175-
/// </summary>
3176-
public SceneHandle LocalSceneHandle;
3177-
#endif
3178-
3179-
/// <inheritdoc cref="INetworkSerializable.NetworkSerialize{T}(BufferSerializer{T})"/>
3180-
public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter
3181-
{
3182-
serializer.SerializeValue(ref MapType);
3183-
serializer.SerializeValue(ref ScenePresent);
3184-
if (serializer.IsReader)
3185-
{
3186-
SceneName = "Not Present";
3187-
}
3188-
if (ScenePresent)
3189-
{
3190-
serializer.SerializeValue(ref SceneName);
3191-
serializer.SerializeValue(ref LocalHandle);
3192-
3193-
}
3194-
serializer.SerializeValue(ref ServerHandle);
3195-
serializer.SerializeValue(ref MappedLocalHandle);
3196-
}
3197-
}
3198-
31993082
/// <summary>
32003083
/// Returns the list of all scene mappings when scene management is enabled.
32013084
/// </summary>
@@ -3210,31 +3093,7 @@ public List<SceneMap> GetSceneMapping(MapTypes mapType)
32103093
{
32113094
var scene = ScenesLoaded[entry.Key];
32123095
var sceneIsPresent = scene.IsValid() && scene.isLoaded;
3213-
var sceneMap = new SceneMap()
3214-
{
3215-
MapType = mapType,
3216-
3217-
#pragma warning disable CS0618 // Type or member is obsolete
3218-
#if SCENE_MANAGEMENT_SCENE_HANDLE_MUST_USE_ULONG
3219-
ServerHandle = (int)entry.Key.GetRawData(),
3220-
MappedLocalHandle = (int)entry.Value.GetRawData(),
3221-
LocalHandle = (int)new NetworkSceneHandle(scene.handle).GetRawData(),
3222-
#else
3223-
ServerHandle = entry.Key.GetRawData(),
3224-
MappedLocalHandle = entry.Value.GetRawData(),
3225-
LocalHandle = new NetworkSceneHandle(scene.handle).GetRawData(),
3226-
#endif
3227-
#pragma warning restore CS0618 // Type or member is obsolete
3228-
3229-
#if SCENE_MANAGEMENT_SCENE_HANDLE_AVAILABLE
3230-
ServerSceneHandle = entry.Key,
3231-
MappedLocalSceneHandle = entry.Value,
3232-
LocalSceneHandle = scene.handle,
3233-
#endif
3234-
Scene = scene,
3235-
ScenePresent = sceneIsPresent,
3236-
SceneName = sceneIsPresent ? scene.name : "NotPresent",
3237-
};
3096+
var sceneMap = new SceneMap(mapType, scene, sceneIsPresent, entry.Key, entry.Value);
32383097
mapping.Add(sceneMap);
32393098
}
32403099

‎com.unity.netcode.gameobjects/Runtime/SceneManagement/SceneMap.cs‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
2+
using System;
3+
#endif
4+
using UnityEngine.SceneManagement;
5+
6+
namespace Unity.Netcode
7+
{
8+
/// <summary>
9+
/// The scene map type <see cref="SceneMap"/>.
10+
/// </summary>
11+
public enum MapTypes
12+
{
13+
/// <summary>
14+
/// Denotes the server to client scene map type.
15+
/// </summary>
16+
ServerToClient,
17+
/// <summary>
18+
/// Denotes the client to server scene map type.
19+
/// </summary>
20+
ClientToServer
21+
}
22+
23+
/// <summary>
24+
/// Provides the status of a loaded scene
25+
/// </summary>
26+
public struct SceneMap : INetworkSerializable
27+
{
28+
/// <summary>
29+
/// The scene mapping type <see cref="MapTypes"/>.
30+
/// </summary>
31+
public MapTypes MapType;
32+
/// <summary>
33+
/// The <see cref="UnityEngine.SceneManagement.Scene"/> struct of the scene mapped.
34+
/// </summary>
35+
public Scene Scene;
36+
/// <summary>
37+
/// When true, the scene is present.
38+
/// </summary>
39+
public bool ScenePresent;
40+
/// <summary>
41+
/// The name of the scene
42+
/// </summary>
43+
public string SceneName;
44+
45+
#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
46+
/// <summary>
47+
/// The scene's server handle (a.k.a network scene handle)
48+
/// </summary>
49+
/// <remarks>
50+
/// This is deprecated in favor of ServerSceneHandle
51+
/// </remarks>
52+
[Obsolete("Int representation of a SceneHandle is deprecated, please use SceneHandle instead. (UnityUpgradable) -> ServerSceneHandle")]
53+
#else
54+
/// <summary>
55+
/// The scene's server handle (a.k.a network scene handle)
56+
/// </summary>
57+
#endif
58+
public int ServerHandle;
59+
60+
#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
61+
/// <summary>
62+
/// The mapped handled. This could be the ServerHandle or LocalHandle depending upon context (client or server).
63+
/// </summary>
64+
/// <remarks>
65+
/// This is deprecated in favor of MappedLocalSceneHandle
66+
/// </remarks>
67+
[Obsolete("Int representation of a SceneHandle is deprecated, please use SceneHandle instead. (UnityUpgradable) -> MappedLocalSceneHandle")]
68+
#else
69+
/// <summary>
70+
/// The mapped handled. This could be the ServerHandle or LocalHandle depending upon context (client or server).
71+
/// </summary>
72+
#endif
73+
public int MappedLocalHandle;
74+
75+
#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
76+
/// <summary>
77+
/// The local handle of the scene.
78+
/// </summary>
79+
/// <remarks>
80+
/// This is deprecated in favor of LocalSceneHandle
81+
/// </remarks>
82+
[Obsolete("Int representation of a SceneHandle is deprecated, please use SceneHandle instead. (UnityUpgradable) -> LocalSceneHandle")]
83+
#else
84+
/// <summary>
85+
/// The local handle of the scene.
86+
/// </summary>
87+
#endif
88+
public int LocalHandle;
89+
90+
#if SCENE_MANAGEMENT_SCENE_HANDLE_AVAILABLE
91+
/// <summary>
92+
/// The scene's server handle (a.k.a network scene handle)
93+
/// </summary>
94+
public SceneHandle ServerSceneHandle;
95+
/// <summary>
96+
/// The mapped handled. This could be the ServerSceneHandle or LocalSceneHandle depending upon context (client or server).
97+
/// </summary>
98+
public SceneHandle MappedLocalSceneHandle;
99+
/// <summary>
100+
/// The local handle of the scene.
101+
/// </summary>
102+
public SceneHandle LocalSceneHandle;
103+
#endif
104+
105+
private NetworkSceneHandle m_ServerHandle;
106+
private NetworkSceneHandle m_MappedLocalHandle;
107+
private NetworkSceneHandle m_LocalHandle;
108+
109+
internal SceneMap(MapTypes mapType, Scene scene, bool isScenePresent, NetworkSceneHandle serverHandle, NetworkSceneHandle mappedLocalHandle)
110+
{
111+
MapType = mapType;
112+
Scene = scene;
113+
ScenePresent = isScenePresent;
114+
SceneName = isScenePresent ? scene.name : "Not Present";
115+
116+
m_ServerHandle = serverHandle;
117+
m_MappedLocalHandle = mappedLocalHandle;
118+
m_LocalHandle = new NetworkSceneHandle(scene.handle);
119+
120+
#if SCENE_MANAGEMENT_SCENE_HANDLE_AVAILABLE
121+
ServerSceneHandle = serverHandle;
122+
MappedLocalSceneHandle = mappedLocalHandle;
123+
LocalSceneHandle = scene.handle;
124+
#endif
125+
126+
127+
#pragma warning disable CS0618 // Type or member is obsolete
128+
#if SCENE_MANAGEMENT_SCENE_HANDLE_MUST_USE_ULONG
129+
ServerHandle = (int)Server.GetRawData();
130+
MappedLocalHandle = (int)MappedLocal.GetRawData();
131+
LocalHandle = (int)Local.GetRawData();
132+
#else
133+
ServerHandle = m_ServerHandle.GetRawData();
134+
MappedLocalHandle = m_MappedLocalHandle.GetRawData();
135+
LocalHandle = m_LocalHandle.GetRawData();
136+
#endif
137+
#pragma warning restore CS0618 // Type or member is obsolete
138+
}
139+
140+
/// <inheritdoc cref="INetworkSerializable.NetworkSerialize{T}(BufferSerializer{T})"/>
141+
public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter
142+
{
143+
serializer.SerializeValue(ref MapType);
144+
serializer.SerializeValue(ref ScenePresent);
145+
if (serializer.IsReader)
146+
{
147+
SceneName = "Not Present";
148+
}
149+
if (ScenePresent)
150+
{
151+
serializer.SerializeValue(ref SceneName);
152+
#pragma warning disable CS0618 // Type or member is obsolete
153+
serializer.SerializeValue(ref LocalHandle);
154+
}
155+
serializer.SerializeValue(ref ServerHandle);
156+
serializer.SerializeValue(ref MappedLocalHandle);
157+
#pragma warning restore CS0618 // Type or member is obsolete
158+
159+
160+
#if SCENE_MANAGEMENT_SCENE_HANDLE_AVAILABLE
161+
// Ensure the SceneHandles are valid to be serialized
162+
if (serializer.IsWriter)
163+
{
164+
if (m_LocalHandle.IsEmpty() && LocalSceneHandle != SceneHandle.None)
165+
{
166+
m_LocalHandle = LocalSceneHandle;
167+
}
168+
if (m_ServerHandle.IsEmpty() && ServerSceneHandle != SceneHandle.None)
169+
{
170+
m_ServerHandle = ServerSceneHandle;
171+
}
172+
if (m_MappedLocalHandle.IsEmpty() && MappedLocalSceneHandle != SceneHandle.None)
173+
{
174+
m_MappedLocalHandle = MappedLocalSceneHandle;
175+
}
176+
}
177+
178+
// Serialize the INetworkSerializable representations
179+
serializer.SerializeValue(ref m_LocalHandle);
180+
serializer.SerializeValue(ref m_ServerHandle);
181+
serializer.SerializeValue(ref m_MappedLocalHandle);
182+
183+
// If we're reading, convert back into the raw SceneHandle
184+
if (serializer.IsReader)
185+
{
186+
ServerSceneHandle = m_ServerHandle;
187+
ServerSceneHandle = m_LocalHandle;
188+
ServerSceneHandle = m_MappedLocalHandle;
189+
}
190+
#endif
191+
}
192+
}
193+
}

‎com.unity.netcode.gameobjects/Runtime/SceneManagement/SceneMap.cs.meta‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)