github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-01-11 02:50:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add docs

Browse Source
This commit is contained in:
Him188 2020-05-26 13:14:41 +08:00
parent f73f064d1a
commit 34b585a6f7
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/command/CommandManager.kt
View File

@ -15,7 +15,6 @@ package net.mamoe.mirai.console.command
import kotlinx.atomicfu.locks.withLock import kotlinx.atomicfu.locks.withLock
import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Job import kotlinx.coroutines.Job
import kotlinx.coroutines.runBlocking
import net.mamoe.mirai.console.plugin.Plugin import net.mamoe.mirai.console.plugin.Plugin
import net.mamoe.mirai.message.data.Message import net.mamoe.mirai.message.data.Message
import net.mamoe.mirai.message.data.MessageChain import net.mamoe.mirai.message.data.MessageChain
@ -89,6 +88,7 @@ fun CommandOwner.unregisterAllCommands() {
* 若已有重名指令, 且 [override] 为 `false`, 返回 `false`; * 若已有重名指令, 且 [override] 为 `false`, 返回 `false`;
* 若已有重名指令, 但 [override] 为 `true`, 覆盖原有指令并返回 `true`. * 若已有重名指令, 但 [override] 为 `true`, 覆盖原有指令并返回 `true`.
* *
* @see JCommandManager.register Java 方法
*/ */
@JvmOverloads @JvmOverloads
fun Command.register(override: Boolean = false): Boolean = InternalCommandManager.modifyLock.withLock { fun Command.register(override: Boolean = false): Boolean = InternalCommandManager.modifyLock.withLock {
@ -111,12 +111,16 @@ fun Command.register(override: Boolean = false): Boolean = InternalCommandManage
/** /**
* 查找并返回重名的指令. 返回重名指令. * 查找并返回重名的指令. 返回重名指令.
*
* @see JCommandManager.findDuplicate Java 方法
*/ */
fun Command.findDuplicate(): Command? = fun Command.findDuplicate(): Command? =
InternalCommandManager.registeredCommands.firstOrNull { it.names intersects this.names } InternalCommandManager.registeredCommands.firstOrNull { it.names intersects this.names }
/** /**
* 取消注册这个指令. 若指令未注册, 返回 `false`. * 取消注册这个指令. 若指令未注册, 返回 `false`.
*
* @see JCommandManager.unregister Java 方法
*/ */
fun Command.unregister(): Boolean = InternalCommandManager.modifyLock.withLock { fun Command.unregister(): Boolean = InternalCommandManager.modifyLock.withLock {
InternalCommandManager.registeredCommands.remove(this) InternalCommandManager.registeredCommands.remove(this)
@ -131,6 +135,8 @@ fun Command.unregister(): Boolean = InternalCommandManager.modifyLock.withLock {
* *
* @param messages 接受 [String] 或 [Message], 其他对象将会被 [Any.toString] * @param messages 接受 [String] 或 [Message], 其他对象将会被 [Any.toString]
* @return 是否成功解析到指令. 返回 `false` 代表无任何指令匹配 * @return 是否成功解析到指令. 返回 `false` 代表无任何指令匹配
*
* @see JCommandManager.executeCommand Java 方法
*/ */
suspend fun CommandSender.executeCommand(vararg messages: Any): Boolean { suspend fun CommandSender.executeCommand(vararg messages: Any): Boolean {
if (messages.isEmpty()) return false if (messages.isEmpty()) return false
@ -145,6 +151,8 @@ internal inline fun <reified T> List<T>.dropToTypedArray(n: Int): Array<T> = Arr
/** /**
* 解析并执行一个指令 * 解析并执行一个指令
* @return 是否成功解析到指令. 返回 `false` 代表无任何指令匹配 * @return 是否成功解析到指令. 返回 `false` 代表无任何指令匹配
*
* @see JCommandManager.executeCommand Java 方法
*/ */
suspend fun CommandSender.executeCommand(message: MessageChain): Boolean { suspend fun CommandSender.executeCommand(message: MessageChain): Boolean {
if (message.isEmpty()) return false if (message.isEmpty()) return false