玩家模块管理接口 `Player`

具体函数名及描述如下:

序号	函数名	函数描述
1	GetHostUin(...)	获取房主Uin
2	SetGameResults(...)	设置对局结果
3	SetGameWin(...)	设置玩家胜利
4	GetCurToolID(...)	获取手持道具ID
5	GetShotcutIndex(...)	获取当前快捷栏索引（索引从1开始）
6	SetShotcutIndex(...)	设置当前快捷栏索引
7	SetSkillCD(...)	设置技能CD
8	ReviveToPos(...)	玩家在指定位置复活
9	SetRevivePoint(...)	设置玩家复活点
10	NotifyGameInfo2Self(...)	显示飘窗文字
11	KickPlayer(...)	移除玩家
12	RotateCamera(...)	旋转摄像机角度
13	ShakeCamera(...)	抖动镜头
14	StopShakeCamera(...)	停止抖动镜头
15	RotateCameraToActor(...)	旋转摄像机朝向目标
16	ChangeViewMode(...)	切换视角模式
17	IsEquipByResID(...)	是否装备指定装备
18	IsHandWeaponSpellEnhancementActive(...)	手持武器铭刻法术强化方向激活状态
19	GetAimPos(...)	获取准心位置
20	GetAimDir(...)	获取准心方向
21	GetRayOriginPos(...)	获取射线起点位置
22	PlayMusic(...)	播放背景音乐2D
23	StopMusic(...)	停止背景音乐2D
24	PauseMusic(...)	暂停/恢复背景音乐
25	OpenUIView(...)	打开UI界面
26	HideUIView(...)	隐藏UI界面
27	GetClientInfo(...)	获取客机类型
28	GetNickname(...)	获取玩家昵称
29	OpenDevGoodsBuyDialog(...)	打开开发者商品购买弹框
30	OpenDevGoodsBuyDetailedDialog(...)	打开开发者商品详情页
31	OpenDevStore(...)	打开开发者商店
32	OpenDevStoreTab(...)	打开开发者商店二级分类
33	OpenDevGoodsPage(...)	打开开发者商店一级页面
34	GetMiniCurrency(...)	获取迷你币数量
35	GetPlayerCostStatic(...)	获取玩家消费统计
36	StandReportEvent(...)	上报埋点事件
37	ClearMotion(...)	清空运动趋势
38	SetMobileVibrate(...)	手机震动
39	GetScreenSpacePos(...)	获取屏幕坐标
40	GetScreenSpacePosV2(...)	获取屏幕坐标V2
41	SendFriendApply(...)	发送好友申请
42	SetCameraPosTransformTo(...)	摄像机移动到位置
43	SetCameraRotTransformTo(...)	摄像机旋转到角度
44	SetCameraFovTransformTo(...)	摄像机FOV到值
45	SetCameraPosTransformBy(...)	摄像机按偏移移动
46	SetCameraRotTransformBy(...)	摄像机相对旋转
47	SetCameraFovTransformBy(...)	摄像机按偏移调整视野
48	SetCameraAttrState(...)	设置摄像机属性开关
49	SetCameraRotMode(...)	设置摄像机旋转模式
50	SetCameraMountObj(...)	摄像机挂载对象
51	SetCameraMountPos(...)	摄像机挂载位置
52	ResetCameraAttr(...)	重置摄像机
53	OpenBoxByPos(...)	打开箱子
54	GetFirstInviter(...)	获取首次邀请人
55	HasFriend(...)	是否好友
56	GetMiniVipLevel(...)	获取VIP等级
57	ChangPlayerMoveType(...)	切换移动方式
58	GunGetMagazine(...)	获取弹匣子弹数
59	PlayAdvertising(...)	播放广告
60	OpenInnerView(...)	打开/关闭游戏内弹窗
61	SetItemAttAction(...)	设置道具能力开关
62	ForceOpenBoxUI(...)	强制打开箱子UI
63	ItemSkillCDEnter(...)	道具技能进入冷却
64	ItemSkillCDDone(...)	道具技能结束冷却
65	SetGunActionState(...)	设置枪械动作开关
66	GetViewMode(...)	获取视角模式
67	GetRevivePoint(...)	获取复活点
68	GetRentCloudServerOwner(...)	获取云房间房主
69	RemovePlayer(...)	将玩家移出本局
70	GetFriendList(...)	获取好友列表
71	SetSettingEnable(...)	设置游戏开关
72	SetSettingAbility(...)	设置游戏设置权限
73	RotateMainModel(...)	旋转玩家模型
74	EnterGunState(...)	进入枪械状态
75	LevelGunState(...)	离开枪械状态

GetHostUin

参数及类型：无
返回值及类型：
- ret:number / nil 玩家Uin
该方法的其他说明：获取房主Uin（云服/房间服环境优先走房主Uin）
具体使用案例如下：

lua

    local uin = Player:GetHostUin()

SetGameResults

参数及类型：
- objid:number 玩家Uin
- result:number 游戏结果（TeamResults）TeamResults
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置玩家的对局结果
具体使用案例如下：

lua

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

SetGameWin

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：结束游戏并将指定玩家设为胜者（会触发游戏结算）
具体使用案例如下：

lua

    local result = Player:SetGameWin(playerId)

GetCurToolID

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- ret:number / string / nil 道具ID
该方法的其他说明：获取玩家当前手持道具ID
具体使用案例如下：

lua

    local toolID = Player:GetCurToolID(playerId)

GetShotcutIndex

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- ret:number / nil 索引值
该方法的其他说明：获取玩家当前选中快捷栏索引（索引从1开始）
具体使用案例如下：

lua

    local index = Player:GetShotcutIndex(playerId)

SetShotcutIndex

参数及类型：
- objid:number 玩家Uin
- index:number 快捷栏索引（1~8）
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置玩家当前选中快捷栏索引（1~8）
具体使用案例如下：

lua

    local result = Player:SetShotcutIndex(playerId, 2)

SetSkillCD

参数及类型：
- objid:number 玩家Uin
- itemid:number / string 道具类型或资源id
- cd:number 冷却时间
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置道具技能冷却时间
具体使用案例如下：

lua

    local result1 = Player:SetSkillCD(playerId, 12005, 10)

ReviveToPos

参数及类型：
- objid:number 玩家Uin
- x:number / table 方块坐标x或坐标表{x=方块坐标x,y=方块坐标y,z=方块坐标z,worldId=星球ID}
- y:number / nil 方块坐标y
- z:number / nil 方块坐标z
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：使玩家在指定方块坐标位置复活（支持传入坐标表）
具体使用案例如下：

lua

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

SetRevivePoint

参数及类型：
- objid:number 玩家Uin
- x:number / table 方块坐标x或坐标表{x=方块坐标x,y=方块坐标y,z=方块坐标z,worldId=星球ID}
- y:number / nil 方块坐标y
- z:number / nil 方块坐标z
- worldId:number / nil 星球ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置玩家复活点（方块坐标）
具体使用案例如下：

lua

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

NotifyGameInfo2Self

参数及类型：
- objid:number 玩家Uin
- info:string 文本内容
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：对玩家显示飘窗文字
具体使用案例如下：

lua

    local result = Player:NotifyGameInfo2Self(playerId, "飘窗提示")

KickPlayer

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的主要作用：移除玩家
具体使用案例如下：

lua

    --会真实剔除玩家,断开连接

    local result = Player:KickPlayer(playerId)

RotateCamera

参数及类型：
- objid:number 玩家Uin
- yaw:number 视角偏航角
- pitch:number 视角俯仰角
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：旋转玩家摄像机角度（支持平滑/修正Yaw）
具体使用案例如下：

lua

    local result = Player:RotateCamera(playerId, 45, 45)

ShakeCamera

参数及类型：
- objid:number 玩家Uin
- duration:number 持续时间
- power:number 强度（1~1000）
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：抖动玩家镜头
具体使用案例如下：

lua

    local result1 = Player:ShakeCamera(playerId, 1, 20)

StopShakeCamera

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：停止抖动玩家镜头
具体使用案例如下：

lua

    local result2 = Player:StopShakeCamera(playerId)

RotateCameraToActor

参数及类型：
- objid:number 玩家Uin
- targetid:number 目标对象objid
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：将玩家摄像机朝向指定目标对象
具体使用案例如下：

lua

    local result = Player:RotateCameraToActor(playerId, objId)

ChangeViewMode

参数及类型：
- objid:number 玩家Uin
- viewmode:number 视角枚举(ViewPortType)ViewPortType
- islock:bool是否锁定
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：切换玩家视角模式
具体使用案例如下：

lua

    local view = ViewPortType.Back -- 背视角

    local result = Player:ChangeViewMode(playerId, view, false)

IsEquipByResID

参数及类型：
- objid:number 玩家Uin
- itemid:number / string 道具类型或资源id
返回值及类型：
- ret:boolean 是否已装备
该方法的其他说明：判断玩家是否装备了指定装备（支持资源id或道具类型）
具体使用案例如下：

lua

    local result = Player:IsEquipByResID(playerId, 12202)

IsHandWeaponSpellEnhancementActive

参数及类型：
- uin:number 玩家Uin
- enhanceIndex:number 强化方向索引(1-8)
返回值及类型：
- ret:boolean 是否激活
该方法的其他说明：判断玩家当前手持武器的铭刻法术强化方向是否激活
具体使用案例如下：

lua

    local Spellix = 1 -- 强化方向索引

    local spellEnhanced = Player:IsHandWeaponSpellEnhancementActive(playerId, Spellix)

GetAimPos

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- x:number / nil 坐标x
- y:number / nil 坐标y
- z:number / nil 坐标z
该方法的其他说明：获取玩家准心射线命中点位置
具体使用案例如下：

lua

    local aimX, aimY, aimZ = Player:GetAimPos(playerId)

GetAimDir

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- dir:table / nil 单位方向向量{x=单位方向x,y=单位方向y,z=单位方向z}
该方法的其他说明：获取玩家准心方向单位向量
具体使用案例如下：

lua

    local result = Player:GetAimDir(playerId)

GetRayOriginPos

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- x:number / nil 坐标x
- y:number / nil 坐标y
- z:number / nil 坐标z
该方法的其他说明：获取玩家射线检测起点位置
具体使用案例如下：

lua

    local result = Player:GetRayOriginPos(playerId)

PlayMusic

参数及类型：
- objid:number 玩家Uin
- musicId:string 声音ID
- volume:number 音量
- pitch:number 音调
- isLoop:bool是否循环
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：对玩家播放2D背景音乐
具体使用案例如下：

lua

    local result = Player:PlayMusic(playerId, 10002, 100, 1, true)

StopMusic

参数及类型：
- objid:number 玩家Uin
- musicId:string 声音ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：停止玩家播放的2D背景音乐
具体使用案例如下：

lua

    local result3 = Player:StopMusic(playerId, 10002)

PauseMusic

参数及类型：
- objid:number 玩家Uin
- musicId:string 声音ID
- pause:booltrue暂停/false恢复
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：暂停或恢复玩家播放的背景音乐
具体使用案例如下：

lua

    local result2 = Player:PauseMusic(playerId, 10002, true)

OpenUIView

参数及类型：
- objid:number 玩家Uin
- uiname:number 自定义UIID
- effectid:number / nil 动作ID(可缺省)
- time:number / nil 动画时间(可缺省)
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：打开一个自定义UI界面（可选播放动作与动画时间）
具体使用案例如下：

lua

    local openResult = Player:OpenUIView(playerId, "7482986899365911542-22886")

HideUIView

参数及类型：
- objid:number 玩家Uin
- uiname:number 自定义UIID
- effectid:number / nil 动作ID(可缺省)
- time:number / nil 动画时间(可缺省)
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：隐藏一个自定义UI界面（可选播放动作与动画时间）
具体使用案例如下：

lua

    local hideResult = Player:HideUIView(playerId, "7482986899365911542-22886")

GetClientInfo

参数及类型：
- uin:number / nil 玩家Uin（兼容参数，当前未使用）
返回值及类型：
- ret:number 设备类型（DeviceType：1 PC 2 Android 3 iOS）
该方法的其他说明：获取当前客户端设备类型
具体使用案例如下：

lua

    local result = Player:GetClientInfo(playerId)

GetNickname

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- name:string / nil 玩家昵称
该方法的其他说明：获取玩家昵称
具体使用案例如下：

lua

    local result = Player:GetNickname(playerId)

OpenDevGoodsBuyDialog

参数及类型：
- objid:number 玩家Uin
- devGoodsId:number 商品ID
- customDesc:string 自定义商品描述
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：打开开发者商店商品购买弹框（开发者账号和自定义按钮点击事件可用）
具体使用案例如下：

lua

    local itemid = "r2_7485931052202679286_22924" --自定义道具

    local result = Player:OpenDevGoodsBuyDialog(playerId, itemid, "自动测试商品")

OpenDevGoodsBuyDetailedDialog

参数及类型：
- objid:number 玩家Uin
- devGoodsId:number 商品ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：打开开发者商店商品详情页（仅开发者可用）
具体使用案例如下：

lua

    local itemid = "r2_7485931052202679286_22924" --自定义道具

    local result = Player:OpenDevGoodsBuyDetailedDialog(playerId, itemid)

OpenDevStore

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：打开开发者商店（仅开发者可用）
具体使用案例如下：

lua

    local result = Player:OpenDevStore(playerId)

OpenDevStoreTab

参数及类型：
- objid:number 玩家Uin
- page:string 分类页码
- name:string 分类名称
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：打开开发者商品二级分类页（仅开发者可用）
具体使用案例如下：

lua

    local page =  "1#1|1" --二级分类全部

    local result = Player:OpenDevStoreTab(playerId, page, "test")

OpenDevGoodsPage

参数及类型：
- playerid:number 玩家Uin
- pagetype:number 页面枚举值(MiniShopPage)MiniShopPage
- pagetitle:string 页面标题
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：打开开发者商店页一级页面（仅开发者可用）
具体使用案例如下：

lua

    local page = MiniShopPage.Skin

    local result = Player:OpenDevGoodsPage(playerId, page, "自动测试")

GetMiniCurrency

参数及类型：
- objid:number 玩家Uin
- itype:number 币种类型(MiniCurrency)MiniCurrency
返回值及类型：
- num:number 数量
该方法的其他说明：获取本地玩家迷你币数量(阻塞等待函数)
具体使用案例如下：

lua

    local result = Player:GetMiniCurrency(playerId, MiniCurrency.MiniCoin)

GetPlayerCostStatic

参数及类型：
- playerid:number 玩家Uin
- tbegin:number 开始时间
- tend:number 结束时间
- costtype:number 查询类型（MiniCurrency）MiniCurrency
返回值及类型：
- icount:number 消费数量（-1表示失败）
该方法的其他说明：获取玩家消费统计（有5s冷却限制，频繁调用可能失败）
具体使用案例如下：

lua

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

StandReportEvent

参数及类型：
- playerid:number 玩家Uin
- eventstr:string 事件名称
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：上报玩家自定义埋点事件
具体使用案例如下：

lua

    playerId = Player:GetHostUin()

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

ClearMotion

参数及类型：
- uin:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：清空玩家运动趋势（配合“禁止移动”使用）
具体使用案例如下：

lua

    local result = Player:ClearMotion(playerId)

SetMobileVibrate

参数及类型：
- playerid:number 玩家Uin
- time:number 震动时长(ms)
- amplitude:number 震动强度(1~255)
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：触发玩家手机震动
具体使用案例如下：

lua

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

GetScreenSpacePos

参数及类型：
- playerid:number 玩家Uin
- x:number 坐标x(cm)
- y:number 坐标y(cm)
- z:number 坐标z(cm)
返回值及类型： retX:number:x坐标 retY:number:y坐标
该方法的其他说明：根据玩家Uin与3D坐标计算屏幕2D坐标（需要注意这里的X、Y、Z需要将方块坐标*100后来使用，例如原方块坐标为（1 ，7 ，1），则需要传入（100，700，100），之后版本会新增接口替代该接口。）
具体使用案例如下：

lua

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

    -- 旧接口使用厘米坐标；GetAimPos 返回方块坐标。

    local worldX, worldY, worldZ = x and x * 100, y and y * 100, z and z * 100

    local screenX, screenY = Player:GetScreenSpacePos(playerId, worldX, worldY, worldZ)

GetScreenSpacePosV2

参数及类型：
- playerid:number 玩家Uin
- x:number 方块坐标x
- y:number 方块坐标y
- z:number 方块坐标z
返回值及类型： retX:number:x坐标 retY:number:y坐标
该方法的其他说明：根据玩家Uin与方块坐标计算屏幕2D坐标（不能高频调用）
具体使用案例如下：

lua

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

    local screenX, screenY = Player:GetScreenSpacePosV2(playerId, x, y, z)

SendFriendApply

参数及类型：
- playerid:number 玩家Uin
- uin2:number 目标玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：向指定玩家发送好友申请
具体使用案例如下：

lua

    local result = Player:SendFriendApply(playerId, playerId)

SetCameraPosTransformTo

参数及类型：
- playerid:number 玩家Uin
- vec:table 位置坐标（单位：方块）
- animid:number 缓动枚举(Easing)Easing
- time:number 动画时长
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：让玩家摄像机插值移动到指定位置
具体使用案例如下：

lua

    local result = Player:SetCameraPosTransformTo(playerId, {x = x, y = y, z = z}, Easing.Linear, 1)

SetCameraRotTransformTo

参数及类型：
- playerid:number 玩家Uin
- vec:table 角度坐标
- animid:number 缓动枚举(Easing)Easing
- time:number 动画时长
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：让玩家摄像机插值旋转到指定角度
具体使用案例如下：

lua

    local result = Player:SetCameraRotTransformTo(playerId, {x = 0, y = 90, z = 0}, Easing.Linear, 1)

SetCameraFovTransformTo

参数及类型：
- playerid:number 玩家Uin
- fov:number FOV值
- animid:number 缓动枚举(Easing)Easing
- time:number 动画时长
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：让玩家摄像机插值调整到指定FOV
具体使用案例如下：

lua

    local result = Player:SetCameraFovTransformTo(playerId, 60, Easing.Linear, 1)

SetCameraPosTransformBy

参数及类型：
- playerid:number 玩家Uin
- vec:table 相对当前位置的偏移量
- animid:number 缓动枚举(Easing)Easing
- time:number 动画时长
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：在当前相机位置基础上再移动一段距离，镜头会平滑跟过去；传入的是相对偏移，不是地图上的目标点坐标。
具体使用案例如下：

lua

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

SetCameraRotTransformBy

参数及类型：
- playerid:number 玩家Uin
- vec:table 相对角度
- animid:number 缓动枚举(Easing)Easing
- time:number 动画时长
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：让玩家摄像机按相对角度进行插值旋转
具体使用案例如下：

lua

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

SetCameraFovTransformBy

参数及类型：
- playerid:number 玩家Uin
- fov:number 相对当前FOV的增减量（非目标FOV）
- animid:number 缓动枚举(Easing)Easing
- time:number 动画时长
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：在当前视野（FOV）基础上再增减一段，平滑过渡；传入的是相对变化量，不是要设成的最终FOV。
具体使用案例如下：

lua

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

SetCameraAttrState

参数及类型：
- playerid:number 玩家Uin
- attr:number 摄像机属性(CameraModel)CameraModel
- enable:bool是否启用
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置玩家摄像机属性开关
具体使用案例如下：

lua

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

SetCameraRotMode

参数及类型：
- playerid:number 玩家Uin
- attr:number 摄像机旋转模式(CameraRotate)CameraRotate
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置玩家摄像机旋转模式
具体使用案例如下：

lua

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

SetCameraMountObj

参数及类型：
- playerid:number 玩家Uin
- objid:number 挂载对象ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：将玩家摄像机挂载到指定对象
具体使用案例如下：

lua

    local result = Player:SetCameraMountObj(playerId, playerId)

SetCameraMountPos

参数及类型：
- playerid:number 玩家Uin
- pos:table 挂载位置坐标
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：将玩家摄像机挂载到指定位置
具体使用案例如下：

lua

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

ResetCameraAttr

参数及类型：
- playerid:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：重置玩家摄像机到默认状态
具体使用案例如下：

lua

    local result = Player:ResetCameraAttr(playerId)

OpenBoxByPos

参数及类型：
- objid:number 玩家Uin
- x:number / table 方块x坐标或坐标table
- y:number / nil 方块y坐标
- z:number / nil 方块z坐标
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：打开指定坐标处的箱子
具体使用案例如下：

lua

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

GetFirstInviter

参数及类型：
- objid:number 被邀请玩家Uin
返回值及类型：
- uin:number / nil 邀请人玩家Uin（失败时回调错误码number）
该方法的其他说明：获取玩家首次邀请人（阻塞接口，触发请求间隔10s）
具体使用案例如下：

lua

    local inviterUin = Player:GetFirstInviter(playerId)

HasFriend

参数及类型：
- playerid:number 玩家Uin
- friendid:number 目标玩家Uin
返回值及类型：
- ret:boolean 是否成功上报
该方法的其他说明：判断目标玩家是否为好友(阻塞接口)
具体使用案例如下：

lua

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

GetMiniVipLevel

参数及类型：
- playerid:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功上报
该方法的其他说明：获取玩家VIP等级
具体使用案例如下：

lua

    local level = Player:GetMiniVipLevel(playerId)

ChangPlayerMoveType

参数及类型：
- uin:number 玩家Uin
- moveType:number 移动方式枚举(MoveType)MoveType
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：改变玩家移动方式
具体使用案例如下：

lua

    local result = Player:ChangPlayerMoveType(playerId, MoveType.Flying)

GunGetMagazine

参数及类型：
- uin:number 玩家Uin
返回值及类型：
- ret:number 子弹数
该方法的其他说明：获取当前武器弹匣内剩余子弹数
具体使用案例如下：

lua

    local result = Player:GunGetMagazine(playerId)

PlayAdvertising

参数及类型：
- objid:number 玩家Uin
- adname:string 广告名称
返回值及类型：
- code:number 执行结果(ErrorCode)ErrorCode
- objid:number 玩家Uin
- adname:string 广告名称
该方法的其他说明：触发器播放广告接口
具体使用案例如下：

lua

    local code, uin, adname = Player:PlayAdvertising(playerId, '测试广告')

    if code == ErrorCode.OK then

        print("广告播放成功")

    else

        print("广告播放失败")

    end

OpenInnerView

参数及类型：
- uin:number 玩家Uin
- iview:number 弹窗类型枚举(InnerPopUpview)InnerPopUpview
- bopen:bool是否打开
- data:any / nil 弹窗附加数据（如储物箱需传入位置）
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：控制玩家侧游戏内弹窗显示与隐藏
具体使用案例如下：

lua

    local result = Player:OpenInnerView(playerId, InnerPopUpview.InviteFriend, true)

SetItemAttAction

参数及类型：
- objid:number 玩家Uin
- itemid:number / string 道具ID或资源ID
- atttype:number 能力枚举(ItemAbility)ItemAbility
- switch:bool是否开启
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：设置玩家道具能力开关（如是否可掉落，是否可丢弃）
具体使用案例如下：

lua

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

ForceOpenBoxUI

参数及类型：
- objid:number 玩家Uin
- itemid:number 枚举(WorkStage)Stage
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：强制打开指定箱子/工作台UI
具体使用案例如下：

lua

    local result = Player:ForceOpenBoxUI(playerId, WorkStage.Craft)

ItemSkillCDEnter

参数及类型：
- objid:number 玩家Uin
- itemid:number / string 道具ID或资源ID
- cd:number / nil 冷却时长
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：让指定道具技能进入冷却（可指定CD时长）
具体使用案例如下：

lua

    local result2 = Player:ItemSkillCDEnter(playerId, 12005)

ItemSkillCDDone

参数及类型：
- objid:number 玩家Uin
- itemid:number / string 道具ID或资源ID
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：结束指定道具技能冷却
具体使用案例如下：

lua

    local result4 = Player:ItemSkillCDDone(playerId, 12005)

SetGunActionState

参数及类型：
- objid:number 玩家Uin
- action:number 枪械动作枚举(GunActionBan)GunActionBan
- switch:bool是否开启
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：开关玩家枪械相关能力（开火、开镜等，具体项见枚举 GunActionBan）
具体使用案例如下：

lua

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

GetViewMode

参数及类型：
- uin:number 玩家Uin
返回值及类型：
- ret:number / nil 视角模式(ViewPortType)
该方法的其他说明：查询玩家当前视角模式
具体使用案例如下：

lua

    local viewMode = Player:GetViewMode(playerId)

GetRevivePoint

参数及类型：
- uin:number 玩家Uin
- worldId:number / nil 星球ID
返回值及类型：
- x:number / nil 方块x
- y:number / nil 方块y
- z:number / nil 方块z
- worldId:number / nil 复活点所在星球ID
该方法的其他说明：获取玩家复活点的方块坐标
具体使用案例如下：

lua

    local reviveX, reviveY, reviveZ,worldId = Player:GetRevivePoint(playerId)

GetRentCloudServerOwner

参数及类型：无
返回值及类型：
- uin:number / nil 房主玩家Uin
该方法的其他说明：在租赁云房间中取当前房间房主是谁（仅租赁云服生效）
具体使用案例如下：

lua

        local result = Player:GetRentCloudServerOwner()

RemovePlayer

参数及类型：
- objid:number 玩家Uin
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：让玩家输掉本局并离开当前对局。
具体使用案例如下：

lua

    local result = Player:RemovePlayer(-1)

GetFriendList

参数及类型：
- uin:number 玩家Uin
- index:number 起始索引
- size:number 获取数量
返回值及类型：
- totalnum:number 好友总人数
- friendlist:table 好友列表{..,{name = string,uin = number,headframe = string,live = bool},...},...}
该方法的其他说明：分页取好友，把总人数和这一页好友信息回给主机。
具体使用案例如下：

lua

    local maxnum, infos = Player:GetFriendList(playerId, 1, 20)

    print("好友最大好友数量",maxnum)

    print("好友信息列表",infos)

    if infos then

        for i = 1, #infos, 1 do

            print("好友昵称",infos[i].name)

            print("好友UIn",infos[i].uin)

            print("好友头像",infos[i].headframe)

            print("是否在线",infos[i].live)

        end

    end

SetSettingEnable

参数及类型：
- playerid:number 玩家Uin
- itype:number 设置项(GameSetting)GameSetting
- enable:bool是否开启
返回值及类型：
- ret:boolean 是否生效
该方法的其他说明：改游戏里某项开关（如开镜、镜头抖、自动跳等），并立刻生效到当前局。
具体使用案例如下：

lua

    local result = Player:SetSettingEnable(playerId, GameSetting.CameraShake, false)

SetSettingAbility

参数及类型：
- playerid:number 玩家Uin
- itype:number 设置项(GameSetting)GameSetting
- enable:bool是否允许修改
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：允许或禁止玩家在设置界面里改某一项。
具体使用案例如下：

lua

    local result = Player:SetSettingAbility(playerId, GameSetting.CameraShake, false)

RotateMainModel

参数及类型：
- uin:number 玩家Uin
- yaw:number 水平角
- pitch:number 俯仰角
返回值及类型：
- ret:boolean 是否成功
该方法的其他说明：转动本机玩家模型的朝向，角度会自动限制在合法范围。
具体使用案例如下：

lua

    local yaw = 90  -- 限制范围0~360

    local pitch = 15  -- 限制范围-88 ~ 88  

    local result = Player:RotateMainModel(playerId, yaw, pitch)

EnterGunState

参数及类型：
- objid:number 玩家Uin
- state:number 枪械状态(GunActionState)GunActionState
返回值及类型：
- bool:boolean 是否设置成功
该方法的主要作用：进入枪械状态
具体使用案例如下：

lua

    local result = Player:EnterGunState(playerId, GunActionState.Fire)

LevelGunState

参数及类型：
- objid:number 玩家Uin
- state:number 枪械状态(GunActionState)GunActionState
返回值及类型：
- bool:boolean 是否设置成功
该方法的主要作用：离开枪械状态
具体使用案例如下：

lua

    local result = Player:LevelGunState(playerId, GunActionState.Fire)

玩家模块管理接口 Player ​

GetHostUin ​

SetGameResults ​

SetGameWin ​

GetCurToolID ​

GetShotcutIndex ​

SetShotcutIndex ​

SetSkillCD ​

ReviveToPos ​

SetRevivePoint ​

NotifyGameInfo2Self ​

KickPlayer ​

RotateCamera ​

ShakeCamera ​

StopShakeCamera ​

RotateCameraToActor ​

ChangeViewMode ​

IsEquipByResID ​

IsHandWeaponSpellEnhancementActive ​

GetAimPos ​

GetAimDir ​

GetRayOriginPos ​

PlayMusic ​

StopMusic ​

PauseMusic ​

OpenUIView ​

HideUIView ​

GetClientInfo ​

GetNickname ​

OpenDevGoodsBuyDialog ​

OpenDevGoodsBuyDetailedDialog ​

OpenDevStore ​

OpenDevStoreTab ​

OpenDevGoodsPage ​

GetMiniCurrency ​

GetPlayerCostStatic ​

StandReportEvent ​

ClearMotion ​

SetMobileVibrate ​

GetScreenSpacePos ​

GetScreenSpacePosV2 ​

SendFriendApply ​

SetCameraPosTransformTo ​

SetCameraRotTransformTo ​

SetCameraFovTransformTo ​

SetCameraPosTransformBy ​

SetCameraRotTransformBy ​

SetCameraFovTransformBy ​

SetCameraAttrState ​

SetCameraRotMode ​

SetCameraMountObj ​

SetCameraMountPos ​

ResetCameraAttr ​

OpenBoxByPos ​

GetFirstInviter ​

HasFriend ​

GetMiniVipLevel ​

ChangPlayerMoveType ​

GunGetMagazine ​

PlayAdvertising ​

OpenInnerView ​

SetItemAttAction ​

ForceOpenBoxUI ​

ItemSkillCDEnter ​

ItemSkillCDDone ​

SetGunActionState ​

GetViewMode ​

GetRevivePoint ​

GetRentCloudServerOwner ​

RemovePlayer ​

GetFriendList ​

SetSettingEnable ​

SetSettingAbility ​

RotateMainModel ​

EnterGunState ​

LevelGunState ​