BMSLD Updates

[dyceron]

• Renames fields and updates formatting
• Moves functions from OSRR to MEDS
• Add enum for actor layers
• Add classes for editing position, rotation, and arguments

[codecov]

Codecov Report

Attention: Patch coverage is 91.26214% with 9 lines in your changes missing coverage. Please review.

Project coverage is 77.82%. Comparing base (5e981a7) to head (2a2cac9).
Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
...rc/mercury_engine_data_structures/formats/bmsld.py	91.26%	9 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #258      +/-   ##
==========================================
+ Coverage   77.58%   77.82%   +0.23%     
==========================================
  Files          78       79       +1     
  Lines        4011     4099      +88     
==========================================
+ Hits         3112     3190      +78     
- Misses        899      909      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[dyceron]

Unsure if keeping reference[layer/actor] is worthwhile. It feels very verbose.

scenario.remove_entity({"layer": 9, "actor": "LE_GrappleDest_007"})
vs
scenario.remove_entity(9, "LE_GrappleDest_007")

[ThanatosGit]

Unsure if keeping reference[layer/actor] is worthwhile. It feels very verbose.

scenario.remove_entity({"layer": 9, "actor": "LE_GrappleDest_007"}) vs scenario.remove_entity(9, "LE_GrappleDest_007")

In this case the first variant is just an ugly way of providing two arguments as one argument to the method.

It only makes sense to me because it wouldn't require "unpacking" such things from an input json in the patcher. But as the schema validation guarantees that the keys exists in the dict from the input json, it is definitely better to unpack it in the patcher and use the second variant here because MEDS doesn't know anything about the schema.

[dyceron]

Unsure if keeping reference[layer/actor] is worthwhile. It feels very verbose.
scenario.remove_entity({"layer": 9, "actor": "LE_GrappleDest_007"}) vs scenario.remove_entity(9, "LE_GrappleDest_007")

In this case the first variant is just an ugly way of providing two arguments as one argument to the method.

It only makes sense to me because it wouldn't require "unpacking" such things from an input json in the patcher. But as the schema validation guarantees that the keys exists in the dict from the input json, it is definitely better to unpack it in the patcher and use the second variant here because MEDS doesn't know anything about the schema.

So I should use the less verbose version here then? Or are you saying keep this in OSRR, which probably shouldn't happen?

[ThanatosGit]

So I should use the less verbose version here then?

Yes

[duncathan]

I'm gonna finish preparing the Vec2/3/4 pr today which should help with this pr too

[duncathan]

this should now return Iterator[tuple[ActorLayer, str, BmsldActor]] (you'll have to modify the function slightly to make it truth these)

[steven11sjf]

I think it might be more accurate to call this actors or entities, and the whole struct should be actor_groups if it matches up with bmssa data. Though I'm not sure of the form of objects, is it like "actor_sname" without referencing the layer? Or a link like how dread does it?

[dyceron]

It used to be called actors but was changed to be more descriptive. I don't think I'd want to change it to actor_groups because that is associated with actors existing in groups (ie adding a new actor to a group (a collision camera group)

[steven11sjf]

given that brfld is basically an iterated structure, i'm pretty sure that this is the analog to dctActorGroup and bmsld.actor_layers is analog to dctSublayers.

[steven11sjf]

either way, this structure is directly analogous to the dctActorGroup structure.

[dyceron]

I probably could rename it to actor groups and be fine anyway

[steven11sjf]

Off topic but could you check if there's any tie between those actors and the bmssa data in that draft pr? I feel like it could be related since cockpit and credits also have some unique actor values.

[dyceron]

Somewhat but I don't think fully related

Cockpit

Bmsld

    actor_layers = ListContainer: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
            LE_Samus = Container: 
                type = u'menu_samus' (total 10)
                position = Vec3(0.0, 0.0, 0.0)
                rotation = Vec3(0.0, 0.0, 0.0)
                component_functions = ListContainer: 
                    Container: 
                        component_type = u'MODELUPDATER' (total 12)
                        command = u'SetScenarioParams' (total 17)
                        arguments = ListContainer: 
                            Container: 
                                type = u'i' (total 1)
                                value = 4294967295
            LE_Baby = Container: 
                type = u'menu_baby' (total 9)
                position = Vec3(0.0, 0.0, 0.0)
                rotation = Vec3(0.0, 0.0, 0.0)
                component_functions = ListContainer: 
                    Container: 
                        component_type = u'MODELUPDATER' (total 12)
                        command = u'SetScenarioParams' (total 17)
                        arguments = ListContainer: 
                            Container: 
                                type = u'i' (total 1)
                                value = 4294967295
            LE_Ship = Container: 
                type = u'menu_shipinterior' (total 17)
                position = Vec3(0.0, 0.0, 0.0)
                rotation = Vec3(0.0, 0.0, 0.0)
                component_functions = ListContainer: 
                    Container: 
                        component_type = u'MODELUPDATER' (total 12)
                        command = u'SetScenarioParams' (total 17)
                        arguments = ListContainer: 
                            Container: 
                                type = u'i' (total 1)
                                value = 4294967295
            LE_Planet = Container: 
                type = u'menu_planet' (total 11)
                position = Vec3(0.0, 0.0, 0.0)
                rotation = Vec3(0.0, 0.0, 0.0)
                component_functions = ListContainer: 
                    Container: 
                        component_type = u'MODELUPDATER' (total 12)
                        command = u'SetScenarioParams' (total 17)
                        arguments = ListContainer: 
                            Container: 
                                type = u'i' (total 1)
                                value = 4294967295
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
        Container: 
    sub_areas = Container: 
    extra_data = Container: 
        eg_SubArea_collision_camera_000 = ListContainer: 
            LE_Baby
            LE_Samus
            LE_Planet
            LE_Ship

Bmssa

Container: 
    version = u'1.22.0' (total 6)
    cameras = Container: 
        collision_camera_000 = Container: 
            setups = Container: 
                Default = Container: 
                    environment_preset = u'interior' (total 8)
                    sound = u'default' (total 7)
                    unk2 = u'lg_collision_camera_000' (total 23)
                    entity_group = u'eg_SubArea_collision_camera_000' (total 31)
                    block_group = u'' (total 0)
                    cc_names = ListContainer: 
                        collision_camera_000
                    actors_in_scenario = ListContainer: 
                        menu_samus
                        menu_baby
                        samusshipinterior
                    cutscenes = ListContainer: 
                    collision_layer = u'collision' (total 9)
                    unk9 = False

[duncathan]

let's improve some typing problems. start off like this:

ActorName: TypeAlias = str
ActorGroupName: TypeAlias = str

then adjust the signatures of your API functions to use these types instead of just str as appropriate. a lot of the functions currently have incorrect signatures, so double check all of them