API:SendPlayerInspectionRequest

UI Lua API · Social functions
Version: WAR 1.4.8

Asks the server to inspect a player.

SendPlayerInspectionRequest()

Arguments

None.

Returns

Nothing.

Details

• The request is a fixed message: it carries no player name or id. The stock UI calls it from the Inspect entry of the player context menu.
• The function reads no arguments; any arguments passed are ignored.
• Nothing is sent if there is no player object, the Lua state is not available, or the connection is not ready.
• The results are read with GetInspectionData and GetInspectionBragData.

Errors

None.

Example

From default/ea_playermenu/source/playermenuwindow.lua:

function PlayerMenuWindow.OnInspect()
    if( ButtonGetDisabledFlag(SystemData.ActiveWindow.name ) == true ) then
        return
    end

    SendPlayerInspectionRequest()
    PlayerMenuWindow.Done()
end

See also

• GetInspectionData
• GetInspectionBragData