Interface IAnimatedArchitectureEventFactory

All Known Implementing Classes:

AnimatedArchitectureEventFactorySpigot

public interface IAnimatedArchitectureEventFactory

Represents a class that can create IAnimatedArchitectureEvents.

Method Summary

Modifier and Type	Method	Description
default IStructurePrepareDeleteEvent	createPrepareDeleteStructureEvent(Structure structure)	Constructs a new IStructurePrepareDeleteEvent and assumes it was not deleted by an IPlayer.
IStructurePrepareDeleteEvent	createPrepareDeleteStructureEvent(Structure structure, @Nullable IPlayer responsible)	Constructs a new IStructurePrepareDeleteEvent.
default IStructurePrepareCreateEvent	createPrepareStructureCreateEvent(Structure structure)	Constructs a new IStructurePrepareCreateEvent and assumes it was not created by an IPlayer.
IStructurePrepareCreateEvent	createPrepareStructureCreateEvent(Structure structure, @Nullable IPlayer responsible)	Constructs a new IStructurePrepareCreateEvent.
default IStructureCreatedEvent	createStructureCreatedEvent(Structure preview)	Constructs a new IStructureCreatedEvent and assumes it was not created by an IPlayer.
IStructureCreatedEvent	createStructureCreatedEvent(Structure preview, @Nullable IPlayer responsible)	Constructs a new IStructureCreatedEvent.
default IStructurePrepareAddOwnerEvent	createStructurePrepareAddOwnerEvent(Structure structure, StructureOwner newOwner)	Constructs a new IStructurePrepareAddOwnerEvent and assumes it was not added by an IPlayer.
IStructurePrepareAddOwnerEvent	createStructurePrepareAddOwnerEvent(Structure structure, StructureOwner newOwner, @Nullable IPlayer responsible)	Constructs a new IStructurePrepareAddOwnerEvent.
default IStructurePrepareLockChangeEvent	createStructurePrepareLockChangeEvent(Structure structure, boolean newLockStatus)	Constructs a new IStructurePrepareLockChangeEvent and assumes it was not added by an IPlayer.
IStructurePrepareLockChangeEvent	createStructurePrepareLockChangeEvent(Structure structure, boolean newLockStatus, @Nullable IPlayer responsible)	Constructs a new IStructurePrepareLockChangeEvent.
default IStructurePrepareRemoveOwnerEvent	createStructurePrepareRemoveOwnerEvent(Structure structure, StructureOwner removedOwner)	Constructs a new IStructurePrepareRemoveOwnerEvent and assumes the owner was not removed by an IPlayer.
IStructurePrepareRemoveOwnerEvent	createStructurePrepareRemoveOwnerEvent(Structure structure, StructureOwner removedOwner, @Nullable IPlayer responsible)	Constructs a new IStructurePrepareRemoveOwnerEvent.
IStructureEventToggleEnd	createToggleEndEvent(Structure structure, StructureSnapshot snapshot, StructureActionCause cause, StructureActionType actionType, IPlayer responsible, double time, boolean skipAnimation)	Constructs a IStructureEventToggleEnd.
IStructureEventTogglePrepare	createTogglePrepareEvent(StructureSnapshot snapshot, StructureActionCause cause, StructureActionType actionType, IPlayer responsible, double time, boolean skipAnimation, Cuboid newCuboid)	Constructs a IStructureEventTogglePrepare.
IStructureEventToggleStart	createToggleStartEvent(Structure structure, StructureSnapshot structureSnapshot, StructureActionCause cause, StructureActionType actionType, IPlayer responsible, double time, boolean skipAnimation, Cuboid newCuboid)	Constructs a IStructureEventToggleStart.

Method Details

createStructureCreatedEvent

IStructureCreatedEvent createStructureCreatedEvent(Structure preview,
 @Nullable IPlayer responsible)

Constructs a new IStructureCreatedEvent.

Parameters:

preview - The preview of the structure that is to be created.

responsible - The IPlayer responsible for the action, if a player was responsible for it.

createStructureCreatedEvent

default IStructureCreatedEvent createStructureCreatedEvent(Structure preview)

Constructs a new IStructureCreatedEvent and assumes it was not created by an IPlayer.

When the structure is created by an IPlayer, consider using createStructureCreatedEvent(Structure, IPlayer) instead.

Parameters:

preview - The preview of the structure that is to be created.

createPrepareStructureCreateEvent

IStructurePrepareCreateEvent createPrepareStructureCreateEvent(Structure structure,
 @Nullable IPlayer responsible)

Constructs a new IStructurePrepareCreateEvent.

Parameters:

structure - The structure that was created.

responsible - The IPlayer responsible for the action, if a player was responsible for it.

createPrepareStructureCreateEvent

default IStructurePrepareCreateEvent createPrepareStructureCreateEvent(Structure structure)

Constructs a new IStructurePrepareCreateEvent and assumes it was not created by an IPlayer.

When the structure is created by a player, consider using createPrepareStructureCreateEvent(Structure, IPlayer) instead.

Parameters:

structure - The structure that was created.

createPrepareDeleteStructureEvent

IStructurePrepareDeleteEvent createPrepareDeleteStructureEvent(Structure structure,
 @Nullable IPlayer responsible)

Constructs a new IStructurePrepareDeleteEvent.

Parameters:

structure - The Structure that will be deleted.

responsible - The IPlayer responsible for the action, if a player was responsible for it.

createPrepareDeleteStructureEvent

default IStructurePrepareDeleteEvent createPrepareDeleteStructureEvent(Structure structure)

Constructs a new IStructurePrepareDeleteEvent and assumes it was not deleted by an IPlayer.

When the structure is deleted by a player, consider using createPrepareDeleteStructureEvent(Structure, IPlayer) instead.

Parameters:

structure - The Structure that will be deleted.

createStructurePrepareAddOwnerEvent

IStructurePrepareAddOwnerEvent createStructurePrepareAddOwnerEvent(Structure structure,
 StructureOwner newOwner,
 @Nullable IPlayer responsible)

Constructs a new IStructurePrepareAddOwnerEvent.

Parameters:

structure - The structure to which a new owner is to be added.

newOwner - The new StructureOwner that is to be added to the structure.

responsible - The IPlayer responsible for the action, if a player was responsible for it.

createStructurePrepareAddOwnerEvent

default IStructurePrepareAddOwnerEvent createStructurePrepareAddOwnerEvent(Structure structure,
 StructureOwner newOwner)

Constructs a new IStructurePrepareAddOwnerEvent and assumes it was not added by an IPlayer.

If the owner is added by an IPlayer, consider using createStructurePrepareAddOwnerEvent(Structure, StructureOwner, IPlayer) instead.

Parameters:

structure - The structure to which a new owner is to be added.

newOwner - The new StructureOwner that is to be added to the structure.

createStructurePrepareRemoveOwnerEvent

IStructurePrepareRemoveOwnerEvent createStructurePrepareRemoveOwnerEvent(Structure structure,
 StructureOwner removedOwner,
 @Nullable IPlayer responsible)

Constructs a new IStructurePrepareRemoveOwnerEvent.

Parameters:

structure - The structure from which an owner will be removed.

removedOwner - The StructureOwner that is to be removed from the structure.

responsible - The IPlayer responsible for the action, if a player was responsible for it.

createStructurePrepareRemoveOwnerEvent

default IStructurePrepareRemoveOwnerEvent createStructurePrepareRemoveOwnerEvent(Structure structure,
 StructureOwner removedOwner)

Constructs a new IStructurePrepareRemoveOwnerEvent and assumes the owner was not removed by an IPlayer.

If the owner is removed by a player, consider using createStructurePrepareRemoveOwnerEvent(Structure, StructureOwner, IPlayer) instead.

Parameters:

structure - The structure from which an owner will be removed.

removedOwner - The StructureOwner that is to be removed from the structure.

createStructurePrepareLockChangeEvent

IStructurePrepareLockChangeEvent createStructurePrepareLockChangeEvent(Structure structure,
 boolean newLockStatus,
 @Nullable IPlayer responsible)

Constructs a new IStructurePrepareLockChangeEvent.

Parameters:

structure - The structure to which the lock status is to be changed

newLockStatus - The new locked status of the structure.

responsible - The IPlayer responsible for the action, if a player was responsible for it.

createStructurePrepareLockChangeEvent

default IStructurePrepareLockChangeEvent createStructurePrepareLockChangeEvent(Structure structure,
 boolean newLockStatus)

Constructs a new IStructurePrepareLockChangeEvent and assumes it was not added by an IPlayer.

If the owner is added by a player, consider using createStructurePrepareLockChangeEvent(Structure, boolean, IPlayer) instead.

Parameters:

structure - The structure to which the lock status is to be changed

newLockStatus - The new locked status of the structure.

createTogglePrepareEvent

IStructureEventTogglePrepare createTogglePrepareEvent(StructureSnapshot snapshot,
 StructureActionCause cause,
 StructureActionType actionType,
 IPlayer responsible,
 double time,
 boolean skipAnimation,
 Cuboid newCuboid)

Constructs a IStructureEventTogglePrepare.

Parameters:

snapshot - The snapshot of the structure.

cause - What caused the action.

actionType - The type of action.

responsible - Who is responsible for this structure. Either the player who directly toggled it (via a command or the GUI), or the original creator when this data is not available.

time - The number of seconds the structure will take to open. Note that there are other factors that affect the total time as well.

skipAnimation - If true, the structure will skip the animation and open instantly.

newCuboid - The Cuboid representing the area the structure will take up after the toggle.

createToggleStartEvent

IStructureEventToggleStart createToggleStartEvent(Structure structure,
 StructureSnapshot structureSnapshot,
 StructureActionCause cause,
 StructureActionType actionType,
 IPlayer responsible,
 double time,
 boolean skipAnimation,
 Cuboid newCuboid)

Constructs a IStructureEventToggleStart.

Parameters:

structure - The structure itself.

structureSnapshot - A snapshot of the structure created at the time the toggle action was requested.

cause - What caused the action.

actionType - The type of action.

responsible - Who is responsible for this structure. Either the player who directly toggled it (via a command or the GUI), or the original creator when this data is not available.

time - The number of seconds the structure will take to open. Note that there are other factors that affect the total time as well.

skipAnimation - If true, the structure will skip the animation and open instantly.

newCuboid - The Cuboid representing the area the structure will take up after the toggle.

createToggleEndEvent

IStructureEventToggleEnd createToggleEndEvent(Structure structure,
 StructureSnapshot snapshot,
 StructureActionCause cause,
 StructureActionType actionType,
 IPlayer responsible,
 double time,
 boolean skipAnimation)

Constructs a IStructureEventToggleEnd.

Parameters:

structure - The structure.

snapshot - A snapshot of the structure created when the structure was preparing to toggle.

cause - What caused the action.

actionType - The type of action.

responsible - Who is responsible for this structure. Either the player who directly toggled it (via a command or the GUI), or the original creator when this data is not available.

time - The number of seconds the structure will take to open. Note that there are other factors that affect the total time as well.

skipAnimation - If true, the structure will skip the animation and open instantly.