Add notes to AddSpecialEffectTarget, SetUnitColor and SetAllyColorFil… #141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…terState The notes are concerning the color of attached effects, the portrait model of units, and that AddSpecialEffectTarget can only be used on units.
Luashine
requested changes
May 21, 2024
Comment on lines
+13503
to
+13505
| portrait model, it won't restart the animation, either). The portrait model can be updated by deselect the unit, switching | ||
| to another unit of a differet type or of a different player. Another option is to call `SetUnitColor` on the unit that is | ||
| showing its portrait model or using `SetAllyColorFilterState` (see `SetAllyColorFilterState` for specifics). |
There was a problem hiding this comment.
maybe a double new line before "The portrait model"? The paragraph is quite long and that sentence begins to describe one of two workarounds.
Double new line because of markdown interpretation
| will not change the portrait color. The portrait will only update correctly if you | ||
| deselect the unit. | ||
| will not change the portrait color (switching to a unit of the same type and player will not do a re-render of the | ||
| portrait model, it won't restart the animation, either). The portrait model can be updated by deselect the unit, switching |
There was a problem hiding this comment.
by deselect the unit
-> by deselecting the unit
Comment on lines
+13507
to
+13511
| @note If the unit being re-colored is the one currently showing its portrait model in the user interface, | ||
| it will correctly re-color the portrait model. | ||
|
|
||
| @note If the unit being re-colored is the one currently showing its portrait model in the user interface, | ||
| the portrait model will be forced to update and restart its animation. |
There was a problem hiding this comment.
these two can be collapsed into one note, right? Not just for repetition's sake, I have seen the Notepad++ auto-completion screenshot by @Leyki, the longer descriptions of ours fill the entire 1080p screen
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…terState
The notes are concerning the color of attached effects, the portrait model of units, and that AddSpecialEffectTarget can only be used on units.