Space Engineers

Space Engineers

3,926 ratings
Text HUD API
2
9
8
2
   
Award
Favorite
Favorited
Unfavorite
Type: Mod
Mod category: Script, Other
File Size
Posted
Updated
1.119 MB
Sep 5, 2016 @ 8:02am
Feb 23, 2022 @ 3:13pm
98 Change Notes ( view )

Subscribe to download
Text HUD API

In 2 collections by DraygoKorvan
Space Engineers Physics
11 items
Deathmatch Toolkit
6 items
Description
Allows modders to add text to the players screen. This mod must be loaded along side any other mod that uses it.

Graphics update note: Post-Processing causes all HUD API text to be dark and blurry unless it uses the PostPP blendtype.

Common Issue: If the mod is not working delete Steam\steamapps\workshop\content\244850\758597413 to force TextHUDAPI to redownload the latest version from steam.

Reference issue
'Reference issue detected (circular reference or wrong order)' in the log does not indicate a problem. All it means is that another mod already loaded this mod and it is skipping loading this mod a second (or third) time. Please look further in your log for a crash message that may indicate the real problem if your save is not loading.

Features:
Add Text HUD elements
Add Text to world
Add Text attached to Entities.
Add Billboards to HUD elements
Adds an interactable mod menu.
Fonts are fully modifable.


There is now a new API class that interfaces with this mod you can get it here:

[SteamLibrary folder]\steamapps\workshop\content\244850\758597413\Data\Scripts\HUDApi\HudAPIv2.cs

In a Session Component init the mod using the Init Method

TextAPI = new HudAPIv2(onRegisteredCallback);

Note: onRegisteredCallback method will be called when the API registers to this mod you can then declare all HUD/Menu elements in that method.

Note before using any class make sure Heartbeat is true. If you try to call a constructor while Heartbeat is false it will lead to a crash. Using the Callback method can help you avoid this issue.

Editing any class property will update it instantly, there is no longer any network messaging involved with the mod. This also means you have to now worry about thread safety.

Modders:


You can change the color of the text with the <color=colorname> tag. No closing tag is required. You can use multiple colors in the same message.
<color=r,g,b> and <color=r,g,b,a> also supported. r = red [0-255] b = blue [0-255] g = green [0-255] a = alpha [0-255]
<i> tag for italic text. end the tag with </i> ex. <i>this is italic text</i>
<reset> will reset the formatting of the text back to the default. <color=red>a<i>b<reset>c

The Heartbeat property lets you know if the class has received a heartbeat, so you can be confident the player has the mod installed. If they do not then you can revert to any previous messaging scheme you had.

V3.1
Added custom font support. ( Example mod: https://steamcommunity.com/sharedfiles/filedetails/?id=2163222751 )

V3.0
Added BoxUI
Fixed menu display order.
Added InitialColor property for HUDMessages.

V2.6
Removed support for version 1.

V2.53
MenuColorPicker added

V2.52
Draw() Method added
Performance improvements

V2.51
Included some performance improvements.
Modders now can manually flush the cache by calling the Flush() method.

V2.5
Texture files eliminated, mod now uses a UV map to generate the font.
Monospace font added
Mod menu added



Thanks to Digi for pointing me in the right direction to get it working properly with 3rd person.

Localization complete, now supports all characters - Thanks Midspace!

Mod List:
Notes (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=758966734
Easy Inventory (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=646796262
Aerodynamic Physics (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=571920453
Build Vision - http://steamcommunity.com/sharedfiles/filedetails/?id=756792814
Text Projector (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=762397930
Build Hints - http://steamcommunity.com/sharedfiles/filedetails/?id=762950855
Dock Assist (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=764754640
Stargate mod - http://steamcommunity.com/sharedfiles/filedetails/?id=754173702
Wormhole portal - http://steamcommunity.com/sharedfiles/filedetails/?id=377773977
Score Screen (v2) - http://steamcommunity.com/sharedfiles/filedetails/?id=767740490
Automatic Ore Pickup - http://steamcommunity.com/sharedfiles/filedetails/?id=657749341
Hunger and Thirst - http://steamcommunity.com/sharedfiles/filedetails/?id=591816613
Build Information - http://steamcommunity.com/sharedfiles/filedetails/?id=514062285
HudLcd - http://steamcommunity.com/sharedfiles/filedetails/?id=911144486
Popular Discussions View All (4)
6
Jul 11, 2020 @ 9:21pm
Suggestion: inline sprite
Digi
4
Mar 5, 2019 @ 10:06pm
Space text shadow and immediate draw call
Digi
0
Jul 26, 2023 @ 1:42pm
Compatibility with Head Tracking Plugin
[ZSU] Dave247
498 Comments
Echthros Nov 27 @ 10:29pm 
After further testing, it seems like the "BellFontData" textures that are being used for the Chinese characters are not in the correct dds format to be used as transparent textures on drawn quads. Creating copies that are in "BC1 (sRGB)" instead of "BC3 (Linear)" seems to fix the issue.
Echthros Nov 27 @ 9:08pm 
Does this work for Chinese characters? I'm seeing them all show up as white squares with the default "white" font.
Divinity Sep 14 @ 9:38pm 
i accidentally unbound my f2 key and cant rebind, any suggestions?
Meta Bluejay May 27 @ 8:23am 
Compass isn't showing
Tanya Sapien Dec 6, 2024 @ 8:46pm 
Found the source of the issue, UI scaling. I had UI scaling set to 80%. reverting it to default (100%) seems to have fixed the issue.
Tanya Sapien Dec 6, 2024 @ 8:43pm 
I'm having an interesting issue where the regular mod menu functions just fine (open chat, hit F2) but when I use the Alt+F10 admin menu, the mod menu header appears, but clicking on it does nothing, it won't open. I'm playing single player, offline mode.
DraygoKorvan  [author] Oct 29, 2024 @ 3:28pm 
HUD Compass throws an exception on load that is normally caught and ignored, i wonder if that is causing your problem DeVOID.
valtroth Oct 28, 2024 @ 2:13pm 
Similar issue to ProtocolPalpatine, I cannot open the F2 menu. This is on a hosted dedicated server, Host Havoc. I am the admin. This is true with or without creative enabled
DeVOID Oct 19, 2024 @ 7:01pm 
I'm getting a crash to desktop when loading in to a server using Text HUD API and the HUD Compass mods.
I know this is a "me problem" because I use Linux, but any help would be appreciated.
I'm running with proton-ge 9-16, with dotnet48 installed (the known dependency for Space Engineers)
I can join just fine, the world loads to 100% and then crashes as soon as it attempts to spawn me on a planet (or upon reaching 100% if I'm already on the planet). The two mods work perfectly fine in my single player worlds. Also this has been an issue for a few updates, I think I attempted to fix this about 6 months ago with the same results.
I can provide SE logs, please help! Thank you :necroheart:
ProtocolPalpatine Oct 19, 2024 @ 8:00am 
when i open chat and press f2 nothing shows up