📺 Viewport

Work with screen properties and effects.

🗿Static ClassClient Only🧑‍💻API Source

---

🗿 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
		SetBrandingBarSettings	Sets the Branding Bar settings (the bar with 'nanos world - closed alpha ver...')
		SetCrosshairEnabled	Enables/Disables the Crosshair
		SetHardwareCursor	Loads and sets a hardware cursor in the game from a PNG image
		SetInteractionToolTipEnabled	Enables/Disables the Interaction ToolTip
		SetMousePosition	Sets the mouse position
	function	Subscribe	Subscribes to an Event
		Unsubscribe	Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

---

Moderate

DeprojectScreenToWorld

Transforms a 2D screen coordinates into 3D world-space location

local ret = Viewport.DeprojectScreenToWorld(screen_position)

Parameters

Type	Parameter	Default	Description
Vector2D	screen_position	Required parameter	Screen position

Returns

Type	Description
table	Table with the world <code>Position</code> and the <code>Direction</code> the screen point looks at with this format

---

Optimal

GetMousePosition

Gets the current mouse screen location

local ret = Viewport.GetMousePosition()

Returns

Type	Description
Vector2D	The current mouse screen location

See also SetMousePosition.

---

Optimal

GetViewportScale

Gets the scale of viewport

local ret = Viewport.GetViewportScale()

Returns

Type	Description
float	The scale of viewport

---

Optimal

GetViewportSize

Gets the size of viewport

local ret = Viewport.GetViewportSize()

Returns

Type	Description
Vector2D	The size of viewport

---

Moderate

ProjectWorldToScreen

Transforms a 3D world-space vector into 2D screen coordinates

local ret = Viewport.ProjectWorldToScreen(world_position)

Parameters

Type	Parameter	Default	Description
Vector	world_position	Required parameter	World 3D position

Returns

Type	Description
Vector2D	The screen position, in pixels

---

Optimal

SetBloodScreenEnabled

Enables/Disables the Blood Screen effect

Viewport.SetBloodScreenEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	is_enabled	Required parameter	Whether to enable the Blood Screen effect

---

Optimal

SetBloodScreenIntensity

If you don't want the Blood Screen to be overridden by the default damage effect, disable it first with Viewport.SetBloodScreenEnabled(false)

Viewport.SetBloodScreenIntensity(intensity)

Parameters

Type	Parameter	Default	Description
float	intensity	Required parameter	From 0.0 to 1.0

---

Optimal

SetBrandingBarSettings

Sets the Branding Bar settings (the bar with 'nanos world - closed alpha ver...')

Viewport.SetBrandingBarSettings(horizontal_alignment, vertical_alignment, is_lean?)

Parameters

Type	Parameter	Default	Description
WidgetHorizontalAlignment	horizontal_alignment	Required parameter	Left, Center and Right supported
WidgetVerticalAlignment	vertical_alignment	Required parameter	Bottom and Top supported
boolean	is_lean?	false	Whether to show less information

---

Optimal

SetCrosshairEnabled

Enables/Disables the Crosshair

Viewport.SetCrosshairEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	is_enabled	Required parameter	Whether to enable the Crosshair

---

Slow

SetHardwareCursor

Loads and sets a hardware cursor in the game from a PNG image
Note: due an engine limitation modifying an already set cursor image will not change the cursor until the game is restarted

Viewport.SetHardwareCursor(cursor_shape, cursor_path, hotspot?)

Parameters

Type	Parameter	Default	Description
CursorType	cursor_shape	Required parameter	Which cursor shape to replace
Image Path	cursor_path	Required parameter	a PNG image relative to Assets/
Vector2D	hotspot?	Vector(0, 0)	Click point of the cursor image, in pixels

---

Optimal

SetInteractionToolTipEnabled

Enables/Disables the Interaction ToolTip

Viewport.SetInteractionToolTipEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	is_enabled	Required parameter	Whether to enable the Interaction ToolTip

---

Optimal

SetMousePosition

Sets the mouse position

Viewport.SetMousePosition(new_position)

Parameters

Type	Parameter	Default	Description
Vector2D	new_position	Required parameter	The new mouse position

See also GetMousePosition.

---

Optimal

Subscribe

Subscribes to an Event

local ret = Viewport.Subscribe(event_name, callback)

Parameters

Type	Parameter	Default	Description
string	event_name	Required parameter	Event to subscribe to
function	callback	Required parameter	Callback to run on the event occurring

Returns

Type	Description
function	The function callback

---

Optimal

Unsubscribe

Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

Viewport.Unsubscribe(event_name, callback?)

Parameters

Type	Parameter	Default	Description
string	event_name	Required parameter	Event to unsubscribe to
function	callback?	nil	Optional callback to specifically unsubscribe to

🚀 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)

Arguments

Type	Argument	Description
Vector2D	new_size	The new screen size