unreal.ScriptableTool_HUDAPI

class unreal.ScriptableTool_HUDAPI(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

UScriptableTool_HUDAPI is helper Object that is created internally by a UScriptableInteractiveTool to allow Blueprints to access basic 2D rendering functionality, in the context of a specific Tool. The OnScriptDrawHUD event is called with an instance of this type.

C++ Source:

• Plugin: ScriptableToolsFramework

• Module: ScriptableToolsFramework

• File: ScriptableInteractiveTool.h

draw_text_array_at_location(location, strings, color=[1.000000, 1.000000, 1.000000, 1.000000], centered, shift_rows_y) → ScriptableTool_HUDAPI

Draw Text Array at Location

Parameters:

• location (Vector) –

• strings (Array[str]) –

• color (LinearColor) –

• centered (bool) –

• shift_rows_y (float) –

Return type:

ScriptableTool_HUDAPI

draw_text_at_location(location, string, color=[1.000000, 1.000000, 1.000000, 1.000000], centered, shift_rows_y) → ScriptableTool_HUDAPI

Draw Text at Location

Parameters:

• location (Vector) –

• string (str) –

• color (LinearColor) –

• centered (bool) –

• shift_rows_y (float) –

Return type:

ScriptableTool_HUDAPI

get_canvas_location(location) -> (ScriptableTool_HUDAPI, canvas_location=Vector2D)

Get Canvas Location

Parameters:

location (Vector) –

Returns:

canvas_location (Vector2D):

Return type:

Vector2D