Knuckle Cracker Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

~~NOTOC~~
<=[[4rpl:start| Index]]

====== SetUnitDebugText ======
SetUnitDebugText(<-unit <-text)

===== Description =====
Sets a text to appear above a unit.

This text can be used instead of, or in conjunction with [[SetObjText]] to display some text above a unit. It is directly attached to the unit and cannot be re-positioned. Although being labeled as "debug", it can be used in non-editor gameplay. For example, the game uses it to display the out-of-ammo message for the Airship.\\
Both this API and [[SetObjText]] have access to all compatible formats in CW4. If you plan to resize the text, you will need to use the format "<color #8BDFFF><line-height=[Insert number]></color>" after resizing as the changed size of text will not scale it's line-height correctly without intervention. Typically; "<color #8BDFFF><size=[SOME NUMBER]><line-height=100%></color>" solves this problem entirely. Unlike [[SetObjText]], new lines will be created so you won't need to manually add formats like "<color #8BDFFF><br></color>".\\
The full list of formats in CW4 can be found in the [[cw4:a.d.a_syntax_syntax_guide|A.D.A. Message editor format]] guide.

The text displayed by SetUnitDebugText is cleared upon game reload. If needed, it is recommended to re-apply the text display inside the [[func_awake|:Awake]] function.
===== Examples =====
<code 4rpl>
SetUnitDebugText(Self "text goes here")
</code>

=== See Also ===
[[4rpl:start#Debugging]]

<=[[4rpl:start| Index]]

Knuckle Cracker Wiki

User Tools

Site Tools

Page Tools