Skip to content

Fix for RuntimeMaterials to pick the right ground texture in Woodland Hills #2545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
KABoissonneault merged 1 commit into from
Feb 11, 2024
Merged

Fix for RuntimeMaterials to pick the right ground texture in Woodland Hills #2545

KABoissonneault merged 1 commit into from
Feb 11, 2024

Conversation

@KABoissonneault
Copy link
Collaborator

@KABoissonneault KABoissonneault commented Nov 18, 2023 •
edited
Loading

A user was having a mismatch in RuntimeMaterials when replacing ground textures according to climate/season/weather.

In this example:
image

The bright green of the hill clashes with the dark green of the rest of the area. This is because the hill has been made to use archive 302-304, and Woodland Hills uses archive 102-104 for ground.

A concrete climate's ground archive is defined in MapsFile.GetWorldClimateSettings, along with its base climate setting. Without the concrete climate, we can get a default ground archive matching the base climate as defined in ClimateSwaps logic (either in ApplyClimate or GetGroundArchive).
In the latter case, we have for the ground:

  • Desert = archive 2
  • Mountain = archive 102
  • Temperate = archive 302
  • Swamp = archive 402
    With winter variants at x03 and rain variants at x04.

For the most part, the climates in MapsFile.GetWorldClimateSettings have a ground archive matching the base climate's in ClimateSwaps.GetGroundArchive. We only have one exception: Climates.MountainWoods (aka "Woodland Hills") has a Temperate base climate (normally ground archive 302), but with a specific ground archive of 102 (the mountain one).
102 is the archive used by the terrain generator. Therefore, any ground generated in this climate needs to match 102, not 302.

This fix adds an explicit check in RuntimeMaterials for whether we're replacing a ground archive, and if so, use the climate settings' ground archive, not the naive climate-based swap.

And the result is a more natural hill
image

Similarly, DaggerfallMesh.SetClimate uses MaterialReader.ChangeClimate which also relies on ClimateSwaps logic to customize by weather. However, I'm not sure whether a DaggerfallMesh ever uses the ground archive, so I did not insert this fix in this PR.

@KABoissonneault
Copy link
Collaborator Author

KABoissonneault commented Nov 19, 2023

We can confirm that the issue also occurs for DaggerfallMesh.
In this example below,
image

The mound uses the grass from archive 302 (Temperate), despite the surrounding ground being archive 102 (Mountain).

I'm not fixing this yet, because DaggerfallMesh only has info on the current "base climate", not the actual climate. Too big of a change for the scope of this. But it's worth noting for the future

@drcarademono
Copy link
Contributor

drcarademono commented Nov 21, 2023

There's another bug with RuntimeMaterials or a related script, which occurs when users put nature flats in an RMB.json override, like this:

        "MiscFlatObjectRecords": [
            {
                "Position": 0,
                "XPos": 1511,
                "YPos": -1,
                "ZPos": -2546,
                "TextureArchive": 504,
                "TextureRecord": 16,
                "FactionID": 0,
                "Flags": 0
            }]

Nature flats in RMB.jsons are placed correctly in their original climate (in this case Temperate), but in other climates are floating or buried the ground:

Correctly placed in Temperate:
2023-11-20_14-43

Incorrectly placed in Mountain:
2023-11-20_14-44

It's possible that the texture is being swapped after a BillboardMesh is created based on the original texture, but that is only my conjecture. Nature flats placed the normal way, through the GroundScenery section in RMB.jsons, work fine.

I'm attaching a modified FILLAA00.RMB.json and two save folders (in Horbury, Dwynnen and Crossgate, Wrothgarian Mountains that can be used to reproduce the issue:
Nature Flats Placement Bug.zip

@drcarademono
Copy link
Contributor

drcarademono commented Dec 11, 2023

In case it helps, this is the section in DaggerfallLocation.cs that's responsible for swapping out nature flats in RMBs. It only handles loose flats, NOT nature flats defined by the GroundScenery section in RMBs. Line 257 ( db.SetMaterial(natureArchive, db.Summary.Record);) handles the swap.

            int natureArchive = GetNatureArchive();

            // Process all DaggerfallBillboard child components
            Billboard[] billboardArray = GetComponentsInChildren<Billboard>();
            foreach (var db in billboardArray)
            {
                if (db.Summary.FlatType == FlatTypes.Nature)
                {
                    // Apply recalculated nature archive
                    db.SetMaterial(natureArchive, db.Summary.Record);
                }
                else
                {
                    // All other flats are just reapplied to handle any other changes
                    db.SetMaterial(db.Summary.Archive, db.Summary.Record);
                }
            }

            // Process nature billboard batch
            if (summary.NatureBillboardBatch != null)
            {
                summary.NatureBillboardBatch.SetMaterial(natureArchive, true);
                summary.NatureBillboardBatch.Apply();
            }
        }```

@KABoissonneault KABoissonneault mentioned this pull request Dec 12, 2023
Merged
@KABoissonneault KABoissonneault added this to the DFU 1.0.1 milestone Feb 3, 2024
@KABoissonneault KABoissonneault merged commit 1827f96 into Interkarma:master Feb 11, 2024
@KABoissonneault KABoissonneault deleted the fix/runtime-materials branch February 11, 2024 15:37
@KABoissonneault KABoissonneault mentioned this pull request Feb 13, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ajrb ajrb ajrb approved these changes

@numidium numidium numidium approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

DFU 1.0.1

Development

Successfully merging this pull request may close these issues.

4 participants

@KABoissonneault @drcarademono @ajrb @numidium