Add Zeus utility modules #4661

RSpeekenbrink · 2016-11-12T00:53:39Z

When merged this pull request will:

Add a Zeus Module category ACE Util
Add Zeus Module: Toggle Simulation
This module needs to be placed on an object. This will toggle the simulation of the object. Handy for base builds etc.
Add Zeus Module: Add Objects to Curator
This module will ask for a radius once placed (radius in meters) and will add all objects to zeus within that radius.
Add Zeus Module: Remove Objects from Curator
This module will do the same as Add but then inverted (Remove all objects in the radius from zeus, it will not remove the objects it will just make them uneditable and no icon will show up etc)

ModuleSimulation toggles simulation for objects

jonpas

Minor things required, no actual code checks performed.

jonpas · 2016-11-12T01:17:41Z

addons/zeus/stringtable.xml

@@ -644,6 +647,9 @@
            <German>Fügt jedes gespawnte Objekt allen Kuratoren der Mission hinzu</German>
            <Japanese>ミッション内で作成されたオブジェクトに全キュレーターを追加</Japanese>
        </Key>
+		<Key ID="STR_ACE_Zeus_RemoveObjectsToCurator">


STR_ACE_Zeus_RemoveObjectsFromCurator

jonpas · 2016-11-12T01:17:58Z

addons/zeus/stringtable.xml

@@ -607,6 +607,9 @@
            <Italian>Piazza su una unità</Italian>
            <Japanese>ユニットの上に設置</Japanese>
        </Key>
+		<Key ID="STR_ACE_Zeus_NoObjectSelected">
+            <English>Place on a object</English>


on an object

jonpas · 2016-11-12T01:18:22Z

addons/zeus/functions/fnc_ui_RemoveObjects.sqf

@@ -0,0 +1,64 @@
+/*
+ * Author: Fisher
+ * Removes all objects in given radius for all curators


Missing final point.

jonpas · 2016-11-12T01:18:31Z

addons/zeus/functions/fnc_ui_RemoveObjects.sqf

+ * Removes all objects in given radius for all curators
+ *
+ * Arguments:
+ * 0: dummy controls group <CONTROL>


Dummy (capitalization)

jonpas · 2016-11-12T01:18:39Z

addons/zeus/functions/fnc_ui_RemoveObjects.sqf

+ * 0: dummy controls group <CONTROL>
+ *
+ * Return Value:
+ * none <NIL>


Just None.

jonpas · 2016-11-12T01:20:43Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+ *
+ * Return Value:
+ * None <NIL>
+ *


An empty line too many.

jonpas · 2016-11-12T01:22:28Z

addons/zeus/config.cpp

@@ -49,6 +52,14 @@ class ACE_Curator {
    GVAR(cargoAndRepair)[] = {"ace_cargo", "ace_repair"};
 };

+class CfgFactionClasses {


Should be in separate file ˙CfgFactionClasses.hpp and included below.

jonpas · 2016-11-12T01:22:48Z

addons/zeus/config.cpp

@@ -49,6 +52,14 @@ class ACE_Curator {
    GVAR(cargoAndRepair)[] = {"ace_cargo", "ace_repair"};
 };

+class CfgFactionClasses {
+    class ACE_Util {


ACE_UI_Util maybe?

jonpas · 2016-11-12T01:23:11Z

addons/zeus/XEH_PREP.hpp

 PREP(moduleSurrender);
 PREP(moduleTeleportPlayers);
 PREP(moduleUnconscious);
 PREP(moduleZeusSettings);
 PREP(ui_attributeCargo);
 //PREP(ui_attributePosition);
+PREP(ui_AddObjects);


ui_addObjects - same for file.

jonpas · 2016-11-12T01:23:17Z

addons/zeus/XEH_PREP.hpp

 PREP(ui_attributeRadius);
 PREP(ui_defendArea);
 PREP(ui_globalSetSkill);
 PREP(ui_groupSide);
 PREP(ui_patrolArea);
+PREP(ui_RemoveObjects);


ui_removeObjects - same for file.

commy2

Newlines @ EOF.

Someone should test this in MP. With Zeus being a client. This heavily relies on global server only commands, but I'm pretty sure the way these modules are set up, they are executed on the zeus machine.

commy2 · 2016-11-12T01:39:13Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+    [LSTRING(NoObjectSelected)] call EFUNC(common,displayTextStructured);
+} else {
+    _simulationEnabled = simulationEnabled _object;
+    _object enableSimulationGlobal (!_simulationEnabled);


doesn't work in MP like this.
https://community.bistudio.com/wiki/enableSimulationGlobal

Has to be executed on server:

There is an event in common component for it.

Fixed it with BIS_fnc_MP now, I couldn't find the event you where talking about

Maybe its on me, been a while since I worked on ArmA files :P

commy2 · 2016-11-12T01:39:45Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+ #include "script_component.hpp"
+
+ params ["_logic"];
+ private ["_object","_simulationEnabled"];


use private keyword instead.

commy2 · 2016-11-12T01:40:46Z

addons/zeus/functions/fnc_ui_AddObjects.sqf

+
+params ["_control"];
+private _display = ctrlParent _control;
+private _logic = GETMVAR(BIS_fnc_initCuratorAttributes_target,objnull);


commy2 · 2016-11-12T01:40:59Z

addons/zeus/functions/fnc_ui_AddObjects.sqf

+};
+
+private _fnc_onUnload = {
+    private _logic = GETMVAR(BIS_fnc_initCuratorAttributes_target,objnull);


commy2 · 2016-11-12T01:41:32Z

addons/zeus/functions/fnc_ui_AddObjects.sqf

+    {
+        _y = _x;
+        { _x addCuratorEditableObjects [[_y], true]; } foreach allCurators;
+    } foreach _objectsToAdd;


forEach.
New scope in new line.
Has to be executed on server and probably doesn't work like this in MP.
missing private for _y

Why isn't this simply:

{ _x addCuratorEditableObjects [_objectsToAdd, true]; } forEach allCurators;

addCuratorEditableObjects is already meant to be able to add arrays of objects. No point in walking over the array just to pass each element in a size one array.

commy2 · 2016-11-12T01:44:05Z

addons/zeus/functions/fnc_ui_RemoveObjects.sqf

+};
+
+private _fnc_onUnload = {
+    private _logic = GETMVAR(BIS_fnc_initCuratorAttributes_target,objnull);


commy2 · 2016-11-12T01:44:14Z

addons/zeus/functions/fnc_ui_RemoveObjects.sqf

+    private _display = ctrlparent _ctrlButtonOK;
+    if (isNull _display) exitWith {};
+
+    private _logic = GETMVAR(BIS_fnc_initCuratorAttributes_target,objnull);


commy2 · 2016-11-12T01:44:22Z

addons/zeus/functions/fnc_ui_RemoveObjects.sqf

+    {
+        _y = _x;
+        { _x removeCuratorEditableObjects [[_y], true]; } foreach allCurators;
+    } foreach _objectsToAdd;


kymckay · 2016-11-12T10:48:51Z

Like the addition of module categories, have been meaning to get around to that myself 👍

UI stuff all looks to be handled correctly in line with the existing modules 👍 (I should probably post some explicit guidelines on standard procedure for the addition of new UI modules - I ought to fix that position attribute at some point too).

I'd like to see a setting on the add/remove modules to toggle whether it's all curators or just the current one (all by default), however I can easily add that after merge if you're not confident with the UI stuff.

Regarding the locality stuff:

Module functions will run globally by default (if inheriting from the base module), so they will run everywhere. The simulation module can thus just use the command without having to worry about locality (since it will be ran on all machines by the module framework).

The UI modules have their functions stem from the UI itself, so those are only run on the zeus client by default. You'll have to handle locality within those function (i.e running the add/remove object commands on the server).

commy2 · 2016-11-12T10:52:29Z

addons/zeus/stringtable.xml

@@ -695,5 +701,8 @@
            <Polish>Wpisano nieprawidłowy promień</Polish>
            <German>Ungültiger Radius eingegeben</German>
        </Key>
+		<Key ID="STR_ACE_Zeus_ModuleSimulation_DisplayName">
+            <English>Toggle Simulation</English>
+        </Key>
    </Package>
 </Project>


commy2 · 2016-11-12T10:52:44Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+    [[_object, (!_simulationEnabled)],"enableSimulationGlobal",false] call BIS_fnc_MP;
+ };
+
+ deleteVehicle _logic;


commy2 · 2016-11-12T10:54:16Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+
+ params ["_logic"];
+
+ if !(local _logic) exitWith {};


@SilentSpike
So this function runs everywhere... Which machine is the module local to? Server or Zeus client? Shouldn't this be a isServercheck for simplicity regardless?

Module will be local to zeus client. However in the case of this module, we may want to actually exploit the module framework and make it only run on the server (then use the simulationGlobal command).

To do so, in the module's cfgVehicles entry you simple set isGlobal = 0;

(and remove this locality check yes)

then make the command instead of enableSimulationGlobal just enableSimulation ?

RSpeekenbrink · 2016-11-12T10:54:53Z

Thanks SilentSpike for the comment, in a way I was confused about the Simulation command since I also thought if you call enableSimulationGlobal it will automatically be executed from the server to all clients. I just tested the simulation script on a server without the BIS_fnc_MP and it works fine.

About the UI stuff, i'm currently learning how UI stuff works in ArmA so im not that confident yet.

commy2 · 2016-11-12T10:55:38Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+    [LSTRING(NoObjectSelected)] call EFUNC(common,displayTextStructured);
+ } else {
+    private _simulationEnabled = simulationEnabled _object;
+    [[_object, (!_simulationEnabled)],"enableSimulationGlobal",false] call BIS_fnc_MP;


that is not what @jonpas and I meant. Should probably be restored to what it was if the other comment regarding the modules locality is solved.

commy2 · 2016-11-12T10:57:04Z

addons/zeus/functions/fnc_ui_addObjects.sqf

+        {
+               _x addCuratorEditableObjects [_objectsToAdd, true];
+        } foreach allCurators;
+    } foreach _objectsToAdd;


that looks wrong

commy2 · 2016-11-12T10:57:35Z

addons/zeus/functions/fnc_ui_removeObjects.sqf

+
+#include "script_component.hpp"
+
+disableSerialization;


@SilentSpike
module scripts are run in scheduled environment, right?

These UI initialisation functions will stem from an onSetFocus event handler, which I don't believe is scheduled, not sure though.

If they don't run in scheduled environment, then disableSerialization should be removed as unscheduled environment does not support serialization to begin with.

commy2 · 2016-11-12T10:58:16Z

addons/zeus/functions/fnc_ui_removeObjects.sqf

+        {
+              _x removeCuratorEditableObjects [_objectsToAdd, true]; 
+        } foreach allCurators;
+    } foreach _objectsToAdd;


same as above. no need to iterate through _objectsToAdd at all. also, forEach camel case

Im a derp, I forgot to remove the other foreach loop

Module will run on the server only via the module framework (removing the need for any back and fourth).

# Conflicts: # addons/zeus/functions/fnc_moduleSimulation.sqf

commy2 · 2016-11-12T11:41:04Z

addons/zeus/functions/fnc_moduleSimulation.sqf

@@ -22,7 +22,8 @@
    [LSTRING(NoObjectSelected)] call EFUNC(common,displayTextStructured);
 } else {
    private _simulationEnabled = simulationEnabled _object;
-    [[_object, (!_simulationEnabled)],"enableSimulationGlobal",false] call BIS_fnc_MP;
+	_object enableSimulationGlobal (!_simulationEnabled);


tab. should be four spaces to let travis pass

commy2 · 2016-11-12T11:41:19Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+ deleteVehicle _logic;
+


white space here

commy2 · 2016-11-12T11:42:54Z

@SilentSpike the same problem exists for fnc_ui_addObjects.sqf (addCuratorEditableObjects) and fnc_ui_removeObjects.sqf (removeCuratorEditableObjects

commy2 · 2016-11-12T14:36:59Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+};
+
+deleteVehicle _logic;
+


white space : (

- Merges the add/remove curator editable objects modules into one with a checkbox to specific behaviour. - Adds a checkbox to specify whether to effect all curators or only the local curator - Fixes locality handling of the module code

kymckay · 2016-11-12T17:11:43Z

I've merged the add/remove modules together, fixed their locality, added checkbox to toggle all/local curator.

All that's left now is some cleanup and this is good to go 👍

- Standardise function headers (remove examples where not applicable) - Add module categories (and make display names beautiful) - Alphabetise some classes

Changes have been met

kymckay · 2016-11-12T17:38:02Z

Alright, I'm happy to merge this, but if someone else wants to give the code a quick re-review beforehand that'd be great 👍

654wak654 · 2016-11-12T17:44:43Z

I'm assuming #4597 is going to need category = QGVAR(Utility) under class moduleAddOrRemoveFRIES because of this PR?

All of @alganthe's PRs will need it too: #4555 #4556 #4576

alganthe · 2016-11-12T17:46:12Z

Will modify my PRs when this is merged.

commy2 · 2016-11-12T19:23:42Z

~~lgtm.~~ I'd use a macro for the IDC's,but that is a general problem with the module and goes beyond this PR.

commy2 · 2016-11-12T22:15:48Z

addons/zeus/XEH_postInit.sqf

+    }] call CBA_fnc_addEventHandler;
+
+    [QGVAR(removeObjects), {
+        params ["_objects", "_curator"];


@SilentSpike
Do you mean:
params ["_objects", ["_curator", objNull]];
so that the exitWith thing works as alternative syntax?
Alternativeley change !isNull _curator to !isNil "_curator"

same above

I know that this works anyway (at least in unscheduled env.) due to isNull silently failing when _curator is undefined, but I still think relying on this SQF ... "feature" is bad design.

Good catch commy, I don't know why I totally forgot params can supply a default value when writing this 👍

commy2 · 2016-11-12T22:19:05Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+
+private _object = attachedTo _logic;
+if (isNull _object) then {
+    [LSTRING(NoObjectSelected)] call EFUNC(common,displayTextStructured);


if this script does indeed only run on the server, then why does it show a text there?

isn't it so that it runs on both server & local? @SilentSpike

Also a good catch, hmm, I suppose it probably should run on the client and then send an event to the server so that this client feedback can be given.

Not optimal in terms of minimising network traffic, but much better UX for zeus and also these modules are only running when prompted by zeus anyway so it's not a big deal.

commy2 · 2016-11-12T22:20:56Z

addons/zeus/functions/fnc_ui_editableObjects.sqf

+
+params ["_control"];
+
+disableSerialization;


does nothing in unscheduled env.
should be removed if these module scripts do indeed run unscheduled. otherwise ignore this

This is probably my bad if unnecessary as it's in all of my existing ui functions, not sure if I had reasoning for that when I first wrote them

commy2

see comments

kymckay · 2016-11-13T13:54:49Z

@654wak654 @alganthe Modules don't necessarily need categories defined, if they inherit from the base module then it'll still default to ACE.

- Module must run on zeus client so that feedback can be shown if validation fails - Use event in common to run the `enableSimulationGlobal` command - Can use existing localised string - Also adds default value to the editable objects events

commy2 · 2016-11-13T15:30:56Z

addons/zeus/functions/fnc_moduleSimulation.sqf

@@ -15,11 +15,13 @@

 params ["_logic"];

+if !(local _logic) exitWith {};


so the module is local to the zeus? good to know

Yep, this line is standard in all zeus modules (BI included) with a few exceptions.

kymckay · 2016-11-13T15:36:19Z

Just tested and confirmed that disableSerialization is unnecessary for the ui functions. Will remove that from them all while I'm at it.

RSpeekenbrink · 2016-11-14T09:24:03Z

addons/zeus/functions/fnc_moduleSimulation.sqf

+if (isNull _object) then {
+    [LSTRING(NothingSelected)] call EFUNC(common,displayTextStructured);
+} else {
+    [QEGVAR(common,enableSimulationGlobal), [_object, !(simulationEnabled _object)]] call CBA_fnc_serverEvent;


Just for learning purposes, what does QEGVAR exactly in this state?
Thanks

QuotedExternalGlobalVARiable
=> "ace_common_enableSimulationGlobal"

http://ace3mod.com/wiki/development/coding-guidelines.html#macro-usage

The line makes use of this event defined in the common component:
https://github.com/acemod/ACE3/blob/master/addons/common/XEH_postInit.sqf#L135

Aah I get it, makes a lot of sense now, thanks 👍

RSpeekenbrink added 4 commits November 11, 2016 13:32

Merge remote-tracking branch 'refs/remotes/acemod/master'

51de0bd

Added Zeus Module: Simulation

d2638cf

ModuleSimulation toggles simulation for objects

Added AddObjects and Remove Objects & ACE Util Category

9332101

Removed Tabs

d27c68c

jonpas previously requested changes Nov 12, 2016

View reviewed changes

jonpas added the kind/feature Release Notes: **ADDED:** label Nov 12, 2016

jonpas added this to the 3.9.0 milestone Nov 12, 2016

commy2 previously requested changes Nov 12, 2016

View reviewed changes

RSpeekenbrink and others added 6 commits November 12, 2016 09:45

Merge remote-tracking branch 'refs/remotes/acemod/master' into ZeusUtil

1683b5d

Code Cleanup

f329405

Fix array in fnc_moduleSimulation.sqf

7037676

Tab and Newline Cleanup

2398ac9

Filename Upercase on remote fix (fnc_removeObjects)

5a87acf

Filename Upercase on remote fix (fnc_addObjects)

aa3289d

kymckay self-assigned this Nov 12, 2016

commy2 reviewed Nov 12, 2016

View reviewed changes

kymckay and others added 3 commits November 12, 2016 11:37

Reduce network traffic of toggle simulation module

221d0ae

Module will run on the server only via the module framework (removing the need for any back and fourth).

Edited functions to meet Review

40ba9ef

Merge remote-tracking branch 'origin/ZeusUtil' into ZeusUtil

7868eaf

# Conflicts: # addons/zeus/functions/fnc_moduleSimulation.sqf

commy2 reviewed Nov 12, 2016

View reviewed changes

addons/zeus/functions/fnc_moduleSimulation.sqf

deleteVehicle _logic;

Copy link

Contributor

commy2 Nov 12, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

white space here

RSpeekenbrink and others added 3 commits November 12, 2016 15:24

Remove fnc_errorAndClose from fnc_ui_addObjects.sqf

be7c4d6

Remove White Space from fnc_moduleSImulation

4b690e8

_fnc_errorAndClose & removed from fnc_ui_removeObjects

a1ebaed

commy2 reviewed Nov 12, 2016

View reviewed changes

addons/zeus/functions/fnc_moduleSimulation.sqf

};

deleteVehicle _logic;

Copy link

Contributor

commy2 Nov 12, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

white space : (

RSpeekenbrink and others added 3 commits November 12, 2016 15:40

Space @ EOF removed :)

dd85fcb

simplified code (Tested in MP & SP)

59ef96c

Merge add/remove editable objects zeus modules

1c73355

- Merges the add/remove curator editable objects modules into one with a checkbox to specific behaviour. - Adds a checkbox to specify whether to effect all curators or only the local curator - Fixes locality handling of the module code

Clean up ace_zeus

30c694d

- Standardise function headers (remove examples where not applicable) - Add module categories (and make display names beautiful) - Alphabetise some classes

Clean up some camel case

aab2cb7

commy2 reviewed Nov 12, 2016

View reviewed changes

commy2 suggested changes Nov 12, 2016

View reviewed changes

Remove disableSerialization from fnc_ui_editableObjects

438255a

commy2 reviewed Nov 13, 2016

View reviewed changes

Remove unnecessary disableSerialization usage

6c6bb58

commy2 approved these changes Nov 13, 2016

View reviewed changes

RSpeekenbrink commented Nov 14, 2016

View reviewed changes

kymckay changed the title ~~Zeus Util Modules~~ Add Zeus utility modules Nov 15, 2016

kymckay merged commit 324bf68 into acemod:master Nov 15, 2016

		@@ -15,11 +15,13 @@

		params ["_logic"];

		if !(local _logic) exitWith {};

Add Zeus utility modules #4661

Add Zeus utility modules #4661

Conversation

RSpeekenbrink commented Nov 12, 2016 • edited Loading

jonpas left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

commy2 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RSpeekenbrink Nov 12, 2016 • edited Loading

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

kymckay commented Nov 12, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

commy2 Nov 12, 2016 • edited Loading

Choose a reason for hiding this comment

kymckay Nov 12, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RSpeekenbrink commented Nov 12, 2016

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

commy2 commented Nov 12, 2016

Choose a reason for hiding this comment

kymckay commented Nov 12, 2016

kymckay commented Nov 12, 2016

654wak654 commented Nov 12, 2016

alganthe commented Nov 12, 2016

commy2 commented Nov 12, 2016 • edited Loading

Choose a reason for hiding this comment

commy2 Nov 12, 2016 • edited Loading

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

commy2 Nov 12, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

commy2 left a comment

Choose a reason for hiding this comment

kymckay commented Nov 13, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kymckay commented Nov 13, 2016

RSpeekenbrink Nov 14, 2016 • edited Loading

Choose a reason for hiding this comment

bux Nov 14, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RSpeekenbrink commented Nov 12, 2016 •

edited

Loading

RSpeekenbrink Nov 12, 2016 •

edited

Loading

kymckay commented Nov 12, 2016 •

edited

Loading

commy2 Nov 12, 2016 •

edited

Loading

kymckay Nov 12, 2016 •

edited

Loading

commy2 commented Nov 12, 2016 •

edited

Loading

commy2 Nov 12, 2016 •

edited

Loading

commy2 Nov 12, 2016 •

edited

Loading

RSpeekenbrink Nov 14, 2016 •

edited

Loading

bux Nov 14, 2016 •

edited

Loading