EventInstructorServerHintCreate
Interface EventInstructorServerHintCreate
Namespace: SwiftlyS2.Shared.GameEventDefinitions
Assembly: SwiftlyS2.CS2.dll
Event "instructor_server_hint_create" 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
public interface EventInstructorServerHintCreate : IGameEvent<EventInstructorServerHintCreate>Implements
Properties
HintActivatorCaption
the hint caption that only the activator sees e.g. "#YouPushedItGood"
type: string
string HintActivatorCaption { get; set; }HintActivatorUserid
playerslot of the activator
type: player_controller
int HintActivatorUserid { get; set; }HintAllowNodrawTarget
if false, the hint will dissappear if the target entity is invisible
type: bool
bool HintAllowNodrawTarget { get; set; }HintBinding
bindings to use when use_binding is the onscreen icon
type: string
string HintBinding { get; set; }HintCaption
the hint caption. e.g. "#ThisIsDangerous"
type: string
string HintCaption { get; set; }HintColor
the hint color in "r,g,b" format where each component is 0-255
type: string
string HintColor { get; set; }HintEntindex
entity id of the env_instructor_hint that fired the event
type: long
int HintEntindex { get; set; }HintFlags
hint flags
type: long
int HintFlags { get; set; }HintForcecaption
if true, the hint caption will show even if the hint is occluded
type: bool
bool HintForcecaption { get; set; }HintGamepadBinding
gamepad bindings to use when use_binding is the onscreen icon
type: string
string HintGamepadBinding { get; set; }HintIconOffscreen
the hint icon to use when the hint is offscreen. e.g. "icon_alert"
type: string
string HintIconOffscreen { get; set; }HintIconOffset
how far on the z axis to offset the hint from entity origin
type: float
float HintIconOffset { get; set; }HintIconOnscreen
the hint icon to use when the hint is onscreen. e.g. "icon_alert_red"
type: string
string HintIconOnscreen { get; set; }HintLayoutfile
Path for Panorama layout file
type: string
string HintLayoutfile { get; set; }HintLocalPlayerOnly
if true, only the local player will see the hint
type: bool
bool HintLocalPlayerOnly { get; set; }HintName
what to name the hint. For referencing it again later (e.g. a kill command for the hint instead of a timeout)
type: string
string HintName { get; set; }HintNooffscreen
if true, the hint will not show when outside the player view
type: bool
bool HintNooffscreen { get; set; }HintRange
range before the hint is culled
type: float
float HintRange { get; set; }HintReplaceKey
type name so that messages of the same type will replace each other
type: string
string HintReplaceKey { get; set; }HintStartSound
Game sound to play
type: string
string HintStartSound { get; set; }HintTarget
entity id that the hint should display at
type: long
int HintTarget { get; set; }HintTimeout
how long in seconds until the hint automatically times out, 0 = never
type: short
short HintTimeout { get; set; }HintVrHeightOffset
Height offset for attached panels
type: float
float HintVrHeightOffset { get; set; }HintVrOffsetX
offset for attached panels
type: float
float HintVrOffsetX { get; set; }HintVrOffsetY
offset for attached panels
type: float
float HintVrOffsetY { get; set; }HintVrOffsetZ
offset for attached panels
type: float
float HintVrOffsetZ { get; set; }HintVrPanelType
Attachment type for the Panorama panel
type: short
short HintVrPanelType { get; set; }UserId
user ID of the player that triggered the hint
type: player_controller
int UserId { get; set; }UserIdController
user ID of the player that triggered the hint
type: player_controller
CCSPlayerController UserIdController { get; }UserIdPawn
user ID of the player that triggered the hint
type: player_controller
CCSPlayerPawn UserIdPawn { get; }UserIdPlayer
IPlayer UserIdPlayer { get; }