#include <EventTypes.hpp>

Static Public Member Functions
static InstructorServerHintCreate	From (IGameEvent &e)

Public Attributes
int	Slot = -1
	user ID of the player that triggered the hint

std::string	HintName

std::string	HintReplaceKey
	type name so that messages of the same type will replace each other

int	HintTarget = 0
	entity id that the hint should display at

int	HintActivatorUseridSlot = -1
	userid id of the activator

int	HintTimeout = 0
	how long in seconds until the hint automatically times out, 0 = never

std::string	HintIconOnscreen
	the hint icon to use when the hint is onscreen. e.g. "icon_alert_red"

std::string	HintIconOffscreen
	the hint icon to use when the hint is offscreen. e.g. "icon_alert"

std::string	HintCaption
	the hint caption. e.g. "#ThisIsDangerous"

std::string	HintActivatorCaption
	the hint caption that only the activator sees e.g. "#YouPushedItGood"

std::string	HintColor
	the hint color in "r,g,b" format where each component is 0-255

float	HintIconOffset = 0.0f
	how far on the z axis to offset the hint from entity origin

float	HintRange = 0.0f
	range before the hint is culled

int	HintFlags = 0
	hint flags

std::string	HintBinding
	bindings to use when use_binding is the onscreen icon

std::string	HintGamepadBinding
	gamepad bindings to use when use_binding is the onscreen icon

bool	HintAllowNodrawTarget = false
	if false, the hint will dissappear if the target entity is invisible

bool	HintNooffscreen = false
	if true, the hint will not show when outside the player view

bool	HintForcecaption = false
	if true, the hint caption will show even if the hint is occluded

bool	HintLocalPlayerOnly = false
	if true, only the local player will see the hint

Static Public Attributes
static constexpr std::string_view	EventName = "instructor_server_hint_create"

Detailed Description

create a hint using data supplied entirely by the server/map. Intended for hints to smooth playtests before content is ready to make the hint unneccessary. NOT INTENDED AS A SHIPPABLE CRUTCH

Definition at line 1073 of file EventTypes.hpp.

Member Function Documentation

◆ From()

InstructorServerHintCreate VoltMod::InstructorServerHintCreate::From ( IGameEvent & e )

static

Definition at line 1016 of file EventTypes.cpp.

References VoltMod::ReadFile(), and Slot.

Member Data Documentation

◆ EventName

constexpr std::string_view VoltMod::InstructorServerHintCreate::EventName = "instructor_server_hint_create"

staticconstexpr

Definition at line 1075 of file EventTypes.hpp.

◆ HintActivatorCaption

std::string VoltMod::InstructorServerHintCreate::HintActivatorCaption

the hint caption that only the activator sees e.g. "#YouPushedItGood"

Definition at line 1086 of file EventTypes.hpp.

◆ HintActivatorUseridSlot

int VoltMod::InstructorServerHintCreate::HintActivatorUseridSlot = -1

userid id of the activator

Definition at line 1081 of file EventTypes.hpp.

◆ HintAllowNodrawTarget

bool VoltMod::InstructorServerHintCreate::HintAllowNodrawTarget = false

if false, the hint will dissappear if the target entity is invisible

Definition at line 1093 of file EventTypes.hpp.

◆ HintBinding

std::string VoltMod::InstructorServerHintCreate::HintBinding

bindings to use when use_binding is the onscreen icon

Definition at line 1091 of file EventTypes.hpp.

◆ HintCaption

std::string VoltMod::InstructorServerHintCreate::HintCaption

the hint caption. e.g. "#ThisIsDangerous"

Definition at line 1085 of file EventTypes.hpp.

◆ HintColor

std::string VoltMod::InstructorServerHintCreate::HintColor

the hint color in "r,g,b" format where each component is 0-255

Definition at line 1087 of file EventTypes.hpp.

◆ HintFlags

int VoltMod::InstructorServerHintCreate::HintFlags = 0

hint flags

Definition at line 1090 of file EventTypes.hpp.

◆ HintForcecaption

bool VoltMod::InstructorServerHintCreate::HintForcecaption = false

if true, the hint caption will show even if the hint is occluded

Definition at line 1095 of file EventTypes.hpp.

◆ HintGamepadBinding

std::string VoltMod::InstructorServerHintCreate::HintGamepadBinding

gamepad bindings to use when use_binding is the onscreen icon

Definition at line 1092 of file EventTypes.hpp.

◆ HintIconOffscreen

std::string VoltMod::InstructorServerHintCreate::HintIconOffscreen

the hint icon to use when the hint is offscreen. e.g. "icon_alert"

Definition at line 1084 of file EventTypes.hpp.

◆ HintIconOffset

float VoltMod::InstructorServerHintCreate::HintIconOffset = 0.0f

how far on the z axis to offset the hint from entity origin

Definition at line 1088 of file EventTypes.hpp.

◆ HintIconOnscreen

std::string VoltMod::InstructorServerHintCreate::HintIconOnscreen

the hint icon to use when the hint is onscreen. e.g. "icon_alert_red"

Definition at line 1083 of file EventTypes.hpp.

◆ HintLocalPlayerOnly

bool VoltMod::InstructorServerHintCreate::HintLocalPlayerOnly = false

if true, only the local player will see the hint

Definition at line 1096 of file EventTypes.hpp.

◆ HintName

std::string VoltMod::InstructorServerHintCreate::HintName

what to name the hint. For referencing it again later (e.g. a kill command for the hint instead of a timeout)

Definition at line 1077 of file EventTypes.hpp.

◆ HintNooffscreen

bool VoltMod::InstructorServerHintCreate::HintNooffscreen = false

if true, the hint will not show when outside the player view

Definition at line 1094 of file EventTypes.hpp.

◆ HintRange

float VoltMod::InstructorServerHintCreate::HintRange = 0.0f

range before the hint is culled

Definition at line 1089 of file EventTypes.hpp.

◆ HintReplaceKey

std::string VoltMod::InstructorServerHintCreate::HintReplaceKey

type name so that messages of the same type will replace each other

Definition at line 1079 of file EventTypes.hpp.

◆ HintTarget

int VoltMod::InstructorServerHintCreate::HintTarget = 0

entity id that the hint should display at

Definition at line 1080 of file EventTypes.hpp.

◆ HintTimeout

int VoltMod::InstructorServerHintCreate::HintTimeout = 0

how long in seconds until the hint automatically times out, 0 = never

Definition at line 1082 of file EventTypes.hpp.

◆ Slot

int VoltMod::InstructorServerHintCreate::Slot = -1

user ID of the player that triggered the hint

Definition at line 1076 of file EventTypes.hpp.

Referenced by From().

The documentation for this struct was generated from the following files:

include/VoltMod/Events/EventTypes.hpp
src/Events/EventTypes.cpp

Static Public Member Functions

Public Attributes

Static Public Attributes