Class KCCPlayer

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Movement subsystem for KCC-based prediction. Implements IPredictableController so that CharacterPredictionController drives replication and reconciliation through a single unified pipeline.

public class KCCPlayer : NetworkBehaviour, IPredictableController

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

NetworkBehaviour

KCCPlayer

Implements

IPredictableController

Inherited Members

NetworkBehaviour.IsSpawned

NetworkBehaviour.ComponentIndex

NetworkBehaviour.NetworkObject

NetworkBehaviour.MAXIMUM_NETWORKBEHAVIOURS

NetworkBehaviour.UNSET_NETWORKBEHAVIOUR_ID

NetworkBehaviour.ToString()

NetworkBehaviour.Reset()

NetworkBehaviour.OnValidate()

NetworkBehaviour.IsBehaviourReconciling

NetworkBehaviour.ClearReplicateCache()

NetworkBehaviour.CreateReconcile()

NetworkBehaviour.Reconcile_Reader<T>(PooledReader, ref T)

NetworkBehaviour.Reconcile_Reader_Local<T>(uint, PooledReader)

NetworkBehaviour.OnStartServerCalled

NetworkBehaviour.OnStartClientCalled

NetworkBehaviour.WritePayload(NetworkConnection, Writer)

NetworkBehaviour.ReadPayload(NetworkConnection, Reader)

NetworkBehaviour.OnStartNetwork()

NetworkBehaviour.OnStopNetwork()

NetworkBehaviour.OnStartServer()

NetworkBehaviour.OnStopServer()

NetworkBehaviour.OnOwnershipServer(NetworkConnection)

NetworkBehaviour.OnSpawnServer(NetworkConnection)

NetworkBehaviour.OnDespawnServer(NetworkConnection)

NetworkBehaviour.OnStopClient()

NetworkBehaviour.ClearBuffedRpcs()

NetworkBehaviour.ExcludeOwnerFromUnbufferedObserversRpcs

NetworkBehaviour.IsClientOnly

NetworkBehaviour.IsServerOnly

NetworkBehaviour.IsHost

NetworkBehaviour.IsClient

NetworkBehaviour.IsServer

NetworkBehaviour.IsDeinitializing

NetworkBehaviour.NetworkManager

NetworkBehaviour.ServerManager

NetworkBehaviour.ClientManager

NetworkBehaviour.ObserverManager

NetworkBehaviour.TransportManager

NetworkBehaviour.TimeManager

NetworkBehaviour.SceneManager

NetworkBehaviour.PredictionManager

NetworkBehaviour.RollbackManager

NetworkBehaviour.NetworkObserver

NetworkBehaviour.IsClientInitialized

NetworkBehaviour.IsClientStarted

NetworkBehaviour.IsClientOnlyInitialized

NetworkBehaviour.IsClientOnlyStarted

NetworkBehaviour.IsServerInitialized

NetworkBehaviour.IsServerStarted

NetworkBehaviour.IsServerOnlyInitialized

NetworkBehaviour.IsServerOnlyStarted

NetworkBehaviour.IsHostInitialized

NetworkBehaviour.IsHostStarted

NetworkBehaviour.IsOffline

NetworkBehaviour.IsNetworked

NetworkBehaviour.GetIsNetworked()

NetworkBehaviour.SetIsNetworked(bool)

NetworkBehaviour.IsManagerReconciling

NetworkBehaviour.Observers

NetworkBehaviour.IsOwner

NetworkBehaviour.IsController

NetworkBehaviour.HasAuthority

NetworkBehaviour.Owner

NetworkBehaviour.OwnerId

NetworkBehaviour.ObjectId

NetworkBehaviour.LocalConnection

NetworkBehaviour.OwnerMatches(NetworkConnection)

NetworkBehaviour.Despawn(GameObject, DespawnType?)

NetworkBehaviour.Despawn(NetworkObject, DespawnType?)

NetworkBehaviour.Despawn(DespawnType?)

NetworkBehaviour.Spawn(GameObject, NetworkConnection, Scene)

NetworkBehaviour.Spawn(NetworkObject, NetworkConnection, Scene)

NetworkBehaviour.RemoveOwnership()

NetworkBehaviour.GiveOwnership(NetworkConnection)

NetworkBehaviour.GiveOwnership(NetworkConnection, bool)

NetworkBehaviour.RegisterInvokeOnInstance<T>(Action<Component>)

NetworkBehaviour.UnregisterInvokeOnInstance<T>(Action<Component>)

NetworkBehaviour.GetInstance<T>()

NetworkBehaviour.RegisterInstance<T>(T, bool)

NetworkBehaviour.TryRegisterInstance<T>(T)

NetworkBehaviour.UnregisterInstance<T>()

NetworkBehaviour.CanLog(LoggingType)

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

CharacterCamera

The camera controller for third-person view.

public KCCCamera CharacterCamera

Field Value

KCCCamera

CharacterController

The character controller for movement and state logic.

public KCCController CharacterController

Field Value

KCCController

Motor

The motor for kinematic character movement.

public KinematicCharacterMotor Motor

Field Value

KinematicCharacterMotor

ObserverPredictionWindowTicks

How many ticks past the last real input an observing client may keep re-simulating that input before it stops carrying it forward.

public uint ObserverPredictionWindowTicks

Field Value

uint

Remarks

Currently inert. The block that reads this only runs for a non-owner, non-server peer, and a client is never handed another character's replicate input while state forwarding is off — Replicate_NonAuthoritative returns before invoking the replicate body, and forwarding is 0 on all 39 networked objects in this project. Observers see other players through NetworkTransform instead. So changing this value has no effect today; it becomes live only if forwarding is enabled.

The value would then want to be near the client's buffered-input depth — about 6 ticks at 200ms and tick rate 30 — because a window of 1 lets an observed character stall for a tick whenever an input is late. It is a plain public field serialized on all nine character prefabs, so raising it means editing those prefabs, not this default.

OnHandleCharacterInput

Delegate for handling character input (owner only). Returns KCCInputReplicateData which is converted to the unified CharacterReplicateData by PopulateInput(ref CharacterReplicateData).

public Func<KCCInputReplicateData> OnHandleCharacterInput

Field Value

Func<KCCInputReplicateData>

Properties

Order

Execution order for this controller during the prediction tick. Lower values run first. Movement should run before abilities so that camera/position state is fresh for ability aiming.

public int Order { get; }

Property Value

int

Methods

OnCreateReconcile(ref CharacterReconcileData)

Writes this controller's authoritative state into the reconcile data (server only). Called once per tick after OnReplicate(ref CharacterReplicateData, ReplicateState, Channel).

public void OnCreateReconcile(ref CharacterReconcileData reconcileData)

Parameters

reconcileData CharacterReconcileData

OnOwnershipClient(NetworkConnection)

Called when the local client gains ownership. Binds the main camera for the case where ownership arrives after OnStartClient.

public override void OnOwnershipClient(NetworkConnection prevOwner)

Parameters

prevOwner NetworkConnection

OnReconcile(CharacterReconcileData, Channel)

Restores this controller's state from the server's authoritative reconcile data.

public void OnReconcile(CharacterReconcileData rd, Channel channel)

Parameters

rd CharacterReconcileData

channel Channel

Remarks

The owner always reconciles — this is the correction that repairs its own predicted movement.

A non-owner only reconciles a forwarded object, because that is the only mode in which the reconcile is what positions this character on an observing client. With forwarding off, position arrives through NetworkTransform and applying a motor state on top would give the transform two writers — the same failure ApplyObserverTransportMode() exists to prevent in the other direction. See ObserverSyncMode.

OnReplicate(ref CharacterReplicateData, ReplicateState, Channel)

Executes this controller's simulation for the current tick. May modify input for observer prediction.

public void OnReplicate(ref CharacterReplicateData input, ReplicateState state, Channel channel)

Parameters

input CharacterReplicateData

state ReplicateState

channel Channel

OnStartClient()

Called when the client starts. Sets up camera following and ignored colliders for the owner.

public override void OnStartClient()

PopulateInput(ref CharacterReplicateData)

Populates this controller's portion of the unified input data (owner only). Called once per tick before OnReplicate(ref CharacterReplicateData, ReplicateState, Channel).

public void PopulateInput(ref CharacterReplicateData input)

Parameters

input CharacterReplicateData

ResetState(bool)

Resets observer prediction state on network reset (e.g., reconnect or scene transfer).

public override void ResetState(bool asServer)

Parameters

asServer bool

True if called on the server.

SetOrientationMethod(OrientationMethod)

Sets the orientation method for the character controller.

public void SetOrientationMethod(OrientationMethod method)

Parameters

method OrientationMethod

Orientation method to set.

SetPlatform(KCCPlatform)

Sets the current platform and snapshots its position for velocity calculation.

public void SetPlatform(KCCPlatform platform)

Parameters

platform KCCPlatform

The platform to set, or null to clear.

UpdateCamera(float, Vector3)

Updates the camera with scroll and look input, using the current tick delta.

public void UpdateCamera(float scrollInput, Vector3 lookInputVector)

Parameters

scrollInput float

Scroll/zoom input.

lookInputVector Vector3

Look input vector.