Update the API files #15
Conversation
Based on OpenRA dev branch + OpenRA PR 21109.
Based on release-20231010 + OpenRA PR 21109.
Made ReinforceWithTransport()'s `cargoTypes` parameter nullable because it should be but we have no good way of automatically marking it as such. See OpenRA PR 20609. (based on commit 35cb21a)
| --- Current actor stance. Returns nil if this actor doesn't support stances. | ||
| ---@field Stance string | ||
| --- Current health of the actor. | ||
| --- **Requires Trait:** [IHealth](https://docs.openra.net/en/release/traits/#ihealth) |
There was a problem hiding this comment.
| --- **Requires Trait:** [IHealth](https://docs.openra.net/en/release/traits/#ihealth) | |
| --- **Requires Trait:** [Health](https://docs.openra.net/en/release/traits/#health) |
There was a problem hiding this comment.
The code does say Requires<IHealthInfo> though, which may or may not be the our Health trait 🤔 and as with the IMove case, there is no way to know which implementation this relies on (and it shouldn't rely on a specific implementation anyway).
I am not sure what to do here because IHealth/IMove may not be very understandable to non-programmers, but they are the correct things. I don't know how we could explain "you need one of the traits that implement this interface, which is: A, B, C, D"
There was a problem hiding this comment.
I just noticed that this is not a regression. We already have these interface links.
| --- Maximum health of the actor. | ||
| --- **Requires Trait:** [IHealth](https://docs.openra.net/en/release/traits/#ihealth) | ||
| ---@type integer | ||
| MaxHealth = nil; | ||
|
|
||
| --- Enter the target actor to repair it instantly. | ||
| --- *Queued Activity* | ||
| --- **Requires Traits:** [IMove](https://docs.openra.net/en/release/traits/#imove), [InstantlyRepairs](https://docs.openra.net/en/release/traits/#instantlyrepairs) |
There was a problem hiding this comment.
| --- **Requires Traits:** [IMove](https://docs.openra.net/en/release/traits/#imove), [InstantlyRepairs](https://docs.openra.net/en/release/traits/#instantlyrepairs) | |
| --- **Requires Traits:** [Mobile](https://docs.openra.net/en/release/traits/#Mobile), [InstantlyRepairs](https://docs.openra.net/en/release/traits/#instantlyrepairs) |
or maybe just unlink it.
|
Created a separate ticket #16 for the interface links. It is actually unrelated to this. |
release-20231010versionBoth were generated using OpenRA/OpenRA#21109.
Closes #13, closes #14.