Interface IStructureEventToggleStart

All Superinterfaces:

IAnimatedArchitectureEvent, IStructureToggleEvent

All Known Implementing Classes:

StructureEventToggleStart

public interface IStructureEventToggleStart
extends IStructureToggleEvent

Represents a toggle action that will be applied to a structure.If you want to cancel the action, use IStructureEventTogglePrepare instead.

Method Summary

Modifier and Type	Method	Description
Cuboid	getNewCuboid()	Gets the new coordinates of the structure after the toggle.
Structure	getStructure()	Gets the structure that is the subject of this event.

Methods inherited from interface IAnimatedArchitectureEvent

getEventName, isAsynchronous

Methods inherited from interface IStructureToggleEvent

getActionType, getCause, getResponsible, getSnapshot, getTime, isAnimationSkipped

Method Details

getStructure

Structure getStructure()

Gets the structure that is the subject of this event.

Note that this structure is not the same as the structure in the snapshot. The snapshot contains the old data of the structure before the animation was applied. The structure, however, may already have been modified.

Returns:

The structure.

getNewCuboid

Cuboid getNewCuboid()

Gets the new coordinates of the structure after the toggle.

Returns:

The new coordinates of the structure after the toggle.