资源图标

JS插件 PneuJai's Form API 1.0.2

登录后下载
资源类型
原创
版权链接
#
支持版本
1.16、1.15 (RTX)、1.14、1.13、1.12、1.11、1.10、1.9、1.8、1.7、更早版本
API加載
JavaScript:
const SimpleForm = getShareData("pFormAPI").SimpleForm, ModalForm = getShareData("pFormAPI").ModalForm, CustomForm = getShareData("pFormAPI").CustomForm;
例子
JavaScript:
let form = new CustomForm();
form.setTitle("这是一个自定义窗体");
form.addLabel("这是一个文本标签");
form.addInput("", "水印文本");
form.addToggle("开关~或许是吧", true);
form.addSlider("游标滑块!?", 0, 10, 2, 3);
form.addStepSlider("矩阵滑块?!", ["Step 1","Step 2","Step 3"], 1);
form.addDropdown("如你所见,下拉框", ["Step 1","Step 2","Step 3"], 1);
let fid = form.sendToPlayer("1d7983df-d68c-3569-9d80-ff52dd758083");
等同於
JavaScript:
let fid = sendCustomForm('1d7983df-d68c-3569-9d80-ff52dd758083' '{"content":[{"type":"label","text":"这是一个文本标签"},{"placeholder":"水印文本","default":"","type":"input","text":""},{"default":true,"type":"toggle","text":"开关~或许是吧"},{"min":0.0,"max":10.0,"step":2.0,"default":3.0,"type":"slider","text":"游标滑块!?"},{"default":1,"steps":["Step 1","Step 2","Step 3"],"type":"step_slider","text":"矩阵滑块?!"},{"default":1,"options":["Option 1","Option 2","Option 3"],"type":"dropdown","text":"如你所见,下拉框"}], "type":"custom_form","title":"这是一个自定义窗体"}');
API接口定义 (writing the documentation takes 4x time more than scripting it)
(1)SimpleForm
// 類別名:SimpleForm
// 功能:定义一个简单表单
// 参数个数:3个
// 参数类型:字符串,字符串,数组
// 参数详解:title (optional) - 表单标题,content (optional) - 内容,buttons (optional) - 按钮文本数组
[例] let f = new SimpleForm()

(2)ModalForm
// 類別名:ModalForm
// 功能:定义一个模式对话框
// 参数个数:4个
// 参数类型:字符串,字符串,字符串,字符串
// 参数详解:title (optional) - 表单标题,content (optional) - 内容,button1 (optional) - 按钮1标题,button2 (optional) - 按钮2标题
[例] let f = new ModalForm()

(3)CustomForm
// 類別名:CustomForm
// 功能:定义一个自定义表单
// 参数个数:2个
// 参数类型:字符串,数组
// 参数详解:title (optional) - 表单标题,content (optional) - 内容項目数组
[例] let f = new CustomForm()

(4)stringify
// 類別:SimpleForm, ModalForm, CustomForm
// 函数名:stringify
// 功能:串化該表单
// 参数个数:0个
// 返回值:字符串
[例] let str = new SimpleForm().stringify()

(5)sendToPlayer
// 類別:SimpleForm, ModalForm, CustomForm
// 函数名:sendToPlayer
// 功能:向指定的玩家发送該表单
// 参数个数:1个
// 参数类型:字符串
// 参数详解:uuid - 在线玩家的uuid字符串
// 返回值:创建的表单id,为 0 表示发送失败
[例] let fid = new SimpleForm().sendToPlayer("1d7983df-d68c-3569-9d80-ff52dd758083")

(6)setTitle
// 類別:SimpleForm, ModalForm, CustomForm
// 函数名:setTitle
// 功能:设置該表单的标题
// 参数个数:1个
// 参数类型:字符串
// 参数详解:title - 表单标题
[例] new SimpleForm().setTitle("这是一个简单窗体")

(7)getTitle
// 類別:SimpleForm, ModalForm, CustomForm
// 函数名:getTitle
// 功能:获取該表单的标题
// 参数个数:0个
// 返回值:該表单的标题的字符串
[例] let str = new SimpleForm().getTitle()

(8)addContent
// 類別:CustomForm
// 函数名:addContent
// 功能:增加一个内容項目到該表单
// 参数个数:1个
// 参数类型:JSON
// 参数详解:content - 内容項目
[例] new CustomForm().addContent({"type":"label","text":"这是一个文本标签"})

(9)getContent
// 類別:SimpleForm, ModalForm
// 函数名:getContent
// 功能:获取該表单的内容
// 参数个数:0个
// 返回值:該表单的内容的字符串
[例] let str = new SimpleForm().getContent()

(9)setContent
// 類別:SimpleForm, ModalForm
// 函数名:setContent
// 功能:设置該表单的内容
// 参数个数:1个
// 参数类型:字符串
// 参数详解:content - 内容
[例] new SimpleForm().setContent("请选择:")

(10)addButton
// 類別:SimpleForm
// 函数名:addButton
// 功能:增加一个按钮到該表单
// 参数个数:3个
// 参数类型:字符串,整型,字符串
// 参数详解:text - 文本,(optional) imageType - 圖片類型(-1: no image,0: local image, 1: remote image),imagePath - 文件名
[例] new SimpleForm().addButton("Apple", 0, "textures/items/apple.png")

(11)setButton1
// 類別:ModalForm
// 函数名:setButton1
// 功能:设置該表单的按钮一
// 参数个数:1个
// 参数类型:字符串
// 参数详解:text - 文本
[例] new ModalForm().setButton1("生存")

(12)getButton1
// 類別:ModalForm
// 函数名:getButton1
// 功能:获取該表单的按钮一
// 参数个数:0个
// 返回值:該表单的按钮一的字符串
[例] let str = new ModalForm().getButton1()

(13)setButton2
// 類別:ModalForm
// 函数名:setButton2
// 功能:设置該表单的按钮二
// 参数个数:1个
// 参数类型:字符串
// 参数详解:text - 文本
[例] new ModalForm().setButton2("死亡")

(14)getButton2
// 類別:ModalForm
// 函数名:getButton2
// 功能:获取該表单的按钮二
// 参数个数:0个
// 返回值:該表单的按钮二的字符串
[例] let str = new ModalForm().getButton2()

(15)addLabel
// 類別:CustomForm
// 函数名:addLabel
// 功能:增加一个文本标签到該表单内容
// 参数个数:1个
// 参数类型:字符串
// 参数详解:text - 文本
[例] new CustomForm().addLabel("这是一个文本标签")

(16)addToggle
// 類別:CustomForm
// 函数名:addToggle
// 功能:增加一个开关到該表单内容
// 参数个数:2个
// 参数类型:字符串,布尔型
// 参数详解:text - 文本,(optional) default - 預設值
[例] new CustomForm().addToggle("开关~或许是吧", true)

(17)addSlider
// 類別:CustomForm
// 函数名:addSlider
// 功能:增加一个游标滑块到該表单内容
// 参数个数:5个
// 参数类型:字符串,整型,整型,整型,整型
// 参数详解:text - 文本,min - 最小值,max - 最大值,(optional) step - 步數,(optional) default - 預設值
[例] new CustomForm().addSlider("游标滑块!?", 0, 10, 2, 3)

(18)addStepSlider
// 類別:CustomForm
// 函数名:addStepSlider
// 功能:增加一个矩阵滑块到該表单内容
// 参数个数:3个
// 参数类型:字符串,数组,整型
// 参数详解:text - 文本,step - 步數,(optional) defaultIndex - 預設值
[例] new CustomForm().addStepSlider("矩阵滑块?!", ["Step 1","Step 2","Step 3"], 1)

(19)addDropdown
// 類別:CustomForm
// 函数名:addDropdown
// 功能:增加一个矩阵滑块到該表单内容
// 参数个数:3个
// 参数类型:字符串,数组,整型
// 参数详解:text - 文本,options - 選項,(optional) default - 預設值
[例] new CustomForm().addDropdown("如你所见,下拉框", ["Step 1","Step 2","Step 3"], 1)

(19)addInput
// 類別:CustomForm
// 函数名:addInput
// 功能:增加一个輸入框到該表单内容
// 参数个数:3个
// 参数类型:字符串,字符串,字符串
// 参数详解:text - 文本,(optional) placeholder - 水印文本,(optional) default - 預設值
[例] new CustomForm().addInput("輸入框")

If you have found any bugs, feel free to report to me
作者
Pneu Jai
下载
12
阅读
306
首次发布
最后更新
评分
0.00 星 0 次评分

Pneu Jai的更多资源

最新更新

  1. Quick fix

    - Fixed addInput not working properly - Modified the file name to let it load earlier
  2. 加上有参构造

    added parameters for SimpleForm, ModalForm and CustomForm constructors