 | TransformSync Methods |
The TransformSync type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Awake |
Unity component method
|
 | CanUnsnap |
Returns true if this object can take authority (set its state to NotSnappedState), otherwise false
|
| ChangeUpdateState |
Changes the update state
|
| CheckRequirement |
Compare state to the expected value
(Overrides IndexedMonoBehaviourWithStateCheckRequirement(InteractionRequirementComparisonType, Int32).) |
| CollectCombineAndEnableTopMostColliders | |
| EnableCombineColliders |
Enables the combined colliders for this rigidbody
|
| EnableTopMostCombineColliders |
Enable/Disable TopMost Combined Colliders
|
| FixedUpdate |
Unity component method
|
| GetColliderBoundsInWorldSpace |
Calculated bounds of the object (colliders are temporarily enabled otherwise it doesn't work)
|
| GetTopMostComponent |
Gets the topmost TransformSync in this objects's hierarchy
|
| HasCollisions |
True if there currently are collisions with other pickups/colliders not belonging to this hierarchy
|
| InitializeSyncData |
Initialises the SyncData for this TransformSync. SyncData is based on the _syncType setting.
|
| IsTopMostCollidersEnabled |
Returns true if the top-most transform has colliders enabled
|
| OnAfterReceivePersistedStateMessage |
Override this method if your class needs to execute code after receiving the persisted state for this TransformSync
|
| OnCollisionEnter |
Unity component method
|
| OnCollisionExit |
Unity component method
|
| OnDisable |
Unity component method
|
| OnEnable |
Unity component method
|
| OnLinkedCollisionEnter |
Called by linked collisions
|
| OnLinkedCollisionExit |
Called by linked collisions
|
| RegisterNewSnapTarget |
Registers a new snap target in our list of targets
|
| ReInitialise |
ReInitialise TransformSync with current properties
|
| ReInitialise(SyncProperties, Boolean, Single, SnappingRotationAxis) |
ReInitialise TransformSync with specified properties
|
| ReleaseCombinedCollider |
Disables one combined collider
|
| ReleaseCombinedColliders |
Disables the combined colliders for this rigidbody
|
| ResetKinematic |
Reset kinematic state back to it's default
|
| ResetTransformSync |
Deletes the persisted state associated with this TransformSync
|
| SetOwner |
Sets the owner of this TransformSync. Triggers the OnAuthorityChanged event
|
| SetPersistedState |
Manually update the persisted state for this object (which includes state, position and orientation depending on what values are synchronised).
|
| SetRelativePosition |
Set the position of the object relative ot it's starting values
|
| SetState |
Sets the state of this TransformSync. Note that this is not persisted unless you called SetPersistedState after.
(Overrides IndexedMonoBehaviourWithStateSetState(Byte, Boolean).) |
| SetStateNonPersisted |
Sets the state of this TransformSync and ensures it's not persisted.
|
| SetToComplete |
Complete synchronization (update) state. If the current user is also the owner, this transform will set it's persisted state as well.
|
| SnapTo(Byte, Boolean) |
Snap to snap target index. Actual position/rotation updates will happen when message is received
|
| SnapTo(SnapTarget, Boolean) |
Snap to SnapTarget. Actual position/rotation updates will happen when message is received
|
| SnapToOrigin |
Snap to origin if it is a valid target. Actual position/rotation updates will happen when message is received
|
| SnapToUnassigned |
Set state to Unassigned, which means not snapped but also not sending
|
| Start |
Unity component method
|
| TakeAuthority |
Takes authority for the local user
|
| Unsnap |
Unsnaps the object
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| GetSnapTarget |
Gets the current snap target using the TransformSync's state
(Defined by TransformSyncExtensions.) |
| IsLocalAuthority |
Checks if the current user is the owner of the TransformSync
(Defined by TransformSyncExtensions.) |
| IsSnapped |
Checks if the TransformSync is in a snapped state or not
(Defined by TransformSyncExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also