NetworkPositionRotation Class Reference

Replicates a Unity Transform's position and rotation states from the NetworkObject.StateAuthority to all other peers. Add this component to a GameObject to sync the position and rotation. A NetworkObject is required on this GameObject or a parent of this GameObject. More...

Inherits NetworkPosition.

Inherited by NetworkTransform.

Public Member Functions
Quaternion	ReadRotation ()
	Reads from the rotation field on this object's networked data with the default Runner position read accuracy.
Quaternion	ReadRotation (int *ptr)
	Reads from a rotation field on the networked data pointed by ptr with the default Runner position read accuracy.
void	WriteRotation (Quaternion rotation)
	Writes to a rotation field on this object's networked data with the default Runner position write accuracy.
void	WriteRotation (Quaternion rotation, int *ptr)
	Writes to a rotation field on the networked data pointed by ptr with the default Runner position write accuracy.
Public Member Functions inherited from NetworkPosition
virtual void	AfterAllTicks (bool resimulation, int tickCount)
	Implements IAfterAllTicks. If overriding this method in an inheritor, the base method should be called. To extend the functionality of copying data from the engine to the networked buffer, override and extend CopyFromEngineToBuffer instead.
void	AfterHostMigration ()
	Invoked after the Host Migration happens in order to setup non-networked data on NetworkBehaviors.
virtual void	BeforeAllTicks (bool resimulation, int tickCount)
	Implements IBeforeAllTicks. If overriding this method in an inheritor, the base method should be called. To extend the functionality of copying data from the networked buffer to the engine, override and extend CopyFromBufferToEngine instead.
virtual void	BeforeCopyPreviousState ()
	Implements IBeforeCopyPreviousState. If overriding this method in an inheritor, the base method should be called.
virtual void	BeforeUpdate ()
	Implements IBeforeUpdate. If overriding this method in an inheritor, the base method should be called.
override void	CopyBackingFieldsToState (bool firstTime)
	Implements NetworkBehaviour.CopyBackingFieldsToState. If overriding this method in an inheritor, the base method should be called.
Vector3	ReadPosition ()
	Reads from the position field on this object's networked data with the default Runner position read accuracy.
Vector3	ReadPosition (int *ptr)
	Reads from a position field on the networked data pointed by ptr with the default Runner position read accuracy.
virtual void	RemotePrefabCreated ()
	Implements IRemotePrefabCreated. If overriding this method in an inheritor, the base method should be called.
override void	Spawned ()
	Overrides NetworkBehaviour.Spawned. If overriding this method in an inheritor, the base method should be called.
void	WritePosition (Vector3 position)
	Writes to a position field on this object's networked data with the default Runner position write accuracy.
void	WritePosition (Vector3 position, int *ptr)
	Writes to a position field on the networked data pointed by ptr with the default Runner position write accuracy.
void	BeforeUpdate ()
	Called at the start of the Fusion Update loop, before the Fusion simulation loop.
void	BeforeAllTicks (bool resimulation, int tickCount)
	Called before the resimulation loop (when applicable), and also before the forward simulation loop. Only called on Updates where resimulation or forward ticks are processed.
void	AfterAllTicks (bool resimulation, int tickCount)
	Called after the resimulation loop (when applicable), and also after the forward simulation loop. Only called on Updates where resimulation or forward ticks are processed.
void	AfterHostMigration ()
	Invoked after the Host Migration happens in order to setup non-networked data on NetworkBehaviors.
Public Member Functions inherited from NetworkBehaviour
virtual void	CopyBackingFieldsToState (bool firstTime)
void	CopyStateFrom (NetworkBehaviour source)
	Copies entire state of passed in source NetworkBehaviour
virtual void	CopyStateToBackingFields ()
virtual void	Despawned (NetworkRunner runner, bool hasState)
	Called before the network object is despawned.
override void	FixedUpdateNetwork ()
	Fusion FixedUpdate timing callback.
T?	GetInput< T > ()
bool	GetInput< T > (out T input)
	Returns true if it a valid INetworkInput can be found for the current simulation tick (Typically this is used in FixedUpdateNetwork).
bool	GetInterpolationData (out InterpolationData data, bool? predicted=null)
	Get 'To' and 'From' states, and the Alpha (t) values needed for lerping.
bool	GetInterpolationData (out InterpolationData data, out bool predicted)
	Get 'To' and 'From' states, and the Alpha (t) values needed for interpolation.
RawInterpolator	GetInterpolator (string propertyName)
	Get a raw interpolator for a networked property. The returned RawInterpolator provides a way to calculate the "between-ticks" value of the named [Networked] property.
Interpolator< T >	GetInterpolator< T > (string propertyName)
	Get an interpolator for a networked property. The returned Interpolator provides a way to calculate the "between-ticks" value of the named [Networked] property with the specified type T. The value is a linear interpolation between the "from" and the "to" ticks and is available via the Value property on the Interpolator.
int	GetLocalAuthorityMask ()
	Gets a bitmask of AuthorityMasks flags, representing the current local authority over this NetworkObject.
delegate int[]	InterestGroupsCallback (Type type, NetworkBehaviour behaviour)
virtual bool	IsInterpolationDataPredicted ()
	If the behaviour data should be interpolated between latest predicted states or between snapshots.
NetworkBehaviourCallbackReference	OnChangeAdd< T > (int wordOffset, int wordCount, ChangedDelegate< T > callback, OnChangedTargets targets=OnChangedTargets.All)
	Adds a OnChange callback to this behaviour which is bound to a specific word offset and word count.
NetworkBehaviourCallbackReference	OnChangeAdd< T > (string propertyName, ChangedDelegate< T > callback, OnChangedTargets targetses=OnChangedTargets.All)
	Adds a OnChange callback to this behaviour which is bound to a specific weaved property.
void	OnChangeClearAll ()
	Clear all dynamic OnChange callbacks from this behaviour.
bool	OnChangeRemove (NetworkBehaviourCallbackReference reference)
	Removes a specific OnChange callback from this behaviour.
virtual void	Spawned ()
	Post spawn callback.
Public Member Functions inherited from SimulationBehaviour
virtual void	FixedUpdateNetwork ()
	Fusion FixedUpdate timing callback.
virtual void	Render ()
	Post simulation frame rendering callback. Runs after all simulations have finished. Use in place of Unity's Update when Fusion is handling Physics.
Public Member Functions inherited from Behaviour
T	AddBehaviour< T > ()
	Wrapper for Unity's GameObject.AddComponent()
T	GetBehaviour< T > ()
	Wrapper for Unity's GameObject.GetComponentInChildren()
bool	TryGetBehaviour< T > (out T behaviour)
	Wrapper for Unity's GameObject.TryGetComponent()

Static Public Member Functions
static Quaternion	ReadRotation (int *ptr, ReadAccuracy readAccuracy)
	Reads from a rotation field on the networked data pointed by ptr with the defined readAccuracy .
static void	WriteRotation (Quaternion rotation, int *ptr, WriteAccuracy writeAccuracy)
	Writes to a rotation field on the networked data pointed by ptr with the defined writeAccuracy .
Static Public Member Functions inherited from NetworkPosition
static Vector3	ReadPosition (int *ptr, ReadAccuracy readAccuracy)
	Reads from a position field on the networked data pointed by ptr with the defined readAccuracy .
static void	WritePosition (Vector3 position, int *ptr, WriteAccuracy writeAccuracy)
	Writes to a position field on the networked data pointed by ptr with the defined writeAccuracy .
Static Public Member Functions inherited from NetworkBehaviour
static NetworkBehaviourUtils.DictionaryInitializer< K, V >	MakeInitializer< K, V > (Dictionary< K, V > dictionary)
	This is a special method that is meant to be used only for [Networked] properties inline initialization.
static NetworkBehaviourUtils.ArrayInitializer< T >	MakeInitializer< T > (T[] array)
	This is a special method that is meant to be used only for [Networked] properties inline initialization.
static T *	MakePtr< T > ()
static T *	MakePtr< T > (T defaultValue)
static ref T	MakeRef< T > ()
static ref T	MakeRef< T > (T defaultValue)
static int	NetworkDeserialize (NetworkRunner runner, byte *data, ref NetworkBehaviour result)
static int	NetworkSerialize (NetworkRunner runner, NetworkBehaviour obj, byte *data)
static NetworkBehaviour	NetworkUnwrap (NetworkRunner runner, NetworkBehaviourId wrapper)
static NetworkBehaviourId	NetworkWrap (NetworkRunner runner, NetworkBehaviour obj)
static implicit	operator NetworkBehaviourId (NetworkBehaviour behaviour)
	Converts NetworkBehaviour to NetworkBehaviourId.
Static Public Member Functions inherited from Behaviour
static void	DestroyBehaviour (Behaviour behaviour)
	Wrapper for Unity's GameObject.Destroy()

Protected Member Functions
override void	CopyFromBufferToEngine ()
	Sets the values retrieved from the networked data to the respective engine (Unity) fields. If overriding this method in an inheritor, the base method should be called.
override void	CopyFromEngineToBuffer ()
	Sets the values retrieved from the engine (Unity) to the respective networked fields. If overriding this method in an inheritor, the base method should be called.
virtual Quaternion	GetEngineRotation ()
	Gets the rotation value from the engine. By default, the world rotation is set to be the output.
virtual void	SetEngineRotation (Quaternion rot)
	Sets a rotation value to the engine. By default, the value is set to the transform's world rotation field.
Protected Member Functions inherited from NetworkPosition
virtual void	Awake ()
	Implements Unity's Awake event function. If overriding this method in an inheritor, the base method should be called.
virtual void	CopyFromBufferToEngine ()
	Sets the position value retrieved from the networked data to the engine's position field. If overriding this method in an inheritor, the base method should be called.
virtual void	CopyFromEngineToBuffer ()
	Sets the position value retrieved from the engine (Unity) to the respective networked field. If overriding this method in an inheritor, the base method should be called.
virtual Vector3	GetEnginePosition ()
	Gets the position value from the engine. By default, the world position is set to be the output.
virtual void	OnEnable ()
	Implements Unity's OnEnable event function. If overriding this method in an inheritor, the base method should be called.
virtual void	SetEnginePosition (Vector3 pos)
	Sets a position value to the engine. By default, the value is set to the transform's world position field.

Static Protected Attributes
const int	WORD_COUNT_NPR = OFFSET_ROTATION + WORD_COUNT_ROTATION
	Number of words used by a NetworkPositionRotation instance on its networked data, including all inherited fields.
Static Protected Attributes inherited from NetworkPosition
const int	WORD_COUNT_NPOS = OFFSET_POSITION + WORD_COUNT_POSITION
	Number of words used by a NetworkPosition instance on its networked data, including all inherited fields.

Properties
virtual int	BaseWordCount [get]
	Number of words used by this class on the networked data buffer, including all inherited fields, to serve for reference to inheritors.
Properties inherited from NetworkPosition
virtual int	BaseWordCount [get]
	Number of words used by this class on the networked data buffer, including all inherited fields, to serve for reference to inheritors.
override int	PositionWordOffset [get]
	Implements NetworkAreaOfInterestBehaviour by defining the word offset from the base pointer to the field that carries the position data used for Area of Interest management.
Transform	Transform [get]
	Cached GameObject.transform reference.
Properties inherited from NetworkAreaOfInterestBehaviour
abstract int	PositionWordOffset [get]
	The int* offset for the Ptr, for the memory location of the position data.
Properties inherited from NetworkBehaviour
virtual ? int	DynamicWordCount [get]
	Override this value for custom memory allocations. This is for advanced use cases only, and cannot be used if NetworkedAttribute is used in the derived class.
NetworkBehaviourId	Id [get]
	The unique identifier for this network behaviour.
InterpolationDataSources	InterpolationDataSource [get, set]
	Get/Set the time frame this object is rendered in.
virtual bool	InvokeOnChangedForInitialNonZeroValues [get]
	Override this property to change whether initial non-zero values assigned to [Networked] properties invoke OnChanged callbacks. For clients the initial value comes from the simulation snapshot, not from what has been set locally in the inspector.
int int count	WordInfo [get]
Properties inherited from SimulationBehaviour
bool	CanReceiveCallback [get]
virtual bool	HasInputAuthority [get]
	Returns true if the Simulation.LocalPlayer of the associated NetworkRunner is the designated as Input Authority for this network entity.
virtual bool	HasStateAuthority [get]
	Returns true if the associated NetworkRunner is the State Authority for this network entity.
virtual bool	IsProxy [get]
	Returns true if the associated NetworkRunner is neither the Input nor State Authority for this network entity. It is recommended to use !HasStateAuthority or !HasInputAuthority when possible instead, as this check requires evaluating both authorities - and is therefore less performant than the individual checks.

Additional Inherited Members
Public Types inherited from NetworkBehaviour
enum	InterpolationDataSources
	Options for which time frame this object will render in. More...
Public Attributes inherited from NetworkBehaviour
bool	InvokeRpc
int	ObjectIndex
	The index of this NetworkBehaviour, in the NetworkObject.NetworkedBehaviours array.
int	offset
	Gives access to the offset (in 32 bit words) and count (in 32 bit words) of this behaviour backing data.
int *	Ptr
	Pointer to the allocated memory associated with this Object.
Public Attributes inherited from SimulationBehaviour
NetworkObject	Object
	The NetworkObject this component is associated with. May be null if this GameObject does not have a NetworkObject.
NetworkRunner	Runner
	The NetworkRunner this component is associated with.
Protected Attributes inherited from NetworkPosition
NetworkPosition	parentNP = null

Detailed Description

Replicates a Unity Transform's position and rotation states from the NetworkObject.StateAuthority to all other peers. Add this component to a GameObject to sync the position and rotation. A NetworkObject is required on this GameObject or a parent of this GameObject.

This component does not interpolate visuals. In order to do that, use a NetworkTransform.

Member Function Documentation

CopyFromBufferToEngine()

override void CopyFromBufferToEngine ( )

protectedvirtual

Sets the values retrieved from the networked data to the respective engine (Unity) fields. If overriding this method in an inheritor, the base method should be called.

Reimplemented from NetworkPosition.

Reimplemented in NetworkRigidbody, and NetworkRigidbody2D.

CopyFromEngineToBuffer()

override void CopyFromEngineToBuffer ( )

protectedvirtual

Sets the values retrieved from the engine (Unity) to the respective networked fields. If overriding this method in an inheritor, the base method should be called.

Reimplemented from NetworkPosition.

Reimplemented in NetworkRigidbody, and NetworkRigidbody2D.