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

Add `Spring.SetUnitPositionXZ`

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

Description

See #1363 - currently SetPosition accepts two separate sets of args:
* either `x, y, z`,
* OR `x, z, bool surface vs underwater`

Split the XZ variant away into its own function, say `Spring.SetUnitPositionXZ`. Keep the functionality in regular `SetUnitPosition` for a while so that games don't immediately break, but don't mention the legacy args set it in the docs.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the existing SetUnitPosition implementation and read the related issue #1363 to understand the current argument variants. Done means a separate Spring.SetUnitPositionXZ function exists, the existing variants continue working temporarily, and the documentation does not describe the legacy XZ arguments.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
api, game-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.