Click or drag to resize

TransformSync Methods

The TransformSync type exposes the following members.

Methods
  NameDescription
Protected methodAwake
Unity component method
(Overrides IndexedMonoBehaviourAwake.)
Public methodCanUnsnap
Returns true if this object can take authority (set its state to NotSnappedState), otherwise false
Protected methodChangeUpdateState
Changes the update state
Public methodCheckRequirement
Compare state to the expected value
(Overrides IndexedMonoBehaviourWithStateCheckRequirement(InteractionRequirementComparisonType, Int32).)
Protected methodEnableCombineColliders
Enables the combined colliders for this rigidbody
Public methodEnableTopMostCombineColliders
Enable/Disable TopMost Combined Colliders
Protected methodFixedUpdate
Unity component method
Public methodGetColliderBoundsInWorldSpace
Calculated bounds of the object (colliders are temporarily enabled otherwise it doesn't work)
Protected methodGetTopMostComponent
Gets the topmost TransformSync in this objects's hierarchy
Public methodHasCollisions
True if there currently are collisions with other pickups/colliders not belonging to this hierarchy
Protected methodInitializeSyncData
Initialises the SyncData for this TransformSync. SyncData is based on the _syncType setting.
Public methodIsTopMostCollidersEnabled
Returns true if the top-most transform has colliders enabled
Protected methodOnAfterReceivePersistedStateMessage
Override this method if your class needs to execute code after receiving the persisted state for this TransformSync
Protected methodOnCollisionEnter
Unity component method
Protected methodOnCollisionExit
Unity component method
Protected methodOnDisable
Unity component method
Protected methodOnEnable
Unity component method
Public methodOnLinkedCollisionEnter
Called by linked collisions
Public methodOnLinkedCollisionExit
Called by linked collisions
Public methodRegisterNewSnapTarget
Registers a new snap target in our list of targets
Public methodReInitialise
ReInitialise Transformsync with current properties
Public methodReInitialise(SyncProperties, Boolean, Single, SnappingRotationAxis)
ReInitialise Transformsync with specified properties
Protected methodReleaseCombinedColliders
Disables the combined colliders for this rigidbody
Public methodResetKinematic
Reset kinematic state back to it's default
Public methodResetTransformSync
Deletes the persisted state associated with this TransformSync
Protected methodSetOwner
Sets the owner of this TransformSync. Triggers the OnAuthorityChanged event
Public methodSetPersistedState
Manually update the persisted state for this object (which includes state, position and orientation depending on what values are synchronised).
Protected methodSetState
Sets the state of this TransformSync. Note that this is not persisted unless you called SetPersistedState after.
(Overrides IndexedMonoBehaviourWithStateSetState(Byte).)
Protected methodSetStateNonPersisted
Sets the state of this TransformSync and ensures it's not persisted.
Public methodSetToComplete
Complete synchronization (update) state. If the current user is also the owner, this transform will set it's persisted state as well.
Public methodSnapTo(Byte)
Snap to snap target index. Actual position/rotation updates will happen when message is received
Public methodSnapTo(SnapTarget)
Snap to SnapTarget. Actual position/rotation updates will happen when message is received
Public methodSnapToOrigin
Snap to origin if it is a valid target. Actual position/rotation updates will happen when message is received
Public methodSnapToUnassigned
Set state to Unassigned, which means not snapped but also not sending
Protected methodStart
Unity component method
(Overrides IndexedMonoBehaviourStart.)
Public methodTakeAuthority
Takes authority for the local user
Public methodUnsnap
Unsnaps the object
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodGetObjectIndex
Gets the index from the IndexedMonoBehaviour
(Defined by GUID.)
Public Extension MethodGetOwner
Gets the owner id from the IndexedMonoBehaviour
(Defined by GUID.)
Public Extension MethodGetOwnerType
Gets the owner type from the IndexedMonoBehaviour
(Defined by GUID.)
Public Extension MethodGetScene
Gets the scene id from the IndexedMonoBehaviour
(Defined by GUID.)
Public Extension MethodGetSnapTarget
Gets the current snap target using the TransformSync's state
(Defined by TransformSyncExtensions.)
Public Extension MethodIsLocalAuthority
Checks if the current user is the owner of the TransformSync
(Defined by TransformSyncExtensions.)
Public Extension MethodIsSnapped
Checks if the TransformSync is in a snapped state or not
(Defined by TransformSyncExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also