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

Annotations related to script tasks #6596

Open
wants to merge 16 commits into
base: develop
Choose a base branch
from

Conversation

lL1l1
Copy link
Contributor

@lL1l1 lL1l1 commented Dec 21, 2024

Description of the proposed changes

  • Annotates ScriptTasks and related code.
    • All task scripts
    • Scry ability (Eye of Rhianne's ability)
      • orders.lua's interaction with scripted abilities like Scry
      • The remote viewing unit class for Scry
  • Whitespace formatting

Testing done on the proposed changes

  • Used cc440f3 to play around with the tasks using the test task while figuring out the behavior.
  • Logging commandmode.lua and UserScriptCommand
  • Looked for and cleared out annotation warnings in the task scripts, RemoteViewing.lua, and XAB3301_script.lua
Clipboard command to view all UnitCommands from RULEUCC command caps
LOG('RULEUCC_Move = ', GetUnitCommandFromCommandCap('RULEUCC_Move'))
LOG('RULEUCC_Stop = ', GetUnitCommandFromCommandCap('RULEUCC_Stop'))
LOG('RULEUCC_Attack = ', GetUnitCommandFromCommandCap('RULEUCC_Attack'))
LOG('RULEUCC_Guard = ', GetUnitCommandFromCommandCap('RULEUCC_Guard'))
LOG('RULEUCC_Patrol = ', GetUnitCommandFromCommandCap('RULEUCC_Patrol'))
LOG('RULEUCC_RetaliateToggle = ', GetUnitCommandFromCommandCap('RULEUCC_RetaliateToggle'))
LOG('RULEUCC_Repair = ', GetUnitCommandFromCommandCap('RULEUCC_Repair'))
LOG('RULEUCC_Capture = ', GetUnitCommandFromCommandCap('RULEUCC_Capture'))
LOG('RULEUCC_Transport = ', GetUnitCommandFromCommandCap('RULEUCC_Transport'))
LOG('RULEUCC_CallTransport = ', GetUnitCommandFromCommandCap('RULEUCC_CallTransport'))
LOG('RULEUCC_Nuke = ', GetUnitCommandFromCommandCap('RULEUCC_Nuke'))
LOG('RULEUCC_Tactical = ', GetUnitCommandFromCommandCap('RULEUCC_Tactical'))
LOG('RULEUCC_Teleport = ', GetUnitCommandFromCommandCap('RULEUCC_Teleport'))
LOG('RULEUCC_Ferry = ', GetUnitCommandFromCommandCap('RULEUCC_Ferry'))
LOG('RULEUCC_SiloBuildTactical = ', GetUnitCommandFromCommandCap('RULEUCC_SiloBuildTactical'))
LOG('RULEUCC_SiloBuildNuke = ', GetUnitCommandFromCommandCap('RULEUCC_SiloBuildNuke'))
LOG('RULEUCC_Sacrifice = ', GetUnitCommandFromCommandCap('RULEUCC_Sacrifice'))
LOG('RULEUCC_Pause = ', GetUnitCommandFromCommandCap('RULEUCC_Pause'))
LOG('RULEUCC_Overcharge = ', GetUnitCommandFromCommandCap('RULEUCC_Overcharge'))
LOG('RULEUCC_Dive = ', GetUnitCommandFromCommandCap('RULEUCC_Dive'))
LOG('RULEUCC_Reclaim = ', GetUnitCommandFromCommandCap('RULEUCC_Reclaim'))
LOG('RULEUCC_SpecialAction = ', GetUnitCommandFromCommandCap('RULEUCC_SpecialAction'))
LOG('RULEUCC_Dock = ', GetUnitCommandFromCommandCap('RULEUCC_Dock'))
LOG('RULEUCC_Script = ', GetUnitCommandFromCommandCap('RULEUCC_Script'))
LOG('RULEUCC_Invalid = ', GetUnitCommandFromCommandCap('RULEUCC_Invalid'))
LOG('RULEUTC_ShieldToggle = ', GetUnitCommandFromCommandCap('RULEUTC_ShieldToggle'))
LOG('RULEUTC_WeaponToggle = ', GetUnitCommandFromCommandCap('RULEUTC_WeaponToggle'))
LOG('RULEUTC_JammingToggle = ', GetUnitCommandFromCommandCap('RULEUTC_JammingToggle'))
LOG('RULEUTC_IntelToggle = ', GetUnitCommandFromCommandCap('RULEUTC_IntelToggle'))
LOG('RULEUTC_ProductionToggle = ', GetUnitCommandFromCommandCap('RULEUTC_ProductionToggle'))
LOG('RULEUTC_StealthToggle = ', GetUnitCommandFromCommandCap('RULEUTC_StealthToggle'))
LOG('RULEUTC_GenericToggle = ', GetUnitCommandFromCommandCap('RULEUTC_GenericToggle'))
LOG('RULEUTC_SpecialToggle = ', GetUnitCommandFromCommandCap('RULEUTC_SpecialToggle'))
LOG('RULEUTC_CloakToggle = ', GetUnitCommandFromCommandCap('RULEUTC_CloakToggle'))

Checklist

  • Changes are annotated, including comments where useful
  • Changes are documented in the changelog for the next game version

@lL1l1 lL1l1 added area: sim Area that is affected by the Simulation of the Game area: ui Anything to do with the User Interface of the Game type: intellisense labels Dec 21, 2024
@lL1l1 lL1l1 added this to the Development I of 2025 milestone Dec 21, 2024
@lL1l1 lL1l1 marked this pull request as ready for review December 21, 2024 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: sim Area that is affected by the Simulation of the Game area: ui Anything to do with the User Interface of the Game type: intellisense
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant