Difference between revisions of "Findnearactor"

From EDukeWiki
Jump to navigation Jump to search
Line 1: Line 1:
findnearactor <[[actor]]> <distance> <[[gamevar]]>
+
'''findnearactor''' <[[actor]]> <distance> <[[gamevar]]>
  
 
Gets the actor ID of the closest <[[actor]]> within <distance> into a <[[gamevar]]>.  If no actor within range is found, the [[gamevar]] is set to -1.  The input for <[[actor]]> may be its tile number (example: 2000) or its defined name (example: PIGCOP).  The <distance> will be determined on the x and y plane only; for finding actors on the x, y, and z axes use [[findnearactor3d]] instead.
 
Gets the actor ID of the closest <[[actor]]> within <distance> into a <[[gamevar]]>.  If no actor within range is found, the [[gamevar]] is set to -1.  The input for <[[actor]]> may be its tile number (example: 2000) or its defined name (example: PIGCOP).  The <distance> will be determined on the x and y plane only; for finding actors on the x, y, and z axes use [[findnearactor3d]] instead.

Revision as of 12:18, 4 May 2009

findnearactor <actor> <distance> <gamevar>

Gets the actor ID of the closest <actor> within <distance> into a <gamevar>. If no actor within range is found, the gamevar is set to -1. The input for <actor> may be its tile number (example: 2000) or its defined name (example: PIGCOP). The <distance> will be determined on the x and y plane only; for finding actors on the x, y, and z axes use findnearactor3d instead.

By getting the actor ID of a nearby actor, the current actor can use getactor/setactor to edit the properties of the target actor or getangle to face the target actor, among other potential uses.

Also note that if the <actor> being located within the <distance> is asleep this will return a value of -1

Also see findnearsprite.