Skip to content

Commit 34d7c78

Browse files
committed
docs: add missing picture
1 parent 92124ea commit 34d7c78

File tree

3 files changed

+93
-119
lines changed

3 files changed

+93
-119
lines changed

docs/apis/ScriptAPI/ScriptHelp.md

Lines changed: 52 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# LLSE - Generic Scripting Interface Documentation
22

3-
> Here are some commonly used **auxiliary functions** , such as plugin registration, output information and asynchronous interfaces, etc.
3+
> Here are some commonly used **auxiliary functions** , such as plugin registration, output information and asynchronous
4+
> interfaces, etc.
45
56
They make it easier and more natural for you to develop scripts and avoid a lot of unnecessary details.
67

@@ -10,124 +11,111 @@ The following APIs add necessary auxiliary interfaces to scripts.
1011

1112
### Output Information To The Console
1213

13-
`log(data1,data2,...)`
14+
`log(data1,data2,...)`
1415

1516
- Parameter:.,
16-
- Variable or data to be output
17-
Can be of any type, and the number of parameters can be any number.
17+
- Variable or data to be output
18+
Can be of any type, and the number of parameters can be any number.
1819
- Return value: none
1920

20-
21-
2221
### Output Color Text
2322

2423
This is an upgraded version of the above function; it supports color output.
2524

2625
`colorLog(color,data1,data2,...)`
2726

28-
- Parameter:
29-
- color : `String`
30-
The color output by this line (code example and effect are as follows)
31-
- data... :
32-
Variable or data to be output
33-
Can be of any type, and the number of parameters can be any number.
34-
- Return value: none
35-
36-
#### Show results:
37-
38-
![ColorLogExample](../../../assets/ColorLog.png)
27+
- Parameter:
28+
- color : `String`
29+
The color output by this line (code example and effect are as follows)
30+
- data... :
31+
Variable or data to be output
32+
Can be of any type, and the number of parameters can be any number.
33+
- Return value: none
3934

35+
#### Show results:
4036

37+
![ColorLogExample](../../../img/ColorLog.png)
4138

4239
### Asynchronous Output
4340

44-
This function returns immediately after the output request is sent, avoiding the blocking time caused by synchronous reading and writing.
41+
This function returns immediately after the output request is sent, avoiding the blocking time caused by synchronous
42+
reading and writing.
4543
The bottom layer has lock protection, different `fastLog` There will be no string phenomenon between.
4644

4745
`fastLog(data1,data2,...)`
4846

49-
- Parameter:
50-
- data... :
51-
Variable or data to be output
52-
Can be of any type, and the number of parameters can be any number
53-
- Return value: none
54-
55-
47+
- Parameter:
48+
- data... :
49+
Variable or data to be output
50+
Can be of any type, and the number of parameters can be any number
51+
- Return value: none
5652

57-
### Delay the execution of a function for a period of time
53+
### Delay the execution of a function for a period of time
5854

5955
`setTimeout(func,msec)`
6056

61-
- Parameter:
57+
- Parameter:
6258

63-
- func : `Function`
64-
The function to be executed.
59+
- func : `Function`
60+
The function to be executed.
6561

66-
- msec : `Integer`
67-
Delay execution time (milliseconds)
62+
- msec : `Integer`
63+
Delay execution time (milliseconds)
6864
- Return value: this task id.
6965
- Return value type: `Integer`
70-
- If it returns `Null`, the task failed.
71-
72-
66+
- If it returns `Null`, the task failed.
7367

7468
### Delay the execution of a code segment for a period of time (eval)
7569

7670
`setTimeout(code,msec)`
7771

78-
- Parameter:
72+
- Parameter:
7973

80-
- code : `String`
81-
The code segment to be executed.
74+
- code : `String`
75+
The code segment to be executed.
8276

83-
- msec : `Integer`
84-
Delay execution time (milliseconds)
85-
- Return value: this task id
77+
- msec : `Integer`
78+
Delay execution time (milliseconds)
79+
- Return value: this task id
8680
- Return value type: `Integer`
87-
- If it returns `Null`, the task creation failed.
88-
89-
81+
- If it returns `Null`, the task creation failed.
9082

9183
### Set period execution function
9284

9385
`setInterval(func,msec)`
9486

95-
- Parameter:
96-
- func : `Function`
97-
The function to be executed
87+
- Parameter:
88+
- func : `Function`
89+
The function to be executed
9890

99-
- msec : `Integer`
100-
Execution interval period (ms)
91+
- msec : `Integer`
92+
Execution interval period (ms)
10193
- Return value: this task id
10294
- Return value type: `Integer`
10395

104-
105-
10696
### Set period execution code segment (eval)
10797

10898
`setInterval(code,msec)`
10999

110-
- Parameter:
111-
- code : `String`
112-
The code to be executed.
100+
- Parameter:
101+
- code : `String`
102+
The code to be executed.
113103

114-
- msec : `Integer`
115-
Execution interval period (ms)
116-
- Return value: this task id
104+
- msec : `Integer`
105+
Execution interval period (ms)
106+
- Return value: this task id
117107
- Return value type: `Integer`
118-
- If it returns `Null`, the task creation failed.
119-
120-
108+
- If it returns `Null`, the task creation failed.
121109

122-
### Cancel Delay/Period Execution Item
110+
### Cancel Delay/Period Execution Item
123111

124112
`clearInterval(taskid)`
125113

126-
- Parameter:
127-
- timerid : `Integer`
128-
The task ID returned by the first few functions
114+
- Parameter:
115+
- timerid : `Integer`
116+
The task ID returned by the first few functions
129117
- Return value: whether the cancellation was successful.
130118
- Return value type: `Boolean`
131-
- If it returns `Null`, the cancellation of the task failed.
119+
- If it returns `Null`, the cancellation of the task failed.
132120

133121

docs/apis/ScriptAPI/ScriptHelp.zh.md

Lines changed: 41 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,30 @@
1010

1111
### 输出信息到控制台
1212

13-
`log(data1,data2,...)`
13+
`log(data1,data2,...)`
1414

1515
- 参数:
16-
- 待输出的变量或者数据
17-
可以是任意类型,参数数量可以是任意个
16+
- 待输出的变量或者数据
17+
可以是任意类型,参数数量可以是任意个
1818
- 返回值:无
1919

20-
21-
2220
### 输出带颜色文本
2321

2422
这是楼上那位的升级版,没错,它支持彩色输出
2523

2624
`colorLog(color,data1,data2,...)`
2725

2826
- 参数:
29-
- color : `String`
30-
此行输出的颜色(代码示例和效果如下图)
31-
- data... :
32-
待输出的变量或者数据
33-
可以是任意类型,参数数量可以是任意个
34-
- 返回值:无
27+
- color : `String`
28+
此行输出的颜色(代码示例和效果如下图)
29+
- data... :
30+
待输出的变量或者数据
31+
可以是任意类型,参数数量可以是任意个
32+
- 返回值:无
3533

3634
#### 效果展示:
3735

38-
![ColorLogExample](../../../assets/ColorLog.png)
39-
40-
36+
![ColorLogExample](../../../img/ColorLog.png)
4137

4238
### 异步输出
4339

@@ -47,87 +43,77 @@
4743
`fastLog(data1,data2,...)`
4844

4945
- 参数:
50-
- data... :
51-
待输出的变量或者数据
52-
可以是任意类型,参数数量可以是任意个
53-
- 返回值:无
54-
55-
46+
- data... :
47+
待输出的变量或者数据
48+
可以是任意类型,参数数量可以是任意个
49+
- 返回值:无
5650

57-
### 推迟一段时间执行函数
51+
### 推迟一段时间执行函数
5852

5953
`setTimeout(func,msec)`
6054

6155
- 参数:
6256

63-
- func : `Function`
64-
待执行的函数
57+
- func : `Function`
58+
待执行的函数
6559

66-
- msec : `Integer`
67-
推迟执行的时间(毫秒)
60+
- msec : `Integer`
61+
推迟执行的时间(毫秒)
6862
- 返回值:此任务ID
6963
- 返回值类型:`Integer`
70-
- 如果返回`Null`,则代表创建任务失败
64+
- 如果返回`Null`,则代表创建任务失败
7165

72-
73-
74-
### 推迟一段时间执行代码段(eval)
66+
### 推迟一段时间执行代码段(eval)
7567

7668
`setTimeout(code,msec)`
7769

7870
- 参数:
7971

80-
- code : `String`
81-
待执行的代码段
72+
- code : `String`
73+
待执行的代码段
8274

83-
- msec : `Integer`
84-
推迟执行的时间(毫秒)
75+
- msec : `Integer`
76+
推迟执行的时间(毫秒)
8577
- 返回值:此任务ID
8678
- 返回值类型:`Integer`
87-
- 如果返回`Null`,则代表创建任务失败
88-
89-
79+
- 如果返回`Null`,则代表创建任务失败
9080

91-
### 设置周期执行函数
81+
### 设置周期执行函数
9282

9383
`setInterval(func,msec)`
9484

9585
- 参数:
96-
- func : `Function`
97-
待执行的函数
86+
- func : `Function`
87+
待执行的函数
9888

99-
- msec : `Integer`
100-
执行间隔周期(毫秒)
89+
- msec : `Integer`
90+
执行间隔周期(毫秒)
10191
- 返回值:此任务ID
10292
- 返回值类型: `Integer`
10393

104-
105-
106-
### 设置周期执行代码段(eval)
94+
### 设置周期执行代码段(eval)
10795

10896
`setInterval(code,msec)`
10997

11098
- 参数:
111-
- code : `String`
112-
待执行的代码段
99+
- code : `String`
100+
待执行的代码段
113101

114-
- msec : `Integer`
115-
执行间隔周期(毫秒)
102+
- msec : `Integer`
103+
执行间隔周期(毫秒)
116104
- 返回值:此任务ID
117105
- 返回值类型: `Integer`
118-
- 如果返回`Null`,则代表创建任务失败
119-
120-
106+
- 如果返回`Null`,则代表创建任务失败
121107

122-
### 取消延时 / 周期执行项
108+
### 取消延时 / 周期执行项
123109

124110
`clearInterval(taskid)`
125111

126112
- 参数:
127-
- timerid : `Integer`
128-
由前几个函数返回的任务ID
113+
- timerid : `Integer`
114+
由前几个函数返回的任务ID
129115
- 返回值:是否取消成功
130116
- 返回值类型: `Boolean`
131-
- 如果返回`Null`,则代表取消任务失败
117+
- 如果返回`Null`,则代表取消任务失败
132118

133119

docs/img/ColorLog.png

6.94 KB
Loading

0 commit comments

Comments
 (0)