Method WorldObject:GetNearestPlayer [-] [+]

Returns the nearest Player object in sight of the WorldObject or within the given range

Synopsis

nearestPlayer = WorldObject:GetNearestPlayer( range )

nearestPlayer = WorldObject:GetNearestPlayer( range, hostile )

nearestPlayer = WorldObject:GetNearestPlayer( range, hostile, dead )

Arguments

number range (533.33333)

Optionally set range. Default range is grid size.

Valid numbers: all decimal numbers.

number hostile (0)

0 both, 1 hostile, 2 friendly.

Valid numbers: integers from 0 to 4,294,967,295.

number dead (1)

0 both, 1 alive, 2 dead.

Valid numbers: integers from 0 to 4,294,967,295.

Returns

Player nearestPlayer
See method description.

Generated on
© 2010 - 2024 Eluna Lua Engine