Type alias SetHumanoidPoseOptionItem Beta

SetHumanoidPoseOption: { timeoutSeconds: number; timeoutTransitionSeconds: number; transitionSeconds: number }

Optional value used to incorporate pose data information from the humanoid model. By passing it as an argument to PlayerHandle.setHumanoidPose, you can control how the pose data is configured for the target avatar.

Type declaration

  • timeoutSeconds: number

    The setting for the number of seconds required to cancel a configured HumanoidPose. The override of the pose data by setHumanoidPose can be cancelled when the specified number of seconds has elapsed after the pose data is set.

    Can be set to a value greater than or equal to transitionSeconds. If a value smaller than transitionSeconds is set, the value of transitionSeconds will be applied. Setting NaN will result in Infinity being applied. If not set, it is treated as Infinity. If Infinity is set, the pose data will not be canceled over time.

  • timeoutTransitionSeconds: number

    The number of seconds for returning to the original pose data when the pose data override is cancelled using timeoutSeconds. During the transition to the original pose data, the overridden pose data and the original pose data are linearly interpolated based on time.

    Can be set to a value greater than or equal to 0. If a value less than 0 or NaN is set, 0 will be applied. If not set, it is treated as 0.

  • transitionSeconds: number

    The number of seconds for reflecting pose data overrides in HumanoidPose. During the transition to the overridden pose data, the current pose data of the avatar and the overridden pose data are linearly interpolated based on time.

    Can be set to a value greater than or equal to 0. If a value less than 0 or NaN is set, 0 will be applied. If not set, it is treated as 0.

Generated using TypeDoc