# RSPlates_Document

**Repository Path**: amoy2211/RSPlatesDocument

## Basic Information

- **Project Name**: RSPlates_Document
- **Description**: Script Document of RSPlates
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-12-23
- **Last Updated**: 2022-12-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## (Please check README.en.md for English language)

## RSPlates 脚本模块文档 

1. #### 关于脚本

       RSPlates的核心定位是 低cpu占用(帧率影响）与  简洁易用 。前者通过代码质量得以保证，后者通过简洁且易于理解的功能/设置界面实现。目前插件的图形设置界面，从打开到找到想要的设置选项大概仅需要几秒钟时间，这便是我预期的。但简洁与易用的代价便是无法满足所有人，我经常收到反馈想添加种种功能与设置，若全部实现恐怕插件早已变得臃肿不堪，虽然RSPlates的设计初衷就不是像Plater那样试图解决所有问题，但我同样能够理解这些反馈者们的需求。
     
       因此我添加了“脚本”这个模块，希望折中的解决这个问题。即在始终保持简洁易用的核心基础上满足不同类型的使用者，目前仅开放了一些参数接口，后续可能会根据反馈在该文档添加更多接口或功能脚本。


2. #### 如何使用
       复制你需要的参数接口或功能代码，粘贴到插件脚本窗口内即可。脚本模块本质是一个代码编辑器，你可以在里面放入任何你希望执行的Lua代码，哪怕它与本插件无关。脚本内的代码会在插件载入时自动执行 或点击 “Save and Run”按钮时手动执行。


3. #### 接口文档

    带有（\*）的设置表示需要重载界面后生效
   
   - #### rs.ExtraConfig.healthValueSize = 11 
        >血量数值大小 （*）
   - #### rs.ExtraConfig.questIconSize = 30 
        >任务标记大小 （*）
   - #### rs.ExtraConfig.stolenBuffSize = 25 
        >可驱散/偷取光环图标大小 （*）
   - #### rs.ExtraConfig.CastingTimerSize = 12 
        >施法时间字体大小 （*）
   - #### rs.ExtraConfig.InterrupteIndicatorSize = 7 
        >打断指示器大小 （*）
   - #### rs.ExtraConfig.ReduceFriendlyNameplatesSize = false 
        >缩小友方姓名板尺寸，以此模拟友方姓名板重叠，让名字模式下的名字始终紧贴单位 （*）
   
   - #### rs.ExtraConfig.BoardSelectColor = true
        >当前目标边框高亮(白色)
   
   - #### rs.ExtraConfig.ExplosiveHelperAffixDetection = true
        >易爆助手仅在检测到身处易爆词缀环境时才会生效
   
   - #### rs.ExtraConfig.ExplosiveHelperScanList = {[120651] = true}
        >易爆助手的检测范围，默认只检测易爆球(npcID:120651)，按下列格式添加更多检测NPC
        >>```
        >>{
        >>   [npc1_ID] = true,  
        >>   [npc2_ID] = true,
        >>   [npc3_ID] = true,
        >>   ...
        >>}
        >>```
   - #### rs.ExtraConfig.ColorOrder = "ABCDEFG"
        >染色优先级，当目标同时满足多个条件时，排在前面的覆盖后面的 
        >>A: 焦点颜色<br>B: 目标颜色<br>C: 灰名无荣誉目标<br>D: 自定义NpcID<br>E: 携带自定义光环<br>F: 斩杀颜色<br>G: 仇恨颜色<br><br>
        >举例：默认的优先级是 "ABCDEFG"，如果你想让斩杀颜色优先级最高，改为 "FABCDEG"