Add resetElements argument to resetWaterLevel #2711

Lpsd · 2022-08-14T03:34:19Z

Resolves #2695

Adds a new argument to resetWaterLevel, resetElements, allowing you to reset the level of one or more water elements

nil (default value) or false: only the GTA world water level will be reset (previous/existing behaviour)
true: all water elements created via createWater will have their level reset.
water-element: specific water element level reset.
table{water-elements}: table of water element level reset

Note: the GTA world water level is unaffected except for values of nil or false

The default level for a water element, is defined as the average of initial Z vertex positions upon creation.

Here's a test resource

Upon starting it spawns 2 small water squares next to each other (one on client, one on server) and teleports you to their position.

Use /slevel <num> (for server) or /clevel <num> (for client) to set the water level.

Use /sreset <type> or /creset <type> to reset the water level for server or client.

The <type> controls the arguments passed to resetWaterLevel

0: nil/none
1: true
2: single water element
3: table of all water elements

Feel free to add more water positions in the waterPositions table, the script works with it.

The only caveat (with this test resource) is that when using /creset it will also reset the water level for server created water elements too (since water only has a "true" representation on the client regardless if created on server). But not vice versa (so using /sreset won't reset client created water elements). You can obviously work around this in your own script by storing a list of the client specific water elements.

Allows all water elements level to be reset

Lpsd · 2022-08-14T03:55:14Z

On second thoughts, it may be nice if you could also pass a specific element (maybe even a table of elements too) instead of just true to reset all water elements. See no reason not to do this.

Lpsd · 2022-08-14T14:38:55Z

I've implemented the above and updated the test resource.

Fernando-A-Rocha · 2024-05-05T12:10:22Z

Nice! Code is ready now?

curl/curl#13748

Client/mods/deathmatch/logic/CClientWaterManager.cpp

Server/mods/deathmatch/logic/CWater.h

Server/mods/deathmatch/logic/CWaterManager.cpp

Client/mods/deathmatch/logic/luadefs/CLuaWaterDefs.cpp

Server/mods/deathmatch/logic/luadefs/CLuaWaterDefs.cpp

Co-authored-by: Marek Kulik <[email protected]>

Lpsd · 2024-06-17T21:55:33Z

As a note for the "caveat" mentioned in the initial PR message, this can be easily worked around by maintaining your own list/table of client water elements; so it's really a non-issue.

FileEX · 2024-06-23T14:38:01Z

Client/mods/deathmatch/logic/CClientWaterManager.cpp

+    pWater->ResetLevel();
+}
+
+void CClientWaterManager::ResetElementWaterLevel(std::vector<CClientWater*>& vecWaterElements)


vector can be const?

FileEX · 2024-06-23T14:39:27Z

Client/mods/deathmatch/logic/CClientWaterManager.cpp

+bool CClientWaterManager::ResetAllElementWaterLevel()
+{
+    for (CClientWater* pWater : m_List)
+        pWater->ResetLevel();
+    return true;
+}


Why is this function as a bool if it is unnecessary? The other functions are of type void and this one doesn't seem to need to return a value either

FileEX · 2024-06-23T14:39:42Z

Client/mods/deathmatch/logic/CClientWaterManager.h

@@ -31,6 +31,9 @@ class CClientWaterManager
    bool SetPositionWaterLevel(const CVector& vecPosition, float fLevel, void* pChangeSource);
    bool SetWorldWaterLevel(float fLevel, void* pChangeSource, bool bIncludeWorldNonSeaLevel, bool bIncludeWorldSeaLevel, bool bIncludeOutsideWorldLevel);
    bool SetAllElementWaterLevel(float fLevel, void* pChangeSource);
+    bool ResetAllElementWaterLevel();
+    void ResetElementWaterLevel(CClientWater* pWater);
+    void ResetElementWaterLevel(std::vector<CClientWater*>& vecWaterElements);


vector can be const?

FileEX · 2024-06-23T14:41:35Z

Server/mods/deathmatch/logic/CWaterManager.cpp

+    pWater->ResetLevel();
+}
+
+void CWaterManager::ResetElementWaterLevel(std::vector<CWater*>& vecWaterElements)


vector can be const?

FileEX · 2024-06-23T14:41:42Z

Server/mods/deathmatch/logic/CWaterManager.h

@@ -37,6 +37,9 @@ class CWaterManager
    void                        ResetWorldWaterLevel();
    void                        SetElementWaterLevel(CWater* pWater, float fLevel);
    void                        SetAllElementWaterLevel(float fLevel);
+    void                        ResetAllElementWaterLevel();
+    void                        ResetElementWaterLevel(CWater* pWater);
+    void                        ResetElementWaterLevel(std::vector<CWater*>& vecWaterElements);


vector can be const?

FileEX · 2024-06-23T14:43:42Z

Server/mods/deathmatch/logic/luadefs/CLuaWaterDefs.cpp

@@ -167,11 +169,42 @@ int CLuaWaterDefs::SetWaterLevel(lua_State* luaVM)
    return 1;
 }

-int CLuaWaterDefs::ResetWaterLevel(lua_State* luaVM)
+bool CLuaWaterDefs::ResetWaterLevel(std::variant<std::monostate, bool, std::vector<CWater*>, CWater*> resetElements)


resetElements can be const?

FileEX · 2024-06-23T14:43:47Z

Server/mods/deathmatch/logic/luadefs/CLuaWaterDefs.h

+
+    static bool ResetWaterLevel(std::variant<std::monostate, bool, std::vector<CWater*>, CWater*> resetElements);


resetElements can be const?

FileEX · 2024-06-23T14:44:05Z

Client/mods/deathmatch/logic/luadefs/CLuaWaterDefs.h

@@ -32,4 +31,6 @@ class CLuaWaterDefs : public CLuaDefs
    LUA_DECLARE(GetWaterLevel);
    LUA_DECLARE(IsWaterDrawnLast);
    LUA_DECLARE(GetWaterVertexPosition);
+
+    static bool ResetWaterLevel(std::variant<std::monostate, bool, std::vector<CClientWater*>, CClientWater*> resetElements);


resetElements can be const?

FileEX · 2024-06-23T14:51:06Z

Client/mods/deathmatch/logic/luadefs/CLuaWaterDefs.cpp

-    return 1;
+    CClientWaterManager* pWaterManager = g_pClientGame->GetManager()->GetWaterManager();
+
+    switch (resetElements.index())


What do you think about using std::holds_alternative instead of an index here?

FileEX · 2024-06-23T14:51:16Z

Server/mods/deathmatch/logic/luadefs/CLuaWaterDefs.cpp

-    return 1;
+    CWaterManager* pWaterManager = g_pGame->GetWaterManager();
+
+    switch (resetElements.index())


What do you think about using std::holds_alternative instead of an index here?

lynconsix · 2025-01-20T16:11:25Z

Bump?

Add resetElements argument to setWaterLevel

b53c262

Allows all water elements level to be reset

Lpsd added the enhancement New feature or request label Aug 14, 2022

Allow bool, element or table or elements

bf061e8

Lpsd added 2 commits August 14, 2022 15:40

Update variable naming for consistency

95d97d3

Use ArgumentParserWarn for Lua defs

b1e8358

Lpsd changed the title ~~Add resetElements argument to setWaterLevel~~ Add resetElements argument to resetWaterLevel Aug 27, 2022

patrikjuvonen modified the milestones: 1.6.0, Next Release (1.6.1) Apr 8, 2023

Lpsd added 5 commits May 24, 2024 10:35

mbedTLS fix for cURL 8.8.0

8a11b3c

curl/curl#13748

Merge branch 'master' of https://github.com/multitheftauto/mtasa-blue

181bf0f

Merge branch 'master' of https://github.com/multitheftauto/mtasa-blue

6728cbe

Merge branch 'master' of https://github.com/multitheftauto/mtasa-blue

0b989ac

Merge branch 'master' of https://github.com/multitheftauto/mtasa-blue

9c19509

botder requested changes Jun 9, 2024

View reviewed changes

Lpsd and others added 3 commits June 17, 2024 22:51

Update CClientWaterManager.cpp

2a5d1a7

Co-authored-by: Marek Kulik <[email protected]>

Update CWater.h

30bec61

Co-authored-by: Marek Kulik <[email protected]>

Update CWaterManager.cpp

400e88b

Co-authored-by: Marek Kulik <[email protected]>

Lpsd added 4 commits June 19, 2024 18:35

Merge branch 'master' of https://github.com/multitheftauto/mtasa-blue

75c36ed

Merge branch 'master' into waterlevel

dfb1ea1

Modify resetWaterLevel argument handling

366780b

Update CClientWater.h

6fd9368

Lpsd requested a review from botder June 19, 2024 18:26

FileEX suggested changes Jun 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add resetElements argument to resetWaterLevel #2711

Add resetElements argument to resetWaterLevel #2711

Lpsd commented Aug 14, 2022 •

edited

Loading

Lpsd commented Aug 14, 2022 •

edited

Loading

Lpsd commented Aug 14, 2022

Fernando-A-Rocha commented May 5, 2024

Lpsd commented Jun 17, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

FileEX Jun 23, 2024

lynconsix commented Jan 20, 2025


		static bool ResetWaterLevel(std::variant<std::monostate, bool, std::vector<CWater>, CWater> resetElements);

Add resetElements argument to resetWaterLevel #2711

Are you sure you want to change the base?

Add resetElements argument to resetWaterLevel #2711

Conversation

Lpsd commented Aug 14, 2022 • edited Loading

Lpsd commented Aug 14, 2022 • edited Loading

Lpsd commented Aug 14, 2022

Fernando-A-Rocha commented May 5, 2024

Lpsd commented Jun 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lynconsix commented Jan 20, 2025

Lpsd commented Aug 14, 2022 •

edited

Loading

Lpsd commented Aug 14, 2022 •

edited

Loading