Skip to content

IsFacing

The IsFacing function checks whether the player is facing a specified unit, object, or position in the game world. This function is useful for determining the player's orientation relative to other entities or locations, which can be important for targeting, navigation, and other gameplay mechanics.

Parameters

  • unitOrObject: The unit identifier (GUID) or unit identifier (such as "player", "target", "focus", etc.) to check if the player is facing.
  • x (optional): The X coordinate of the position to check if the player is facing.
  • y (optional): The Y coordinate of the position to check if the player is facing.
  • z (optional): The Z coordinate of the position to check if the player is facing.

Returns

  • isFacing: A boolean value indicating whether the player is facing the specified unit, object, or position (true if facing, false otherwise).

Example Usage in Lua

Here is an example of how to use the IsFacing function in Lua:

local api = ...

-- Function to check if the player is facing a specified unit
function CheckIfFacingUnit(unit)
    local isFacing = api.IsFacing(unit)
    if isFacing then
        print("Player is facing unit: " .. unit)
    else
        print("Player is not facing unit: " .. unit)
    end
end

-- Function to check if the player is facing a specified position
function CheckIfFacingPosition(x, y, z)
    local isFacing = api.IsFacing(x, y, z)
    if isFacing then
        print("Player is facing position (" .. x .. ", " .. y .. ", " .. z .. ").")
    else
        print("Player is not facing position (" .. x .. ", " .. y .. ", " .. z .. ").")
    end
end

-- Example usage: Check if the player is facing the target
CheckIfFacingUnit("target")

-- Example usage: Check if the player is facing position (100, 200, 300)
CheckIfFacingPosition(100, 200, 300)