Interface IStructurePrepareLockChangeEvent

All Superinterfaces:

IAnimatedArchitectureEvent, ICancellableAnimatedArchitectureEvent, IStructureEvent

All Known Implementing Classes:

StructurePrepareLockChangeEvent

public interface IStructurePrepareLockChangeEvent
extends IStructureEvent, ICancellableAnimatedArchitectureEvent

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

Method Summary

Modifier and Type	Method	Description
boolean	newLockStatus()	The new lock status of the Structure that will be applied if this event is not cancelled.

Methods inherited from interface IAnimatedArchitectureEvent

getEventName, isAsynchronous

Methods inherited from interface ICancellableAnimatedArchitectureEvent

isCancelled, setCancelled

Methods inherited from interface IStructureEvent

getResponsible, getStructure

Method Details

newLockStatus

boolean newLockStatus()

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

Returns:

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