Skip to main content

UseFlag

This is represented as an object instead of an enum due to limitations with TypeScript enums. (We want this type to be a child of the BitFlag type.)

Not Exported

Enumeration Members

NO_ANIMATION

NO_ANIMATION = number

Don't play use animations.

1 << 0 (1)

Defined in

flags/UseFlag.ts:15


NO_COSTUME

NO_COSTUME = number

Don't add costume.

1 << 1 (2)

Defined in

flags/UseFlag.ts:22


OWNED

OWNED = number

Effect was triggered by an active item owned by the player.

1 << 2 (4)

Defined in

flags/UseFlag.ts:29


ALLOW_NON_MAIN_PLAYERS

ALLOW_NON_MAIN_PLAYERS = number

Allow the effect to trigger on non-main players (i.e. coop babies).

1 << 3 (8)

Defined in

flags/UseFlag.ts:36


REMOVE_ACTIVE

REMOVE_ACTIVE = number

D4 only: Reroll the player's active item.

1 << 4 (16)

Defined in

flags/UseFlag.ts:43


CAR_BATTERY

CAR_BATTERY = number

Effect was triggered a second time by Car Battery (or Tarot Cloth for cards).

1 << 5 (32)

Defined in

flags/UseFlag.ts:50


VOID

VOID = number

Effect was triggered by Void.

1 << 6 (64)

Defined in

flags/UseFlag.ts:57


MIMIC

MIMIC = number

Effect was mimicked by an active item (Blank Card, Placebo).

1 << 7 (128)

Defined in

flags/UseFlag.ts:64


NO_ANNOUNCER_VOICE

NO_ANNOUNCER_VOICE = number

Never play announcer voice.

1 << 8 (256)

Defined in

flags/UseFlag.ts:71


ALLOW_WISP_SPAWN

ALLOW_WISP_SPAWN = number

This allows an item to spawn wisps when called from another item usage as the wisps generator checks for NO_ANIMATION, so usually you want to use this with NO_ANIMATION call.

1 << 9 (512)

Defined in

flags/UseFlag.ts:79


CUSTOM_VARDATA

CUSTOM_VARDATA = number

If set, forces UseActiveItem to use the CustomVarData argument instead of the active item's stored VarData.

1 << 10 (1024)

Defined in

flags/UseFlag.ts:87


NO_HUD

NO_HUD = number

Don't display text in the HUD. (This is currently only used by Echo Chamber.)

1 << 11 (2048)

Defined in

flags/UseFlag.ts:94