Package net.kyori.adventure.platform.facet

Interface Facet.FakeEntity<V,P>

Type Parameters:

V - a viewer type

P - a position type

All Superinterfaces:

AutoCloseable, Closeable, Facet<V>, Facet.Position<V,P>

All Known Subinterfaces:

Facet.BossBarEntity<V,P>

Enclosing interface:

Facet<V>

public static interface Facet.FakeEntity<V,P>
extends Facet.Position<V,P>, Closeable

A facet for spawning client-side entities.

Since:

4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.platform.facet.Facet

Facet.ActionBar<V,M>, Facet.Book<V,M,B>, Facet.BossBar<V>, Facet.BossBarEntity<V,P>, Facet.BossBarPacket<V>, Facet.Chat<V,M>, Facet.ChatPacket<V,M>, Facet.EntitySound<V,M>, Facet.FakeEntity<V,P>, Facet.Message<V,M>, Facet.Pointers<V>, Facet.Position<V,P>, Facet.Sound<V,P>, Facet.TabList<V,M>, Facet.Title<V,M,C,T>, Facet.TitlePacket<V,M,C,T>

Method Summary

Modifier and Type	Method	Description
void	close()	Remove the entity for all viewers.
void	health(float health)	Sets the entity health.
void	invisible(boolean invisible)	Sets the entity visibility.
void	metadata(int position, @NotNull Object data)	Sets the entity metadata.
void	name(@NotNull net.kyori.adventure.text.Component name)	Sets the entity name.
void	teleport(V viewer, P position)	Teleports the entity for a viewer.

Methods inherited from interface net.kyori.adventure.platform.facet.Facet

isApplicable, isSupported

Methods inherited from interface net.kyori.adventure.platform.facet.Facet.Position

createPosition, createPosition

Method Detail

teleport

void teleport(@NotNull
              V viewer,
              @Nullable
              P position)

Teleports the entity for a viewer.

Parameters:

viewer - a viewer

position - an entity position or null to remove

Since:

4.0.0

metadata

void metadata(int position,
              @NotNull
              @NotNull Object data)

Sets the entity metadata.

Parameters:

position - a metadata position

data - a value

Since:

4.0.0

invisible

void invisible(boolean invisible)

Sets the entity visibility.

Parameters:

invisible - if invisible

Since:

4.0.0

health

void health(float health)

Sets the entity health.

Parameters:

health - health level, between 0 and 1

Since:

4.0.0

name

void name(@NotNull
          @NotNull net.kyori.adventure.text.Component name)

Sets the entity name.

Parameters:

name - a name

Since:

4.0.0

close

void close()

Remove the entity for all viewers.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Since:

4.0.0