2.1 - Open Net Battle

BACKPORT#

A very helpful community member named Alrysc helped back-port awaited 2.5 features into the older 2.0 engine. He did this so that everyone can enjoy new content sooner and iron out innaccuracies in PVP.

This effort, dubbed "the backport" was unplanned and volunteered by him because he is very cool. Because he was also helpful, he was brought into the official team for 2.5 to work on the C++ codebase.

2.1 CHANGELOG#

Hit.Flinch is now allowed to queue with Hit.Drag, so you will flinch when hit by Hit.Drag if you don't have armor/DefenseRule-s.
Hit.Stun and Hit.Freeze replace each other instead of allowing you to be stunned and frozen at the same time.
Grass heal works properly.
Fixed an issue where you could skip the battle start text when form changing if any Player took weakness damage since the last transform state.
Fixed TFC softlock if you did TFC on the last possible frame.
Breaking change: Player.charged_time_table_func was renamed to Player.charge_time_func, and now takes Player (self) and the Charge level as input.

Note

You will not get errors if you don't fix this, but it will not work as expected!
Breaking change: PlayerForm.calculate_charge_time_func was renamed to PlayerForm.charge_time_func, and now takes Player (self) and the Charge level as input, so it works the same as the Player's version.

Caution

This will make the mod unnusable if you don't fix this.
Fixed mistake on Player.charge_time_func.
Added Entity.is_dragged so you can check if you're currently under the effects of Drag, which prevents all action.
Fixed Entity.can_attack.
Drag now returns false for is_moving and is_sliding after movement ends for the rest of the duration of Drag.
Added Confuse status, which lasts for 110 frames when applied. You can access with Hit.Confuse.
1. Added Entity.is_confused so you can check if you are under the effects on Confusion.
2. Enemies may want to use this to choose different logic. Kirby summarizes how enemies tend to react to Confuse in later games.
TimeFreeze attacks don't-counter hit anymore.
Turns now last 512 frames by default (~8.5 seconds vs. old 10 seconds).
Battle.get_turn_count, which returns the current turn number. 0.0 initially, then increases by 1.0 every Battle Start banner.
Battle.get_cust_gauge_value, which returns a double ranging from 0.0 to 1.0, as a percentage of the Cust gauge (or maybe it can go over 1.0, but 1.0 is full. I'll update this text later once I check.).
Battle.get_cust_gauge_time, which returns a number in frames for the current gauge time (e.g. 256.0 when gauge is half full with default duration).
Battle.get_cust_gauge_max_time, which returns a number in frames for the current max gauge time (e.g. 512.0 for default time).
Battle.get_default_cust_gauge_max_time, which returns the default gauge time, 512.0 frames.
Battle.set_cust_gauge_time, takes in a frametime (like frames(256)) to set current gauge time to.
Battle.set_cust_gauge_max_time, takes in frametime to set max time to (current time is automatically readjusted to match the percentage of total time it had before, e.g. max time 512 and current time 256 will have current time 100 if you set max time to 200).
Battle.reset_cust_gauge_to_default, sets max time to default time.
Added secondary element to HitProps, called element2. You can access with props.element2.
Form change resets emotion.
The old HitProps constructor is deprecated! But it exists for now. In the future and now, you can create a HitProps with HitProps.new() or HitProps.new(context). Then you use a series of functions (builder design pattern) to customize.
Fixes duplicate name that made it impossible to read a HitProps Drag. The function drag is now drg.
Obstacles cannot become blind or confused.
The player session tracks BugFrags, and then can be set (and rewarded with battle rewards) from the server.
Fixed a crash related to leaving the server in recent builds
Obstacles are now deleted immediately when hitting 0 health, rather than waiting for their next update like all other Entities.
Unfinished Battle.UIComponent is included, but does not yet support layering.
Low health beep is back, but plays at slightly wrong times. To be fixed later.
Because the timing of battle results signals has changed, liberations may react sooner than expected.
Opacity is set correctly by the server for drawn sprites.
Hiding the HUD will no longer allow you to open an invisible menu.
1. Pressing Start will still interrupt other inputs. For example, moving and pressing Start will stop moving for a frame.
Instead of saying "No Data", results will say "Pending" in the text box if the server indicated a card would be received but had not finished installing.
Fixed a crash when editing folder.
UIComponents now respond to layering and can be drawn over the Cust gauge at certain layers.
UI component draw fixes when perspective flipping.
mob:no_results() skips showing battle results, but results still go to servers (for tourney style battles).
Battle results run is now replaced with reason on the server.
1. win - when the battle is over b/c the player won
2. lose - when the battle is over b/c the player lost
3. draw - when the battle is over but the match was a draw
4. runaway - " " b/c the player requested to run away
5. debugesc - " " b/c the user player aborted (panic)
The engine now responds to a unique heuristic: if the user presses ESC three times in a row within a second, the scenes can respond to a user panic operation. This trigger aborts the battle scene and the overworld online scene. This is useful if you get stuck and replaces the debug ESC behavior entirely.
1. 2 scenes now implement this: battle + overworld online. Performing this operation will return you to the previous scene.
Custom battle hit SFX. This makes the engine more accurate in behavior.
1. Entity:set_hurt_sfx(audio) changes the entity hurt sfx.
2. Entity:use_default_hurt_sfx(bool) toggles whether to use the default hurt sfx from before.
3. DefenseFrameStateJudge:set_hit_sfx(audio) changes the final sfx to play. Adopts the victim entity's hurt sfx if one is provided.
4. DefenseFrameStateJudge:hit_spawn_gfx(bool) adds a hint to the defense frame state judge whether or not to spawn a hit graphic effect.
5. DefenseFrameStateJudge:hint_spawn_gfx() - used in hitbox attack + collision func to read if the entity should obey the hint to spawn image graphics or not.
6. Additionally, attack and collision callbacks now receive an optional last parameter judge object so you can read this hint and respond to it.
Tip

For those who care about mod accuracy, custom sfx during combat resolution is a must. For most people, this means you don't have to provide hit sounds in most of your mods anymore, or handle playing them.
Hit.cancel is automatically added to Hit.stun, Hit.freeze, Hit.flinch, and Hit.drag.
You can add a callback event to react to this.
Hit.cancel can be erased by defense rules.
The purpose of this flag is to cancel a chip or interrupt an enemy.
1. This behavior used to be applied to everything that used a CardAction for attacking or behavior, but was inconsistent with the games. So now it's still "automatic" but you can opt-out of this behavior.
2. For example: when viruses are stunned, they do not have their action interrupted. They continue after un-stun. However, bosses do handle interrupts.
3. Side effects: if you are dragged and remove Hit.cancel, it's now possible to move mid-action. This may or may not be what you want, if it happens. Just handle this case.
4. TL;DR if you're programming a virus, use virus body defense rule or remove Hit.cancel in the defense rule step. This assumes you're using CardAction-s for behaviors (correct).
FullSynchro is no longer removed accidentally in places where it shouldn't be (when DefenseOrder.Always blocked the attack, or when anybody using a CardAction).
ActionOrder.Immediate now causes the last action added to go first, so queuing multiple actions with ActionOrder.Immediate will have reversed order now (FILO aka stack).
Losing in PvE battles can no longer end in a draw. Either win or lose (with the exception of userAbort).
The fade time after battle was changed, for people who noticed it was different last build. The results widget now stays around while fading out. This is like the games.
New title screen. May be the final title screen depending on if we get custom art by the time public release happens.
1. bg_blue.png -> bg.png
2. added vnum.png which you can customize but the location is pre-coded.
Servers can play the email ring.
Servers can provide card mod assets and cause them to load on the client.
Servers can send battle rewards, which display in battle for real!
1. There can be multiple rewards sent at the same time.
Servers can tell the client to draw sprites on the screen in the overworld.
Servers can toggle the HUD between health and PET.

Note

the PET and face shown are currently just the ones in the resource folder, but they may read from the mod in the future.
1. New API endpoints for:
  1. Battle rewards
  2. Toggling HUD
  3. Sending emails
  4. Ringing PET
  5. Drawing sprites on screen
Server sprites are drawn in an optimized manner for potentially hundreds of sprites over the network.
mob:no_results() skips results presentation for tourney-style battles
Asset type and package type hints (optional) when providing assets to your users (makes chip rewards work)
For the sprite API, the a channel is now an alternative name for opacity channel.
Sprite API supports color_mode and rgb channels.
James released "Stardust" - a simple particle system plugin for ONB servers.
1. Stardust API updated to support rgb color channels
2. Added enums.lua to the server libs to start documenting enum values.
Added Net.virtual_input(event={player_id, events={{name, state}}) for the server to handle input.

Note

Be sure to lock the player's client-side input first!
Server-side sprite anims loop now like they were supposed to.
When providing assets, you can now give an optional asset type and mod type on the server-side.

Tip

This helps resolve chips for giving them as rewards in battle.

2.1.2 CHANGELOG#

New Bubble status.
1. Use Hit.Bubble or the builder pattern for HitProps with HitProps:bubble(), and you can also add a frametime like Stun and other statuses to give a duration (Default 150f).
New Entity.is_bubbled to check if Bubble is active.
Weakness no longer multiplies damage by 2. This means a Wood Entity getting hit by Fire on Grass will take +200% (x3) damage instead of x4.
Obstacles can now be affected by Lava, but until v2.5, you will need to remove their default FloatShoes for them to take damage.
Obstacles are immune to Bubble status.
Shaved one frame off the start of movement animation (does not affect move speed, just the animation).
1. This should make it so you don't see looping move animation during time freeze anymore (unless you did TFC mid-movement)
NaviCust parts are sorted after loading.
1. This prevents a desync where the remote player could load parts in a different order.
Tip

If you have used parts that rely on load order, you may see them behave slightly differently because of the new enforced order.

2.1.3 CHANGELOG#

Blind animation file correction.
Field.find_nearest_characters no longer crashes when called with a test Entity that has no Tile.
AirShoe is no longer checked in places where only FloatShoe should be checked.
ActionQueue prevents duplicate actions.
Convenient HitProps.has_flags and HitProps.has_element added.
Lava does not turn HP red.
New AudioPriority.Immediate, SFX replays if already playing and told to play with Immediate priority.
Audio Play handles nullptr buffer (prevents crash).
Certain statuses will pause a voluntary movement instead of allowing it to continue.
Added Lua bindings for AudioTypes that were missing bindings.
Music resumes as expected in SelectMobScene.
PlayerCustScene plays music.
Setting Player.charge_time_func will also recalculate charge time.

2.1.4 CHANGELOG#

ScriptedPlayerForm can now have callbacks set on it just like ScriptedPlayerFormMeta.
1. This means the charged_attack_func, special_attack_func and update_func can be changed during battle.
Entities can no longer be spawned on multiple Tiles, which prevents a related crash and other odd behavior.
Battle continues properly if Player is deleted but has alive team members.
Setting skip_time_freeze_intro=true:
No longer dims the screen.
No longer displays its name.
Can no longer be used to counter a card in time freeze.
Can no longer be countered by other cards in time freeze.
DefenseFrameStateJudge.block_impact and .is_impact_blocked are deprecated.
DefenseFrameStateJudge.block_collision prevents hitbox from colliding.
DefenseFrameStateJudge.is_collision_blocked returns true if collision was previously blocked by a DefenseRule.
Engine.get_viewport_size() returns vector containing width/height of game window logic size (480.0, 320.0).
Field:tile_from_pixels(px, py) returns a Tile on the Field found at pixel location px, py.
Returns nil if no Tile is at that location.
Player.get_flinch_count returns number of times the Player has been "flinched".
1. Increments each time the player inflicted with Flinch, Stun, Freeze, Bubble, or Drag status.
2. Caps at 255f.
Anger emotion activates when stunned/flinched/frozen/bubbled for more than 120f.
Anger emotion deactivates when active for over 600f.
Flinch duration adjusted slightly.
Fixed issues around Player deletion in PvP battles with extra Team members.
Fixed Battle.BusterAction attachment animation.
Reading email will let the server know you read the email.
Being stunned or frozen now plays the first flinch animation frame, like Bubble does.
PlayerForm.on_activate_func and .on_deactivate_func now run after any pending movements finish.
Reward Rank penalties around getting hit are more accurate.
Fixed a crash that could happen when removing Entities on the same frame that they are spawned.
Fixed a crash that could happen with certain inputs to math.random.
1. Cases that used to crash now provide a descriptive error message.
Homepages will respect background music path.
New title screen and startup sequence.

SERVER#

Version bumped to match new client
Net.set_song_for_player(player_id, song) plays music for the given player only.
Net.stop_song_for_player(player_id) stops music for the given player only.
Tile custom property shadow can be set to Never which will never have that Tile be drawn in the shadow pass.