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.ContainerElement Class Reference
Inheritance diagram for GTA.UI.ContainerElement:
GTA.UI.IElement

Public Member Functions

 ContainerElement ()
 Initializes a new instance of the ContainerElement class used for grouping items on screen. More...
 
 ContainerElement (PointF position, SizeF size)
 Initializes a new instance of the ContainerElement class used for grouping items on screen. More...
 
 ContainerElement (PointF position, SizeF size, Color color)
 Initializes a new instance of the ContainerElement class used for grouping items on screen. More...
 
 ContainerElement (PointF position, SizeF size, Color color, bool centered)
 Initializes a new instance of the ContainerElement class used for grouping items on screen. More...
 
virtual void Draw ()
 Draws this ContainerElement this frame. More...
 
virtual void Draw (SizeF offset)
 Draws this ContainerElement this frame at the specified offset. More...
 
virtual void ScaledDraw ()
 Draws this ContainerElement this frame using the width returned in Screen.ScaledWidth. More...
 
virtual void ScaledDraw (SizeF offset)
 Draws this ContainerElement this frame at the specified offset using the width returned in Screen.ScaledWidth. More...
 

Properties

virtual bool Enabled [get, set]
 Gets or sets a value indicating whether this ContainerElement will be drawn. More...
 
virtual Color Color [get, set]
 Gets or sets the color of this ContainerElement. More...
 
virtual PointF Position [get, set]
 Gets or sets the position of this ContainerElement. More...
 
SizeF Size [get, set]
 Gets or sets the size to draw the ContainerElement More...
 
virtual bool Centered [get, set]
 Gets or sets a value indicating whether this ContainerElement should be positioned based on its center or top left corner More...
 
List< IElementItems [get]
 The IElements Contained inside this ContainerElement More...
 
- Properties inherited from GTA.UI.IElement
bool Enabled [get, set]
 Gets or sets a value indicating whether this IElement will be drawn. More...
 
Color Color [get, set]
 Gets or sets the color of this IElement. More...
 
PointF Position [get, set]
 Gets or sets the position of this IElement. More...
 
bool Centered [get, set]
 Gets or sets a value indicating whether this IElement should be positioned based on its center or top left corner More...
 

Constructor & Destructor Documentation

◆ ContainerElement() [1/4]

GTA.UI.ContainerElement.ContainerElement ( )

Initializes a new instance of the ContainerElement class used for grouping items on screen.

◆ ContainerElement() [2/4]

GTA.UI.ContainerElement.ContainerElement ( PointF  position,
SizeF  size 
)

Initializes a new instance of the ContainerElement class used for grouping items on screen.

Parameters
positionSet the Position on screen where to draw the ContainerElement.
sizeSet the Size of the ContainerElement.

◆ ContainerElement() [3/4]

GTA.UI.ContainerElement.ContainerElement ( PointF  position,
SizeF  size,
Color  color 
)

Initializes a new instance of the ContainerElement class used for grouping items on screen.

Parameters
positionSet the Position on screen where to draw the ContainerElement.
sizeSet the Size of the ContainerElement.
colorSet the Color used to draw the ContainerElement.

◆ ContainerElement() [4/4]

GTA.UI.ContainerElement.ContainerElement ( PointF  position,
SizeF  size,
Color  color,
bool  centered 
)

Initializes a new instance of the ContainerElement class used for grouping items on screen.

Parameters
positionSet the Position on screen where to draw the ContainerElement.
sizeSet the Size of the ContainerElement.
colorSet the Color used to draw the ContainerElement.
centeredPosition the ContainerElement based on its center instead of top left corner, see also
See also
Centered
.

Member Function Documentation

◆ Draw() [1/2]

virtual void GTA.UI.ContainerElement.Draw ( )
virtual

Draws this ContainerElement this frame.

Implements GTA.UI.IElement.

◆ Draw() [2/2]

virtual void GTA.UI.ContainerElement.Draw ( SizeF  offset)
virtual

Draws this ContainerElement this frame at the specified offset.

Parameters
offsetThe offset to shift the draw position of this ContainerElement using a 1280*720 pixel base.

Implements GTA.UI.IElement.

◆ ScaledDraw() [1/2]

virtual void GTA.UI.ContainerElement.ScaledDraw ( )
virtual

Draws this ContainerElement this frame using the width returned in Screen.ScaledWidth.

Implements GTA.UI.IElement.

◆ ScaledDraw() [2/2]

virtual void GTA.UI.ContainerElement.ScaledDraw ( SizeF  offset)
virtual

Draws this ContainerElement this frame at the specified offset using the width returned in Screen.ScaledWidth.

Parameters
offsetThe offset to shift the draw position of this ContainerElement using a Screen.ScaledWidth*720 pixel base.

Implements GTA.UI.IElement.

Property Documentation

◆ Centered

virtual bool GTA.UI.ContainerElement.Centered
getset

Gets or sets a value indicating whether this ContainerElement should be positioned based on its center or top left corner

true if centered; otherwise, false.

◆ Color

virtual Color GTA.UI.ContainerElement.Color
getset

Gets or sets the color of this ContainerElement.

The color.

◆ Enabled

virtual bool GTA.UI.ContainerElement.Enabled
getset

Gets or sets a value indicating whether this ContainerElement will be drawn.

true if enabled; otherwise, false.

◆ Items

List<IElement> GTA.UI.ContainerElement.Items
get

The IElements Contained inside this ContainerElement

◆ Position

virtual PointF GTA.UI.ContainerElement.Position
getset

Gets or sets the position of this ContainerElement.

The position scaled on a 1280*720 pixel base.

If ScaledDraw is called, the position will be scaled by the width returned in Screen.ScaledWidth.

◆ Size

SizeF GTA.UI.ContainerElement.Size
getset

Gets or sets the size to draw the ContainerElement

The size on a 1280*720 pixel base

If ScaledDraw is called, the size will be scaled by the width returned in Screen.ScaledWidth.


The documentation for this class was generated from the following file: