Some gadgets contain hardcoded unitnames or weaponnames, which is an issue for moddability

CarabusX commented 3 years ago

Here is the list of some gadgets that I found that contain hardcoded unitnames or weaponnames. The list is not complete, as I mostly looked at unit and weapon gadgets, and could miss some.

[x] 1. unit_air_plants.lua - L33-L45 - the list of air factories and plates, with their default Fly/Land setting. Could be turned to customParam.
[x] 2. unit_bomber_command.lua - L55-L68 - list of units with airpads, with some config. Could be moved to config file.
[x] 3. unit_factory_guard.lua - L50-L73 - list of factories and plates. Could probably be detected automatically.
[x] 4. unit_refuel_pad_handler.lua - L60-L62 - list of mobile units with airpads. Could be detected automatically, or use config from 2.
[x] 5. unit_show_shooter.lua - L35-L37 - list of units that don't decloak when firing. Could be turned to customParam.
[x] 6. unit_teleporter.lua - L67 - teleporter beacon unit is hardcoded. Could be turned to customParam on the teleporter like the teleporting ability already is.
[x] 7. unit_transport_load_unload.lua - L20-L23 - list of air transports. Could be detected automatically.
[x] 8. unit_transport_pickup_floating_amphib.lua - L71-L94 - list of units that can be dropped to sea. And some evil code that bases this ability on buildability by Amph Factory. Could be turned to customParam or even detected automatically if there are no exceptions.
[ ] 9. weapon_projectile_hold.lua - L27-L34 - some hardcoded weaponnames. Could be turned to customParams. (can be skipped for now because gadget is not enabled)
[x] 10. weapon_projectile_radar_homing.lua - L25-L29 - some hardcoded weaponnames and values. Could be turned to customParam.
[ ] 11. weapon_projectile_retarget.lua - L39-L90 - some configs for weapons. Could be moved to config file.
[x] 12. weapon_torpedo_stay_underwater.lua - L18-L24 - list of torpedo weapons. Could be detected automatically or turned to customParam if there are some exceptions.
[x] 13. weapon_shield_merge.lua - L216-L219 - list of units called "beamMultiHitException". Seems to be unused and probably can be removed.
[x] 14. cmd_block_ally_attack.lua - L25-L30 - list of units that can target allied units. Could be turned to customParam.
[x] 15. unit_target_on_the_move.lua - L110-L113 - list of units that can target allied units. Could be turned to customParam.
[ ] 16. game_over.lua - L86-L103 - list of units that do not count for game over condition. Could use existing dontcount customParam or add new customParam for units that should count only in campaign.
[x] 17. mod_stats.lua - L47-L70 - map of weapon names to attacker unit names. Could probably be generated automatically.
[x] 18. unit_terraform.lua - L212-L214 - list of units that have buildpower but can't terraform. Could be turned to customParam or even detected automatically.
[x] 19. unit_transport_ai_buttons.lua - L79-L82 - list of transports. Could be detected automatically as in point 7.
[x] 20. unit_puppy_handler.lua - L134-L139 - Puppy def and Puppy weapon def. Could be turned to customParams.
[ ] 21. factory_anti_slacker.lua - L26-L31 - the list of factories that don't eject produced units. Could be turned to customParam.
[x] 22. awards.lua - L432 - list of factories that can produce ships. Could probably be detected automatically.
[ ] 22a. awards.lua - L92-L121 - list of statics that are excluded from Turtle Shell award, or give Apocalyptic award. Could be turned to customParam or moved to config file. Also list of kamikaze units. Could be generated automatically.
[x] 23. unit_prevent_turret_overshoot.lua - L17-L20 - list of turrets with spherical targetting. Could be turned to customParam.

I may look into some, but also fell free to fix any of these :)

CarabusX commented 3 years ago

Points 1, 2, 3, 4, 5, 7 fixed in PR #4536.

CarabusX commented 3 years ago

Point 6 fixed in PR #4542.

CarabusX commented 3 years ago

Point 13 fixed by Sprung in commit https://github.com/ZeroK-RTS/Zero-K/commit/065dbc94e796ce3caad52b4517adc0dfbebaca74

CarabusX commented 3 years ago

Point 8 fixed in PR #4543.

GoogleFrog commented 3 years ago

I think the ticks should be for pulled PRs rather than open ones.

CarabusX commented 3 years ago

I think the ticks should be for pulled PRs rather than open ones.

They are. I am not ticking them until given PR is merged. Just posting links to PRs here so that someone doesn't accidentally start fixing something simultanously.

CarabusX commented 3 years ago

Points 10 and 12 fixed in PR #4546.

sprunk commented 3 years ago

How did you perform the check? There are more, for example https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Gadgets/unit_starlight_handler.lua#L29-L30

CarabusX commented 3 years ago

Yeah I didn't look for units with non-standard names. I mostly searched for strings prefixed with amph..., hover... (for all mobile unit types including stuff like bomber..., drone..., sub...), and then for statics (static..., energy..., plate..., turret... etc.). I skipped some I found not worth fixing or that don't need fixing for me. (like the hardcoded windgen in some OD places)

sprunk commented 3 years ago

Would anything be missed by grepping for UnitDefNames?

GoogleFrog commented 3 years ago

Or better, UnitDefNames[".

sprunk commented 3 years ago

That doesn't find things like

local udn = UnitDefNames
local rockoDefID = udn.rocko.id

CarabusX commented 3 years ago

Because things like these are too evil to find. Once I get through the current batch I may try finding some more.

CarabusX commented 3 years ago

Points 14, 15, 18, 19, 22, 23 fixed in PR #4549.

CarabusX commented 3 years ago

Point 17 fixed in PR #4557. Point 20 fixed in PR #4558.

Mach565 commented 1 year ago

Point 11 fixed in PR #4930.

ZeroK-RTS / Zero-K

Some gadgets contain hardcoded unitnames or weaponnames, which is an issue for moddability #4535