Space Engineers

Space Engineers

3,352 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.

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
< >
465 Comments
DraygoKorvan  [author] Jan 29 @ 10:31am 
To use this you would have to subscribe to or create a mod that uses this mods API. If your not a programmer, dont worry about it.
carbombthedestroyer Jan 29 @ 9:23am 
How do I use this? Do I need to do something beyond subscribe?
Deapri Jan 11 @ 7:45pm 
Ai enabled appears for me as intended...
Pixie Jan 2 @ 7:00pm 
Good afternoon Dray, When I look for the Ai Enabled mod it is not in the list. I see build vision so Text HUD API is working fine. Do you think this is a Ai Enabled issue or something you might be able to look at?
Bored Guys Josh Nov 28, 2023 @ 8:44pm 
I figured it was worth checking. Thanks.
DraygoKorvan  [author] Nov 28, 2023 @ 8:47am 
This mod has nothing to do with grids moving or not moving.
Bored Guys Josh Nov 26, 2023 @ 8:21pm 
In singleplayer worlds, lately if I use a mod that needs this one as well as this mod, my grids will eventually stop moving. Is that a bug related to updating?
maxwindude Nov 11, 2023 @ 7:18pm 
This mod requires an update.
TinyGrox Oct 28, 2023 @ 8:42am 
all Chinese characters become some white boxes in game as long as HudAPIv2.HUDMessage is used. Can't solve by myself :csgo_despair:
sarnath1 Oct 17, 2023 @ 9:49pm 
I can't get this to show up/load. When I go into global chat and press F2, nothing happens. Although I can't say for sure, I suspect that this is due to Warfare 2. Seems like that DLC broke almost every mod for this game. Outside of blueprints, I haven't found ANY that worked.