org.spongepowered.api.effect

Interface Viewer

All Known Subinterfaces:

Player, World

public interface Viewer

A Viewer is something that sees effects. The Viewer class contains methods for spawning particles and playing sound effects.

Method Summary

Modifier and Type	Method and Description
default void	clearTitle() Removes the currently displayed Title from the player's screen.
void	playRecord(com.flowpowered.math.vector.Vector3i position, RecordType recordType) Plays the given RecordType at the given position.
void	playSound(SoundType sound, SoundCategory category, com.flowpowered.math.vector.Vector3d position, double volume) Plays the given SoundType at the given position.
void	playSound(SoundType sound, SoundCategory category, com.flowpowered.math.vector.Vector3d position, double volume, double pitch) Plays the given SoundType at the given position, with the category SoundCategories.MASTER.
void	playSound(SoundType sound, SoundCategory category, com.flowpowered.math.vector.Vector3d position, double volume, double pitch, double minVolume) Plays the given SoundType at the given position.
default void	playSound(SoundType sound, com.flowpowered.math.vector.Vector3d position, double volume) Plays the given SoundType at the given position, with the category SoundCategories.MASTER.
default void	playSound(SoundType sound, com.flowpowered.math.vector.Vector3d position, double volume, double pitch) Plays the given SoundType at the given position, with the category SoundCategories.MASTER.
default void	playSound(SoundType sound, com.flowpowered.math.vector.Vector3d position, double volume, double pitch, double minVolume) Plays the given SoundType at the given position, with the category SoundCategories.MASTER.
void	resetBlockChange(int x, int y, int z) Resets the client's view of the provided position to what actually exists in the World.
default void	resetBlockChange(com.flowpowered.math.vector.Vector3i vec) Resets the client's view of the provided position to what actually exists in the World.
default void	resetTitle() Removes the currently displayed Title from the player and resets all settings back to default values.
void	sendBlockChange(int x, int y, int z, BlockState state) Sends a client-only block change.
default void	sendBlockChange(com.flowpowered.math.vector.Vector3i vec, BlockState state) Sends a client-only block change.
void	sendBookView(BookView bookView) Sends a BookView to this viewer.
void	sendTitle(Title title) Sends a Title to this player.
void	spawnParticles(ParticleEffect particleEffect, com.flowpowered.math.vector.Vector3d position) Spawn a ParticleEffect at a given position.
void	spawnParticles(ParticleEffect particleEffect, com.flowpowered.math.vector.Vector3d position, int radius) Spawn a ParticleEffect at a given position.
void	stopRecord(com.flowpowered.math.vector.Vector3i position) Stops the record that is playing at the given position.
void	stopSounds() Stops all the sounds.
void	stopSounds(SoundCategory category) Stops all the sounds that are played in the given SoundCategory.
void	stopSounds(SoundType sound) Stops all the sounds of the given SoundType.
void	stopSounds(SoundType sound, SoundCategory category) Stops all the sounds of the given SoundType that are played in the given SoundCategory.

Method Detail

spawnParticles

void spawnParticles(ParticleEffect particleEffect,
                    com.flowpowered.math.vector.Vector3d position)

Spawn a ParticleEffect at a given position. All players within a default radius around the position will see the particles.

Parameters:

particleEffect - The particle effect to spawn

position - The position at which to spawn the particle effect

spawnParticles

void spawnParticles(ParticleEffect particleEffect,
                    com.flowpowered.math.vector.Vector3d position,
                    int radius)

Spawn a ParticleEffect at a given position. All players within a given radius around the position will see the particles.

Parameters:

particleEffect - The particle effect to spawn

position - The position at which to spawn the particle effect

radius - The radius around the position where the particles can be seen by players

playSound

default void playSound(SoundType sound,
                       com.flowpowered.math.vector.Vector3d position,
                       double volume)

Plays the given SoundType at the given position, with the category SoundCategories.MASTER. All players within range will hear the sound with the given volume.

Parameters:

sound - The sound to play

position - The position to play the sound

volume - The volume to play the sound at, usually between 0 and 2

playSound

void playSound(SoundType sound,
               SoundCategory category,
               com.flowpowered.math.vector.Vector3d position,
               double volume)

Plays the given SoundType at the given position. All players within range will hear the sound with the given volume.

Parameters:

sound - The sound to play

category - The category to play the sound with

position - The position to play the sound

volume - The volume to play the sound at, usually between 0 and 2

playSound

default void playSound(SoundType sound,
                       com.flowpowered.math.vector.Vector3d position,
                       double volume,
                       double pitch)

Plays the given SoundType at the given position, with the category SoundCategories.MASTER. All players within range will hear the sound with the given volume.

Parameters:

sound - The sound to play

position - The position to play the sound

volume - The volume to play the sound at, usually between 0 and 2

pitch - The modulation of the sound to play at, usually between 0 and 2

playSound

void playSound(SoundType sound,
               SoundCategory category,
               com.flowpowered.math.vector.Vector3d position,
               double volume,
               double pitch)

Plays the given SoundType at the given position, with the category SoundCategories.MASTER. All players within range will hear the sound with the given volume.

Parameters:

sound - The sound to play

category - The category to play the sound with

position - The position to play the sound

volume - The volume to play the sound at, usually between 0 and 2

pitch - The modulation of the sound to play at, usually between 0 and 2

playSound

default void playSound(SoundType sound,
                       com.flowpowered.math.vector.Vector3d position,
                       double volume,
                       double pitch,
                       double minVolume)

Plays the given SoundType at the given position, with the category SoundCategories.MASTER. All players within range will hear the sound with the given volume.

Parameters:

sound - The sound to play

position - The position to play the sound

volume - The volume to play the sound at, usually between 0 and 2

pitch - The modulation of the sound to play at, usually between 0 and 2

minVolume - The minimum volume to play the sound at, usually between 0 and 2

playSound

void playSound(SoundType sound,
               SoundCategory category,
               com.flowpowered.math.vector.Vector3d position,
               double volume,
               double pitch,
               double minVolume)

Plays the given SoundType at the given position. All players within range will hear the sound with the given volume.

Parameters:

sound - The sound to play

category - The category to play the sound with

position - The position to play the sound

volume - The volume to play the sound at, usually between 0 and 2

pitch - The modulation of the sound to play at, usually between 0 and 2

minVolume - The minimum volume to play the sound at, usually between 0 and 2

stopSounds

void stopSounds()

Stops all the sounds.

stopSounds

void stopSounds(SoundType sound)

Stops all the sounds of the given SoundType.

Parameters:

sound - The sound type

stopSounds

void stopSounds(SoundCategory category)

Stops all the sounds that are played in the given SoundCategory.

Parameters:

category - The sound category

stopSounds

void stopSounds(SoundType sound,
                SoundCategory category)

Stops all the sounds of the given SoundType that are played in the given SoundCategory.

Parameters:

sound - The sound type

category - The sound category

playRecord

void playRecord(com.flowpowered.math.vector.Vector3i position,
                RecordType recordType)

Plays the given RecordType at the given position. The benefit of playing RecordType instead of a SoundType allows you to stop them through the stopRecord(Vector3i). Playing a new RecordType at the same position will cancel the currently playing one.

Parameters:

position - The position

recordType - The record type

stopRecord

void stopRecord(com.flowpowered.math.vector.Vector3i position)

Stops the record that is playing at the given position.

Parameters:

position - The position

sendTitle

void sendTitle(Title title)

Sends a Title to this player.

Parameters:

title - The Title to send to the player

resetTitle

default void resetTitle()

Removes the currently displayed Title from the player and resets all settings back to default values.

clearTitle

default void clearTitle()

Removes the currently displayed Title from the player's screen.

sendBookView

void sendBookView(BookView bookView)

Sends a BookView to this viewer.

Parameters:

bookView - BookView to send

sendBlockChange

default void sendBlockChange(com.flowpowered.math.vector.Vector3i vec,
                             BlockState state)

Sends a client-only block change.

This will not change the World in any way.

Parameters:

vec - The position

state - The block state

sendBlockChange

void sendBlockChange(int x,
                     int y,
                     int z,
                     BlockState state)

Sends a client-only block change.

This will not change the World in any way.

Parameters:

x - The x position

y - The y position

z - The z position

state - The block state

resetBlockChange

default void resetBlockChange(com.flowpowered.math.vector.Vector3i vec)

Resets the client's view of the provided position to what actually exists in the World.

This is useful for resetting what the client sees after sending a block change.

Parameters:

vec - The position

resetBlockChange

void resetBlockChange(int x,
                      int y,
                      int z)

Resets the client's view of the provided position to what actually exists in the World.

This is useful for resetting what the client sees after sending a block change.

Parameters:

x - The x position

y - The y position

z - The z position