Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
M
Mirai
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
MyCard
Mirai
Commits
f0a67d78
Commit
f0a67d78
authored
Jun 12, 2020
by
Him188
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve docs on mirai code
parent
c9988f4c
Changes
6
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
43 additions
and
7 deletions
+43
-7
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/code/CodableMessage.kt
...ain/kotlin/net.mamoe.mirai/message/code/CodableMessage.kt
+12
-1
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt
.../src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt
+5
-1
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/AtAll.kt
...c/commonMain/kotlin/net.mamoe.mirai/message/data/AtAll.kt
+5
-1
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Face.kt
...rc/commonMain/kotlin/net.mamoe.mirai/message/data/Face.kt
+3
-0
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/HummerMessage.kt
...Main/kotlin/net.mamoe.mirai/message/data/HummerMessage.kt
+14
-3
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Image.kt
...c/commonMain/kotlin/net.mamoe.mirai/message/data/Image.kt
+4
-1
No files found.
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/code/CodableMessage.kt
View file @
f0a67d78
...
...
@@ -9,7 +9,7 @@
package
net.mamoe.mirai.message.code
import
net.mamoe.mirai.message.data.
Message
import
net.mamoe.mirai.message.data.
*
import
net.mamoe.mirai.utils.MiraiExperimentalAPI
import
net.mamoe.mirai.utils.SinceMirai
...
...
@@ -18,7 +18,18 @@ import net.mamoe.mirai.utils.SinceMirai
*
* 使用 `mirai-serialization` 中 `String.parseMiraiCode()` 转回 [Message].
*
* ## 规范
* 可在 [mirai-code-specification.md](https://github.com/mamoe/mirai/blob/dev/docs/mirai-code-specification.md) 查看 mirai 码规范.
*
* @suppress 警告: 此 API 可能在任何时刻被改变
*
* @see At
* @see AtAll
* @see VipFace
* @see Face
* @see Image
* @see FlashImage
* @see PokeMessage
*/
@MiraiExperimentalAPI
@SinceMirai
(
"1.1.0"
)
...
...
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt
View file @
f0a67d78
...
...
@@ -18,6 +18,7 @@ import net.mamoe.mirai.LowLevelAPI
import
net.mamoe.mirai.contact.Member
import
net.mamoe.mirai.contact.nameCardOrNick
import
net.mamoe.mirai.message.code.CodableMessage
import
net.mamoe.mirai.utils.SinceMirai
import
kotlin.jvm.JvmMultifileClass
import
kotlin.jvm.JvmName
import
kotlin.jvm.JvmStatic
...
...
@@ -27,6 +28,9 @@ import kotlin.jvm.JvmSynthetic
/**
* At 一个群成员. 只能发送给一个群.
*
* ## mirai 码支持
* 格式: [mirai:at:*[target]*,*[display]*]
*
* @see AtAll 全体成员
*/
data class
At
...
...
@@ -37,7 +41,7 @@ private constructor(
* "@群员名片"
*/
val
display
:
String
)
:
MessageContent
,
CodableMessage
{
)
:
MessageContent
,
@SinceMirai
(
"1.1.0"
)
CodableMessage
{
/**
* 构造一个 [At] 实例. 这是唯一的公开的构造方式.
...
...
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/AtAll.kt
View file @
f0a67d78
...
...
@@ -13,6 +13,7 @@
package
net.mamoe.mirai.message.data
import
net.mamoe.mirai.message.code.CodableMessage
import
net.mamoe.mirai.utils.SinceMirai
import
kotlin.jvm.JvmMultifileClass
import
kotlin.jvm.JvmName
...
...
@@ -23,11 +24,14 @@ private const val displayA = "@全体成员"
*
* 非会员每天只能发送 10 次 [AtAll]. 超出部分会被以普通文字看待.
*
* ## mirai 码支持
* 格式: [mirai:atall]
*
* @see At at 单个群成员
*/
object
AtAll
:
Message
.
Key
<
AtAll
>,
MessageContent
,
CodableMessage
{
MessageContent
,
@SinceMirai
(
"1.1.0"
)
CodableMessage
{
const
val
display
=
displayA
override
val
typeName
:
String
get
()
=
"AtAll"
...
...
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Face.kt
View file @
f0a67d78
...
...
@@ -20,6 +20,9 @@ import kotlin.jvm.JvmSynthetic
/**
* QQ 自带表情
*
* ## mirai 码支持
* 格式: [mirai:face:*[id]*]
*/
data class
Face
(
val
id
:
Int
)
:
// used in delegation
MessageContent
,
CodableMessage
{
...
...
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/HummerMessage.kt
View file @
f0a67d78
...
...
@@ -16,7 +16,9 @@ package net.mamoe.mirai.message.data
import
net.mamoe.mirai.message.code.CodableMessage
import
net.mamoe.mirai.message.data.PokeMessage.Types
import
net.mamoe.mirai.message.data.VipFace.Companion
import
net.mamoe.mirai.message.data.VipFace.Kind
import
net.mamoe.mirai.utils.PlannedRemoval
import
net.mamoe.mirai.utils.SinceMirai
import
kotlin.jvm.*
/**
...
...
@@ -40,6 +42,9 @@ sealed class HummerMessage : MessageContent {
/**
* 戳一戳. 可以发送给好友或群.
*
* ## mirai 码支持
* 格式: [mirai:poke:*[name]*,*[type]*,*[id]*]
*
* @see Types 使用伴生对象中的常量
*/
data class
PokeMessage
internal
constructor
(
...
...
@@ -50,7 +55,7 @@ data class PokeMessage internal constructor(
val
type
:
Int
,
val
id
:
Int
)
:
HummerMessage
(),
CodableMessage
{
)
:
HummerMessage
(),
@SinceMirai
(
"1.1.0"
)
CodableMessage
{
@Suppress
(
"DEPRECATION_ERROR"
,
"DEPRECATION"
,
"INVISIBLE_MEMBER"
,
"INVISIBLE_REFERENCE"
)
companion
object
Types
:
Message
.
Key
<
PokeMessage
>
{
override
val
typeName
:
String
...
...
@@ -152,6 +157,9 @@ data class PokeMessage internal constructor(
*
* 不支持发送.
*
* ## mirai 码支持
* 格式: [mirai:vipface:*[Kind.id]*,*[Kind.name]*,*[count]*]
*
* @see Types 使用伴生对象中的常量
*/
data class
VipFace
internal
constructor
(
...
...
@@ -160,7 +168,7 @@ data class VipFace internal constructor(
*/
val
kind
:
Kind
,
val
count
:
Int
)
:
HummerMessage
(),
CodableMessage
{
)
:
HummerMessage
(),
@SinceMirai
(
"1.1.0"
)
CodableMessage
{
data class
Kind
(
val
id
:
Int
,
val
name
:
String
...
...
@@ -235,11 +243,14 @@ data class VipFace internal constructor(
/**
* 闪照
*
* ## mirai 码支持
* 格式: [mirai:flash:*[Image.imageId]*]
*
* @see Image.flash 转换普通图片为闪照
*
* @see Image 查看图片相关信息
*/
sealed
class
FlashImage
:
MessageContent
,
HummerMessage
(),
CodableMessage
{
sealed
class
FlashImage
:
MessageContent
,
HummerMessage
(),
@SinceMirai
(
"1.1.0"
)
CodableMessage
{
companion
object
Key
:
Message
.
Key
<
FlashImage
>
{
/**
* 将普通图片转换为闪照.
...
...
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Image.kt
View file @
f0a67d78
...
...
@@ -55,10 +55,13 @@ import kotlin.jvm.JvmSynthetic
*
* 查看平台 `actual` 定义以获取上传方式扩展.
*
* ## mirai 码支持
* 格式: [mirai:image:*[Image.imageId]*]
*
* @see FlashImage 闪照
* @see Image.flash 转换普通图片为闪照
*/
expect
interface
Image
:
Message
,
MessageContent
,
CodableMessage
{
expect
interface
Image
:
Message
,
MessageContent
,
@SinceMirai
(
"1.1.0"
)
CodableMessage
{
companion
object
Key
:
Message
.
Key
<
Image
>
{
override
val
typeName
:
String
}
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment