net.caseif.flint.lobby

Interface LobbySign

All Superinterfaces:

Component<Arena>

All Known Subinterfaces:

ChallengerListingLobbySign, StatusLobbySign

public interface LobbySign
extends Component<Arena>

Represents a physical sign in the world which provides graphical information to players regarding a particular arena.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LobbySign.Type

Method Summary

Modifier and Type	Method and Description
Arena	getArena() Gets the Arena this LobbySign is owned by.
Location3D	getLocation() Gets the physical location of this LobbySign.
LobbySign.Type	getType() Gets the LobbySign.Type of this LobbySign.
void	unregister() Unregisters this LobbySign from the engine and blanks the physical sign.
void	update() Updates this LobbySign's display in the world.

Methods inherited from interface net.caseif.flint.component.Component

getOwner

Method Detail

getArena

Arena getArena()
        throws OrphanedComponentException

Gets the Arena this LobbySign is owned by.

Note: This a convenience method for Component.getOwner().

Returns:

The Arena this LobbySign is owned by

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getLocation

Location3D getLocation()
                throws OrphanedComponentException

Gets the physical location of this LobbySign.

Returns:

The physical location of this LobbySign

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getType

LobbySign.Type getType()
                throws OrphanedComponentException

Gets the LobbySign.Type of this LobbySign.

Returns:

The LobbySign.Type of this LobbySign

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

update

void update()
     throws OrphanedComponentException

Updates this LobbySign's display in the world.

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

unregister

void unregister()
         throws OrphanedComponentException

Unregisters this LobbySign from the engine and blanks the physical sign.

Note that calling this method will orphan this object, causing all of its methods to throw OrphanedComponentExceptions.

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0