Skip to content

玩家模块管理接口 Player

具体函数名及描述如下:

序号函数名函数描述
1GetHostUin(...)获取房主uin
2SetGameResults(...)设置玩家是否胜利
3SetGameWin(...)设置玩家胜利
4GetCurToolID(...)获取玩家手持道具
5GetShotcutIndex(...)获取玩家当前选中快捷栏索引
6SetShotcutIndex(...)设置玩家当前选中快捷栏索引
7SetSkillCD(...)设置道具技能时间
8ReviveToPos(...)玩家在指定位置复活
9SetRevivePoint(...)设置玩家复活点
10NotifyGameInfo2Self(...)使玩家显示飘窗文字
11RotateCamera(...)玩家旋转摄像机角度
12ShakeCamera(...)抖动玩家镜头
13StopShakeCamera(...)停止抖动玩家镜头
14RotateCameraToActor(...)玩家旋转摄像机角度朝向actor
15ChangeViewMode(...)玩家改变视角
16IsEquipByResID(...)玩家是否装备了某件装备
17GetAimPos(...)获取玩家准心位置
18GetAimDir(...)获取玩家准心方向
19GetRayOriginPos(...)获取玩家射线检测起点位置
20PlayMusic(...)对玩家播放背景音乐2D
21StopMusic(...)玩家停止播放背景音乐2D
22PauseMusic(...)玩家暂停/恢复播放背景音乐
23OpenUIView(...)打开一个UI界面
24HideUIView(...)隐藏一个UI界面
25GetClientInfo(...)获取客机类型
26GetNickname(...)获取玩家昵称
27OpenDevGoodsBuyDialog(...)打开开发者商店商品购买弹框(开发者账号和自定义按钮点击事件可用)
28OpenDevGoodsBuyDetailedDialog(...)打开开发者商店商品详情页
29OpenDevStore(...)玩家打开开发者商店(仅开发者可用)
30OpenDevStoreTab(...)打开开发者商品二级分类
31OpenDevGoodsPage(...)打开开发者商店一级页面
32GetPlayerCostStatic(...)获取玩家的消费统计(有5s冷却限制,触发冷却返回nil)
33StandReportEvent(...)玩家自定义数据上报埋点
34ClearMotion(...)清空运动趋势(配合'禁止移动'使用)
35SetMobileVibrate(...)玩家手机震动
36GetScreenSpacePos(...)根据玩家uin,3D坐标获取玩家屏幕2D坐标
37GetScreenSpacePosV2(...)根据玩家uin,3D坐标获取玩家屏幕2D坐标
38SendFriendApply(...)发送好友申请
39SetCameraPosTransformTo(...)玩家摄像机变换到位置
40SetCameraPosTransformBy(...)玩家摄像机变换相对位置
41SetCameraRotTransformBy(...)玩家摄像机旋转相对角度
42SetCameraFovTransformBy(...)玩家摄像机Fvo变换相对值
43SetCameraAttrState(...)设置玩家的摄像机设置开关
44SetCameraRotMode(...)设置玩家的摄像机旋转模式
45SetCameraMountObj(...)设置玩家的摄像机挂载到对象
46SetCameraMountPos(...)设置玩家的摄像机挂载到位置
47ResetCameraAttr(...)重置玩家摄像机
48OpenBoxByPos(...)打开可以操作的箱子
49GetFirstInviter(...)获取玩家首次邀请人(阻塞接口,请求间隔10s)
50HasFriend(...)判断两个玩家是否是好友(阻塞接口)
51GetMiniVipLevel(...)获取玩家VIP等级
52ChangPlayerMoveType(...)改变玩家移动方式
53PlayAdvertising(...)触发器播放广告接口
54OpenInnerView(...)玩家组显示游戏内弹窗
55SetItemAttAction(...)设置玩家道具设置属性
56ForceOpenBoxUI(...)玩家强制打开UI界面
57ItemSkillCDEnter(...)设置道具技能进入冷却
58ItemSkillCDDone(...)设置道具技能结束冷却
59SetGunActionState(...)设置玩家枪械权限
60GetViewMode(...)获取玩家视角模式
61GetRevivePoint(...)获取玩家复活点
62GetRentCloudServerOwner(...)获取租赁云服务器服主

GetHostUin

  • 参数及类型: 无
  • 返回值及类型:
  • 该方法的主要作用: 获取房主uin
  • 具体使用案例如下:
lua
    local uin = Player:GetHostUin()

SetGameResults

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 设置玩家是否胜利
  • 具体使用案例如下:
lua
    local result = Player:SetGameResults(Player:GetHostUin(), TeamResults.Win)

SetGameWin

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 设置玩家胜利
  • 具体使用案例如下:
lua
    local result = Player:SetGameWin(Player:GetHostUin())

GetCurToolID

  • 参数及类型:
  • 返回值及类型:
    • ret:number,string道具ID
  • 该方法的主要作用: 获取玩家手持道具
  • 具体使用案例如下:
lua
    local toolID = Player:GetCurToolID(Player:GetHostUin())

GetShotcutIndex

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 获取玩家当前选中快捷栏索引
  • 具体使用案例如下:
lua
    local index = Player:GetShotcutIndex(Player:GetHostUin())

SetShotcutIndex

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 设置玩家当前选中快捷栏索引
  • 具体使用案例如下:
lua
    local result = Player:SetShotcutIndex(Player:GetHostUin(), 2)

SetSkillCD

  • 参数及类型:
    • objid:number玩家Uin
    • itemid:number,string道具类型
    • cd:number冷却时间
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 设置道具技能时间
  • 具体使用案例如下:
lua
    local result = Player:SetSkillCD(Player:GetHostUin(), 12005, 10)

ReviveToPos

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家在指定位置复活
  • 具体使用案例如下:
lua
    local result = Player:ReviveToPos(Player:GetHostUin(), x, y, z)

SetRevivePoint

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 设置玩家复活点
  • 具体使用案例如下:
lua
    local result = Player:SetRevivePoint(Player:GetHostUin(), x, y, z)

NotifyGameInfo2Self

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 使玩家显示飘窗文字
  • 具体使用案例如下:
lua
    local result = Player:NotifyGameInfo2Self(Player:GetHostUin(), "飘窗提示")

RotateCamera

  • 参数及类型:
    • objid:number玩家Uin
    • yaw:number视角偏移旋转角度
    • pitch:number视角仰望旋转角度
    • issmooth:bool是否平滑
    • iscorrectyaw:bool:是否修正,deltayaw:number:视角偏移平滑变化量,deltapitch:number:视角仰望变化量
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家旋转摄像机角度
  • 具体使用案例如下:
lua
    local result = Player:RotateCamera(Player:GetHostUin(), 45, 0)

ShakeCamera

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 抖动玩家镜头
  • 具体使用案例如下:
lua
    local result = Player:ShakeCamera(Player:GetHostUin(), 1, 20)

StopShakeCamera

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 停止抖动玩家镜头
  • 具体使用案例如下:
lua
    local result = Player:StopShakeCamera(Player:GetHostUin())

RotateCameraToActor

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家旋转摄像机角度朝向actor
  • 具体使用案例如下:
lua
    local result = Player:RotateCameraToActor(Player:GetHostUin(), objId)

ChangeViewMode

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家改变视角
  • 具体使用案例如下:
lua
    local result = Player:ChangeViewMode(Player:GetHostUin(), ViewPortType.Main, false)

IsEquipByResID

  • 参数及类型:
    • objid:number玩家Uin
    • itemid:number,string道具类型
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家是否装备了某件装备
  • 具体使用案例如下:
lua
    local result = Player:IsEquipByResID(Player:GetHostUin(), 12202)

GetAimPos

  • 参数及类型:
  • 返回值及类型: ret:x|y|z:number:坐标
  • 该方法的主要作用: 获取玩家准心位置
  • 具体使用案例如下:
lua
    local x, y, z = Player:GetAimPos(Player:GetHostUin())

GetAimDir

  • 参数及类型:
  • 返回值及类型:
    • ret:table单位方向向量
  • 该方法的主要作用: 获取玩家准心方向
  • 具体使用案例如下:
lua
local ret = Player:GetAimDir(objid)

GetRayOriginPos

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 获取玩家射线检测起点位置
  • 具体使用案例如下:
lua
local x,y,z = Player:GetRayOriginPos(objid)

PlayMusic

  • 参数及类型:
    • objid:number玩家Uin
    • musicId:string声音ID
    • volume:number声音大小
    • pitch:number::声音音调
    • isLoop:是否循环
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 对玩家播放背景音乐2D
  • 具体使用案例如下:
lua
    local result = Player:PlayMusic(Player:GetHostUin(), 10002, 100, 1, false)

StopMusic

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家停止播放背景音乐2D
  • 具体使用案例如下:
lua
    local result = Player:StopMusic(Player:GetHostUin(), 10002)

PauseMusic

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家暂停/恢复播放背景音乐
  • 具体使用案例如下:
lua
    local result = Player:PauseMusic(Player:GetHostUin(), 10002, true)

OpenUIView

  • 参数及类型:
    • objid:number玩家Uin
    • uiname:number自定义UIID
    • effectid:number动作ID(缺省参数)
    • time:number动画事件(缺省参数)
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 打开一个UI界面
  • 具体使用案例如下:
lua
    local result = Player:OpenUIView(Player:GetHostUin(), "7482986899365911542-22886")

HideUIView

  • 参数及类型:
    • objid:number玩家Uin
    • uiname:number自定义UIID
    • effectid:number动作ID(缺省参数)
    • time:number动画事件(缺省参数)
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 隐藏一个UI界面
  • 具体使用案例如下:
lua
    local result = Player:HideUIView(Player:GetHostUin(), "7482986899365911542-22886")

GetClientInfo

  • 参数及类型:
  • 返回值及类型:
    • ret:number返回值(1 pc 2 android 3 ios)
  • 该方法的主要作用: 获取客机类型
  • 具体使用案例如下:
lua
local ret = Player:GetClientInfo(uin)

GetNickname

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 获取玩家昵称
  • 具体使用案例如下:
lua
local name = Player:GetNickname(objid)

OpenDevGoodsBuyDialog

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 打开开发者商店商品购买弹框(开发者账号和自定义按钮点击事件可用)
  • 具体使用案例如下:
lua
local code = Player:OpenDevGoodsBuyDialog(objid, devGoodsId, customDesc)

OpenDevGoodsBuyDetailedDialog

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 打开开发者商店商品详情页
  • 具体使用案例如下:
lua
local code = Player:OpenDevGoodsBuyDetailedDialog(objid, devGoodsId)

OpenDevStore

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家打开开发者商店(仅开发者可用)
  • 具体使用案例如下:
lua
local ret = Player:OpenDevStore(objid)

OpenDevStoreTab

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 打开开发者商品二级分类
  • 具体使用案例如下:
lua
local ret = Player:OpenDevStoreTab(objid, page, name)

OpenDevGoodsPage

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 打开开发者商店一级页面
  • 具体使用案例如下:
lua
local ret = Player:OpenDevGoodsPage(playerid, pagetype, pagetitle)

GetPlayerCostStatic

  • 参数及类型:
  • 返回值及类型:
    • icount:number消费数量(-1 请求失败)
  • 该方法的主要作用: 获取玩家的消费统计(有5s冷却限制,触发冷却返回nil)
  • 具体使用案例如下:
lua
    -- 获取玩家24小时内消耗的迷你币

    local result = Player:GetPlayerCostStatic(Player:GetHostUin(), os.time() - 24 * 60 * 60, os.time(), MiniCurrency.MiniCoin)

StandReportEvent

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家自定义数据上报埋点
  • 具体使用案例如下:
lua
    local result = Player:StandReportEvent(Player:GetHostUin(), "自动测试上报")

ClearMotion

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 清空运动趋势(配合'禁止移动'使用)
  • 具体使用案例如下:
lua
    local result = Player:ClearMotion(Player:GetHostUin())

SetMobileVibrate

  • 参数及类型:
    • playerid:number玩家Uin
    • time:number震动时长(单位:ms)
    • amplitude:number震动强度(范围:1~255)
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家手机震动
  • 具体使用案例如下:
lua
    local result = Player:SetMobileVibrate(Player:GetHostUin(), 1, 20)

GetScreenSpacePos

  • 参数及类型:
  • 返回值及类型: retX:number:x坐标 retY:number:y坐标 需要注意这里的X、Y、Z需要将方块坐标*100后来使用,例如原方块坐标为(1 ,7 ,1),则需要传入(100,700,100),之后版本会新增接口替代该接口。
  • 该方法的主要作用: 根据玩家uin,3D坐标获取玩家屏幕2D坐标
  • 具体使用案例如下:
lua
    local screenX, screenY = Player:GetScreenSpacePos(Player:GetHostUin(), x, y, z)

GetScreenSpacePosV2

  • 参数及类型:
  • 返回值及类型: retX:number:x坐标 retY:number:y坐标 需要注意这里的X、Y、Z需要将方块坐标使用
  • 该方法的主要作用: 根据玩家uin,3D坐标获取玩家屏幕2D坐标
  • 具体使用案例如下:
lua
local retX = Player:GetScreenSpacePosV2(playerid, x, y, z)

SendFriendApply

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 发送好友申请
  • 具体使用案例如下:
lua
    local result = Player:SendFriendApply(Player:GetHostUin(), friendUin)

SetCameraPosTransformTo

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家摄像机变换到位置
  • 具体使用案例如下:
lua
    local result = Player:SetCameraPosTransformTo(Player:GetHostUin(), {x = 0, y = 100, z = 0}, Easing.ExpoIn, 0.2)

SetCameraPosTransformBy

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家摄像机变换相对位置
  • 具体使用案例如下:
lua
    local result = Player:SetCameraPosTransformBy(Player:GetHostUin(), {x = 0, y = 0, z = 100}, Easing.Linear, 1)

SetCameraRotTransformBy

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家摄像机旋转相对角度
  • 具体使用案例如下:
lua
    -- 摄像机线性旋转,时间1秒

    local result = Player:SetCameraRotTransformBy(Player:GetHostUin(), {x = 0, y = 100, z = 0}, Easing.Linear, 1)

SetCameraFovTransformBy

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家摄像机Fvo变换相对值
  • 具体使用案例如下:
lua
    local result = Player:SetCameraFovTransformBy(Player:GetHostUin(), 45, Easing.Linear, 1)

SetCameraAttrState

  • 参数及类型:
  • 返回值及类型:
    • enable:bool开关(true开启 false关闭)
  • 该方法的主要作用: 设置玩家的摄像机设置开关
  • 具体使用案例如下:
lua
    local result = Player:SetCameraAttrState(Player:GetHostUin(), CameraModel.MoveFollow, true)

SetCameraRotMode

  • 参数及类型:
  • 返回值及类型:
    • code:bool成功(true)
  • 该方法的主要作用: 设置玩家的摄像机旋转模式
  • 具体使用案例如下:
lua
    local result = Player:SetCameraRotMode(Player:GetHostUin(), CameraRotate.AllDir)

SetCameraMountObj

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 设置玩家的摄像机挂载到对象
  • 具体使用案例如下:
lua
    local result = Player:SetCameraMountObj(Player:GetHostUin(), playerUin)

SetCameraMountPos

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 设置玩家的摄像机挂载到位置
  • 具体使用案例如下:
lua
    local result = Player:SetCameraMountPos(Player:GetHostUin(), {x = x, y = y, z = z})

ResetCameraAttr

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 重置玩家摄像机
  • 具体使用案例如下:
lua
    local result = Player:ResetCameraAttr(Player:GetHostUin())

OpenBoxByPos

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 打开可以操作的箱子
  • 具体使用案例如下:
lua
    local result = Player:OpenBoxByPos(Player:GetHostUin(), x, y, z)

GetFirstInviter

  • 参数及类型:
    • call_back:function内部回调(缺省参数)
    • objid:number被邀请的玩家Uin
  • 返回值及类型:
    • uin:number邀请人的玩家Uin(获取失败时返回错误码)
  • 该方法的主要作用: 获取玩家首次邀请人(阻塞接口,请求间隔10s)
  • 具体使用案例如下:
lua
    local inviterUin = Player:GetFirstInviter(Player:GetHostUin())

HasFriend

  • 参数及类型:
  • 返回值及类型:
    • code:bool是否是好友
  • 该方法的主要作用: 判断两个玩家是否是好友(阻塞接口)
  • 具体使用案例如下:
lua
    local result = Player:HasFriend(Player:GetHostUin(), "123456")

GetMiniVipLevel

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 获取玩家VIP等级
  • 具体使用案例如下:
lua
    local level = Player:GetMiniVipLevel(Player:GetHostUin())

ChangPlayerMoveType

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 改变玩家移动方式
  • 具体使用案例如下:
lua
    local result = Player:ChangPlayerMoveType(Player:GetHostUin(), MoveType.Flying)

PlayAdvertising

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 触发器播放广告接口
  • 具体使用案例如下:
lua
    local code,uin,adname = Player:PlayAdvertising(Player:GetHostUin(),'测试广告')

    if code == ErrorCode.OK then

        print("广告播放成功")

    else

        print("广告播放失败")

    end

OpenInnerView

  • 参数及类型:
    • uin:number玩家Uin
    • iview:number弹窗类型枚举(InnerPopUpview)InnerPopUpview
    • bopen:bool打开或者关闭
    • data:any根据前面枚举传参(储物箱需要传入位置)
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 玩家组显示游戏内弹窗
  • 具体使用案例如下:
lua
    local result = Player:OpenInnerView(Player:GetHostUin(), InnerPopUpview.InviteFriend, true)

    local result2 = Player:OpenInnerView(Player:GetHostUin(),InnerPopUpview.StorageBox, true,{x=0,y = 7,z = 0}) -- 打开坐标(0 7 0)位置的储物箱

SetItemAttAction

  • 参数及类型:
  • 返回值及类型:
    • ret:bool成功(true)
  • 该方法的主要作用: 设置玩家道具设置属性
  • 具体使用案例如下:
lua
    local result = Player:SetItemAttAction(Player:GetHostUin(), 10025, ItemAbility.Drop, true)

ForceOpenBoxUI

  • 参数及类型:
  • 返回值及类型:
    • code:bool成功(true)
  • 该方法的主要作用: 玩家强制打开UI界面
  • 具体使用案例如下:
lua
    local result = Player:ForceOpenBoxUI(Player:GetHostUin(), WorkStage.Repair)

ItemSkillCDEnter

  • 参数及类型:
    • objid:number玩家Uin
    • itemid:number/string道具ID
    • cd:number/nil CD时间
  • 返回值及类型:
  • 该方法的主要作用: 设置道具技能进入冷却
  • 具体使用案例如下:
lua
    local result = Player:ItemSkillCDEnter(Player:GetHostUin(), 12005)

ItemSkillCDDone

  • 参数及类型:
    • objid:number玩家Uin
    • itemid:number/string道具ID
  • 返回值及类型:
  • 该方法的主要作用: 设置道具技能结束冷却
  • 具体使用案例如下:
lua
    local result = Player:ItemSkillCDDone(Player:GetHostUin(), 12005)

SetGunActionState

  • 参数及类型:
    • objid:number玩家Uin
    • action:枪禁用状态枚举 GunActionBan
    • switch:boolean是否打开
  • 返回值及类型:
  • 该方法的主要作用: 设置玩家枪械权限
  • 具体使用案例如下:
lua
    local result = Player:SetGunActionState(Player:GetHostUin(), GunActionBan.AimFire, true)

GetViewMode

  • 参数及类型:
  • 返回值及类型:
    • ret:number视角模式 ViewPortType
  • 该方法的主要作用: 获取玩家视角模式
  • 具体使用案例如下:
lua
local ret = Player:GetViewMode(uin)

GetRevivePoint

  • 参数及类型:
  • 返回值及类型:
  • 该方法的主要作用: 获取玩家复活点
  • 具体使用案例如下:
lua
local x|y|z = Player:GetRevivePoint(uin)

GetRentCloudServerOwner

  • 参数及类型: 无
  • 返回值及类型:
    • uin:number玩家Uin (仅租赁云服生效)
  • 该方法的主要作用: 获取租赁云服务器服主
  • 具体使用案例如下:
lua
local uin = Player:GetRentCloudServerOwner()