net.tridentsdk.server.effect.sound

Class TridentSoundEffect

java.lang.Object

net.tridentsdk.server.effect.TridentEffect<T>

net.tridentsdk.server.effect.TridentRemoteEffect<SoundEffectType>

net.tridentsdk.server.effect.sound.TridentSoundEffect

All Implemented Interfaces:

Effect<SoundEffectType>, RemoteEffect<SoundEffectType>, SoundEffect

public class TridentSoundEffect
extends TridentRemoteEffect<SoundEffectType>
implements SoundEffect

Represents a sound effect

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
TridentSoundEffect(World world, SoundEffectType type)

Method Summary

Modifier and Type	Method and Description
OutPacket	getPacket()
int	pitch() Returns the pitch of the sound
void	setPitch(int pitch) Set the pitch of the sound
void	setPosition(Vector vector) Set the position of the effect
void	setType(SoundEffectType type) Set the type of the effect
void	setVolume(float volume) Set the volume of the sound
SoundEffectType	type() The type of the effect
float	volume() Returns the volume of the sound

Methods inherited from class net.tridentsdk.server.effect.TridentEffect

apply, apply, applyToEveryoneExcept

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.tridentsdk.effect.Effect

apply, apply, applyToEveryoneExcept

Constructor Detail

TridentSoundEffect

public TridentSoundEffect(World world,
                          SoundEffectType type)

Method Detail

type

public SoundEffectType type()

Description copied from interface: Effect

The type of the effect

Specified by:

type in interface Effect<SoundEffectType>

Returns:

The type of the effect

setType

public void setType(SoundEffectType type)

Description copied from interface: Effect

Set the type of the effect

Specified by:

setType in interface Effect<SoundEffectType>

Parameters:

type - The type of the effect

setPosition

public void setPosition(Vector vector)

Description copied from interface: RemoteEffect

Set the position of the effect

Specified by:

setPosition in interface RemoteEffect<SoundEffectType>

Parameters:

vector - The vector of the effect

setVolume

public void setVolume(float volume)

Description copied from interface: SoundEffect

Set the volume of the sound

Specified by:

setVolume in interface SoundEffect

Parameters:

volume - The volume of the sound (1 is 100%, can be higher)

setPitch

public void setPitch(int pitch)

Description copied from interface: SoundEffect

Set the pitch of the sound

Specified by:

setPitch in interface SoundEffect

Parameters:

pitch - The pitch of the sound (63 is 100%, can be higher)

volume

public float volume()

Description copied from interface: SoundEffect

Returns the volume of the sound

Specified by:

volume in interface SoundEffect

Returns:

The volume of the sound

pitch

public int pitch()

Description copied from interface: SoundEffect

Returns the pitch of the sound

Specified by:

pitch in interface SoundEffect

Returns:

The pitch of the sound

getPacket

public OutPacket getPacket()

Specified by:

getPacket in class TridentEffect<SoundEffectType>