2025-03-23 18:51:55 +08:00
|
|
|
|
|
|
|
|
|
|
# 用户相关函数文档
|
|
|
|
|
|
|
|
|
|
|
|
## 一、获取当前区域
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetArea(b)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受一个布尔值参数`b`，返回一个整数，表示当前区域索引。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二、获取当前区域位置
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetAreaPos()`
|
|
|
|
|
|
|
|
|
|
|
|
该函数返回一个包含两个整数属性`X`和`Y`的对象，分别表示当前位置的横坐标和纵坐标。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三、获取朝向
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetDirections()`
|
|
|
|
|
|
|
|
|
|
|
|
此函数返回一个整数，表示朝向。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四、获取可见 values
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetVisibleValues()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示可见值。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五、获取当前城镇位置
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetLocation()`
|
|
|
|
|
|
|
|
|
|
|
|
该函数返回一个对象，包含`Pos`（对象，包含当前位置的横坐标和纵坐标）、`Town`（整数，表示城镇索引）、`Area`（整数，表示区域索引）。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 六、账号状态
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetState()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，代表账号状态（登录后大于等于 3）。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 七、角色数量
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCharacCount()`
|
|
|
|
|
|
|
|
|
|
|
|
此函数返回一个整数，表示角色数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 八、账号 ID
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetUID()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示账号 ID。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 九、唯一 ID
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetUniqueId()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示唯一 ID。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十、角色 ID
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCID()`
|
|
|
|
|
|
|
|
|
|
|
|
此函数返回一个整数，表示角色 ID。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十一、角色职业
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCharacJob()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示角色职业。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十二、角色名称
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCharacName()`
|
|
|
|
|
|
|
|
|
|
|
|
该函数返回一个字符串，表示角色名称。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十三、角色等级
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCharacLevel()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示角色等级。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十四、设置角色等级
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SetCharacLevel(new_level)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受一个整数参数`new_level`，表示新的角色等级，返回一个布尔值。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十五、角色转职职业
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCharacGrowType()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示角色转职职业。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十六、角色觉醒职业
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCharacSecondGrowType()`
|
|
|
|
|
|
|
|
|
|
|
|
该函数返回一个整数，表示角色觉醒职业。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十七、更改转职职业
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function ChangeGrowType(GrowType, IsAwa)`
|
|
|
|
|
|
|
|
|
|
|
|
接受两个参数，`GrowType`为整数，转职职业；`IsAwa`为布尔值，表示是否觉醒。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十八、已用疲劳值
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetFatigue()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示已用疲劳值。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 十九、最大疲劳值
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetMaxFatigue()`
|
|
|
|
|
|
|
|
|
|
|
|
此函数返回一个整数，表示最大疲劳值。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十、获取背包
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetInven()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示背包索引，若没有则返回 null。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十一、踢人
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function Kick(...)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受可变参数，参数包括`src`（整数，渠道，可选）、`p2`（整数，可选）、`p3`（整数，可选），返回一个整数，表示错误码？
|
|
|
|
|
|
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function DisConn(err)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个错误号参数`err`（可选），返回一个整数，表示踢人结果。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十二、当前小队/副本
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetParty()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个`CParty`对象，表示当前小队/副本，若没有则返回 null。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十三、是否在领主塔
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function CheckInBossTower()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个布尔值，表示是否在领主塔。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十四、是否在龙之路
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function CheckInBlueMarble()`
|
|
|
|
|
|
|
|
|
|
|
|
该函数返回一个布尔值，表示是否在龙之路。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十五、是否开启 GM 权限
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function IsGmMode()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个布尔值，表示是否开启 GM 权限。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十六、获取账号上次退出游戏的时间
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCurCharacLastPlayTick()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个时间戳，表示账号上次退出游戏的时间。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十七、获取账号本次登录游戏的时间
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCurCharacLoginTick()`
|
|
|
|
|
|
|
|
|
|
|
|
此函数返回一个时间戳，表示账号本次登录游戏的时间。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十八、获得公网地址
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetIpAddress()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示公网地址。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 二十九、发包
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function Send(SPacket)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受一个数据包对象`SPacket`作为参数。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十一、发送消息包
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendNotiPacket(Str, Type2, Type3)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受三个整数参数`Type1`、`Type2`、`Type3`。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十二、获取技能树
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetSkillW()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个技能树对象。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十三、重置技能树
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function InitSkillW(GrowType, IsAwa)`
|
|
|
|
|
|
|
|
|
|
|
|
接受两个参数，`GrowType`为整数，转职编号；`IsAwa`为布尔值，表示是否觉醒。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十四、发送公告消息
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendNotiPacketMessage(String, Type)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受两个参数，一个字符串`String`和一个整数`Type`。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十五、发送公告消息（带颜色）
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendNotiForColorPacketMessage(StringArr, Type)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个字符串数组`StringArr`和一个整数`Type`作为参数。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十六、发送公告消息（带颜色和 ID）
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendNotiForColorAIdPacketMessage(StringArr, Type)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个字符串数组`StringArr`和一个整数`Type`作为参数。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十七、调试信息包
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function Debug(Any)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个任意对象`Any`作为参数。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十八、发送道具
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GiveItem(ItemId, ItemCount)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受两个参数，一个整数`ItemId`表示道具 ID，一个整数`ItemCount`表示道具数量，返回一个数组，表示发送成功后的道具信息，若发送失败则返回 null。
|
|
|
|
|
|
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GiveItemEx(GiveTab)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个包含道具 ID 和数量的对象Map`GiveTab`作为参数。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 三十九、更新背包栏
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendItemSpace(ItemSpace)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个整数参数`ItemSpace`，表示背包栏索引。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十、更新道具信息
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendUpdateItemList(Type, ItemSpace, Slot)`
|
|
|
|
|
|
|
|
|
|
|
|
此函数接受三个参数，一个整数`Type`、一个整数`ItemSpace`表示背包栏索引、一个整数`Slot`表示道具槽位。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十一、发送系统邮件
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendMail(ItemList,...)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个道具列表`ItemList`和可变参数，可选参数包含邮件标题和正文等信息。
|
2025-11-20 16:31:34 +08:00
|
|
|
|
```
|
|
|
|
|
|
local emailItemTable = {};
|
|
|
|
|
|
#添加邮件物品
|
|
|
|
|
|
emailItemTable.rawset(3037, 10);
|
|
|
|
|
|
emailItemTable.rawset(3038, 10);
|
|
|
|
|
|
#发送
|
|
|
|
|
|
SUser.SendMail(emailItemTable, {
|
|
|
|
|
|
Title = "这是邮件标题",
|
|
|
|
|
|
Text = "这是邮件正文"
|
|
|
|
|
|
});
|
|
|
|
|
|
```
|
2025-03-23 18:51:55 +08:00
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十二、无条件完成指定任务并领取奖励
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function ClearQuest_Gm(QuestId)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个整数参数`QuestId`，表示任务 ID。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十三、充值点券
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function RechargeCera(Amount)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个整数参数`Amount`，表示点券数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十四、获取点券
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCera()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示点券数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十五、充值代币券
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function RechargeCeraPoint(Amount)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个整数参数`Amount`，表示代币券数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十六、获取代币券
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCeraPoint()`
|
|
|
|
|
|
|
|
|
|
|
|
此函数返回一个整数，表示代币券数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十七、充值金币
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function RechargeMoney(Amount)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个整数参数`Amount`，表示金币数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十八、充值胜点
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function RechargeWinPoint(Amount)`
|
|
|
|
|
|
|
|
|
|
|
|
接受一个整数参数`Amount`，表示胜点数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四十九、获取胜点
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetWinPoint()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个整数，表示胜点数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五十、获取复活币
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetCoin()`
|
|
|
|
|
|
|
|
|
|
|
|
此函数返回一个整数，表示复活币数量。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五十一、离开队伍
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function LeaveParty()`
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五十二、放弃副本
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GiveupDgn()`
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五十三、设置玩家坐标
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SetPosition(Xpos, Ypos, Direction)`
|
|
|
|
|
|
|
|
|
|
|
|
接受三个参数，一个整数`Xpos`表示横坐标，一个整数`Ypos`表示纵坐标，一个整数`Direction`表示方向。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五十四、获取玩家任务信息
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetQuest()`
|
|
|
|
|
|
|
|
|
|
|
|
返回一个任务信息对象。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五十四、发送弹窗公告包(可自定义文字需要客户端修复233dll搭配)
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function SendNotiBox(Msg, Type)`
|
|
|
|
|
|
|
|
|
|
|
|
接受三个参数，一个字符串`Msg`公告文本，一个整数`Type`表示类型 0全体 1自己 2队伍。
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 五十四、获取公会名称
|
|
|
|
|
|
### 函数签名
|
|
|
|
|
|
- `function GetGuildName()`
|
|
|
|
|
|
### 返回值
|
|
|
|
|
|
- 如果公会的名称。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
