- servers - players

Download

Documentation
Client functions
getPlayerCrosshairImage

Function

getPlayerCrosshairImage

New function!Added to Trilogy Hub on 11 Nov 2026.

ClientPlayersTrilogy Hub only

Returns the path, width, height and tint of the image set by setPlayerCrosshairImage. Returns false when no custom image is set.

Syntax

string/bool, float, float, int getPlayerCrosshairImage()

Returns

Path, width, height, tint, or false.

Example

local path, width, height, color = getPlayerCrosshairImage()
if path then outputDebugString(path) end

See also

setPlayerCrosshairImageSets a custom crosshair image at the screen centre and hides the original game reticle. The image is continuously visible while the "crosshair" HUD component is enabled; your script decides when to show it during aiming. The file must be available to the client, e.g. through <file src="crosshair.png" /> in meta.xml. Pass false to remove the image and restore the game reticle according to its visibility setting. Stopping the owning resource removes its image. Errors leave the previous image unchanged.