GetMouseHitEntity: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetMouseHitEntity()}} {{FuncParameters}} {{FuncNoParam}} {{FuncReturnValue|__EDIT_ME__}} == Exam...")
 
No edit summary
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Get entity type and identifier the mouse pointer hits.}}


{{FuncSyntax|GetMouseHitEntity()}}
{{FuncSyntax|GetMouseHitEntity()}}
Line 8: Line 8:
{{FuncNoParam}}
{{FuncNoParam}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns the hit entity type [[HitType]] and entity identifier.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
local entityType, entityId = GetMouseHitEntity()
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
__EDIT_ME__

Revision as of 05:18, 4 December 2019

GetMouseHitEntity

Type: Function
Context: Client
Introduced: v1.0

Description

Get entity type and identifier the mouse pointer hits.

Syntax

GetMouseHitEntity()

Parameters

  • This function has no parameters.

Return Value

  • Returns the hit entity type HitType and entity identifier.

Example

local entityType, entityId = GetMouseHitEntity()

See also

__EDIT_ME__