Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface MaskingLibrary.CompiledZMask

All Known Implementing Classes:

MUDZapper.CompiledZapperMaskImpl

Enclosing interface:

MaskingLibrary

public static interface MaskingLibrary.CompiledZMask

A Compiled ZapperMask is a set of conditions, typically of the form VALUE in SET, KEY=VALUE or VALUE, etc. These masks are used to select among a stream of objects, in order to determine the objects eligibility for some purpose. The most common use is as a mask to determine whether some mob is able to do something, or will have something happen to them. ZapperMasks are made up of one or more entries, as mentioned above. These entries have an implicit AND connector between them, whereas the entries themselves are typically an internal OR (see above).

See Also:

MaskingLibrary.CompiledZMaskEntry

Method Summary

Modifier and Type	Method	Description
boolean	empty()	Returns whether the mask is empty and always passes
MaskingLibrary.CompiledZMaskEntry[][]	entries()	Returns a list of ZapperMask entries, where all the list entries must pass for the mask to pass
boolean	useItemFlag()	As some mask entries only apply to items, set this flag if an item MIGHT be masked, or if the mask contains item entries, and thus an item needs creating to do the check.
boolean	useRoomFlag()	As some mask entries only apply to rooms, set this flag if an item MIGHT be masked, or if the mask contains location entries, and thus a room needs referencing to do the check.

Method Detail

entries

MaskingLibrary.CompiledZMaskEntry[][] entries()

Returns a list of ZapperMask entries, where all the list entries must pass for the mask to pass

Returns:

a list of entries

See Also:

MaskingLibrary.CompiledZMaskEntry

empty

boolean empty()

Returns whether the mask is empty and always passes

Returns:

true if this mask always passes

useItemFlag

boolean useItemFlag()

As some mask entries only apply to items, set this flag if an item MIGHT be masked, or if the mask contains item entries, and thus an item needs creating to do the check.

Returns:

true to create an item, false otherwise

useRoomFlag

boolean useRoomFlag()

As some mask entries only apply to rooms, set this flag if an item MIGHT be masked, or if the mask contains location entries, and thus a room needs referencing to do the check.

Returns:

true to create or reference a room, false otherwise