Developer want to rework NetworkComponents

[Ismoh]

Just to be clear: NetworkComponent isn't a NoitaAPI component. It's NoitaMP code.

NoitaMP/mods/noita-mp/files/scripts/entity_manager.lua

Line 152 in 6bae9dc

local nc_serialised = ComponentGetValue2(variable_storage_component_id, "value_string") or nil

As you can see above, the whole network component is serialised and then saved in a VariableStorageComponent(NoitaAPI).
This leads for some reasons to problems, because desirialisation doesn't work as expected. The stored Ids are wrong and messed up, for example:
NUID = 126 -> serialised and saved to VariableStorageComponent -> loaded from this V.S.Component -> desirialised -> NUID = 1837364748. The fuijck is happening?

That's why I discussed with the mod community and came to the idea to change it completely:

1. World is loaded
2. If client simply despawn all entities in a specific range (keep doing this, while moving / playing the game)
3. If server send your (in the same specific range) all entities to the clients + get pos of clients and send the servers entities to the client in the same range -> think of: your mate dont want to stick together
4. That's enough for know :D

Instead of de-/serialising the network component, simply use the entityManager to add per each attribute of the networkComponent as a VariableStorageComponent to the entity itself:

NetworkComponent
NUID = 183
attr2 = foo
attr3 = bar

Leads to three VariableStorageComponent added to one entity. First VSC has 183 as value etc.

Have a look on this:
https://github.com/Ismoh/NoitaMP/blob/master/.debug/network%20ids%20chat%20history.PNG

[Ismoh]

In addition to this see #26

[Ismoh]

• De-/serialisation is replaced with json string, which is human-readable.
• Rework network component creation and storing: remove all entities on clients and spawn server entities on clients. Or send notification to server that there is a entity removed on Client and spawn this again on all clients with a NUID.
• Rework and refresh cache on server and all clients. Also when saving and loading. I am thinking of a NUID file/class which handles all NUID stuff. Same as GUID class
• only sync a defined list of entities or better to say: provide an exclude (black) list, for entities which shouldnt be synced

[Ismoh]

• De-/serialisation is replaced with json string, which is human-readable

This leads to saving and loading issues:

SpawnPlayer, because joystick is connected
Loading player: ??SAV/player
XML error in file(??SAV/player.xml) at line (1490)parsing tag (owner":{"guid":"AB4D7A8E-2928-044C-CA1C-63E67502E0E9","username":"noita_dev.exe"},"nuid":"nil","component_id":14,"local_entity_id":145}") - expected '='
XML error in file(??SAV/player.xml) at line (1491)parsing tag (VariableStorageComponent) - expected '='

Therefore I need to add one VariableStorageComponent for each field in NetworkComponent..

[Ismoh]

Notes of today! Everytihng in the comments above isn't up to date anymore because it doesnt work. Game still crashing!

• Rename Nuid to NuidUtils, which should be a static class ✔️
• NuidUtil is only accessible by server_class ✔️
• it returns the latest/current nuid ✔️
• latest/current means: if globals are set, get highest nuid. Entity updates globals by a nuid_updater noita component. If entity was found and does not have any nuid, NetworkVscUtil will add the VariableStorageComponents. ✔️
• Update/set nuid is only possible, as long as nuid in vsc is empty
• Rename entity_manager to EntityUtils, which is also a static class ✔️
• EntityUtil runs on server:update and client:update ✔️
• get entity in radius only run on server ✔️
• remove/despawn entities only run on client ✔️
• get entities in radius depending on its components: currently only velocityComponent ✔️ Special thanks to @TheHorscht !
• EntityUtil syncs entity values (health, pos, velocity, kill/death, etc) on client to server and server send this to all clients besides the one who sent it
• adds NuidUpdater to the entity by default, if not exists already ✔️
• convertPhysicsObjectsBackToEntities function is static and runs in modPreInit to i.e. convert the minecart back to an entity

yes, using TextFileGetContent, replace the value using string.gsub, then TextFileSetContent
Will be done in #50

• Rename NetworkVscValues to NetworkVscUtils ✔️
• adds all VariableStorageComponents to a specific entity provided by EntityUtil ✔️
• updates/set nuid to entity, if not already set ( - Update/set nuid is only possible, as long as nuid in vsc is empty) ✔️
• get/return all values by nuid ✔️
• add a function to check, if the entity still exists ✔️
• GlobalsUtil
• set entityId to -99 (despawned), when entity died ✔️
• set entityId to "outdated", when nuid_updater updates the entityId after loading a savegame new entityId will be set to the already set nuid
• Rework nuid_updater
• Try to use GlobalUtils if possible ✔️
• rewrite functions ✔️
• make use of executed_on_added and _removed ✔️
• get rid of death function in adding the noita component and in the script itself ✔️

Something left?

[Ismoh]

Last commit looks really promising!
No crashes yet and only two lua errors, I don't know yet.
We'll see!

[Ismoh]

• everytime entity_id or entityId is passed as a parameter, first check on top of the function, if entity still exists with EntityGetIsAlive(entity_id)

I am pretty sure this is reason for the client crash: when a projectile is shot by server near to the ground, there is no time left to set the nuid on client. Client tries to set nuid on a non existing entity.

Should be double checked in #37, when #27 is done.

[Ismoh]

• Mod settings
• Add documentation for debug mod settings ✔️
• Add include and exclude config file and use it in ModSettings. This might not work because ModSettings does not allow unsafe functions. Does dofile work? A lua file might work well! ✔️
• Add documentation for include and exclude lua file. Use EntityUtils in that file to put it in the correct global. ✔️

[Ismoh]

PR merged. Closing this.