#Class: Camera

Beta

包含与指定玩家的活动相机相关的方法。

Contains methods relating to the active camera for the specified player.

#Properties

#isValid

readonly isValid: boolean

Beta

#Remarks

返回该相机是否可访问和使用。当相机的拥有者玩家已加载且自身有效时，该相机被视为有效。

Returns whether the Camera is valid to access and use. A Camera is considered valid when the owning Player of the Camera is loaded and valid itself.

#Methods

#addShake()

addShake(shakeCameraOptions): void

Beta World Mutation

#Parameters

#shakeCameraOptions

CameraShakeOptions

#Returns

void

#Remarks

#Throws

This function can throw errors.

ArgumentOutOfBoundsError

InvalidEntityError

---

#attachToEntity()

attachToEntity(attachCameraOptions?): void

World Mutation Beta

#Parameters

#attachCameraOptions?

CameraAttachOptions

相机要附加到的实体的选项。包含实体标识符和可选的实体位置。

Options for the entity the camera is attaching to. Contains the entity identifier and optional entity location.

#Returns

void

#Remarks

将相机附加到非玩家实体上。

Attaches the camera to a non-player entity.

#Throws

This function can throw errors.

---

#clear()

clear(): void

World Mutation Beta

#Returns

void

#Remarks

清除指定玩家的活动相机。使指定玩家结束任何进行中的相机视角，包括任何缓动相机运动，并返回到其正常视角。

Clears the active camera for the specified player. Causes the specified players to end any in-progress camera perspectives, including any eased camera motions, and return to their normal perspective.

#Throws

This function can throw errors.

---

#fade()

fade(fadeCameraOptions?): void

World Mutation Beta

#Parameters

#fadeCameraOptions?

CameraFadeOptions

相机淡入淡出操作的附加选项。

Additional options around camera fade operations.

#Returns

void

#Remarks

开始相机淡入淡出过渡。淡入淡出过渡是一种全屏颜色，会淡入、保持、然后淡出。

Begins a camera fade transition. A fade transition is a full-screen color that fades-in, holds, and then fades-out.

#Throws

This function can throw errors.

---

#playAnimation()

playAnimation(splineType, cameraAnimationOptions): void

World Mutation Beta

#Parameters

#splineType

CatmullRomSpline | LinearSpline

#cameraAnimationOptions

AnimationOptions

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#setCamera()

setCamera(cameraPreset, setOptions?): void

World Mutation Beta

#Parameters

#cameraPreset

string

在 JSON 中定义的相机预设文件的标识符。

Identifier of a camera preset file defined within JSON.

#setOptions?

CameraFixedBoomOptions | CameraSetFacingOptions | CameraSetLocationOptions | CameraSetPosOptions | CameraSetRotOptions | CameraTargetOptions

相机的附加选项。

Additional options for the camera.

#Returns

void

#Remarks

为指定玩家设置当前活动相机。

Sets the current active camera for the specified player.

#Throws

This function can throw errors.

---

#setCameraWithEase()

setCameraWithEase(cameraPreset, easeOptions): void

Beta World Mutation

#Parameters

#cameraPreset

string

在 JSON 中定义的相机预设文件的标识符。

Identifier of a camera preset file defined within JSON.

#easeOptions

EaseOptions

用于将相机从上一个位置缓动到当前位置的选项。

Options to ease the camera from the previous camera to the current one.

#Returns

void

#Remarks

使用缓动设置当前活动相机。

Sets the current active camera with easing.

#Throws

当前在未启用实验性相机切换功能时，缓动到 minecraft:first_person 预设会抛出异常。

Throws when easing to minecraft:first_person presets currently without the experimental cameras toggle enabled.

---

#setDefaultCamera()

setDefaultCamera(cameraPreset, easeOptions?): void

World Mutation Beta

#Parameters

#cameraPreset

string

在 JSON 中定义的相机预设文件的标识符。

Identifier of a camera preset file defined within JSON.

#easeOptions?

EaseOptions

用于将相机缓动回其原始位置和旋转的选项。

Options to ease the camera back to its original position and rotation.

#Returns

void

#Remarks

为指定玩家设置当前活动相机，并将位置和旋转重置为 JSON 中定义的值。

Sets the current active camera for the specified player and resets the position and rotation to the values defined in the JSON.

#Throws

This function can throw errors.

---

#setFov()

setFov(fovCameraOptions?): void

World Mutation Beta

#Parameters

#fovCameraOptions?

CameraFovOptions

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#stopShaking()

stopShaking(): void

Beta World Mutation

#Returns

void

#Remarks

#Throws

This function can throw errors.

InvalidEntityError