Package net.neoforged.neoforge.client.event

Class CalculateDetachedCameraDistanceEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.CalculateDetachedCameraDistanceEvent

public class CalculateDetachedCameraDistanceEvent
extends net.neoforged.bus.api.Event

Fired for hooking the maximum distance from the player to the camera in third-person view. The ray-cast that reduces this distance based on the blocks around the player is invoked after this event is fired.

This event is not cancellable.

This event is fired on the main Forge event bus, only on the logical client.

Field Summary

Fields

Modifier and Type	Field	Description
private final Camera	camera
private final boolean	cameraFlipped
private float	distance
private final float	entityDistance
private final float	entityScale
private final float	vehicleEntityDistance
private final float	vehicleEntityScale

Constructor Summary

Constructors

Constructor	Description
CalculateDetachedCameraDistanceEvent(Camera camera, boolean cameraFlipped, float entityScale, float entityDistance, float vehicleEntityScale, float vehicleDistance)

Method Summary

Modifier and Type	Method	Description
Camera	getCamera()	Returns the camera instance.
float	getDistance()	Returns the final distance from the camera to the camera entity.
float	getEntityDistance()	Returns the unscaled camera distance provided by the camera entity.
float	getEntityScalingFactor()	Returns the scaling factor that will be applied to the entityDistance to compute the final distance, based on the size of the camera entity.
float	getVehicleEntityDistance()	Returns the unscaled camera distance provided by the vehicle ridden by the camera entity, if any.
float	getVehicleEntityScalingFactor()	Returns the scaling factor that will be applied to the vehicleEntityDistance to compute the final distance, based on the size of the vehicle ridden by the camera entity, if any.
boolean	isCameraFlipped()	Returns `true` if the camera is flipped (ie facing backward instead of forward).
void	setDistance(float distance)	Sets final distance from the camera to the camera entity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

camera

private final Camera camera

cameraFlipped

private final boolean cameraFlipped

entityScale

private final float entityScale

entityDistance

private final float entityDistance

vehicleEntityScale

private final float vehicleEntityScale

vehicleEntityDistance

private final float vehicleEntityDistance

distance

private float distance

Constructor Details

CalculateDetachedCameraDistanceEvent

@Internal
public CalculateDetachedCameraDistanceEvent(Camera camera,
 boolean cameraFlipped,
 float entityScale,
 float entityDistance,
 float vehicleEntityScale,
 float vehicleDistance)

Method Details

getCamera

public Camera getCamera()

Returns the camera instance.

isCameraFlipped

public boolean isCameraFlipped()

Returns `true` if the camera is flipped (ie facing backward instead of forward).

getEntityScalingFactor

public float getEntityScalingFactor()

Returns the scaling factor that will be applied to the entityDistance to compute the final distance, based on the size of the camera entity.

getEntityDistance

public float getEntityDistance()

Returns the unscaled camera distance provided by the camera entity.

getVehicleEntityScalingFactor

public float getVehicleEntityScalingFactor()

Returns the scaling factor that will be applied to the vehicleEntityDistance to compute the final distance, based on the size of the vehicle ridden by the camera entity, if any.

getVehicleEntityDistance

public float getVehicleEntityDistance()

Returns the unscaled camera distance provided by the vehicle ridden by the camera entity, if any.

getDistance

public float getDistance()

Returns the final distance from the camera to the camera entity.

setDistance

public void setDistance(float distance)

Sets final distance from the camera to the camera entity.

Parameters:

distance - The new distance from the camera to the camera entity