Files
gymkhana-actions/docs/api/SetHudVisibleCommand.md
Dennis Ploeger 58d880101d Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
2021-06-22 23:06:20 +02:00

763 B

SetHudVisibleCommand

Extends: ESCBaseCommand < Node

Description

set_hud_visible visible

If you have a cutscene like sequence where the player doesn't have control, and you also have HUD elements visible, use this to hide the HUD. You want to do that because it explicitly signals the player that there is no control over the game at the moment. "visible" is true or false.

@ESC

Method Descriptions

configure

func configure() -> ESCCommandArgumentDescriptor

Return the descriptor of the arguments of this command

run

func run(command_params: Array) -> int

Run the command