Class NetworkCustomPropertiesProvider
Provides the NetworkPropertiesTable neccessary for NetworkPropertySync<K, V> components.
Inheritance
NetworkCustomPropertiesProvider
Inherited Members
Namespace: Evergine.Networking.Components
Assembly: Evergine.Networking.dll
Syntax
public abstract class NetworkCustomPropertiesProvider : Component, IDependencyObject, IDisposable
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()
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 all is OK. |
Overrides
OnDetach()
Invoked when the object is detached.
Declaration
protected override void OnDetach()
Overrides
UpdateCustomPropertiesReference()
Updates the custom properties reference.
Declaration
protected void UpdateCustomPropertiesReference()
Events
CustomPropertiesRefreshed
Occurs when the CustomProperties property is changed. Previous properties table is received as parameter.
Declaration
public event EventHandler<NetworkPropertiesTable> CustomPropertiesRefreshed
Event Type
Type | Description |
---|---|
EventHandler<NetworkPropertiesTable> |