Package com.pixelmonmod.pixelmon.api.pokemon.species.parameters.swimming

Class SwimmingParameters

java.lang.Object

com.pixelmonmod.pixelmon.api.pokemon.species.parameters.swimming.SwimmingParameters

public class SwimmingParameters
extends Object

Represents the parameters for an entities' swimming movement & AI & animation

Constructor Summary

Constructors

Constructor	Description
SwimmingParameters()	Constructor providing the default values
SwimmingParameters(int depthMin, int depthMax, double swimSpeed, double decayRate, int refreshRate, boolean shouldSink)	Constructor taking all potential values that can be changed

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
float	getDecayRate()	Gets the decay rate
int	getDepthRangeEnd()	Gets the depth rate end value
int	getDepthRangeStart()	Gets the depth range start value
int	getRefreshRate()	Gets the refresh rate
float	getSwimSpeed()	Gets the swim speed
boolean	isShouldSink()

Methods inherited from class java.lang.Object

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

Constructor Details

SwimmingParameters

public SwimmingParameters(int depthMin,
 int depthMax,
 double swimSpeed,
 double decayRate,
 int refreshRate,
 boolean shouldSink)

Constructor taking all potential values that can be changed

Parameters:

depthMin - The minimum depth at which swimming can be done

depthMax - The maximum depth at which swimming can be done

swimSpeed - The speed at which swimming occurs

decayRate - The decay rate of swimming

refreshRate - The refresh rate of swimming

SwimmingParameters

public SwimmingParameters()

Constructor providing the default values

Method Details

getDepthRangeStart

public int getDepthRangeStart()

Gets the depth range start value

Returns:

The depth range start

getDepthRangeEnd

public int getDepthRangeEnd()

Gets the depth rate end value

Returns:

The depth range end

getSwimSpeed

public float getSwimSpeed()

Gets the swim speed

Returns:

Swim speed

getDecayRate

public float getDecayRate()

Gets the decay rate

Returns:

The rate of decay

getRefreshRate

public int getRefreshRate()

Gets the refresh rate

Returns:

Refresh rate

isShouldSink

public boolean isShouldSink()

equals

public boolean equals(Object o)

Overrides:

equals in class Object