FreeKill/lua/lsp/player.lua

67 lines
1.5 KiB
Lua
Raw Normal View History

-- SPDX-License-Identifier: GPL-3.0-or-later
2022-03-30 08:33:56 +00:00
---@meta
---@class fk.Player
2022-03-30 08:33:56 +00:00
FPlayer = {}
---@return integer id
2022-03-30 08:33:56 +00:00
function FPlayer:getId()end
---@param id integer
2022-03-30 08:33:56 +00:00
function FPlayer:setId(id)end
---@return string name
function FPlayer:getScreenName()end
---@param name string
function FPlayer:setScreenName(name)end
---@return string avatar
function FPlayer:getAvatar()end
---@param avatar string
function FPlayer:setAvatar(avatar)end
---@return string state
function FPlayer:getStateString()end
---@param state string
function FPlayer:setStateString(state)end
---@class fk.ServerPlayer : fk.Player
2022-03-30 08:33:56 +00:00
FServerPlayer = {}
---@return fk.Server
2022-03-30 08:33:56 +00:00
function FServerPlayer:getServer()end
---@return fk.Room
2022-03-30 08:33:56 +00:00
function FServerPlayer:getRoom()end
---@param room fk.Room
2022-03-30 08:33:56 +00:00
function FServerPlayer:setRoom(room)end
---@param msg string
function FServerPlayer:speak(msg)end
--- Send a request to client, and allow client to reply within *timeout* seconds.
---
--- *timeout* must not be negative or **nil**.
---@param command string
---@param jsonData string
---@param timeout integer
2022-03-30 08:33:56 +00:00
function FServerPlayer:doRequest(command,jsonData,timeout)end
--- Wait for at most *timeout* seconds for reply from client.
---
--- If *timeout* is negative or **nil**, the function will wait forever until get reply.
---@param timeout integer @ seconds to wait
---@return string @ JSON data
2022-03-30 08:33:56 +00:00
---@overload fun()
function FServerPlayer:waitForReply(timeout)end
--- Notice the client.
---@param command string
---@param jsonData string
function FServerPlayer:doNotify(command,jsonData)end