QCherry: Complete Lua function catalog

2026-08-15T09:54:28Z

Complete Lua function catalog

← Older revision		Revision as of 09:54, 15 August 2026
Line 43:		Line 43:
	* This is a geometric targeting helper. It does not perform an Unreal visibility trace and does not test world occlusion.		* This is a geometric targeting helper. It does not perform an Unreal visibility trace and does not test world occlusion.

			[[Category:Lua Functions]]
	[[Category:Server Functions]]		[[Category:Server Functions]]
	[[Category:Player Functions]]		[[Category:Player Functions]]
	[[Category:Spatial Functions]]		[[Category:Spatial Functions]]

QCherry: Synchronize Lua API documentation

2026-08-13T20:32:51Z

Synchronize Lua API documentation

New page

= isPlayerInTarget =
Checks whether one player is looking towards another player within a validated distance and field of view.

== Syntax ==
<syntaxhighlight lang="lua">
bool isPlayerInTarget(int viewerPlayerId, int targetPlayerId [, number maximumDistance = 25 [, number fieldOfView = 60]])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>viewerPlayerId</code> || <code>int</code> || yes || The player whose position and facing direction are tested.
|-
| <code>targetPlayerId</code> || <code>int</code> || yes || The player that must be inside the viewer's target cone.
|-
| <code>maximumDistance</code> || <code>number</code> || no || Maximum three-dimensional distance in metres, from 0.1 to 1000; defaults to 25.
|-
| <code>fieldOfView</code> || <code>number</code> || no || Total horizontal field of view in degrees, from 1 to 180; defaults to 60.
|}

== Returns ==
Returns <code>true</code> when both players are valid and the target is inside the viewer's distance and horizontal view cone; otherwise returns <code>false</code>.

== Examples ==
Allow an interaction only while the other player is in front of the caller:
<syntaxhighlight lang="lua" line>
addCommandHandler("inspect", function(playerId, _, targetId)
targetId = tonumber(targetId)
if targetId and isPlayerInTarget(playerId, targetId, 4.0, 50.0) then
outputChatBox("The player is in your target.", playerId)
else
outputChatBox("Look at a nearby player first.", playerId)
end
end)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The check uses authoritative server positions and the viewer's replicated yaw.
* The aliases <code>ifPlayerIsInTarget</code> and <code>ifPlayerisInTarget</code> are available for compatibility. New scripts should use <code>isPlayerInTarget</code>.
* This is a geometric targeting helper. It does not perform an Unreal visibility trace and does not test world occlusion.

[[Category:Server Functions]]
[[Category:Player Functions]]
[[Category:Spatial Functions]]

IsPlayerInTarget - Revision history

QCherry: Complete Lua function catalog

QCherry: Synchronize Lua API documentation