net.darkhax.gamestages.event

Class GameStageEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.darkhax.gamestages.event.GameStageEvent

Direct Known Subclasses:

GameStageEvent.Add, GameStageEvent.Check, GameStageEvent.ClientSync, GameStageEvent.Remove

public class GameStageEvent
extends net.minecraftforge.fml.common.eventhandler.Event

This class holds all the various game stage events. The main class itself should not be treated as an event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GameStageEvent.Add This event is fired every time a stage is added to a player, or unlocked.
static class	GameStageEvent.Check This event is fired every time a check for a stage is made.
static class	GameStageEvent.ClientSync This event is fired every time there is a client side stage sync.
static class	GameStageEvent.Remove This event is fired every time a stage is removed from a player, or locked.

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.common.eventhandler.Event.HasResult, net.minecraftforge.fml.common.eventhandler.Event.Result

Constructor Summary

Constructors

Constructor and Description
GameStageEvent(net.minecraft.entity.player.EntityPlayer player, java.lang.String stageName) The base constructor for all game stage events.

Method Summary

Modifier and Type	Method and Description
net.minecraft.entity.player.EntityPlayer	getPlayer() Gets the player the event is for.
java.lang.String	getStageName() Gets the stage name for the event.
void	setStage(java.lang.String stage) Sets the stage for the event.

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

GameStageEvent

public GameStageEvent(net.minecraft.entity.player.EntityPlayer player,
                      java.lang.String stageName)

The base constructor for all game stage events.

Parameters:

player - The player the event is for.

stageName - The stage the event is for.

Method Detail

getPlayer

public net.minecraft.entity.player.EntityPlayer getPlayer()

Gets the player the event is for.

Returns:

The player that the event was fired for.

getStageName

public java.lang.String getStageName()

Gets the stage name for the event. Note that other listeners can change this!

Returns:

The stage name for the event.

setStage

public void setStage(java.lang.String stage)

Sets the stage for the event. This can be used to change or manipulate the stage name.

Parameters:

stage - The new name for the stage.