๐บ Viewport
Work with screen properties and effects.
๐ฟStatic Class
This is a Static Class. Access it's methods directly with
.
. It's not possible to spawn new instances.๐Authority
This static class can be accessed only on ๐ง Client side.
๐งโ๐ปAPI Source
The methods, properties and events descriptions from this page are defined in our GitHub API Repository!
๐ฟย Static Functionsโ
Returns | Name | Description | |
---|---|---|---|
table | DeprojectScreenToWorld | Transforms a 2D screen coordinates into 3D world-space location | |
Vector2D | GetMousePosition | Gets the current mouse screen location | |
float | GetViewportScale | Gets the scale of viewport | |
Vector2D | GetViewportSize | Gets the size of viewport | |
Vector2D | ProjectWorldToScreen | Transforms a 3D world-space vector into 2D screen coordinates | |
SetBloodScreenEnabled | Enables/Disables the Blood Screen effect | ||
SetBloodScreenIntensity | Manually sets the Blood Screen intensity | ||
SetCrosshairEnabled | Enables/Disables the Crosshair | ||
SetHardwareCursor | Loads and sets a hardware cursor in the game from a PNG image | ||
SetMousePosition | Sets the mouse position |

DeprojectScreenToWorld
Transforms a 2D screen coordinates into 3D world-space location
โ Returns table (with this format).
local ret = Viewport.DeprojectScreenToWorld(screen_position)
Type | Parameter | Default | Description |
---|---|---|---|
Vector2D | screen_position | Screen position |

GetMousePosition
Gets the current mouse screen location
โ Returns Vector2D (The current mouse screen location).
local ret = Viewport.GetMousePosition()
See also SetMousePosition.

GetViewportScale
Gets the scale of viewport
โ Returns float (The scale of viewport).
local ret = Viewport.GetViewportScale()

GetViewportSize
Gets the size of viewport
โ Returns Vector2D (The size of viewport).
local ret = Viewport.GetViewportSize()

ProjectWorldToScreen
Transforms a 3D world-space vector into 2D screen coordinates
โ Returns Vector2D.
local ret = Viewport.ProjectWorldToScreen(world_position)
Type | Parameter | Default | Description |
---|---|---|---|
Vector | world_position | World 3D position |

SetBloodScreenEnabled
Enables/Disables the Blood Screen effect
Viewport.SetBloodScreenEnabled(is_enabled)
Type | Parameter | Default | Description |
---|---|---|---|
boolean | is_enabled |

SetBloodScreenIntensity
If you want the Blood Screen to do not be overridden, disable it with Client.SetBloodScreenEnabled(false)
before
Viewport.SetBloodScreenIntensity(intensity)
Type | Parameter | Default | Description |
---|---|---|---|
float | intensity | From 0.0 to 1.0 |

SetCrosshairEnabled
Enables/Disables the Crosshair
Viewport.SetCrosshairEnabled(is_enabled)
Type | Parameter | Default | Description |
---|---|---|---|
boolean | is_enabled |

SetHardwareCursor
Loads and sets a hardware cursor in the game from a PNG image
Viewport.SetHardwareCursor(cursor_shape, cursor_path, hotspot?)
Type | Parameter | Default | Description |
---|---|---|---|
CursorType | cursor_shape | ||
Image Path | cursor_path | a PNG image relative to Assets/ | |
Vector2D | hotspot? | Vector(0, 0) |

SetMousePosition
Sets the mouse position
Viewport.SetMousePosition(new_position)
Type | Parameter | Default | Description |
---|---|---|---|
Vector2D | new_position |
See also GetMousePosition.
๐ย Eventsโ
Name | Description | |
---|---|---|
Resize | Called when the screen is resized |

Resize
Called when the screen is resized
Viewport.Subscribe("Resize", function(new_size)
-- Resize was called
end)
Type | Argument | Description |
---|---|---|
Vector2D | new_size | New new screen size |