玩家模块管理接口 Player

具体函数名及描述如下:

序号	函数名	函数描述
1	GetHostUin(...)	获取房主uin
2	SetGameResults(...)	设置玩家是否胜利
3	SetGameWin(...)	设置玩家胜利
4	GetCurToolID(...)	获取玩家手持道具
5	GetShotcutIndex(...)	获取玩家当前选中快捷栏索引
6	SetShotcutIndex(...)	设置玩家当前选中快捷栏索引
7	SetSkillCD(...)	设置道具技能时间
8	ReviveToPos(...)	玩家在指定位置复活
9	SetRevivePoint(...)	设置玩家复活点
10	NotifyGameInfo2Self(...)	使玩家显示飘窗文字
11	RotateCamera(...)	玩家旋转摄像机角度
12	ShakeCamera(...)	抖动玩家镜头
13	StopShakeCamera(...)	停止抖动玩家镜头
14	ChangeViewMode(...)	玩家改变视角
15	ChangeViewModeForMod(...)	玩家改变视角(支持冒险模式)
16	IsEquipByResID(...)	玩家是否装备了某件装备
17	GetAimPos(...)	获取玩家准心位置
18	PlayMusic(...)	对玩家播放背景音乐2D
19	StopMusic(...)	玩家停止播放背景音乐2D
20	PauseMusic(...)	玩家暂停/恢复播放背景音乐
21	OpenUIView(...)	打开一个UI界面
22	HideUIView(...)	隐藏一个UI界面
23	GetNickname(...)	获取玩家昵称
24	GetPlayerCostStatic(...)	获取玩家的消费统计（有5s冷却限制，触发冷却返回nil)
25	StandReportEvent(...)	玩家自定义数据上报埋点
26	OpenShopTryOnView(...)	打开商城试穿界面
27	OpenShopSkinBuyDialog(...)	打开商城皮肤购买界面(购买玩家对象同款皮肤)
28	SetMobileVibrate(...)	玩家手机震动
29	OpenShopGiveGiftView(...)	打开商店赠送界面
30	SendFriendApply(...)	发送好友申请
31	SetCameraPosTransformTo(...)	玩家摄像机变换到位置
32	SetCameraPosTransformBy(...)	玩家摄像机变换相对位置
33	SetCameraRotTransformBy(...)	玩家摄像机旋转相对角度
34	SetCameraFovTransformBy(...)	玩家摄像机Fvo变换相对值
35	SetCameraAttrState(...)	设置玩家的摄像机设置开关
36	SetCameraRotMode(...)	设置玩家的摄像机旋转模式
37	SetCameraMountObj(...)	设置玩家的摄像机挂载到对象
38	SetCameraMountPos(...)	设置玩家的摄像机挂载到位置
39	ResetCameraAttr(...)	重置玩家摄像机
40	OpenBoxByPos(...)	打开可以操作的箱子
41	GetFirstInviter(...)	获取玩家首次邀请人(阻塞接口，请求间隔10s)
42	HasFriend(...)	判断两个玩家是否是好友(阻塞接口)
43	GetMiniVipLevel(...)	获取玩家VIP等级
44	SetCrawl(...)	设置玩家的爬行状态
45	GunGetMagazine(...)	当前枪里的弹药量
46	PlayAdvertisingCallback(...)	玩家播放开发者广告（仅开发者可用）
47	OpenInnerView(...)	玩家组显示游戏内弹窗
48	SetItemAttAction(...)	设置玩家道具设置属性
49	ForceOpenBoxUI(...)	玩家强制打开UI界面
50	ItemSkillCDEnter(...)	设置道具技能进入冷却
51	ItemSkillCDDone(...)	设置道具技能结束冷却
52	SetGunActionState(...)	设置玩家枪械权限

GetHostUin

• 参数及类型： 无
• 返回值及类型：
  • ret:number玩家Uin
• 该方法的主要作用： 获取房主uin
• 具体使用案例如下：

    local uin = Player:GetHostUin()

SetGameResults

• 参数及类型：
  • objid:number玩家Uin
  • result:number游戏结果(TeamResults)TeamResults
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 设置玩家是否胜利
• 具体使用案例如下：

    local result = Player:SetGameResults(Player:GetHostUin(), TeamResults.Win)

SetGameWin

• 参数及类型：
  • objid:number玩家Uin
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 设置玩家胜利
• 具体使用案例如下：

    local result = Player:SetGameWin(Player:GetHostUin())

GetCurToolID

• 参数及类型：
  • objid:number玩家Uin
• 返回值及类型：
  • ret:number,string道具ID
• 该方法的主要作用： 获取玩家手持道具
• 具体使用案例如下：

    local toolID = Player:GetCurToolID(Player:GetHostUin())

GetShotcutIndex

• 参数及类型：
  • objid:number玩家Uin
• 返回值及类型：
  • ret:number索引值
• 该方法的主要作用： 获取玩家当前选中快捷栏索引
• 具体使用案例如下：

    local index = Player:GetShotcutIndex(Player:GetHostUin())

SetShotcutIndex

• 参数及类型：
  • objid:number玩家Uin
  • index:number快捷栏索引（1~8）
• 返回值及类型：
  • ret:bool成功
• 该方法的主要作用： 设置玩家当前选中快捷栏索引
• 具体使用案例如下：

    local result = Player:SetShotcutIndex(Player:GetHostUin(), 2)

SetSkillCD

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

    local result = Player:SetSkillCD(Player:GetHostUin(), 12005, 10)

ReviveToPos

• 参数及类型：
  • objid:number玩家Uin
  • x,y,z:number方块坐标
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家在指定位置复活
• 具体使用案例如下：

    local result = Player:ReviveToPos(Player:GetHostUin(), x, y, z)

SetRevivePoint

• 参数及类型：
  • objid:number玩家Uin
  • x,y,z:number方块坐标
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 设置玩家复活点
• 具体使用案例如下：

    local result = Player:SetRevivePoint(Player:GetHostUin(), x, y, z)

NotifyGameInfo2Self

• 参数及类型：
  • objid:number玩家Uin
  • info:string文本内容
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 使玩家显示飘窗文字
• 具体使用案例如下：

    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)
• 该方法的主要作用： 玩家旋转摄像机角度
• 具体使用案例如下：

    local result = Player:RotateCamera(Player:GetHostUin(), 45, 0)

ShakeCamera

• 参数及类型：
  • objid:number玩家ID
  • power:number强度(取值范围1-1000)
  • duration:number持续时间
• 返回值及类型：
  • ret:boolean操作是否成功
• 该方法的主要作用： 抖动玩家镜头
• 具体使用案例如下：

    local result = Player:ShakeCamera(Player:GetHostUin(), 1, 20)

StopShakeCamera

• 参数及类型：
  • objid:number玩家ID
• 返回值及类型：
  • ret:boolean操作是否成功
• 该方法的主要作用： 停止抖动玩家镜头
• 具体使用案例如下：

    local result = Player:StopShakeCamera(Player:GetHostUin())

ChangeViewMode

• 参数及类型：
  • objid:number玩家Uin
  • viewmode:number视角枚举(ViewPortType)ViewPortType
  • islock:boolean是否锁定
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家改变视角
• 具体使用案例如下：

    local result = Player:ChangeViewMode(Player:GetHostUin(), ViewPortType.Main, false)

ChangeViewModeForMod

• 参数及类型：
  • objid:number玩家Uin
  • viewmode:number视角枚举(ViewPortType)ViewPortType
  • islock:boolean是否锁定
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家改变视角(支持冒险模式)
• 具体使用案例如下：

local ret = Player:ChangeViewModeForMod(objid, viewmode, islock)

IsEquipByResID

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

    local result = Player:IsEquipByResID(Player:GetHostUin(), 12202)

GetAimPos

• 参数及类型：
  • objid:number玩家Uin
• 返回值及类型： ret:x|y|z:number:坐标
• 该方法的主要作用： 获取玩家准心位置
• 具体使用案例如下：

    local x, y, z = Player:GetAimPos(Player:GetHostUin())

PlayMusic

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

    local result = Player:PlayMusic(Player:GetHostUin(), 10002, 100, 1, false)

StopMusic

• 参数及类型：
  • objid:number玩家Uin
  • musicId:string声音ID
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家停止播放背景音乐2D
• 具体使用案例如下：

    local result = Player:StopMusic(Player:GetHostUin(), 10002)

PauseMusic

• 参数及类型：
  • objid:number玩家Uin
  • musicId:string声音ID
  • pause:booltrue暂停/false恢复
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家暂停/恢复播放背景音乐
• 具体使用案例如下：

    local result = Player:PauseMusic(Player:GetHostUin(), 10002, true)

OpenUIView

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

    local result = Player:OpenUIView(Player:GetHostUin(), "7482986899365911542-22886")

HideUIView

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

    local result = Player:HideUIView(Player:GetHostUin(), "7482986899365911542-22886")

GetNickname

• 参数及类型：
  • objid:number玩家Uin
• 返回值及类型：
  • name:string玩家昵称
• 该方法的主要作用： 获取玩家昵称
• 具体使用案例如下：

local name = Player:GetNickname(objid)

GetPlayerCostStatic

• 参数及类型：
  • call_back:function内部回调(缺省参数)
  • playerid:number玩家Uin
  • tbegin:number开始时间
  • tend:number结束时间
  • costtype:number查询类型 MiniCurrencyMiniCurrency
• 返回值及类型：
  • icount:number消费数量(-1 请求失败)
• 该方法的主要作用： 获取玩家的消费统计（有5s冷却限制，触发冷却返回nil)
• 具体使用案例如下：

    -- 获取玩家24小时内消耗的迷你币

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

StandReportEvent

• 参数及类型：
  • playerid:number玩家Uin
  • eventstr:string事件名称
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家自定义数据上报埋点
• 具体使用案例如下：

    local result = Player:StandReportEvent(Player:GetHostUin(), "自动测试上报")

OpenShopTryOnView

• 参数及类型：
  • objid:number玩家Uin
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 打开商城试穿界面
• 具体使用案例如下：

    local result = Player:OpenShopTryOnView(Player:GetHostUin())

OpenShopSkinBuyDialog

• 参数及类型：
  • objid:number玩家Uin
  • objid:number玩家ID
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 打开商城皮肤购买界面(购买玩家对象同款皮肤)
• 具体使用案例如下：

    local result = Player:OpenShopSkinBuyDialog(Player:GetHostUin(), playerUin)

SetMobileVibrate

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

    local result = Player:SetMobileVibrate(Player:GetHostUin(), 1, 20)

OpenShopGiveGiftView

• 参数及类型：
  • playerid:number玩家Uin
  • giveuin:number被赠送的玩家UIN
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 打开商店赠送界面
• 具体使用案例如下：

    local result = Player:OpenShopGiveGiftView(Player:GetHostUin(), playerUin)

SendFriendApply

• 参数及类型：
  • playerid:number玩家Uin
  • uin2:number添加的好友
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 发送好友申请
• 具体使用案例如下：

    local result = Player:SendFriendApply(Player:GetHostUin(), friendUin)

SetCameraPosTransformTo

• 参数及类型：
  • playerid:number玩家Uin
  • vec:table位置坐标
  • animid:number线性变换枚举（Easing）Easing
  • time:number动画时间
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家摄像机变换到位置
• 具体使用案例如下：

    local result = Player:SetCameraPosTransformTo(Player:GetHostUin(), {x = 0, y = 100, z = 0}, Easing.ExpoIn, 0.2)

SetCameraPosTransformBy

• 参数及类型：
  • playerid:number玩家Uin
  • vec:table位置坐标(100=1方块)
  • animid:number线性变换枚举（Easing）Easing
  • time:number动画时间
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家摄像机变换相对位置
• 具体使用案例如下：

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

SetCameraRotTransformBy

• 参数及类型：
  • playerid:number玩家Uin
  • vec:table角度坐标
  • animid:number线性变换枚举（Easing）Easing
  • time:number动画时间
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家摄像机旋转相对角度
• 具体使用案例如下：

    -- 摄像机线性旋转，时间1秒

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

SetCameraFovTransformBy

• 参数及类型：
  • playerid:number玩家Uin
  • fov:numberfov值
  • animid:number线性变换枚举（Easing）Easing
  • time:number动画时间
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 玩家摄像机Fvo变换相对值
• 具体使用案例如下：

    local result = Player:SetCameraFovTransformBy(Player:GetHostUin(), 45, Easing.Linear, 1)

SetCameraAttrState

• 参数及类型：
  • playerid:number玩家Uin
  • attr:number摄像机属性(CameraModel)CameraModel
• 返回值及类型：
  • enable:bool开关(true开启 false关闭)
• 该方法的主要作用： 设置玩家的摄像机设置开关
• 具体使用案例如下：

    local result = Player:SetCameraAttrState(Player:GetHostUin(), CameraModel.MoveFollow, true)

SetCameraRotMode

• 参数及类型：
  • playerid:number玩家Uin
  • attr:number摄像机旋转模式(CameaRotate)aRotate
• 返回值及类型：
  • code:bool成功(true)
• 该方法的主要作用： 设置玩家的摄像机旋转模式
• 具体使用案例如下：

    local result = Player:SetCameraRotMode(Player:GetHostUin(), CameraRotate.AllDir)

SetCameraMountObj

• 参数及类型：
  • playerid:number玩家Uin
  • objid:number挂载对象ID
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 设置玩家的摄像机挂载到对象
• 具体使用案例如下：

    local result = Player:SetCameraMountObj(Player:GetHostUin(), playerUin)

SetCameraMountPos

• 参数及类型：
  • playerid:number玩家Uin
  • pos:table挂载位置坐标
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 设置玩家的摄像机挂载到位置
• 具体使用案例如下：

    local result = Player:SetCameraMountPos(Player:GetHostUin(), {x = x, y = y, z = z})

ResetCameraAttr

• 参数及类型：
  • playerid:number玩家Uin
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 重置玩家摄像机
• 具体使用案例如下：

    local result = Player:ResetCameraAttr(Player:GetHostUin())

OpenBoxByPos

• 参数及类型：
  • objid:number玩家Uin
  • x,y,z:number方块坐标
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 打开可以操作的箱子
• 具体使用案例如下：

    local result = Player:OpenBoxByPos(Player:GetHostUin(), x, y, z)

GetFirstInviter

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

    local inviterUin = Player:GetFirstInviter(Player:GetHostUin())

HasFriend

• 参数及类型：
  • playerid:number玩家Uin
  • playerid2:number玩家Uin2
• 返回值及类型：
  • code:bool是否是好友
• 该方法的主要作用： 判断两个玩家是否是好友(阻塞接口)
• 具体使用案例如下：

    local result = Player:HasFriend(Player:GetHostUin(), "123456")

GetMiniVipLevel

• 参数及类型：
  • playerid:number玩家Uin
• 返回值及类型：
  • viplevel:numbervip等级
• 该方法的主要作用： 获取玩家VIP等级
• 具体使用案例如下：

    local level = Player:GetMiniVipLevel(Player:GetHostUin())

SetCrawl

• 参数及类型：
  • playerid:number玩家Uin
  • bCrawl:bool爬行状态
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 设置玩家的爬行状态
• 具体使用案例如下：

local ret = Player:SetCrawl(playerid, bCrawl)

GunGetMagazine

• 参数及类型：
  • uin:number玩家Uin
• 返回值及类型：
  • ret:number弹药量
• 该方法的主要作用： 当前枪里的弹药量
• 具体使用案例如下：

local ret = Player:GunGetMagazine(uin)

PlayAdvertisingCallback

• 参数及类型：
  • objid:number玩家ID
  • adname:string广告名称
  • callback:function更新回调(function(code/错误码ErrorCode，adname/广告名))ErrorCode
• 返回值及类型：
  • code:number成功(ErrorCode.OK)ErrorCode
• 该方法的主要作用： 玩家播放开发者广告（仅开发者可用）
• 具体使用案例如下：

local code = Player:PlayAdvertisingCallback(objid, adname, callback)

OpenInnerView

• 参数及类型：
  • uin:number玩家Uin
  • iview:number弹窗类型枚举(InnerPopUpview)InnerPopUpview
  • bopen:bool打开或者关闭
  • data:any根据前面枚举传参
• 返回值及类型： 无
• 该方法的主要作用： 玩家组显示游戏内弹窗
• 具体使用案例如下：

    local result = Player:OpenInnerView(Player:GetHostUin(), PlayerRelations.InviteFriend, true)

SetItemAttAction

• 参数及类型：
  • objid:number玩家ID
  • itemid:number,string道具ID
  • atttype:number掉落属性枚举 ItemAbilityItemAbility
  • switch:boolean是否打开
• 返回值及类型：
  • ret:bool成功(true)
• 该方法的主要作用： 设置玩家道具设置属性
• 具体使用案例如下：

    local result = Player:SetItemAttAction(Player:GetHostUin(), 10025, ItemAbility.Drop, true)

ForceOpenBoxUI

• 参数及类型：
  • objid:number玩家Uin
  • itemid:number 枚举WorkStageStage
• 返回值及类型：
  • code:bool成功(true)
• 该方法的主要作用： 玩家强制打开UI界面
• 具体使用案例如下：

    local result = Player:ForceOpenBoxUI(Player:GetHostUin(), WorkStage.Repair)

ItemSkillCDEnter

• 参数及类型：
  • objid:number玩家Uin
  • itemid:number/string道具ID
• 返回值及类型：
  • ret:boolean操作是否成功
• 该方法的主要作用： 设置道具技能进入冷却
• 具体使用案例如下：

    local result = Player:ItemSkillCDEnter(Player:GetHostUin(), 12005)

ItemSkillCDDone

• 参数及类型：
  • objid:number玩家Uin
  • itemid:number/string道具ID
• 返回值及类型：
  • ret:boolean操作是否成功
• 该方法的主要作用： 设置道具技能结束冷却
• 具体使用案例如下：

    local result = Player:ItemSkillCDDone(Player:GetHostUin(), 12005)

SetGunActionState

• 参数及类型：
  • objid:number玩家Uin
  • action:枪禁用状态枚举 GunActionBan
  • switch:boolean是否打开
• 返回值及类型：
  • ret:boolean操作是否成功
• 该方法的主要作用： 设置玩家枪械权限
• 具体使用案例如下：

    local result = Player:SetGunActionState(Player:GetHostUin(), GunActionBan.AimFire, true)