Class NetworkCustomPropertiesProvider

Provides the NetworkPropertiesTable necessary for NetworkPropertySync<K, V> components.

Inheritance
object
IdentifiableObject
DependencyObject
AttachableObject
PrefabInstanceObject
Component
NetworkCustomPropertiesProvider
NetworkPlayerProvider
NetworkRoomProvider
Implements
Inherited Members
Namespace: Evergine.Networking.Components
Assembly: Evergine.Networking.dll
Syntax
public abstract class NetworkCustomPropertiesProvider : Component, IDependencyObject

Properties

CustomProperties

Gets the NetworkPropertiesTable.

Declaration
public NetworkPropertiesTable CustomProperties { get; }
Property Value
Type Description
NetworkPropertiesTable

Methods

CheckMultipleProvidersOfType<T>()

Checks if there is more than one provider of type T in the Owner entity and raises an exception in that case.

Declaration
protected void CheckMultipleProvidersOfType<T>() where T : NetworkCustomPropertiesProvider
Type Parameters
Name Description
T

The NetworkCustomPropertiesProvider type to be checked.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

GetCustomProperties(MatchmakingClientService)

Gets the NetworkPropertiesTable instance.

Declaration
protected abstract NetworkPropertiesTable GetCustomProperties(MatchmakingClientService matchmakingClientService)
Parameters
Type Name Description
MatchmakingClientService matchmakingClientService

The MatchmakingClientService reference.
Returns
Type Description
NetworkPropertiesTable

The NetworkPropertiesTable instance.

OnAttached()

Invoked when the object is attached to the system.

Declaration
protected override bool OnAttached()
Returns
Type Description
bool

True if everything is OK.
Overrides

OnDetach()

Invoked when the object is detached.

Declaration
protected override void OnDetach()
Overrides

UpdateCustomPropertiesReference()

Updates the reference to the custom properties.

Declaration
protected void UpdateCustomPropertiesReference()

Events

CustomPropertiesRefreshed

Occurs when the CustomProperties property is changed. The previous properties table is received as a parameter.

Declaration
public event EventHandler<NetworkPropertiesTable> CustomPropertiesRefreshed
Event Type
Type Description
EventHandler<NetworkPropertiesTable>

Implements

Extension Methods