Space Engineers

Space Engineers

3,628 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
5 Sep, 2016 @ 8:02am
23 Feb, 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://steamproxy.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://steamproxy.com/sharedfiles/filedetails/?id=758966734
Easy Inventory (v2) - http://steamproxy.com/sharedfiles/filedetails/?id=646796262
Aerodynamic Physics (v2) - http://steamproxy.com/sharedfiles/filedetails/?id=571920453
Build Vision - http://steamproxy.com/sharedfiles/filedetails/?id=756792814
Text Projector (v2) - http://steamproxy.com/sharedfiles/filedetails/?id=762397930
Build Hints - http://steamproxy.com/sharedfiles/filedetails/?id=762950855
Dock Assist (v2) - http://steamproxy.com/sharedfiles/filedetails/?id=764754640
Stargate mod - http://steamproxy.com/sharedfiles/filedetails/?id=754173702
Wormhole portal - http://steamproxy.com/sharedfiles/filedetails/?id=377773977
Score Screen (v2) - http://steamproxy.com/sharedfiles/filedetails/?id=767740490
Automatic Ore Pickup - http://steamproxy.com/sharedfiles/filedetails/?id=657749341
Hunger and Thirst - http://steamproxy.com/sharedfiles/filedetails/?id=591816613
Build Information - http://steamproxy.com/sharedfiles/filedetails/?id=514062285
HudLcd - http://steamproxy.com/sharedfiles/filedetails/?id=911144486
Popular Discussions View All (4)
6
11 Jul, 2020 @ 9:21pm
Suggestion: inline sprite
Digi
4
5 Mar, 2019 @ 10:06pm
Space text shadow and immediate draw call
Digi
0
26 Jul, 2023 @ 1:42pm
Compatibility with Head Tracking Plugin
[ZSU] Dave247
492 Comments
DraygoKorvan  [author] 29 Oct @ 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 28 Oct @ 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 19 Oct @ 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 19 Oct @ 8:00am 
when i open chat and press f2 nothing shows up
FEEÐBACK 18 Oct @ 4:04am 
Any chance that fix ultra wide ui fix for faction, economy, etc ?..
eragon8864 17 Oct @ 11:41pm 
am starting to think it's not this one or its a combination of this & something else but idk - I spent almost 2hrs already just to narrow down/eliminate most of my mods/plugins - was really hoping it was something stupid simple but that’s not my luck - I'll reach out if I can’t find any other solutions, but I think you're right w/ the post before mine that it must be some combination or other conflict - taking this one out was just the first time loading in the first time gave me HUD/toolbars & all. I’ma do some more digging into this & adding/removing/testing about. Wish it would be less of a PITA to narrow down this stuff.

Seems like I always insist on somehow finding/making the most edge case issues lol - literally had been one of a very small number of servers a few major updates back that were having issues ONLY w/ large numbers of mods & took Keen like a solid 2+ MONTHS to actually discover the cause on that one.
DraygoKorvan  [author] 15 Oct @ 6:28pm 
Would need your log to troubleshoot as I cant reproduce that issue on my end.
eragon8864 15 Oct @ 4:51pm 
it appears this mod is causing the HUD not to show if loaded/active - I've removed every other plugin/mod I use and if I have this mod active my entire vanilla HUD doesn't seem to be visible - no o2/h2/health bars, no speed, no crosshair, gps markers, anything - regardless of being in a cockpit or not - every other mod/plugin I use works just fine except for BuildInfo and Compass HUD since they use this - not sure what else it could be conflicting with but I've done as much testing as I can/know how to do and when I remove/disable this mod/plugin, HUD shows up just fine with or without all the rest. Figured I'd post here - might not be this, could totally be something else it's conflicting with but I don't see how since everything appears just fine without this but doesn't work with this running.
DraygoKorvan  [author] 15 Oct @ 9:36am 
Update did not impact this mod, it may impact the mod that uses this mod.
Ozlav 15 Oct @ 9:10am 
Modded HUD not showing anymore, did the last update break the mod?