Version: Unity 6.5 Alpha (6000.5)
LanguageEnglish
  • C#

PhysicsCallbacks.ITransformWriteCallback.OnTransformWrite

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void OnTransformWrite(TransformWriteEvent transformWriteEvent);

Parameters

Parameter Description
transformWriteEvent The event that occurred.

Description

The callback will only occur if PhysicsWorld.transformWriteMode is set to PhysicsWorld.TransformWriteMode.Custom and there are PhysicsWorld.bodyUpdateEvents available. To aid in correctly calculating the write pose, PhysicsBody.TransformWriteTween.GetPose can be used. The TransformWriteTween sent to this event will automatically be assigned to the world for tweening if PhysicsWorld.transformTweenMode is not PhysicsWorld.TransformTweenMode.Off. This will always be called on the main-thread after the simulation has finished. You should avoid write operations on physics objects during this callback.

NOTE: When transform writing, the TransformWriteEvent provides all the TransformWriteTween in preparation for transform writing and tweening.