阅读须知
2022年10月22日
阅读须知
本文档为第一代API文档,也即CloudControl Pro的默认引擎(Rhino犀牛引擎)的文档。如果你从来没有听说过什么第一代API,犀牛引擎,Node.js引擎,那么说明你来对文档了。
查看基于Node.js的API(第二代API)的文档请在菜单栏切换第二代API文档。
API稳定性
由于CloudControl Pro处于活跃的更新和开发状态,API可能随时有变动,我们用Stability来标记模块、函数的稳定性。这些标记包括:
Stability: 0 - Deprecated
弃用的函数、模块或特性,在未来的更新中将很快会被移除或更改。应该在脚本中移除对这些函数的使用,以免后续出现意料之外的问题。
Stability: 1 - Experimental
实验性的函数、模块或特性,在未来的更新中可能会更改或移除。应该谨慎使用这些函数或模块,或者仅用作临时或试验用途。
Stability: 2 - Stable
稳定的函数、模块或特性,在未来的更新中这些模块已有的函数一般不会被更改,会保证后向兼容性。
如何阅读本文档
先看一个例子,下面是基于控件的操作模拟的章节中input函数的部分说明。
input([i, ]text)
i
{number} 表示要输入的为第i + 1个输入框text
{string} 要输入的文本
input表示函数名,括号内的[i, ]text
为函数的参数。下面是参数列表,"number"表示参数i的类型为数值,"string"表示参数text的类型为字符串。
例如input(1, "啦啦啦"),执行这个语句会在屏幕上的第2个输入框处输入"啦啦啦"。
方括号[ ]表示参数为可选参数。也就是说,可以省略i直接调用input。例如input("嘿嘿嘿"),按照文档,这个语句会在屏幕上所有输入框输入"嘿嘿嘿"。
调用有可选参数的函数时请不要写上方括号。