Skip to content

Add Lua documentation details#21740

Merged
PunkPun merged 1 commit intoOpenRA:bleedfrom
JovialFeline:clarify-lua
Feb 8, 2025
Merged

Add Lua documentation details#21740
PunkPun merged 1 commit intoOpenRA:bleedfrom
JovialFeline:clarify-lua

Conversation

@JovialFeline
Copy link
Contributor

This PR adds details to the Lua documentation that are not obvious without testing or looking at the underlying C# code.

There is also a minor annoyance with OnProduction and OnCapture that I'd like to fix.


[Desc("Call a function when one of the actors in a group is killed. The callback " +
[Desc("Call a function when one of the actors in a group is killed. " +
"This trigger removes itself once activated. The callback " +
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think both of these are incorrect. The triggers are never removed, but rather they are deactivated. Maybe better wording would be, the trigger is called only once?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Done.

@PunkPun PunkPun merged commit 052c74e into OpenRA:bleed Feb 8, 2025
2 checks passed
@PunkPun
Copy link
Member

PunkPun commented Feb 8, 2025

changelog

@PunkPun PunkPun added this to the Next Release milestone Feb 8, 2025
@PunkPun
Copy link
Member

PunkPun commented Feb 8, 2025

2030c17

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants