Breaking Changes

https://github.com/Hub-OS/mod-upgrade-tool

0.28

• field:reclaim_column(x) now requires a team: field:reclaim_column(x, team)
• tile:set_team(team, direction) now requires direction

0.27

• Lifetime.Battle now runs during time freeze, use Lifetime.ActiveBattle for the previous behavior
• Renamed aux_prop:require_hit_flag() to aux_prop:require_hit_flags()
• Removed entity:player_hit_state() and entity:player_move_state()
• Flinch is now mutually exclusive with flinch-like statuses, such as paralyze and freeze
• PLAYER_ animation prefix changed to CHARACTER_
• PLAYER_SHOOTING renamed to CHARACTER_SHOOT
  • Related: PLAYER_SWORD has been renamed to CHARACTER_SWING in mods outside of the engine

0.25

• blocks_flags and blocked_by fields in statuses, replaced by mutual_exclusions
• Renamed defense_rule.can_block_func to defense_rule.defense_func
• Renamed defense_rule.filter_statuses_func to defense_rule.filter_func
• Renamed DefenseJudge to Defense

0.20

• Renamed TileState.Hidden to TileState.Void
• Renamed entity:tile_offset() to entity:movement_offset()
• Split tile_state.change_request_func into tile_state.can_replace_func and tile_state.on_replace_func

0.17

• Removed animation:derive_state(), replaced with a new parameter on animation:set_state()

0.13

• Renamed player_form:set_mugshot_texture_path() -> player_form:set_mugshot_texture()

0.12

• Actions no longer revert to previous animation state on completion for non Players.
  • Fixed by defining on_idle_func.
• Renamed [tile:highlight()] to tile:set_highlight()
• Renamed component Lifetimes to Lifetime
• AuxProp increase_/decrease_ effects now add/subtract rather than set final values.

0.11

• Modified field:find_* functions to search through all spawned entities, not just "hittable" entities.
  • Artifacts will now appear in field:find_entities()
  • entity:hittable() can be utilized in the filter function for previous behavior
• Renamed player:get_augments() to player:augments()
• Movement.new() replaced with more specific constructors.
• Renamed player:slide_when_moving() to player:set_slide_when_moving().

0.10

• Renamed card_properties.meta_classes to card_properties.tags
• Renamed sprite:never_flip(bool?) to sprite:set_never_flip(bool?)

0.9

• Replaced AudioPriority with AudioBehavior

0.3

• Renamed "enemies" folder to "encounters"
• Renamed battle_init to encounter_init
• Renamed battle mod category to encounter
• Renamed include to require
• Removed is_ and get_ prefix for direct getters
• Renamed Engine to Resources
• Renamed Engine.stream_music() to Resources.play_music()
• Move Engine turn gauge functions to TurnGauge
• Removed Battle. prefix
• Renamed Battle.CardAction to Action
• Renamed card_properties.shortname to card_properties.short_name
• Renamed entity:card_action_event() to entity:queue_action()
• Renamed action:get_actor() to action:owner()
• Renamed action:copy_metadata() to action:copy_card_properties()
  • Replacement / removal is under consideration.
• Renamed action:set_metadata() to action:set_card_properties()
  • Replacement / removal is under consideration.
• Renamed Hit.Stun to Hit.Paralyze
• Renamed spell:highlight_tile() to spell:set_tile_highlight()
• Removed tile:is_cracked(), tile:is_hidden(), and tile:is_hole()
  • not tile:is_walkable() can be used where tile:is_hole() is called
• Renamed tile:reserve_entity_by_id() to tile:reserve_for_id()
  • Added tile:reserve_for(entity)
  • Added tile:remove_reservation_for_id(entity_id)
  • Added tile:remove_reservation_for(entity)
• Renamed TileState.Empty to TileState.PermaHole
• Renamed MoveAction to Movement
• Renamed entity:raw_move_event() to entity:queue_movement()
• Renamed entity:share_tile() to entity:enable_sharing_tile()
• Renamed entity:set_float_shoe() to entity:ignore_negative_tile_effects()
• Renamed entity:set_air_shoe() to entity:ignore_hole_tiles()
• Renamed entity:get_current_palette() to entity:palette()
• Renamed entity:set_animation(path) to entity:load_animation(path)
• Renamed sprite:show() to sprite:reveal()
• Renamed sprite:enable_parent_shader() to sprite:use_root_shader()
• Renamed animation:refresh(sprite) to animation:apply(sprite)
• Moved entity:shake_camera() to field:shake()
  • Also accepts game frames instead of seconds
• Renamed living:toggle_hitbox() to living:enabled_hitbox()
• Renamed living:toggle_counter() to living:set_counterable()
• Moved IntangibleRule to IntangibleRule
• Renamed Lifetime.Battlestep to Lifetime.Battle

0.2

• package_init and package_requires_scripts removed, replaced with package.toml
  • mods/blocks -> mods/augments
  • block:set_mutator() -> function augment_init(augment)
  • charge_boost + attack_boost + rapid_boost in package.toml for blocks
• For battles: package_build -> battle_init
• For characters: package_init -> character_init

0.1

• entity.on_delete_func
  • Requires call to entity:erase(), entity:default_character_delete(), or entity:default_player_delete()
• charged_time_table_func -> calculate_charge_time_func
• Simplified Battle.Step.new() + card_action:add_step(step) to card_action:create_step()
• Simplified Battle.Component.new(lifetime) + entity:register_component(component) to entity:create_component(lifetime)
• Removed frames(number), just use the number directly
• Removed make_frame_data(data), just use the data directly
• Removed the dt param from entity.on_update_func()