SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.UI Namespace Reference

Classes

class  ContainerElement
 
class  CustomSprite
 A sprite element using a custom image texture. More...
 
class  Hud
 Methods to manipulate the HUD (heads-up-display) of the game.
 
interface  IElement
 
interface  ISpriteElement
 
class  LoadingPrompt
 Methods to manage the display of a loading spinner prompt.
 
class  Notification
 Methods to manage the display of notifications above the minimap.
 
class  Screen
 Methods to handle UI actions that affect the whole screen.
 
class  Sprite
 A sprite element using a built-in texture. More...
 
class  TextElement
 

Enumerations

enum  Alignment { Alignment.Center = 0, Alignment.Left = 1, Alignment.Right = 2 }
 
enum  CursorSprite {
  CursorSprite.Normal = 1, CursorSprite.LightArrow, CursorSprite.OpenHand, CursorSprite.GrabHand,
  CursorSprite.MiddleFinger, CursorSprite.LeftArrow, CursorSprite.RightArrow, CursorSprite.UpArrow,
  CursorSprite.DownArrow, CursorSprite.HorizontalDoubleArrow, CursorSprite.NormalWithPlus, CursorSprite.NormalWithMinus
}
 An enumeration of all possible cursor sprites. More...
 
enum  Font {
  Font.ChaletLondon, Font.HouseScript, Font.Monospace, Font.ChaletComprimeCologne = 4,
  Font.Pricedown = 7
}
 An enumeration of fonts the game supports. More...
 
enum  HudComponent {
  HudComponent.WantedStars = 1, HudComponent.WeaponIcon, HudComponent.Cash, HudComponent.MpCash,
  HudComponent.MpMessage, HudComponent.VehicleName, HudComponent.AreaName, HudComponent.Unused,
  HudComponent.StreetName, HudComponent.HelpText, HudComponent.FloatingHelpText1, HudComponent.FloatingHelpText2,
  HudComponent.CashChange, HudComponent.Reticle, HudComponent.SubtitleText, HudComponent.RadioStationsWheel,
  HudComponent.Saving, HudComponent.GamingStreamUnusde, HudComponent.WeaponWheel, HudComponent.WeaponWheelStats,
  HudComponent.DrugsPurse01, HudComponent.DrugsPurse02, HudComponent.DrugsPurse03, HudComponent.DrugsPurse04,
  HudComponent.MpTagCashFromBank, HudComponent.MpTagPackages, HudComponent.MpTagCuffKeys, HudComponent.MpTagDownloadData,
  HudComponent.MpTagIfPedFollowing, HudComponent.MpTagKeyCard, HudComponent.MpTagRandomObject, HudComponent.MpTagRemoteControl,
  HudComponent.MpTagCashFromSafe, HudComponent.MpTagWeaponsPackage, HudComponent.MpTagKeys, HudComponent.MpVehicle,
  HudComponent.MpVehicleHeli, HudComponent.MpVehiclePlane, HudComponent.PlayerSwitchAlert, HudComponent.MpRankBar,
  HudComponent.DirectorMode, HudComponent.ReplayController, HudComponent.ReplayMouse, HudComponent.ReplayHeader,
  HudComponent.ReplayOptions, HudComponent.ReplayHelpText, HudComponent.ReplayMiscText, HudComponent.ReplayTopLine,
  HudComponent.ReplayBottomLine, HudComponent.ReplayLeftBar, HudComponent.ReplayTimer
}
 An enumeration of all possible component of the HUD. More...
 
enum  LoadingSpinnerType {
  LoadingSpinnerType.Clockwise1 = 1, LoadingSpinnerType.Clockwise2, LoadingSpinnerType.Clockwise3, LoadingSpinnerType.SocialClubSaving,
  LoadingSpinnerType.RegularClockwise
}
 An enumeration of possible loading spinner styles. More...
 
enum  NotificationIcon {
  NotificationIcon.Abigail, NotificationIcon.AllPlayersConf, NotificationIcon.Amanda, NotificationIcon.Ammunation,
  NotificationIcon.Andreas, NotificationIcon.Antonia, NotificationIcon.Arthur, NotificationIcon.Ashley,
  NotificationIcon.BankBol, NotificationIcon.BankFleeca, NotificationIcon.BankMaze, NotificationIcon.Barry,
  NotificationIcon.Beverly, NotificationIcon.Bikesite, NotificationIcon.BlankEntry, NotificationIcon.Blimp,
  NotificationIcon.Blocked, NotificationIcon.Boatsite, NotificationIcon.BrokenDownGirl, NotificationIcon.Bugstars,
  NotificationIcon.Call911, NotificationIcon.Carsite, NotificationIcon.Carsite2, NotificationIcon.Castro,
  NotificationIcon.ChatCall, NotificationIcon.Chef, NotificationIcon.Cheng, NotificationIcon.Chengsr,
  NotificationIcon.Chop, NotificationIcon.Cris, NotificationIcon.Dave, NotificationIcon.Default,
  NotificationIcon.Denise, NotificationIcon.DetonateBomb, NotificationIcon.DetonatePhone, NotificationIcon.Devin,
  NotificationIcon.DialASub, NotificationIcon.Dom, NotificationIcon.DomesticGirl, NotificationIcon.Dreyfuss,
  NotificationIcon.DrFriedlander, NotificationIcon.Epsilon, NotificationIcon.EstateAgent, NotificationIcon.Facebook,
  NotificationIcon.FilmNoir, NotificationIcon.Floyd, NotificationIcon.Franklin, NotificationIcon.FrankTrevConf,
  NotificationIcon.Gaymilitary, NotificationIcon.Hao, NotificationIcon.HitcherGirl, NotificationIcon.HumanDefault,
  NotificationIcon.Hunter, NotificationIcon.Jimmy, NotificationIcon.JimmyBoston, NotificationIcon.Joe,
  NotificationIcon.Josef, NotificationIcon.Josh, NotificationIcon.Lamar, NotificationIcon.Lazlow,
  NotificationIcon.Lester, NotificationIcon.LesterDeathwish, NotificationIcon.LesFrankConf, NotificationIcon.LesMikeConf,
  NotificationIcon.Lifeinvader, NotificationIcon.LsCustoms, NotificationIcon.LsTouristBoard, NotificationIcon.Manuel,
  NotificationIcon.Marnie, NotificationIcon.Martin, NotificationIcon.MaryAnn, NotificationIcon.Maude,
  NotificationIcon.Mechanic, NotificationIcon.Michael, NotificationIcon.MikeFrankConf, NotificationIcon.MikeTrevConf,
  NotificationIcon.Milsite, NotificationIcon.Minotaur, NotificationIcon.Molly, NotificationIcon.MpArmyContact,
  NotificationIcon.MpBikerBoss, NotificationIcon.MpBikerMechanic, NotificationIcon.MpBrucie, NotificationIcon.MpDetonatePhone,
  NotificationIcon.MpFamBoss, NotificationIcon.MpFIBContact, NotificationIcon.MpFmContact, NotificationIcon.MpGerald,
  NotificationIcon.MpJulio, NotificationIcon.MpMechanic, NotificationIcon.MpMerryweather, NotificationIcon.MpMexBoss,
  NotificationIcon.MpMexDocks, NotificationIcon.MpMexLt, NotificationIcon.MpMorsMutual, NotificationIcon.MpProfBoss,
  NotificationIcon.MpRayLavoy, NotificationIcon.MpRoberto, NotificationIcon.MpSnitch, NotificationIcon.MpStretch,
  NotificationIcon.MpStripclubPr, NotificationIcon.MrsThornhill, NotificationIcon.Multiplayer, NotificationIcon.Nigel,
  NotificationIcon.Omega, NotificationIcon.Oneil, NotificationIcon.Ortega, NotificationIcon.Oscar,
  NotificationIcon.Patricia, NotificationIcon.PegasusDelivery, NotificationIcon.Planesite, NotificationIcon.PropertyArmsTrafficking,
  NotificationIcon.PropertyBarAirport, NotificationIcon.PropertyBarBayview, NotificationIcon.PropertyBarCafeRojo, NotificationIcon.PropertyBarCockotoos,
  NotificationIcon.PropertyBarEclipse, NotificationIcon.PropertyBarFes, NotificationIcon.PropertyBarHenHouse, NotificationIcon.PropertyBarHiMen,
  NotificationIcon.PropertyBarHookies, NotificationIcon.PropertyBarIrish, NotificationIcon.PropertyBarLesBianco, NotificationIcon.PropertyBarMirrorPark,
  NotificationIcon.PropertyBarPitchers, NotificationIcon.PropertyBarSingletons, NotificationIcon.PropertyBarTequilala, NotificationIcon.PropertyBarUnbranded,
  NotificationIcon.PropertyCarModShop, NotificationIcon.PropertyCarScrapYard, NotificationIcon.PropertyCinemaDowntown, NotificationIcon.PropertyCinemaMorningwood,
  NotificationIcon.PropertyCinemaVinewood, NotificationIcon.PropertyGolfClub, NotificationIcon.PropertyPlaneScrapYard, NotificationIcon.PropertySonarCollections,
  NotificationIcon.PropertyTaxiLot, NotificationIcon.PropertyTowingImpound, NotificationIcon.PropertyWeedShop, NotificationIcon.Ron,
  NotificationIcon.Saeeda, NotificationIcon.Sasquatch, NotificationIcon.Simeon, NotificationIcon.SocialClub,
  NotificationIcon.Solomon, NotificationIcon.Steve, NotificationIcon.SteveMikeConf, NotificationIcon.SteveTrevConf,
  NotificationIcon.Stretch, NotificationIcon.StripperChastity, NotificationIcon.StripperCheetah, NotificationIcon.StripperFufu,
  NotificationIcon.StripperInfernus, NotificationIcon.StripperJuliet, NotificationIcon.StripperNikki, NotificationIcon.StripperPeach,
  NotificationIcon.StripperSapphire, NotificationIcon.Tanisha, NotificationIcon.Taxi, NotificationIcon.TaxiLiz,
  NotificationIcon.TennisCoach, NotificationIcon.TowTonya, NotificationIcon.Tracey, NotificationIcon.Trevor,
  NotificationIcon.Wade, NotificationIcon.YouTube, NotificationIcon.CreatorPortraits
}
 
enum  ScreenEffect {
  ScreenEffect.SwitchHudIn, ScreenEffect.SwitchHudOut, ScreenEffect.FocusIn, ScreenEffect.FocusOut,
  ScreenEffect.MinigameEndNeutral, ScreenEffect.MinigameEndTrevor, ScreenEffect.MinigameEndFranklin, ScreenEffect.MinigameEndMichael,
  ScreenEffect.MinigameTransitionOut, ScreenEffect.MinigameTransitionIn, ScreenEffect.SwitchShortNeutralIn, ScreenEffect.SwitchShortFranklinIn,
  ScreenEffect.SwitchShortTrevorIn, ScreenEffect.SwitchShortMichaelIn, ScreenEffect.SwitchOpenMichaelIn, ScreenEffect.SwitchOpenFranklinIn,
  ScreenEffect.SwitchOpenTrevorIn, ScreenEffect.SwitchHudMichaelOut, ScreenEffect.SwitchHudFranklinOut, ScreenEffect.SwitchHudTrevorOut,
  ScreenEffect.SwitchShortFranklinMid, ScreenEffect.SwitchShortMichaelMid, ScreenEffect.SwitchShortTrevorMid, ScreenEffect.DeathFailOut,
  ScreenEffect.CamPushInNeutral, ScreenEffect.CamPushInFranklin, ScreenEffect.CamPushInMichael, ScreenEffect.CamPushInTrevor,
  ScreenEffect.SwitchSceneFranklin, ScreenEffect.SwitchSceneTrevor, ScreenEffect.SwitchSceneMichael, ScreenEffect.SwitchSceneNeutral,
  ScreenEffect.MpCelebWin, ScreenEffect.MpCelebWinOut, ScreenEffect.MpCelebLose, ScreenEffect.MpCelebLoseOut,
  ScreenEffect.DeathFailNeutralIn, ScreenEffect.DeathFailMpDark, ScreenEffect.DeathFailMpIn, ScreenEffect.MpCelebPreloadFade,
  ScreenEffect.PeyoteEndOut, ScreenEffect.PeyoteEndIn, ScreenEffect.PeyoteIn, ScreenEffect.PeyoteOut,
  ScreenEffect.MpRaceCrash, ScreenEffect.SuccessFranklin, ScreenEffect.SuccessTrevor, ScreenEffect.SuccessMichael,
  ScreenEffect.DrugsMichaelAliensFightIn, ScreenEffect.DrugsMichaelAliensFight, ScreenEffect.DrugsMichaelAliensFightOut, ScreenEffect.DrugsTrevorClownsFightIn,
  ScreenEffect.DrugsTrevorClownsFight, ScreenEffect.DrugsTrevorClownsFightOut, ScreenEffect.HeistCelebPass, ScreenEffect.HeistCelebPassBw,
  ScreenEffect.HeistCelebEnd, ScreenEffect.HeistCelebToast, ScreenEffect.MenuMgHeistIn, ScreenEffect.MenuMgTournamentIn,
  ScreenEffect.MenuMgSelectionIn, ScreenEffect.ChopVision, ScreenEffect.DmtFlightIntro, ScreenEffect.DmtFlight,
  ScreenEffect.DrugsDrivingIn, ScreenEffect.DrugsDrivingOut, ScreenEffect.SwitchOpenNeutralFib5, ScreenEffect.HeistLocate,
  ScreenEffect.MpJobLoad, ScreenEffect.RaceTurbo, ScreenEffect.MpIntroLogo, ScreenEffect.HeistTripSkipFade,
  ScreenEffect.MenuMgHeistOut, ScreenEffect.MpCoronaSwitch, ScreenEffect.MenuMgSelectionTint, ScreenEffect.SuccessNeutral,
  ScreenEffect.ExplosionJosh3, ScreenEffect.SniperOverlay, ScreenEffect.RampageOut, ScreenEffect.Rampage,
  ScreenEffect.DontTazemeBro
}
 An enumeration of possible screen effects. More...
 

Enumeration Type Documentation

◆ Alignment

enum GTA.UI.Alignment
strong
Enumerator
Center 
Left 
Right 

◆ CursorSprite

enum GTA.UI.CursorSprite
strong

An enumeration of all possible cursor sprites.

Enumerator
Normal 
LightArrow 
OpenHand 
GrabHand 
MiddleFinger 
LeftArrow 
RightArrow 
UpArrow 
DownArrow 
HorizontalDoubleArrow 
NormalWithPlus 
NormalWithMinus 

◆ Font

enum GTA.UI.Font
strong

An enumeration of fonts the game supports.

Enumerator
ChaletLondon 
HouseScript 
Monospace 
ChaletComprimeCologne 
Pricedown 

◆ HudComponent

enum GTA.UI.HudComponent
strong

An enumeration of all possible component of the HUD.

Enumerator
WantedStars 
WeaponIcon 
Cash 
MpCash 
MpMessage 
VehicleName 
AreaName 
Unused 
StreetName 
HelpText 
FloatingHelpText1 
FloatingHelpText2 
CashChange 
Reticle 
SubtitleText 
RadioStationsWheel 
Saving 
GamingStreamUnusde 
WeaponWheel 
WeaponWheelStats 
DrugsPurse01 
DrugsPurse02 
DrugsPurse03 
DrugsPurse04 
MpTagCashFromBank 
MpTagPackages 
MpTagCuffKeys 
MpTagDownloadData 
MpTagIfPedFollowing 
MpTagKeyCard 
MpTagRandomObject 
MpTagRemoteControl 
MpTagCashFromSafe 
MpTagWeaponsPackage 
MpTagKeys 
MpVehicle 
MpVehicleHeli 
MpVehiclePlane 
PlayerSwitchAlert 
MpRankBar 
DirectorMode 
ReplayController 
ReplayMouse 
ReplayHeader 
ReplayOptions 
ReplayHelpText 
ReplayMiscText 
ReplayTopLine 
ReplayBottomLine 
ReplayLeftBar 
ReplayTimer 

◆ LoadingSpinnerType

An enumeration of possible loading spinner styles.

Enumerator
Clockwise1 
Clockwise2 
Clockwise3 
SocialClubSaving 
RegularClockwise 

◆ NotificationIcon

Enumerator
Abigail 
AllPlayersConf 
Amanda 
Ammunation 
Andreas 
Antonia 
Arthur 
Ashley 
BankBol 
BankFleeca 
BankMaze 
Barry 
Beverly 
Bikesite 
BlankEntry 
Blimp 
Blocked 
Boatsite 
BrokenDownGirl 
Bugstars 
Call911 
Carsite 
Carsite2 
Castro 
ChatCall 
Chef 
Cheng 
Chengsr 
Chop 
Cris 
Dave 
Default 
Denise 
DetonateBomb 
DetonatePhone 
Devin 
DialASub 
Dom 
DomesticGirl 
Dreyfuss 
DrFriedlander 
Epsilon 
EstateAgent 
Facebook 
FilmNoir 
Floyd 
Franklin 
FrankTrevConf 
Gaymilitary 
Hao 
HitcherGirl 
HumanDefault 
Hunter 
Jimmy 
JimmyBoston 
Joe 
Josef 
Josh 
Lamar 
Lazlow 
Lester 
LesterDeathwish 
LesFrankConf 
LesMikeConf 
Lifeinvader 
LsCustoms 
LsTouristBoard 
Manuel 
Marnie 
Martin 
MaryAnn 
Maude 
Mechanic 
Michael 
MikeFrankConf 
MikeTrevConf 
Milsite 
Minotaur 
Molly 
MpArmyContact 
MpBikerBoss 
MpBikerMechanic 
MpBrucie 
MpDetonatePhone 
MpFamBoss 
MpFIBContact 
MpFmContact 
MpGerald 
MpJulio 
MpMechanic 
MpMerryweather 
MpMexBoss 
MpMexDocks 
MpMexLt 
MpMorsMutual 
MpProfBoss 
MpRayLavoy 
MpRoberto 
MpSnitch 
MpStretch 
MpStripclubPr 
MrsThornhill 
Multiplayer 
Nigel 
Omega 
Oneil 
Ortega 
Oscar 
Patricia 
PegasusDelivery 
Planesite 
PropertyArmsTrafficking 
PropertyBarAirport 
PropertyBarBayview 
PropertyBarCafeRojo 
PropertyBarCockotoos 
PropertyBarEclipse 
PropertyBarFes 
PropertyBarHenHouse 
PropertyBarHiMen 
PropertyBarHookies 
PropertyBarIrish 
PropertyBarLesBianco 
PropertyBarMirrorPark 
PropertyBarPitchers 
PropertyBarSingletons 
PropertyBarTequilala 
PropertyBarUnbranded 
PropertyCarModShop 
PropertyCarScrapYard 
PropertyCinemaDowntown 
PropertyCinemaMorningwood 
PropertyCinemaVinewood 
PropertyGolfClub 
PropertyPlaneScrapYard 
PropertySonarCollections 
PropertyTaxiLot 
PropertyTowingImpound 
PropertyWeedShop 
Ron 
Saeeda 
Sasquatch 
Simeon 
SocialClub 
Solomon 
Steve 
SteveMikeConf 
SteveTrevConf 
Stretch 
StripperChastity 
StripperCheetah 
StripperFufu 
StripperInfernus 
StripperJuliet 
StripperNikki 
StripperPeach 
StripperSapphire 
Tanisha 
Taxi 
TaxiLiz 
TennisCoach 
TowTonya 
Tracey 
Trevor 
Wade 
YouTube 
CreatorPortraits 

◆ ScreenEffect

enum GTA.UI.ScreenEffect
strong

An enumeration of possible screen effects.

Enumerator
SwitchHudIn 
SwitchHudOut 
FocusIn 
FocusOut 
MinigameEndNeutral 
MinigameEndTrevor 
MinigameEndFranklin 
MinigameEndMichael 
MinigameTransitionOut 
MinigameTransitionIn 
SwitchShortNeutralIn 
SwitchShortFranklinIn 
SwitchShortTrevorIn 
SwitchShortMichaelIn 
SwitchOpenMichaelIn 
SwitchOpenFranklinIn 
SwitchOpenTrevorIn 
SwitchHudMichaelOut 
SwitchHudFranklinOut 
SwitchHudTrevorOut 
SwitchShortFranklinMid 
SwitchShortMichaelMid 
SwitchShortTrevorMid 
DeathFailOut 
CamPushInNeutral 
CamPushInFranklin 
CamPushInMichael 
CamPushInTrevor 
SwitchSceneFranklin 
SwitchSceneTrevor 
SwitchSceneMichael 
SwitchSceneNeutral 
MpCelebWin 
MpCelebWinOut 
MpCelebLose 
MpCelebLoseOut 
DeathFailNeutralIn 
DeathFailMpDark 
DeathFailMpIn 
MpCelebPreloadFade 
PeyoteEndOut 
PeyoteEndIn 
PeyoteIn 
PeyoteOut 
MpRaceCrash 
SuccessFranklin 
SuccessTrevor 
SuccessMichael 
DrugsMichaelAliensFightIn 
DrugsMichaelAliensFight 
DrugsMichaelAliensFightOut 
DrugsTrevorClownsFightIn 
DrugsTrevorClownsFight 
DrugsTrevorClownsFightOut 
HeistCelebPass 
HeistCelebPassBw 
HeistCelebEnd 
HeistCelebToast 
MenuMgHeistIn 
MenuMgTournamentIn 
MenuMgSelectionIn 
ChopVision 
DmtFlightIntro 
DmtFlight 
DrugsDrivingIn 
DrugsDrivingOut 
SwitchOpenNeutralFib5 
HeistLocate 
MpJobLoad 
RaceTurbo 
MpIntroLogo 
HeistTripSkipFade 
MenuMgHeistOut 
MpCoronaSwitch 
MenuMgSelectionTint 
SuccessNeutral 
ExplosionJosh3 
SniperOverlay 
RampageOut 
Rampage 
DontTazemeBro