MiniStudio的API文档看不懂怎么办？（上）原创

当我们激动的打开官网的API时，一连串的英文出现在了屏幕上，这让我们小白是看的一脸茫然。不过不慌，这期教程中我来教大家怎么去看懂这个API。

首先进入API文档的首页我们将看见这里官方将API文档分为了五个类型

•沙盒指引

•类

•枚举

•数据类型

•基类

这五个分类中我将给大家一一去解释一遍。

首先是第一个“沙盒指引”

其实我们可以把”沙盒指引“理解为一个”目录“

没错，在这个目录中官方按照从A~Z的顺序排列了,不过话说这个全是英文怎么看的懂啊？

这......不慌，我们还有翻译器，

当我们把英文翻译成中文时这个时候大家是不是就能看懂了？

下面我们来看看“目录”后面的内容——类、枚举、数据类型、基类

一、类

这里的“类”其实一些官方写好了的“代码块”然后打包成了一个“函数”只需要你通过Lua进行调用这个“函数”即可，当然有的函数里面或许会给你一些“值”需要填写。就比如

在这一段中

前面的“void”是一个函数“返回”的“类型”（你可以理解成一串代码运行之后的结果输出的什么，[比如A=1 B=2 A+B=C]在这里面A+B输出的结果是C的值；也就说明C=A+B，即C=3；而这个3是不是一个数字？所以A+B返回的也就是一个数字类型。）

Invoke 直接通过翻译器翻译的话是调用的意思，但是在 void lnvoke(lua_State* L, ReflexTuple params)中，这个lnvoke是官方要你在这个单词的位置上填写一个函数的名字。所以这个地方的lnvoke这个单词是可以替换成其他的函数名字的。

至于最后面的括号里面的东西......

括号里面的是前面lnvoke的一个属性，就比如在这串代码中，官方给出的是lua_State* L和ReflexTuple params这两个属性。当然这个属性并不是一乘不变的，这个属性的内容是根据前面的函数（也就是前面说的“lnvoke”这个单词的介绍）来变化的。

比如在MiniStudio中的“UIBase”去设置一个UI页面是否可被显示出来。

首先在官方给的API文档的页面我们可以根据注释来快速找到UI页面的显示控制的函数Visible ()

不过为什么不是bool Visible ()？前面的bool为啥去掉了？这是因为前面的bool并不是跟Visible一起的，他们两个单词之间用空格分开了，所以这也就变成了两个单独的单词。而在这里，bool这个单词是一个备注，告诉你括号里面填写的内容应该是什么类型的。这里bool用英文翻译成中过来也就是布尔的意思，所以也就是在告诉你Visible ()这个函数中应该是填写一个布尔值。

Visible（true）--true 是布尔值“真”的意思，也就是让UI显示出来

Visible（false）--false 是布尔值“假”的意思，也就是让UI隐藏起来