beyond-all-reason / beyond-all-reason/RecoilEngine

Unify Lua API for world objects

Open
#1,374 2 comments 0 reactions 0 assignees View on GitHub
area: Lua API enhancement
Dominant language
C++
Stars
679
Forks
290
Avg merge
3d 2h
Merged PRs (30d)
40

Description

Bill of materials to be done before starting this ticket:
* #1373

----

After #1373, features units and projectiles will have unique IDs so (for example) `Spring.SetUnitPosition(unitID, xyz)` and `Spring.SetFeaturePosition(featureID, xyz)` will be redundant. There would be able to be a single `Spring.SetPosition(thingID, xyz)`.

Add unified interfaces where possible. Keep the old ones as aliases to the new ones.

Contributor guide

Open the contributing guide

Research direction

Start by reading prerequisite issue #1373 to confirm how unique IDs for units and projectiles are represented. Review the existing Spring.SetUnitPosition and Spring.SetFeaturePosition Lua interfaces, then identify other redundant unit, feature, and projectile APIs that can share unified interfaces. Done means unified calls exist where possible and the old calls remain usable as aliases.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, lua
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.