Kiln API / kiln / despawnOnExit

Function: despawnOnExit()

function despawnOnExit<S>(s, value): [Trait<{
  state: string;
  value: string;
}>, Partial<{
  state: string;
  value: string;
}>];

The DespawnOnExit trait for a state value: commands.spawn(Enemy, ..., despawnOnExit(Screen, 'playing')).

Type Parameters

Type Parameter
S extends string

Parameters

Parameter	Type
s	State<S>
value	S

Returns

[Trait<{ state: string; value: string; }>, Partial<{ state: string; value: string; }>]