Package dev.kosmx.playerAnim.api.layered.modifier

Class FirstPersonModifier

java.lang.Object

dev.kosmx.playerAnim.api.layered.AnimationContainer<IAnimation>

dev.kosmx.playerAnim.api.layered.modifier.AbstractModifier

dev.kosmx.playerAnim.api.layered.modifier.FirstPersonModifier

All Implemented Interfaces:

IAnimation

public class FirstPersonModifier
extends AbstractModifier

The FirstPersonModifier class is responsible for modifying the first-person view configuration in a system. It allows enabling or disabling specific arms and/or items in the first-person view using predefined configurations.

This class extends AbstractModifier and overrides the methods getFirstPersonConfiguration and getFirstPersonMode to return the current configuration and mode defined by the FirstPersonConfigEnum and FirstPersonMode, respectively.

The default configuration is ENABLE_BOTH_ARMS, which enables both arms and items in the first-person view. The default mode is DISABLED.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FirstPersonModifier.FirstPersonConfigEnum	Enumeration representing predefined first-person view configurations.

Field Summary

Fields inherited from class dev.kosmx.playerAnim.api.layered.modifier.AbstractModifier

host

Fields inherited from class dev.kosmx.playerAnim.api.layered.AnimationContainer

anim

Constructor Summary

Constructors

Constructor	Description
FirstPersonModifier()

Method Summary

Modifier and Type	Method	Description
@NotNull FirstPersonConfiguration	getFirstPersonConfiguration(float tickDelta)	Retrieves the current first-person configuration.
@NotNull FirstPersonMode	getFirstPersonMode(float tickDelta)	Retrieves the current first-person mode.

Methods inherited from class dev.kosmx.playerAnim.api.layered.modifier.AbstractModifier

canRemove

Methods inherited from class dev.kosmx.playerAnim.api.layered.AnimationContainer

get3DTransform, getAnim, isActive, setAnim, setupAnim, tick

Methods inherited from class java.lang.Object

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

Constructor Details

FirstPersonModifier

public FirstPersonModifier()

Method Details

getFirstPersonConfiguration

@NotNull
public @NotNull FirstPersonConfiguration getFirstPersonConfiguration(float tickDelta)

Retrieves the current first-person configuration.

This method returns the configuration defined by the currentFirstPersonConfig field, which specifies which arms and items are visible in the first-person view.

Specified by:

getFirstPersonConfiguration in interface IAnimation

Overrides:

getFirstPersonConfiguration in class AnimationContainer<IAnimation>

Parameters:

tickDelta -

Returns:

The active FirstPersonConfiguration based on currentFirstPersonConfig.

getFirstPersonMode

@NotNull
public @NotNull FirstPersonMode getFirstPersonMode(float tickDelta)

Retrieves the current first-person mode.

This method returns the mode defined by the currentFirstPersonMode field, which specifies whether the first-person view is enabled, disabled, or in another mode.

Specified by:

getFirstPersonMode in interface IAnimation

Overrides:

getFirstPersonMode in class AnimationContainer<IAnimation>

Parameters:

tickDelta -

Returns:

The active FirstPersonMode based on currentFirstPersonMode.