PickupKind class final

The kinds of entity a shooter's levels contain beyond the format's own.

EntityTypes keeps the vocabulary true of any level whatever the game is — a spawn point, a door, a lift, a button, a trigger, an exit, a light. What a pickup gives, what a key unlocks and what a note says are this genre's, and they left the format the day the format stopped being one game's.

Constructors

PickupKind(GiftRegistry gifts)
const

Properties

gifts → GiftRegistry
What a gives string may name, and what it grants.
final
gives → Iterable<String>
What a document may ask for, taken from the registry rather than listed again here: two lists of the same names is one list too many.
no setter
hashCode → int
The hash code for this object.
no setterinherited
mustBeReachable → bool
Whether a player has to be able to get to one of these.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → String
The string that appears in a level document.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
place(EntityDef entity, SpawnContext context, {required ColliderKind kind, int layer = CollisionLayers.world, int mask = CollisionLayers.all, Vector3? fallbackSize}) → Collider
Puts the box this entity brings with it into the world.
inherited
requireKeyExists(EntityDef entity, LevelScope scope, List<LevelIssue> out) → void
Reports that a key this entity demands exists nowhere in the level.
inherited
requireSize(EntityDef entity, LevelScope scope, List<LevelIssue> out) → void
Reports that an entity which has to occupy space does not say how much.
inherited
requireTarget(EntityDef entity, LevelScope scope, List<LevelIssue> out, {bool optional = false}) → void
Reports that a named reference does not resolve.
inherited
requireText(EntityDef entity, LevelScope scope, List<LevelIssue> out, String key) → void
inherited
requireTravel(EntityDef entity, LevelScope scope, List<LevelIssue> out) → void
Reports that a movement offset is missing or goes nowhere.
inherited
spawn(EntityDef entity, SpawnContext context) → void
Brings this entity into the world.
toString() → String
A string representation of this object.
inherited
validate(EntityDef entity, LevelScope scope, List<LevelIssue> out) → void
Checks one entity of this kind, in the context of the level around it.

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

defaultSize → Vector3
A panel of light on the floor, roughly the size of what it represents.
no setter