Class StructurePrepareLockChangeEvent

java.lang.Object

org.bukkit.event.Event

nl.pim16aap2.animatedarchitecture.spigot.core.events.AnimatedArchitectureSpigotEvent

nl.pim16aap2.animatedarchitecture.spigot.core.events.StructurePrepareLockChangeEvent

All Implemented Interfaces:

IAnimatedArchitectureEvent, ICancellableAnimatedArchitectureEvent, IStructureEvent, IStructurePrepareLockChangeEvent

public class StructurePrepareLockChangeEvent
extends AnimatedArchitectureSpigotEvent
implements IStructurePrepareLockChangeEvent

Represents the event where a structure will be (un)locked.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
protected final Optional<IPlayer>	responsible	The player responsible for the event.
protected final Structure	structure	The structure that is targeted by the event.

Constructor Summary

Constructors

Constructor	Description
StructurePrepareLockChangeEvent(Structure structure, @Nullable IPlayer responsible, boolean newLockStatus)

Method Summary

Modifier and Type	Method	Description
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
Optional<IPlayer>	getResponsible()	The player responsible for the event.
Structure	getStructure()	The structure that is targeted by the event.
boolean	isCancelled()	Checks if this event has been cancelled or not.
boolean	newLockStatus()	The new lock status of the Structure that will be applied if this event is not cancelled.
void	setCancelled(boolean isCancelled)	Sets the cancelled status of this event.
@NonNull String	toString()

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class Object

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

Methods inherited from interface IAnimatedArchitectureEvent

getEventName, isAsynchronous

Methods inherited from interface IStructureEvent

getResponsible, getStructure

Field Details

structure

protected final Structure structure

The structure that is targeted by the event.

responsible

protected final Optional<IPlayer> responsible

The player responsible for the event.

If the event is caused by a player, such as a player deleting a structure, the responsible player will be set.

If the event is not caused by a player, this will be empty. This can be the case when a structure is toggled by a redstone signal.

Constructor Details

StructurePrepareLockChangeEvent

public StructurePrepareLockChangeEvent(Structure structure,
 @Nullable IPlayer responsible,
 boolean newLockStatus)

Method Details

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()

newLockStatus

public boolean newLockStatus()

Description copied from interface: IStructurePrepareLockChangeEvent

The new lock status of the Structure that will be applied if this event is not cancelled.

Specified by:

newLockStatus in interface IStructurePrepareLockChangeEvent

Returns:

The new lock status of the Structure, where true indicates locked, and false indicates unlocked.

toString

public @NonNull String toString()

Overrides:

toString in class AnimatedArchitectureSpigotEvent

isCancelled

public boolean isCancelled()

Description copied from interface: ICancellableAnimatedArchitectureEvent

Checks if this event has been cancelled or not.

Specified by:

isCancelled in interface ICancellableAnimatedArchitectureEvent

Returns:

True if it has been cancelled.

setCancelled

public void setCancelled(boolean isCancelled)

Description copied from interface: ICancellableAnimatedArchitectureEvent

Sets the cancelled status of this event.

Specified by:

setCancelled in interface ICancellableAnimatedArchitectureEvent

Parameters:

isCancelled - True to cancel the event.

getStructure

public Structure getStructure()

The structure that is targeted by the event.

Specified by:

getStructure in interface IStructureEvent

Returns:

The Structure that will be created.

getResponsible

public Optional<IPlayer> getResponsible()

The player responsible for the event.

If the event is caused by a player, such as a player deleting a structure, the responsible player will be set.

If the event is not caused by a player, this will be empty. This can be the case when a structure is toggled by a redstone signal.

Specified by:

getResponsible in interface IStructureEvent

Returns:

The player responsible for the event or empty if the event is not caused by a player.