README

创建 SOAP 账户

为了能够使用库，您首先必须创建一个专门的 SOAP 账户。
要执行此操作，请在您的世界服务器控制台中执行以下命令
accont create 2#1 accountPassword
其中

2#1 - 账户 ID，可以是任何数字，但建议使用下一个 可用的 ID
accountPassword - 您的 SOAP 账户的安全密码

完成之后，我们需要授予账户权限，这可以通过以下命令完成
account set gmlevel 2#1 3 -1

初始化连接到 SOAP 服务

在创建 SOAP 账户后，我们可以继续初始化库的连接
$console = new \FreedomCore\TrinityCore\Console\Client('2#1', 'accountPassword');
这就完成了。现在您可以使用这个库了！

可用方法

控制台客户端当前实现具有以下 '端点'

account() - 允许您对特定账户执行各种操作
bnet() - 允许您管理相关的 battle.net 设置
character() - 允许您对特定设置执行各种操作
gm() - 允许您与 GM 进行交流
guild() - 允许您管理不同的公会特定设置
lfg() - 提供关于 LFG 系统的信息
reset() - 允许您重置角色的不同方面（或服务器上所有角色的所有方面）
server() - 允许您管理不同的服务器相关设置
send() - 允许您发送游戏内邮件

客户端选项

setAddress - 设置服务器地址
$console->setAddress(string $serverAddress);
getAddress - 获取服务器地址
$console->getAddress();
setPort - 设置服务器端口
$console->setPort(int $serverPort);
getPort - 获取服务器端口
$console->getPort();
getVersion - 获取客户端版本
$console->getVersion();
createConnection - 初始化与服务器连接（如果已更改地址/端口，则需要调用）
$console->createConnection();
getClient - 获取客户端实例
$console->getClient();

$console->account()

create() - 创建新账户
$result = $console->account()->create(string $account, string $password);
delete() - 删除指定的账户
$result = $console->account()->delete(string $account);
password() - 为账户设置新密码
$result = $console->account()->password(string $oldPassword, string $newPassword, string $repeatPassword);
setAddon() - 为指定账户设置扩展版本
$result = $console->account()->setAddon(string $account, int $addon);
setGmLevel() - 为账户设置游戏大师等级
$result = $console->account()->setGmLevel(string $account, int $level, int $realm = -1);
setSecRegmail() - 设置指定账户的regmail
$result = $console->account()->setSecRegmail(string $account, string $regMail, string $repeatRegMail);
setSecEmail() - 设置指定账户的邮箱
$result = $console->account()->setSecEmail(string $account, string $email, string $repeatEmail);
setPassword() - 设置账户密码。
$result = $console->account()->setPassword(string $oldPassword, string $newPassword, string $repeatPassword);

$console->bnet()

create - 创建新的battle.net账户
$result = $console->bnet()->create(string $email, string $password);
gameAccountCreate - 为指定的battle.net账户创建游戏账户
$result = $console->bnet()->gameAccountCreate(string $email);
link - 将现有的游戏账户与battle.net账户关联
$result = $console->bnet()->link(string $email, string $login);
unlink - 将现有账户从指定的battle.net账户中取消关联
$result = $console->bnet()->unlink(string $account, string $password);
listGameAccounts - 列出指定battle.net账户上的游戏账户
$result = $console->bnet()->listGameAccounts(string $email);
setPassword - 为指定的battle.net账户设置新密码
$result = $console->bnet()->setPassword(string $email, string $password, string $repeatPassword);

$console->character()

unstuck - 将指定的玩家传送到指定位置
$result = $console->character()->unstuck(string $playerName, string $location = 'graveyard');
unmute - 恢复指定角色的消息功能
$result = $console->character()->unmute(string $playerName);
unban - 通过名字取消禁言角色
$result = $console->character()->unban(string $playerName, $function = 'character');
ban - 禁止指定角色
$result = $console->character()->ban(string $playerName, $function = 'character');
mute - 禁用角色的消息功能
$result = $console->character()->mute(string $playerName, int $minutes, $reason = 'No reason given!');
kick - 将玩家踢出游戏世界
$result = $console->character()->kick(string $playerName, string $reason = 'No reason given!');
customize - 在下次登录时发送“自定义角色”请求
$result = $console->character()->customize(string $playerName);
changeFaction - 在下次登录时发送“更改阵营”请求
$result = $console->character()->changeFaction(string $playerName);
changeRace - 在下次登录时发送“更改种族”请求
$result = $console->character()->changeRace(string $playerName);
erase - 完全删除角色
$result = $console->character()->erase(string $playerName);
level - 通过提供的值增加/减少角色的等级
$result = $console->character()->level(string $playerName, int $level = 1);
rename - 在下次登录时发送“更改名字”请求。如果提供了$newName，则名字将被强制更改
$result = $console->character()->rename(string $oldName, string $newName = '');
reputation - 显示选定角色的声望信息。玩家必须在线
$result = $console->character()->reputation(string $playerName);
titles - 显示角色所知的称号。玩家必须在线
$result = $console->character()->titles(string $playerName);
deletedDelete - 删除包含指定字符串在其中的角色
$result = $console->character()->deletedDelete(string $playerName);
deletedList - 显示具有指定字符串在其中的已删除角色
$result = $console->character()->deletedList(string $playerName);
deletedRestore - 恢复具有指定字符串在其中的已删除角色
$result = $console->character()->deletedRestore(string $playerName);
deletedOld - 删除删除时间超过$days天前的角色
$result = $console->character()->deletedOld(string $playerName, int $days);

$console->gm()

announce - 向所有游戏管理员发送公告
$result = $console->gm()->announce(string $announcement);
nameAnnounce - 向所有游戏管理员（作为控制台）发送公告
$result = $console->gm()->nameAnnounce(string $announcement);
notify - 向所有游戏管理员发送通知
$result = $console->gm()->notify(string $notification);

$console->guild()

create - 创建新的公会。玩家必须在线
$result = $console->guild()->create(string $leaderName, string $guildName);
delete - 删除指定的公会
$result = $console->guild()->delete(string $guildName);
invite - 邀请指定的玩家加入指定的公会
$result = $console->guild()->invite(string $playerName, string $guildName);
rename - 重命名公会
$result = $console->guild()->rename(string $oldName, string $newName);
info - 获取指定公会的信息
$result = $console->guild()->info(string $guildName);

$console->lfg()

queue - 显示当前LFG队列的信息
$result = $console->lfg()->queue();
clean - 清除当前队列，仅用于DEBUG
$result = $console->lfg()->clean();
options - 显示当前LFG选项。如果设置了值，则更新现有值。
$result = $console->lfg()->options($value = '');

$console->reset()

achievements - 重置指定玩家的成就
$result = $console->reset()->achievements(string $playerName);
honor - 重置指定玩家的荣誉
$result = $console->reset()->honor(string $playerName);
level - 重置指定玩家的等级
$result = $console->reset()->level(string $playerName);
spells - 重置指定玩家的法术
$result = $console->reset()->spells(string $playerName);
stats - 重置指定玩家的统计数据
$result = $console->reset()->stats(string $playerName);
talents - 重置指定玩家的天赋
$result = $console->reset()->talents(string $playerName);
all - 重置所有玩家的类型（天赋/法术）
$result = $console->reset()->all(string $type);

$console->send()

items - 向玩家发送物品 （此方法需要您也导入freedomcore/trinitycore-support库）
$console->send()->items(string $playerName, string $mailSubject, string $mailText, Items $items);
mail - 向玩家发送邮件
$console->send()->mail(string $playerName, string $mailSubject, string $mailText);
message - 向玩家发送将在屏幕中间显示的消息
$console->send()->message(string $playerName, string $message);
money - 向玩家发送金钱
$console->send()->money(string $playerName, string $mailSubject, string $mailText, int $amount);

$console->server()

corpses - 触发世界中的尸体过期检查
$result = $console->server()->corpses();
exit - 立即终止服务器。退出代码0
$result = $console->server()->exit();
info - 显示服务器版本和连接玩家数量
$result = $console->server()->info();
motd - 显示每日消息
$result = $console->server()->motd();
plimit - 不传递参数时，将显示当前玩家的限制。如果参数大于0，将设置新的最大玩家限制。'reset'参数可以用来从配置中设置值。
$result = $console->server()->plimit($parameter = '');
setDiffTime - 设置服务器的Diff时间
$result = $console->server()->setDiffTime(int $diffTime);
setLogLevel - 设置服务器的日志级别
$result = $console->server()->setLogLevel(string $facility, string $name, int $logLevel);
setMotd - 设置新的每日消息
将结果赋值给 $result = $console->server()->setMotd(string $motd);
setClosed - 设置世界是否接受新的客户端连接
将结果赋值给 $result = $console->server()->setClosed(bool $isClosed);
shutdown - 关闭服务器
将结果赋值给 $result = $console->server()->shutdown(int $timer, bool $force = false, int $code = 0);
shutdownCancel - 如果存在，取消重启/关闭计时器
将结果赋值给 $result = $console->server()->shutdownCancel();
saveAll - 保存所有玩家。
将结果赋值给 $result = $console->server()->saveAll();
notify - 向所有在线玩家显示消息
将结果赋值给 $result = $console->server()->notify(string $message);
announce - 发送公告
将结果赋值给 $result = $console->server()->announce(string $message);

附言：

如果您发现任何错误，或者想提出一些“额外”的功能建议，请自由创建一个新的问题。

freedomcore / trinitycore-console

维护者

详细信息