Skip to content
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.

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

Add RPT logging macros to all functions #12

Open
53 of 68 tasks
SiegeToaster opened this issue Jun 30, 2022 · 3 comments
Open
53 of 68 tasks

Add RPT logging macros to all functions #12

SiegeToaster opened this issue Jun 30, 2022 · 3 comments
Assignees
Labels
good first issue Good for newcomers to-do Something that needs to be completed.
Milestone

Comments

@SiegeToaster
Copy link
Member

SiegeToaster commented Jun 30, 2022

See the RPT Logging Macros for information on the available macros.

ace module

  • addActionsManageKit
  • addActionsTPToSquad
  • initLocalArsenal
  • interactions
  • playerActions
  • zeusActions

configuration module

  • additionalItemsAddCompatible
  • additionalItemsAddItems
  • additionalItemsCategory
  • additionalItemsClear
  • additionalItemsImport
  • additionalItemsKeyDown
  • additionalItemsSave
  • additionalItemsSelect
  • additionalItemsSpawn
  • editGroupsCreateGroup
  • editGroupsDeleteGroup
  • editGroupsKeyDown
  • editGroupsMode
  • editGroupsRefresh
  • editGroupsSaveSettings
  • editGroupsSelect
  • editGroupsSpawn
  • editRolesCleanupGlobals
  • editRolesCreateRole
  • editRolesDeleteRole
  • editRolesRefresh
  • editRolesSaveRole
  • editRolesSpawn
  • initFramework
  • rolesExpression
  • scanConfig

core module

  • briefing
  • checkModPresence
  • exitAFK
  • exportOCAP
  • exportScoreboard
  • formatBriefing
  • goAFK
  • introText
  • loadoutNotes
  • loadoutNotesDataToText
  • loadoutNotesGetLoadout
  • loadoutNotesName
  • loadoutNotesWepMags
  • orbat
  • safeStartHint
  • safeStartInit
  • safeStartLoop
  • setupGlobalArsenal
  • startMission
  • teleport
  • teleportToSquad
  • vehicleInfo
  • vehicleInfoTab

dynamicgroups module

  • handleMouse
  • handleScrollWheel
  • roleSelectOnLoad
  • roleSelectOnMBDown
  • roleSelectOnMBUp
  • roleSelectOnUnload
  • setRole
  • updateCamPos

radio module

  • giveRadios
  • loadDefaultSpatial
  • reorderMPTT
  • setDefaultSpatial
  • setRadioChannel

Auto-generated by tools/update_RPT_ToDo.py

@SiegeToaster SiegeToaster added the enhancement New feature or request label Jun 30, 2022
@SiegeToaster SiegeToaster added this to the Alpha Release milestone Jul 19, 2022
@SiegeToaster
Copy link
Member Author

Added to Alpha Release milestone because this logging information needs to be available in order to properly diagnose any problems that arise during playtesting.

@L-McKendrick L-McKendrick added the good first issue Good for newcomers label Jul 29, 2022
@h4ppy2243 h4ppy2243 self-assigned this Jul 31, 2022
@h4ppy2243 h4ppy2243 added to-do Something that needs to be completed. and removed enhancement New feature or request labels Jul 31, 2022
SiegeToaster added a commit that referenced this issue Aug 18, 2022
@SiegeToaster SiegeToaster self-assigned this Aug 18, 2022
SiegeToaster added a commit that referenced this issue Aug 18, 2022
@SiegeToaster
Copy link
Member Author

exitAFK start 6a530bd (updated 2a03863)
goAFK start e456a50 (updated 6f7ef79 and ed458b5)

@L-McKendrick
Copy link
Contributor

Format briefing, loadoutNotes, safeStartHint, and loadoutNotes already completed

L-McKendrick referenced this issue Sep 21, 2022
Added to:
- core\fnc_formatBriefing.sqf
- core\fnc_introText.sqf
- core\fnc_loadoutNotesDataToText.sqf
- core\fnc_loadoutNotesGetLoadout.sqf
- core\fnc_loadoutNotesName.sqf
- core\fnc_loadoutNotesWepMags.sqf
- core\fnc_orbat.sqf.sqf
- core\fnc_startMission.sqf
- core\fnc_teleport.sqf
- core\fnc_teleportToSquad.sqf
- radio\fnc_setRadioChannel.sqf
SiegeToaster added a commit that referenced this issue Oct 1, 2022
* Orbat function port for #8

* orbat function updates; settings.json cspell additions
orbat updates:
- added HEX code definitions for better code readability
- Update function description and fix example
- check briefOrbat before executing
- whitespace removal/addition where necessary
- changed string addition to joinString (see https://community.bistudio.com/wiki/Code_Optimisation#Concatenating_multiple_small_strings_together)
- fix refresh execution
- renamed to proper format

Cspell additions:
"Koromiko" - color
"QFUNC" - macro

* loadoutNotes function port for #8

* Removed leftover lame code

* Functions ports #8

* Prep

* remove test functions and calls; add new line at end of file
close #7

* hotfixes
giveRadios fix function call
orbat fix variables

* alphebetize PREP, add checkModPresence func, check if acre is loaded before executing giveRadios
PREP should be alphebetized so that it is easier to read and compare it to the file explorer.
ACRE shouldn't need to be checked in individual functions, just the handler.  But it doesn't hurt (about 1.25ms exec time) to have some redundancy.

* Fixed functions

* minor function updates
hint:
- macro usage
- haveKATMedical is a config value
- whitespace
- semicolon at end of command

teleport to squad: update example

* hint refinement

* checkModPresence log additions, description update

* move loadoutNotes private functions to their own file.

* change structure
handlers module removed because of lack of need
acre and tfar modules merged into radios module
kat and ctab modules merged into misc_items module
https://discord.com/channels/689674061366034435/966070504060489788/992215410357321829

* Port acre radio setup function (#13)

* acreRadioSetup add function and header

* finish acreRadioSetup port

* fix circular addon dependency

* update .gitignore to ignore shortcuts
for example, a shortcut to .rpt logs

* rewrite acreRadioSetup fnc GET_HASH macro

* add XEH files to ace & fix checkModPresence docs

* fix ace functions thing

* fix ace function v2

* start init framework script (see #1)

* AFK functions port

* initialization updates
create composition (doesn't work properly)
fix SET_CONFIG macro

* remove composition since it doesn't work properly

* configuration readme config def update
- change "SCALAR" type to "Integer"
- add default value column

* merge GET_CONFIG and GET_CONFIG_DEFAULT
GET_CONFIG now requires a default value.  closes #14

* added isArsenal object attribute (currently no functionality)

* add isButton and role object/unit attributes

* make role variable global

* create arsenals array, port initServer, misc
added all of the macros to cspell ignored words
port necessary parts of initServer

* port images, CfgEventHandlers whitespace

* CfgEventHandlers spaces to tabs

* Fixed: Setup Global Arsenal #15

* Demo concept for Setup Briefing Functionality #19

* add complete examples for briefing functionality

* rename .cpp imported files to .hpp

* update imports to match .cpp file name update

* configuration module updates; bug fixes
finalized briefing GUI for #19
removed initFramework function and related code
fixed GVAR using EGVAR syntax - pls at least build and launch before commiting :(

* Description.ext ports for #18 and #16

* add basic briefing function for #19

* formatting, naming, misc mainly for #16
fixed formatting (main problem was no end of file newline)
moves classes to the file where the class content is
changed event handler function calls to match convention

* formatting, naming, misc mainly for #16
fixed formatting (main problem was no end of file newline)
moves classes to the file where the class content is
changed event handler function calls to match convention

* finish briefing functionality; closes #19

* Add onPlayerKilled and onPlayerRespawn for #17
Doesn't resolve issue since it is called on respawn too.
Need to find out how to set respawnOnStart = -1

* semi colon

* setup Visual Studio/gitignore stuff for extension

* finish respawnOnStart = -1 thing
might be another 2 GB large commit idk

* add comments to extension source

* extension formatting, documentation, delete .vs folder

* add .vs folder to gitignore
couldn't do it before because then it wouldn't register the changes to delete the folder

* converted ace_button_img.jpg to a .paa file type

* Import TPD teleport function

* Update function name for #16

* Frontend for #26

* Revert "Frontend for #26"

This reverts commit ff66ddf.

* Frontend for #26

* Updated ace_button_img.paa reference for #22

* TPD revert and fixes for #16

* fnc_teleport proper header formatting; linebreaks

* core\fnc_teleport spaces to tabs

* formatting, proper macro usage, delete duplicate files.

* initialize framework button; front end for make_descriptionExt
closes #32

* Proper global variable names for #35

* Initial for port #39

* front end addon options

* check if file exists before writing

* formatting & error cleanup

* Improved formatting and macros for #39

* Move radio\Cfg3DEN to configuration\Cfg3DEN #37

* Moved radio clientInit

* Backend for #26

* newline at end of file, formatting, fix macro use

* move macro to script_macros, see development 5.1.7

* fnc_acreRadioSetup logging for #12

* fnc_briefing logging for #12

* created exportScoreboard function for #31

* GUI stuff, misc

Created Edit Role GUI for #30
Updated the way GUIs are implemented because I was lazy
misc bug fixes

* update GUI Defines
Mods do this differently than missions

* SafeStart Hint Functionality #38

* fixed formatting

* minor macro fixes for safeStart Hint #88

* fix goAFK create GUI thing; add example test code

* update faction name config values
Used for easy compatibility with ``side player``

* make.py improvement
When building while the game is running, make.py used to give a warning that is easy to miss.  Now, it is more clear since it tells you that something is wrong at the end of the command line instead of a few lines up where it may be hidden.

* roles stuff
made create role GUI
made buttons to access GUIs
made functionality to access edit role GUI

* Fixed and cleaned safeStart hint for #38

* fixed "safestart_phase" macro

* button to open createRoles GUI, misc.

* more functionality for the role editors
added empty functions:
roleChangedEditRoles - will update the checkboxes whenever a new role is selected
saveEditRoles - saves changes to role settings
also added ``closeDialog 2`` to all cancel buttons

* added RPT logging to fnc_exitAFK.sqf

* Added RPT Logging to fnc_goAFK.sqf

ignore the fact that I semi-doxed myself in the last commit

* fixed a RPT log typo in fnc_goAFK.sqf

* updated RPT logging for fnc_exitAFK.sqf

* updated RPT logging in fnc_goAFK.sqf

* added RPT logging to fnc_formatBriefing.sqf

* added RPT logging to fnc_hint.sqf

* added RPT logging to fnc_loadoutNotes.sqf

* updated RPT logging in fnc_hint.sqf

* updated RPT logging for fnc_formatBriefing.sqf

* roles GUI - update front end & function names

* renamed functions again, debug items, misc

* roles GUI add create role functionality, misc
also figured out that the mission has to be saved for config values to be updated; updated code and documentation accordingly.
misc stuff, idk look through the code if you're that interested

* Save role settings functionality
Also stopped save menu from opening when entering 3den

* delete role functionality; create role updates

* create GUI for additional items editor
still need functionality

* add items GUI - remove unneeded comments/attribute

* update configuration functions header examples
now include proper parameter examples

* Role Additional Items GUI list items functionality
Can now select categories and see available items and filter items based on name
featuring a ton of stolen code

also some formatting and cspell stuff

* covert stolen code from spaced indents to tabs

* update unneeded edit role GUI idc's

* remove tags from GUI controls; they aren't needed
The controls are local to their respective GUI

* Finish role GUI
guiControls.hpp: add all event handles, remove excess code, formatting.  Also replaced RscButton to ctrlButton because I think it looks better.
added functions for event handlers where needed
added a3 DIK Codes to includes

* add filepatching related files; fix syntax errors

* align additional items editor buttons and text

* update edit role GUI; add edit presets button

* setup edit presets GUI base; rename edit roles functions to classify them more easily

* fix function references, GUI idcs, add GUI
update function calls and references to match file name changes
update GUI idcs for less overlap
remove outdated and unused GUI editor save (now use ctrl + I, configFile >> "sia3f_configuration_GUIName")
add editGroups (aka presets) GUI, no functionality

* update roles GUI so that it uses the uiNamespace
until ready to save

* add functionality for edit groups GUI; misc
functionality was to create and assign roles to groups; still need to make a way to configure group settings.

* update configuration documentation; in-game stuff

* macro for buttom img

* fixed setPhase directory

* Task 1 for #39

* introText port

* startMission port
Part of task 3 for addAceActions Port #39

* Tasks 2 and 3 for addAceActions Port #39
- Resolves: addAceActions Port #39
- Resolves: Soliders-in-Arms-Arma-3-Group/SIA-Mission-Framework.VR#33

* removed bad 'return' code

* isArsenal/button bug fixes; allow removal

* Fixed radio channel not being set properly
Also fixed macro for fnc_hint

* Fixed missing ln

* bug fixes to SIA actions
Fixed: toggle info hint not working.
Fixed: exiting AFK not working.
Fixed: goAFK macro usage.
Fixed: teleport option for AFK dialog

* tweaked giveRadios to run locally
Workaround fix for double radio bug and JIP limitation for giveRadios

* fixed safeStart hint radio name display

* Rewrite for teleportTosquad function
Fixes: #48

* teleportToSquad - proper return syntax; formatting

* Replaced sleep with CBA_fnc_waitAndExecute
Fixed: #50

* Tweaked teleportToSquad to be an additional second

* tweaked unscheduled code conversion
Fixed: #50

* giveRadios unscheduled code conversion
Fixed: #51
Tweaked: fnc_setRadioChannel to run from fnc_giveRadios.
Added: fnc_setRadioChannel debug log if given radiotype is missing.

* Replaced CBA_fnc_waitAndExecute with waitUntil

* add front end for #49

* start groups mode GUI; misc
made gap between main part of GUI and top/bottom smaller
update groups value format
misc

* groups settings functionality
added mode checks for some funcs
added compatibility for both modes for some funcs

* convert mode select to buttons; misc bug fixes
having the mode select as a toolbox prevented switching GUIs easily

* make additional items GUI compatible with groups
significant changes are in guiControls.hpp, additionalItemsSave.sqf, and additionalItemsSpawn.sqf
other changes are mostly proper variable naming

* added global var cleanup; misc
removed test systemChat stuff
prevent group with empty name from being added

* fix group editor double click

* apply role settings; roles GUI enhancements
All role settings except for local arsenal items are now functional (I think)
Setting a unit's role to something not in the roles hashmap will create a new role of the role name in the hashmap
additional items import now accepts ACE arsenal arrays
additional items import no longer overwrites the current items list, but instead adds to it

* fixed macro path

* minor aceActions improvements
Fixed: macro usages for "TpSquad" and "AFK".
Tweaked: Replaced `spawn` with `CBA_fnc_waitAndExecute` for "loadoutNotesRefresh".
Tweaked: Cleaned up code for phase actions.

* minor safeStart hint display tweaks
Radio lane is now "<RADIO NAME>, Ch <#>".
Made header text sightly smaller.

* fixed exitAFK bugs, still captive and spawn code
Fixed:
- Player was still set as captive after exiting AFK.
- Replaced spawn with CBA_fnc_waitAndExecute.
- AFK timeout condition had bad macro in ace action.

* filter additional items import even more; misc

* role value bug fixes; local arsenal func start

* init arsenal fixes and implementation; bug fixes

* fixed reference to missing variable

* fixed issue with acre2 requirement

* move roles expression to function; bug fixes

* remove stupid 'press enter to continue' prompt at the end of make.py

* naming tweaks
"ACRE/TFAR Options" to "Radio Options"
"Groups Editor" to "Role Groups"

* additional items editor updates
added GUI_THEME_COLOR macro for GUI title bar
changed "OK" to "RETURN" in edit groups GUIs
changed "+" to "∞" in additional items editor
merged title background into title text

* make build.py declare how many addons it has built
to make sure that the changes made are being applied

* move radio module macros to script_macros.hpp

* backend for #49
Resolves: #49
Tweaked:
- tooltip for start mission code section specifies "zeus misison start".
- 3den mission start code section attribute control changed to code multi line.

* safeStart init and functionality for #43
Added:
- "safeStartInit" function.
- "safeStartLoop" function.
Tweaked:
- renamed "hint" function to "safeStartHint".
- "safeStartHint" is now called through the "safeStartInit" instead of serverPostInit.

* tweaked safeStartLoop to scheduled for #43
recursion is bad.
- Also accurately waits until zeus is initalized before running safeStart.

* fix incorrect var name

* safe start formatting, spelling, params updates
#43

* update settings macro

* added ACE checks and proper docs to safeStartLoop
_unit param is not needed since this script is ran locally
Updated description; this function is now completely unique from the hot mess that is F3's safeStart

* ui improvements for roles/groups editor
Added:
- info tooltips explaining certain elements.
- background fade

* convert role assigned groups value to array
for #30 and "Before PR Merge" 6th item in #54

* expanded default role options for roles editor
part of task #1 for "before pr merge"

* added "leadership" default group to role editor
- resolves task 1 for "before pr merge"

* fixed mixed up has variables

* replaced "real_date" ext call with CBA_fnc_weekDay
Resolves: #56

* mission outcome added to ocap2 export

* fixed radio error due to missing default param

* add "NONE" to radio options (on the right branch)
for #46

* update radio macros

* UI size increase for role editor
- Resolves task 4
- Macro implementation for gui control sizes and positions.
Credit to R3vo for guiControl code from 3den Enhanced VIM GUI.

* RPT logging macros added to functions
Added to:
- core\fnc_formatBriefing.sqf
- core\fnc_introText.sqf
- core\fnc_loadoutNotesDataToText.sqf
- core\fnc_loadoutNotesGetLoadout.sqf
- core\fnc_loadoutNotesName.sqf
- core\fnc_loadoutNotesWepMags.sqf
- core\fnc_orbat.sqf.sqf
- core\fnc_startMission.sqf
- core\fnc_teleport.sqf
- core\fnc_teleportToSquad.sqf
- radio\fnc_setRadioChannel.sqf

* fixed return statement

* acre radio options rework and improvements
Resolves: #46

Added:
- "SEM-52SL" as personal radio option.
- "PRC 343" as handheld radio option.
- "SEM 70" as a manpack radio option.

Tweaked:
- Replaced GET_CONFIG(radio) usage with missionNameSpace getVariable.
- fnc_safeStartHint.sqf condition to say "NONE" if set as none, unless player has another radio given.

* formatting; error macros; type checking

* split acreRadioSetup into individual functions
also some formatting fixes and task 3 for #27

* add github actions (checks) and credit

* sqf validator fix

* add .gitattributes, remove dumb VS project files

* Make HEMTT build action work

remove lint action; make HEMTT build action work
lint action doesn't actually check anything; completely useless due to so many false positives

fix dumb file names

fix dumb file names v2

* undo test stuff

* finalize setting spatialization settings

* run modules only in appropriate score; misc.
resolves #45 :)

* delete misc_items module

* add credit to config_style_checker.py

* regulate respawn templates for ace spectator

* removed bad variable use

* add unique defaults for radio spatialization

* prevent XEH scripts from executing in main menu
resolves #45

* add default mission attributes to initFramework
also moved the roles and groups default stuff to initFramework
resolves tasks 1, 2, and 3 for #59

* update module READMEs, enable debug mode full

* add proper authors to modules

* add function start/stop logging macros

* RPT logging; syntax stuff; misc.

* Cfg3DEN syntax and such

* syntax; remove period from tooltips

* fixed default radio settings in wrong module

* 3den framework settings tweaks
- Added missing tooltips and tweaked some text for consistency.
- Tweaked config name and text from "status hint" to "safestart hint".
- Removed img from safeStart hint.

* rebuild extensions to reflect #41
Also turns out those dumb project files are useful for storing build instructions

* fix scanConfig function not being run

* syntax; RPT logging; misc

* fixed missing semicolon

* fix tooltips; misc

* core module XEH scripts formatting, syntax, misc

* core module XEH_serverPostInit fix vars and macros

* core functions/scripts formatting, logging, misc.

Co-authored-by: Liam McKendrick <liammckendirckgaming@gmail.com>
Co-authored-by: h4ppy2243 <106175210+h4ppy2243@users.noreply.github.com>
Co-authored-by: L-McKendrick <83250894+L-McKendrick@users.noreply.github.com>
Co-authored-by: johndm22 <106129909+johndm22@users.noreply.github.com>
Co-authored-by: heart <83671890+Heart-SIA@users.noreply.github.com>
SiegeToaster added a commit that referenced this issue Oct 6, 2022
I've done all the testing I can, but it still might break
I also want to add this to the workflows, waiting for permissions to add a token to the environment variables
@SiegeToaster SiegeToaster pinned this issue Oct 8, 2022
@SiegeToaster SiegeToaster modified the milestones: Beta Release, Ongoing Oct 11, 2022
SiegeToaster added a commit that referenced this issue Nov 24, 2022
* replace real_date extension with CBA_fnc_weekDay
resolves #70

* create script to automatically update #12

* copy commonObject actions to function
function not yet used

* disable functionality if framework not initialized
resolves #65

* add vehicle info functions; see #40
from https://github.com/Soliders-in-Arms-Arma-3-Group/SIA-Mission-Framework.VR/blob/main/sia_f/functions/briefing/fn_vehicleInfo.sqf

* touch up parameters; misc.

* move obj attributes to file; supportInfo option
#40 front end

* fix actions stuff (I think)

* finish vehicle info briefing stuff
Still needs some final touches, but pretty much done.

* add zeus actions to func; misc.

* save loadout on mission start
requested by Austin [here](https://discord.com/channels/689674061366034435/690255520728350720/1029724157413445632)

* move proper actions to buttonActions/playerActions
misc

* move core serverPostInit into functions
resolves #71

* add new functions to prep

* bug fixes; convert spaces to tabs

* update vehicle info header; formatting

* fix #import instead of #include; delete build.bat
hopefully build.bat isn't used, but it just runs hemtt

* add expression disclaimer in configuration readme
not that anyone will ever read it.

* progress on #74, formatting/syntax, documentation

* Fix for #74

* safeStart Safety and Init readded
Resolves: #76

* minor tweaks
- Removed error message when a section of the briefing is empty.
- Added zeusActions function to run on postClientInit.

* XEH_PREP alphabetized

* addActions non-ace tweaks

* fix formatting

* make.py now works with pre-defined keys

* update version to v1.0.0
@SiegeToaster SiegeToaster removed the to-do Something that needs to be completed. label Jan 4, 2023
@SiegeToaster SiegeToaster added the to-do Something that needs to be completed. label Jan 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers to-do Something that needs to be completed.
Development

No branches or pull requests

4 participants