Note

HELP WANTED!

Most class reference pages are not fully covered yet! If you have more information, please consider Contributing!

CharacterState

Inherits: ObjectState < StateInterface < Node < Object

No description provided.

Overview

Properties Index

void

@export _c_Air_Data

null

void

@export _c_Interrupt_Categories

null

void

@export _c_Interrupt_Data

null

void

@export _c_Menu

null

void

@export _c_Misc

null

void

@export _c_Stances

null

void

@export _c_Super

null

AirType

@export air_type

AirType.Grounded

bool

@export allow_framecheat

false

String

@export allowed_stances_string

"Normal"

bool

@export apply_pushback

true

bool

@export backdash_iasa

false

bool

@export beats_backdash

false

bool

@export burst_cancellable

true

bool

@export burstable

true

BusyInterrupt

@export busy_interrupt_type

BusyInterrupt.Normal

Texture

@export button_texture

null

bool

@export can_be_counterhit

true

bool

@export can_feint_if_possible

true

String

@export change_stance_to

""

bool

@export combo_only

false

PackedScene

@export data_ui_scene

null

bool

@export dynamic_iasa

true

bool

@export end_feint

true

bool

@export flip_icon

true

bool

@export flip_with_facing

false

bool

@export force_feintable

false

String

@export hit_cancel_exceptions_string

null

String

@export hit_cancel_into_string

null

int

@export iasa_at

- 1

int

@export iasa_on_hit

- 1

bool

@export iasa_on_hit_on_block

true

bool

@export initiative_effect

false

int

@export initiative_startup_reduction_amount

0

bool

@export instant_cancellable

true

String

@export interrupt_exceptions_string

null

Array

@export interrupt_frames

\[\]

String

@export interrupt_from_string

null

String

@export interrupt_into_string

null

bool

@export interruptible_on_opponent_turn

false

bool

@export land_cancel

false

int

@export landing_recovery

- 1

int

@export min_land_cancel_frame

- 1

bool

@export neutral_only

false

bool

@export next_state_on_hold

true

bool

@export next_state_on_hold_on_opponent_turn

false

int

@export no_collision_end_frame

- 1

int

@export no_collision_start_frame

- 1

bool

@export release_opponent_on_exit

false

bool

@export release_opponent_on_startup

false

bool

@export reversible

true

bool

@export scale_combo_meter_

false

bool

@export selectable

true

bool

@export self_hit_cancellable

true

bool

@export self_interruptable

true

bool

@export show_in_menu

true

bool

@export super_effect_

false

int

@export super_freeze_ticks_

15

int

@export super_level_

0

int

@export supers_used_

- 1

bool

@export throw_techable

false

int

@export tick_priority

0

String

@export title

null

ActionType

@export type

null

bool

@export update_facing_on_exit

true

bool

@export usable_from_whiff_cancel_if_possible

true

bool

@export uses_air_movement

false

fixed

@export velocity_forward_meter_gain_multiplier

"1.0"

fixed

@export whiff_meter_gain_multiplier

"1.0"

Array

allowed_stances

\[\]

Array

busy_interrupt_into

\[\]

bool

dash_iasa

false

bool

feinted_last

false

bool

feinting

false

bool

hit_anything

false

Array

hit_cancel_exceptions

\[\]

Array

hit_cancel_into

\[\]

bool

hit_cancelled

false

bool

hit_yet

false

bool

initiative_effect_spawned

false

bool

initiative_startup_reduction

false

Array

interrupt_exceptions

\[\]

Array

interrupt_from

\[\]

Array

interrupt_into

\[\]

bool

is_brace

false

bool

is_hurt_state

false

bool

start_interruptible_on_opponent_turn

false

bool

started_during_combo

false

bool

started_in_air

false

int

starting_iasa_at

- 1

Array

starting_interrupt_frames

\[\]

Array

usable_requirement_nodes

\[\]

bool

was_blocked

false

Methods Index

Variant

_can_hit_cancel(obj: Variant, hitbox: Variant)

void

_enter_shared()

void

_exit_shared()

void

_frame_0_shared()

void

_on_hit_something(obj: Variant, hitbox: Variant)

void

_tick_after()

Variant

_tick_shared()

Variant

allowed_in_stance()

Variant

can_feint()

Variant

can_hit_cancel()

Variant

can_interrupt()

void

enable_hit_cancel(projectile: bool)

Variant

enable_interrupt(check_opponent: bool, remove_hitlag: bool)

Variant

get_allowed_stances()

Variant

get_busy_interrupt_into()

Variant

get_categories(string: String)

Variant

get_hit_cancel_exceptions()

Variant

get_hit_cancel_into()

Variant

get_interrupt_exceptions()

Variant

get_interrupt_from()

Variant

get_interrupt_into()

Variant

get_ui_category()

Variant

get_velocity_forward_meter_gain_multiplier()

void

init()

void

initiative_effect()

Variant

is_usable()

Variant

is_usable_with_grounded_check(force_aerial: bool, force_grounded: bool)

void

on_continue()

void

on_got_hit()

void

opponent_turn_interrupt()

void

process_hitboxes()

void

spawn_exported_projectile()

void

try_hit_cancel(obj: Variant, hitbox: Variant)

void

update_parameters()

void

update_sprite_frame()


Signals

state_hit_cancellable() πŸ”—

No description provided.


state_interruptable() πŸ”—

No description provided.


Constants

int WHIFF_SUPER_GAIN = 10 πŸ”—

No description provided.


Property Descriptions

@export

void _c_Air_Data = null πŸ”—

No description provided.


@export

void _c_Interrupt_Categories = null πŸ”—

No description provided.


@export

void _c_Interrupt_Data = null πŸ”—

No description provided.


@export

void _c_Menu = null πŸ”—

No description provided.


@export

void _c_Misc = null πŸ”—

No description provided.


@export

void _c_Stances = null πŸ”—

No description provided.


@export

void _c_Super = null πŸ”—

No description provided.


@export

AirType air_type = AirType.Grounded πŸ”—

No description provided.


@export

bool allow_framecheat = false πŸ”—

No description provided.


@export

String allowed_stances_string = "Normal" πŸ”—

No description provided.


@export

bool apply_pushback = true πŸ”—

No description provided.


@export

bool backdash_iasa = false πŸ”—

No description provided.


@export

bool beats_backdash = false πŸ”—

No description provided.


@export

bool burst_cancellable = true πŸ”—

No description provided.


@export

bool burstable = true πŸ”—

No description provided.


@export

BusyInterrupt busy_interrupt_type = BusyInterrupt.Normal πŸ”—

No description provided.


@export

Texture button_texture = null πŸ”—

No description provided.


@export

bool can_be_counterhit = true πŸ”—

No description provided.


@export

bool can_feint_if_possible = true πŸ”—

No description provided.


@export

String change_stance_to = "" πŸ”—

No description provided.


@export

bool combo_only = false πŸ”—

No description provided.


@export

PackedScene data_ui_scene = null πŸ”—

No description provided.


@export

bool dynamic_iasa = true πŸ”—

If true, sets ^interruptible_on_opponent_turn to true after the first interrupt turn during the use of this state.


@export

bool end_feint = true πŸ”—

No description provided.


@export

bool flip_icon = true πŸ”—

No description provided.


@export

bool flip_with_facing = false πŸ”—

No description provided.


@export

bool force_feintable = false πŸ”—

No description provided.


@export

String hit_cancel_exceptions_string = null πŸ”—

No description provided.


@export

String hit_cancel_into_string = null πŸ”—

No description provided.


@export

int iasa_at = - 1 πŸ”—

The tick number (0 being when the state starts) when the player will get their next interrupt turn.

Negative numbers will be converted during ^init() to be that many ticks before ^ObjectState.anim_length , with the default of -1 being the tick this state naturally ends.

Has no effect if ^ObjectState.endless is true, or ^interrupt_into_string is empty.


@export

int iasa_on_hit = - 1 πŸ”—

The tick number (0 being when the state starts) when the player will get their next interrupt turn if one of this state’s hitboxes hits something during this state’s use.

Negative values have no effect.

Has no effect if ^ObjectState.endless is true, or ^interrupt_into_string is empty.


@export

bool iasa_on_hit_on_block = true πŸ”—

Whether or not ^iasa_on_hit has any effect when hitting the opponents block.


@export

bool initiative_effect = false πŸ”—

No description provided.


@export

int initiative_startup_reduction_amount = 0 πŸ”—

No description provided.


@export

bool instant_cancellable = true πŸ”—

No description provided.


@export

String interrupt_exceptions_string = null πŸ”—

No description provided.


@export

Array interrupt_frames = \[\] πŸ”—

Array of tick numbers (0 being when the state starts) when the player will get additional interrupt turns.

Has no effect if ^ObjectState.endless is true, or ^interrupt_into_string is empty.


@export

String interrupt_from_string = null πŸ”—

No description provided.


@export

String interrupt_into_string = null πŸ”—

No description provided.


@export

bool interruptible_on_opponent_turn = false πŸ”—

If true, during this state’s use, the player will gain interrupt turns at the same time as the opponent’s interrupt turns.


@export

bool land_cancel = false πŸ”—

No description provided.


@export

int landing_recovery = - 1 πŸ”—

No description provided.


@export

int min_land_cancel_frame = - 1 πŸ”—

No description provided.


@export

bool neutral_only = false πŸ”—

No description provided.


@export

bool next_state_on_hold = true πŸ”—

If true, the player locking in the β€œHold” button on early turns before this state ends will cause the fighter to transition to ^ObjectState.fallback_state , rather than stay and continue the rest of state.

Has no effect on the opponents turn unless ^next_state_on_hold_on_opponent_turn is true.


@export

bool next_state_on_hold_on_opponent_turn = false πŸ”—

Whether or not ^next_state_on_hold will also cause a state transition on opponents turns.


@export

int no_collision_end_frame = - 1 πŸ”—

No description provided.


@export

int no_collision_start_frame = - 1 πŸ”—

No description provided.


@export

bool release_opponent_on_exit = false πŸ”—

No description provided.


@export

bool release_opponent_on_startup = false πŸ”—

No description provided.


@export

bool reversible = true πŸ”—

No description provided.


@export

bool scale_combo_meter_ = false πŸ”—

No description provided.


@export

bool selectable = true πŸ”—

No description provided.


@export

bool self_hit_cancellable = true πŸ”—

No description provided.


@export

bool self_interruptable = true πŸ”—

No description provided.


@export

bool show_in_menu = true πŸ”—

No description provided.


@export

bool super_effect_ = false πŸ”—

No description provided.


@export

int super_freeze_ticks_ = 15 πŸ”—

No description provided.


@export

int super_level_ = 0 πŸ”—

No description provided.


@export

int supers_used_ = - 1 πŸ”—

No description provided.


@export

bool throw_techable = false πŸ”—

No description provided.


@export

int tick_priority = 0 πŸ”—

No description provided.


@export

String title = null πŸ”—

No description provided.


@export

ActionType type = null πŸ”—

No description provided.


@export

bool update_facing_on_exit = true πŸ”—

No description provided.


@export

bool usable_from_whiff_cancel_if_possible = true πŸ”—

No description provided.


@export

bool uses_air_movement = false πŸ”—

No description provided.


@export

fixed velocity_forward_meter_gain_multiplier = "1.0" πŸ”—

No description provided.


@export

fixed whiff_meter_gain_multiplier = "1.0" πŸ”—

No description provided.


Array allowed_stances = \[\] πŸ”—

No description provided.


Array busy_interrupt_into = \[\] πŸ”—

No description provided.


bool dash_iasa = false πŸ”—

No description provided.


bool feinted_last = false πŸ”—

No description provided.


bool feinting = false πŸ”—

No description provided.


bool hit_anything = false πŸ”—

No description provided.


Array hit_cancel_exceptions = \[\] πŸ”—

No description provided.


Array hit_cancel_into = \[\] πŸ”—

No description provided.


bool hit_cancelled = false πŸ”—

No description provided.


bool hit_yet = false πŸ”—

No description provided.


bool initiative_effect_spawned = false πŸ”—

No description provided.


bool initiative_startup_reduction = false πŸ”—

No description provided.


Array interrupt_exceptions = \[\] πŸ”—

No description provided.


Array interrupt_from = \[\] πŸ”—

No description provided.


Array interrupt_into = \[\] πŸ”—

No description provided.


bool is_brace = false πŸ”—

No description provided.


bool is_hurt_state = false πŸ”—

No description provided.


bool start_interruptible_on_opponent_turn = false πŸ”—

No description provided.


bool started_during_combo = false πŸ”—

No description provided.


bool started_in_air = false πŸ”—

No description provided.


int starting_iasa_at = - 1 πŸ”—

No description provided.


Array starting_interrupt_frames = \[\] πŸ”—

No description provided.


Array usable_requirement_nodes = \[\] πŸ”—

No description provided.


bool was_blocked = false πŸ”—

No description provided.


Method Descriptions

Variant _can_hit_cancel(obj: Variant, hitbox: Variant) πŸ”—

No description provided.


void _enter_shared() πŸ”—

No description provided.


void _exit_shared() πŸ”—

No description provided.


void _frame_0_shared() πŸ”—

No description provided.


void _on_hit_something(obj: Variant, hitbox: Variant) πŸ”—

No description provided.


void _tick_after() πŸ”—

No description provided.


Variant _tick_shared() πŸ”—

No description provided.


Variant allowed_in_stance() πŸ”—

No description provided.


Variant can_feint() πŸ”—

No description provided.


Variant can_hit_cancel() πŸ”—

No description provided.


Variant can_interrupt() πŸ”—

No description provided.


void enable_hit_cancel(projectile: bool) πŸ”—

No description provided.


Variant enable_interrupt(check_opponent: bool, remove_hitlag: bool) πŸ”—

No description provided.


Variant get_allowed_stances() πŸ”—

No description provided.


Variant get_busy_interrupt_into() πŸ”—

No description provided.


Variant get_categories(string: String) πŸ”—

No description provided.


Variant get_hit_cancel_exceptions() πŸ”—

No description provided.


Variant get_hit_cancel_into() πŸ”—

No description provided.


Variant get_interrupt_exceptions() πŸ”—

No description provided.


Variant get_interrupt_from() πŸ”—

No description provided.


Variant get_interrupt_into() πŸ”—

No description provided.


Variant get_ui_category() πŸ”—

No description provided.


Variant get_velocity_forward_meter_gain_multiplier() πŸ”—

No description provided.


void init() πŸ”—

No description provided.


void initiative_effect() πŸ”—

No description provided.


Variant is_usable() πŸ”—

No description provided.


Variant is_usable_with_grounded_check(force_aerial: bool, force_grounded: bool) πŸ”—

No description provided.


void on_continue() πŸ”—

No description provided.


void on_got_hit() πŸ”—

No description provided.


void opponent_turn_interrupt() πŸ”—

No description provided.


void process_hitboxes() πŸ”—

No description provided.


void spawn_exported_projectile() πŸ”—

No description provided.


void try_hit_cancel(obj: Variant, hitbox: Variant) πŸ”—

No description provided.


void update_parameters() πŸ”—

No description provided.


void update_sprite_frame() πŸ”—

No description provided.