su.plo.voice.proto.data.audio.capture

Interface Activation

All Known Subinterfaces:

ServerActivation

All Known Implementing Classes:

VoiceActivation

public interface Activation

Method Summary

Modifier and Type	Method and Description
int	getDefaultDistance() Gets the activation's default distance
java.util.List<java.lang.Integer>	getDistances() Gets the activation's available distances
@NotNull java.lang.String	getIcon() Gets the activation's icon Minecraft ResourceLocation or base64 in format: "base64;base64_string"
@NotNull java.util.UUID	getId() Gets the activation id
int	getMaxDistance() Gets the max distance from a distances collection
int	getMinDistance() Gets the min distance from a distances collection
@NotNull java.lang.String	getName() Gets the activation name
@NotNull java.lang.String	getTranslation() Gets the activation's translation string
default int	getWeight() Gets the activation's weight todo: doc
boolean	isProximity() Checks if activation has proximity output todo: doc
default boolean	isStereoSupported() Checks if stereo is supported Client will send a stereo audio if it's enabled in the client settings
boolean	isTransitive() Checks if activation is transitive todo: doc

Method Detail

getId

@NotNull
@NotNull java.util.UUID getId()

Gets the activation id

Returns:

the activation id

getName

@NotNull
@NotNull java.lang.String getName()

Gets the activation name

Returns:

the activation name

getTranslation

@NotNull
@NotNull java.lang.String getTranslation()

Gets the activation's translation string

Returns:

the activation's translation string

getIcon

@NotNull
@NotNull java.lang.String getIcon()

Gets the activation's icon Minecraft ResourceLocation or base64 in format: "base64;base64_string"

Returns:

the activation's icon

getDistances

java.util.List<java.lang.Integer> getDistances()

Gets the activation's available distances

Returns:

collection of distances

getDefaultDistance

int getDefaultDistance()

Gets the activation's default distance

Returns:

the default distance

getMinDistance

int getMinDistance()

Gets the min distance from a distances collection

Returns:

the min distance

getMaxDistance

int getMaxDistance()

Gets the max distance from a distances collection

Returns:

the max distance

isProximity

boolean isProximity()

Checks if activation has proximity output

todo: doc

Returns:

true if activation has proximity output

isTransitive

boolean isTransitive()

Checks if activation is transitive

todo: doc

Returns:

true if activation is transitive

isStereoSupported

default boolean isStereoSupported()

Checks if stereo is supported

Client will send a stereo audio if it's enabled in the client settings

Returns:

true if stereo is supported

getWeight

default int getWeight()

Gets the activation's weight

todo: doc

Returns:

the weight