Note

HELP WANTED!

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

Hitbox

Inherits: CollisionBox < Node2D < CanvasItem < Node < Object

No description provided.

Overview

Properties Index

void	@export _c_Block_Properties	`null`
void	@export _c_Damage	`null`
void	@export _c_Frame_Data	`null`
void	@export _c_Fx	`null`
void	@export _c_Grouping	`null`
void	@export _c_Hit_Properties	`null`
void	@export _c_Knockback	`null`
void	@export _c_Knockback_Type	`null`
void	@export _c_Loop_Data	`null`
void	@export _c_Sfx	`null`
bool	@export activated	`true`
int	@export active_ticks	`5`
String	@export aerial_hit_state	`"HurtAerial"`
bool	@export air_ground_bounce	`false`
bool	@export always_on	`false`
bool	@export bass_on_whiff	`false`
bool	@export beats_grab	`true`
bool	@export block_cancel_allowed	`true`
bool	@export block_punishable	`false`
String	@export block_pushback_modifier	`"1.0"`
bool	@export bump_on_whiff	`false`
Vector2	@export camera_bump_dir	`Vector2()`
bool	@export can_clash	`true`
bool	@export can_counter_hit	`true`
bool	@export cancellable	`true`
fixed	@export chip_damage_modifier	`"1.0"`
int	@export combo_hitstun_ticks	`- 1`
int	@export combo_scaling_amount	`1`
int	@export damage	`0`
int	@export damage_in_combo	`- 1`
int	@export damage_proration	`0`
fixed	@export di_modifier	`"1.0"`
String	@export dir_x	`"1.0"`
String	@export dir_y	`"-1.0"`
bool	@export disable_collision	`true`
String	@export followup_state	`""`
bool	@export force_grounded	`false`
bool	@export ground_bounce	`true`
fixed	@export ground_bounce_knockback_modifier	`"1.0"`
String	@export grounded_hit_state	`"HurtGrounded"`
int	@export group	`0`
bool	@export guard_break	`false`
bool	@export hard_knockdown	`false`
AudioStream	@export hit_bass_sound	`preload("res://sound/common/hit\_bass.wav")`
Hitbox.HitHeight	@export hit_height	`HitHeight.Mid`
PackedScene	@export hit_particle	`null`
AudioStream	@export hit_sound	`preload("res://sound/common/hit1.wav")`
float	@export hit_sound_volume	`- 5.0`
HitboxType	@export hitbox_type	`HitboxType.Normal`
int	@export hitlag_ticks	`4`
bool	@export hits_otg	`false`
bool	@export hits_projectiles	`true`
bool	@export hits_vs_aerial	`true`
bool	@export hits_vs_dizzy	`true`
bool	@export hits_vs_grounded	`true`
bool	@export hits_vs_standing	`true`
int	@export hitstun_ticks	`30`
bool	@export ignore_armor	`false`
bool	@export ignore_projectile_armor	`false`
bool	@export increment_combo	`true`
String	@export knockback	`"10.0"`
bool	@export knockdown	`false`
bool	@export knockdown_extends_hitstun	`true`
bool	@export launch_reversible	`false`
int	@export loop_active_ticks	`2`
int	@export loop_inactive_ticks	`2`
bool	@export looping	`false`
fixed	@export meter_gain_modifier	`"1.0"`
int	@export minimum_damage	`0`
int	@export minimum_grounded_frames	`- 1`
int	@export parry_meter_gain	`- 1`
int	@export plus_frames	`0`
int	@export priority	`0`
String	@export pushback_x	`"1.0"`
bool	@export replace_hit_particle	`false`
bool	@export rumble	`true`
bool	@export scale_combo	`true`
int	@export screenshake_amount	`4`
int	@export screenshake_frames	`- 1`
fixed	@export sdi_modifier	`"1.0"`
bool	@export send_away_from_center	`false`
int	@export start_tick	`0`
bool	@export vacuum	`false`
int	@export victim_hitlag	`- 1`
bool	@export wall_slam	`false`
PackedScene	@export whiff_particle	`null`
AudioStream	@export whiff_sound	`preload("res://sound/common/whiff1.wav")`
float	@export whiff_sound_volume	`- 8.0`
bool	active	`false`
bool	enabled	`false`
Array	grouped_hitboxes	`\[\]`
VariableSound2D	hit_bass_sound_player	`null`
Array	hit_objects	`\[\]`
PackedScene	HIT_PARTICLE	`preload("res://fx/HitEffect1.tscn")`
VariableSound2D	hit_sound_player	`null`
BaseObj	host	`null`
NativeMethods	native	`null`
bool	played_whiff_sound	`false`
PoolStringArray	property_list	`null`
bool	spawn_particle_effect	`true`
bool	throw	`false`
int	tick	`1`
VariableSound2D	whiff_sound_player	`null`

Methods Index

void	activate()
bool	already_hit_object(obj: Variant)
bool	can_draw_box()
void	copy_to(hitbox: CollisionBox)
void	deactivate()
float	get_angle_float(facing: bool)
Vector2	get_dir_float(facing: bool)
int	get_facing_int()
int	get_real_hitstun()
fixed	get_real_knockback()
void	hit(obj: Variant)
void	init()
bool	is_counter_hit()
bool	is_projectile()
bool	otg_check(obj: Variant)
void	play_whiff_sound()
void	save_hit_object(obj: Variant)
void	setup_audio()
void	spawn_particle(particle: Variant, obj: Variant, dir: Variant)
void	spawn_whiff_particle()
void	tick()
HitboxData	to_data()
void	update_property_list()

Signals

got_parried() 🔗

No description provided.

hit_something(obj: Variant, hitbox: Variant) 🔗

No description provided.

Constants

fixed COMBO_PUSHBACK_COEFFICIENT = "0.4" 🔗

No description provided.

int COMBO_SAME_MOVE_HITSTUN_DECREASE_AMOUNT = 1 🔗

No description provided.

fixed COMBO_SAME_MOVE_KNOCKBACK_INCREASE_AMOUNT_AERIAL = "1.05" 🔗

No description provided.

fixed COMBO_SAME_MOVE_KNOCKBACK_INCREASE_AMOUNT_GROUNDED = "1.25" 🔗

No description provided.

PackedScene DEFAULT_HIT_PARTICLE = preload("res://fx/HitEffect1.tscn") 🔗

No description provided.

fixed MAX_KNOCKBACK = "30" 🔗

No description provided.

Property Descriptions

@export

void _c_Block_Properties = null 🔗

No description provided.

@export

void _c_Damage = null 🔗

No description provided.

@export

void _c_Frame_Data = null 🔗

No description provided.

@export

void _c_Fx = null 🔗

No description provided.

@export

void _c_Grouping = null 🔗

No description provided.

@export

void _c_Hit_Properties = null 🔗

No description provided.

@export

void _c_Knockback = null 🔗

No description provided.

@export

void _c_Knockback_Type = null 🔗

No description provided.

@export

void _c_Loop_Data = null 🔗

No description provided.

@export

void _c_Sfx = null 🔗

No description provided.

@export

bool activated = true 🔗

No description provided.

@export

int active_ticks = 5 🔗

No description provided.

@export

String aerial_hit_state = "HurtAerial" 🔗

No description provided.

@export

bool air_ground_bounce = false 🔗

No description provided.

@export

bool always_on = false 🔗

No description provided.

@export

bool bass_on_whiff = false 🔗

No description provided.

@export

bool beats_grab = true 🔗

No description provided.

@export

bool block_cancel_allowed = true 🔗

If true, hitting the opponent while they are blocking will grant them an interrupt turn. Note that if the opponent Perfect Parries, they will gain an interrupt turn regardless of what value this is set to.

@export

bool block_punishable = false 🔗

If false, hitting the opponent while they are soft blocking (without a **Perfect Parry*)* will cause the player to gain their next interrupt turn on their opponents next turn. This generally means that if true, the player will not get a turn when hitting the opponents block.

Has no effect if ^block_cancel_allowed is false, or if the parent ^CharacterState.interruptible_on_opponent_turn is true.

@export

String block_pushback_modifier = "1.0" 🔗

No description provided.

@export

bool bump_on_whiff = false 🔗

No description provided.

@export

Vector2 camera_bump_dir = Vector2() 🔗

No description provided.

@export

bool can_clash = true 🔗

No description provided.

@export

bool can_counter_hit = true 🔗

No description provided.

@export

bool cancellable = true 🔗

No description provided.

@export

fixed chip_damage_modifier = "1.0" 🔗

No description provided.

@export

int combo_hitstun_ticks = - 1 🔗

No description provided.

@export

int combo_scaling_amount = 1 🔗

No description provided.

@export

int damage = 0 🔗

No description provided.

@export

int damage_in_combo = - 1 🔗

No description provided.

@export

int damage_proration = 0 🔗

No description provided.

@export

fixed di_modifier = "1.0" 🔗

No description provided.

@export

String dir_x = "1.0" 🔗

No description provided.

@export

String dir_y = "-1.0" 🔗

No description provided.

@export

bool disable_collision = true 🔗

No description provided.

@export

String followup_state = "" 🔗

No description provided.

@export

bool force_grounded = false 🔗

No description provided.

@export

bool ground_bounce = true 🔗

No description provided.

@export

fixed ground_bounce_knockback_modifier = "1.0" 🔗

No description provided.

@export

String grounded_hit_state = "HurtGrounded" 🔗

No description provided.

@export

int group = 0 🔗

No description provided.

@export

bool guard_break = false 🔗

If true, this hitbox will bypass the opponents block unless they Perfect Parry.

@export

bool hard_knockdown = false 🔗

No description provided.

@export

AudioStream hit_bass_sound = preload("res://sound/common/hit\_bass.wav") 🔗

No description provided.

@export

Hitbox.HitHeight hit_height = HitHeight.Mid 🔗

The height the opponent must select during for a block in order to Perfect Parry this hitbox. (Note that the opponent must also select the tick they are getting hit in order to **Perfect Parry*)*

A height of Mid counts as height of High.

@export

PackedScene hit_particle = null 🔗

No description provided.

@export

AudioStream hit_sound = preload("res://sound/common/hit1.wav") 🔗

No description provided.

@export

float hit_sound_volume = - 5.0 🔗

No description provided.

@export

HitboxType hitbox_type = HitboxType.Normal 🔗

No description provided.

@export

int hitlag_ticks = 4 🔗

No description provided.

@export

bool hits_otg = false 🔗

No description provided.

@export

bool hits_projectiles = true 🔗

No description provided.

@export

bool hits_vs_aerial = true 🔗

No description provided.

@export

bool hits_vs_dizzy = true 🔗

No description provided.

@export

bool hits_vs_grounded = true 🔗

No description provided.

@export

bool hits_vs_standing = true 🔗

No description provided.

@export

int hitstun_ticks = 30 🔗

No description provided.

@export

bool ignore_armor = false 🔗

No description provided.

@export

bool ignore_projectile_armor = false 🔗

No description provided.

@export

bool increment_combo = true 🔗

No description provided.

@export

String knockback = "10.0" 🔗

No description provided.

@export

bool knockdown = false 🔗

No description provided.

@export

bool knockdown_extends_hitstun = true 🔗

No description provided.

@export

bool launch_reversible = false 🔗

No description provided.

@export

int loop_active_ticks = 2 🔗

No description provided.

@export

int loop_inactive_ticks = 2 🔗

No description provided.

@export

bool looping = false 🔗

No description provided.

@export

fixed meter_gain_modifier = "1.0" 🔗

No description provided.

@export

int minimum_damage = 0 🔗

No description provided.

@export

int minimum_grounded_frames = - 1 🔗

No description provided.

@export

int parry_meter_gain = - 1 🔗

No description provided.

@export

int plus_frames = 0 🔗

The amount of ticks the start of the opponents next state will be delayed for after hitting them while they are soft blocking (without a **Perfect Parry*)*.

Negative values will cause the attacker to be delayed instead.

*Tip: values should generally range from -1 to +4 depending on speed, size, and other aspects, while projectiles hitboxes should generally be +2. You can always check the base roster for “balancing advice”*”

@export

int priority = 0 🔗

No description provided.

@export

String pushback_x = "1.0" 🔗

No description provided.

@export

bool replace_hit_particle = false 🔗

No description provided.

@export

bool rumble = true 🔗

No description provided.

@export

bool scale_combo = true 🔗

No description provided.

@export

int screenshake_amount = 4 🔗

No description provided.

@export

int screenshake_frames = - 1 🔗

No description provided.

@export

fixed sdi_modifier = "1.0" 🔗

No description provided.

@export

bool send_away_from_center = false 🔗

No description provided.

@export

int start_tick = 0 🔗

No description provided.

@export

bool vacuum = false 🔗

No description provided.

@export

int victim_hitlag = - 1 🔗

No description provided.

@export

bool wall_slam = false 🔗

No description provided.

@export

PackedScene whiff_particle = null 🔗

No description provided.

@export

AudioStream whiff_sound = preload("res://sound/common/whiff1.wav") 🔗

No description provided.

@export

float whiff_sound_volume = - 8.0 🔗

No description provided.

bool active = false 🔗

No description provided.

bool enabled = false 🔗

No description provided.

Array grouped_hitboxes = \[\] 🔗

No description provided.

VariableSound2D hit_bass_sound_player = null 🔗

No description provided.

Array hit_objects = \[\] 🔗

No description provided.

PackedScene HIT_PARTICLE = preload("res://fx/HitEffect1.tscn") 🔗

No description provided.

VariableSound2D hit_sound_player = null 🔗

No description provided.

BaseObj host = null 🔗

No description provided.

NativeMethods native = null 🔗

No description provided.

bool played_whiff_sound = false 🔗

No description provided.

PoolStringArray property_list = null 🔗

No description provided.

bool spawn_particle_effect = true 🔗

No description provided.

bool throw = false 🔗

No description provided.

int tick = 1 🔗

No description provided.

VariableSound2D whiff_sound_player = null 🔗

No description provided.

Method Descriptions

void activate() 🔗

No description provided.

bool already_hit_object(obj: Variant) 🔗

No description provided.

bool can_draw_box() 🔗

No description provided.

void copy_to(hitbox: CollisionBox) 🔗

No description provided.

void deactivate() 🔗

No description provided.

float get_angle_float(facing: bool) 🔗

No description provided.

Vector2 get_dir_float(facing: bool) 🔗

No description provided.

int get_facing_int() 🔗

No description provided.

int get_real_hitstun() 🔗

No description provided.

fixed get_real_knockback() 🔗

No description provided.

void hit(obj: Variant) 🔗

No description provided.

void init() 🔗

No description provided.

bool is_counter_hit() 🔗

No description provided.

bool is_projectile() 🔗

No description provided.

bool otg_check(obj: Variant) 🔗

No description provided.

void play_whiff_sound() 🔗

No description provided.

void save_hit_object(obj: Variant) 🔗

No description provided.

void setup_audio() 🔗

No description provided.

void spawn_particle(particle: Variant, obj: Variant, dir: Variant) 🔗

No description provided.

void spawn_whiff_particle() 🔗

No description provided.

void tick() 🔗

No description provided.

HitboxData to_data() 🔗

No description provided.

void update_property_list() 🔗

No description provided.