Space Engineers

Space Engineers

3,507 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
480 Comments
DraygoKorvan  [author] Jul 3 @ 7:05am 
Anywhere, it doesnt matter.
Malpherian Jun 28 @ 6:46pm 
Where in the load order does this go?
lotherius Jun 7 @ 5:49pm 
The "Reference Issue Detected" is actually a real issue despite author's claims. However it was easily resolved by unsubscribing and resubscribing.
maxdean02 May 16 @ 9:00pm 
Nevermind, it just randomly fixed itself
maxdean02 May 16 @ 8:53pm 
I'm having a problem where the mod will cause hud elements to like, jump around for lack of a better term. They're moving all over the place and not staying still. I just did a clean install of my game and all my mods, so I'm confused as to why this would happen when it's never been an issue before. When I try to access the mod settings in the top left, it doesn't even display any of the settings for mods that use this.
may i ask what does VSLP mean?
i found my problem buddy thanks one mod was not loading all he needed so its not the Text HUD API some other mod is causing the problems for me sorry i just needed to ask i really love this mod and for me not to use it will change everything thanks again guys
:selike:
OK i will search trough my files and see if i see something wrong thanks buddy
DraygoKorvan  [author] Mar 14 @ 10:22am 
What are you even talking about?
but it says that the hub will not be visible buddy what does that mean buddy