Code cleanup and documentation

Added documentation in GUI.rst for the new settings

Cleaned up the MR with some remnant changes.
This commit is contained in:
Kagernac 2024-06-19 11:08:05 -07:00
parent 7d403089ec
commit f7628ff0a8
3 changed files with 55 additions and 3 deletions

View file

@ -157,6 +157,32 @@ The alpha value is currently ignored.
A topic response is considered unique if its Actor filter field contains the speaking actor's object ID and hasn't yet been read.
color topic specific over
--------------------
:Type: RGBA floating point
:Range: 0.0 to 1.0
:Default: empty
This setting provides an "over" colour to dialogue topics that meet the color topic specific criteria.
The value is composed of four floating point values representing the red, green, blue and alpha channels.
The alpha value is currently ignored.
A dialogue topic is considered "over" if it is the active GUI element through keyboard or mouse events.
color topic specific pressed
--------------------
:Type: RGBA floating point
:Range: 0.0 to 1.0
:Default: empty
This setting provides an "pressed" colour to dialogue topics that meet the color topic specific criteria.
The value is composed of four floating point values representing the red, green, blue and alpha channels.
The alpha value is currently ignored.
A dialogue topic is considered "pressed" if it is the active GUI element and it receives a sustained keyboard or mouse event.
color topic exhausted
---------------------
@ -169,3 +195,29 @@ The value is composed of four floating point values representing the red, green,
The alpha value is currently ignored.
A topic is considered "exhausted" if the response the player is about to see has already been seen.
color topic exhausted over
--------------------
:Type: RGBA floating point
:Range: 0.0 to 1.0
:Default: empty
This setting provides an "over" colour to dialogue topics that meet the color topic exhausted criteria.
The value is composed of four floating point values representing the red, green, blue and alpha channels.
The alpha value is currently ignored.
A dialogue topic is considered "over" if it is the active GUI element through keyboard or mouse events.
color topic exhausted pressed
--------------------
:Type: RGBA floating point
:Range: 0.0 to 1.0
:Default: empty
This setting provides an "pressed" colour to dialogue topics that meet the color topic exhausted criteria.
The value is composed of four floating point values representing the red, green, blue and alpha channels.
The alpha value is currently ignored.
A dialogue topic is considered "pressed" if it is the active GUI element and it receives a sustained keyboard or mouse event.