Skip to content

Commit 459f35c

Browse files
committed
Document color index for SetColor
1 parent fc43020 commit 459f35c

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

doc/lua/functions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,8 @@ Change the players nation.
229229
Change the players team.
230230

231231
**SetColor(color or colorIdx)**
232-
Sets the players color by index or directly if its alpha value is not zero.
232+
Sets the players color by index into the [`PLAYER_COLORS`](https://github.com/Return-To-The-Roots/libutil/blob/master/libs/common/include/s25util/colors.h#L34-L46) array.
233+
You can also use custom colors by specifying an ARGB value with a non-zero alpha channel (`0xFF` is strongly recommended).
233234
Duplicate color values are possible, so you have to ensure unique colors if you want them!
234235

235236
**Close()**

0 commit comments

Comments
 (0)