Suika3Ray VN API 参考
《VN API (Suika.*)》是为视觉小说创作而设计的。
每个 Suika.* API 函数都只接受一个参数。
该参数必须是一个字典, 并且函数的选项必须作为键值对存储在字典中。
在本文档中，「参数」是指该字典中的键值对。
索引
- 基础
- 配置
- 输入
- Suika.getMousePosX()
- Suika.getMousePosY()
- Suika.isMouseLeftPressed()
- Suika.isMouseRightPressed()
- Suika.isMouseLeftClicked()
- Suika.isMouseRightClicked()
- Suika.isMouseDragging()
- Suika.isReturnKeyPressed()
- Suika.isSpaceKeyPressed()
- Suika.isEscapeKeyPressed()
- Suika.isUpKeyPressed()
- Suika.isDownKeyPressed()
- Suika.isLeftKeyPressed()
- Suika.isRightKeyPressed()
- Suika.isPageUpKeyPressed()
- Suika.isPageDownKeyPressed()
- Suika.isControlKeyPressed()
- Suika.isSKeyPressed()
- Suika.isLKeyPressed()
- Suika.isHKeyPressed()
- Suika.isTouchCanceled()
- Suika.isSwiped()
- Suika.clearInputState()
- 游戏
- Suika.startCommandRepetition()
- Suika.stopCommandRepetition()
- Suika.isInCommandRepetition()
- Suika.setMessageActive()
- Suika.clearMessageActive()
- Suika.isMessageActive()
- Suika.startAutoMode()
- Suika.stopAutoMode()
- Suika.isAutoMode()
- Suika.startSkipMode()
- Suika.stopSkipMode()
- Suika.isSkipMode()
- Suika.setSaveLoad()
- Suika.isSaveLoadEnabled()
- Suika.setNonInterruptible()
- Suika.isNonInterruptible()
- Suika.setPenPosition()
- Suika.getPenPositionX()
- Suika.getPenPositionY()
- Suika.pushForCall()
- Suika.popForReturn()
- Suika.readCallStack()
- Suika.writeCallStack()
- Suika.setCallArgument()
- Suika.getCallArgument()
- Suika.isPageMode()
- Suika.appendBufferedMessage()
- Suika.getBufferedMessage()
- Suika.clearBufferedMessage()
- Suika.resetPageLine()
- Suika.incPageLine()
- Suika.isPageTop()
- Suika.registerBGVoice()
- Suika.getBVoice()
- [Suika.setBGVoicePlaying()](#suikasetbgvoiceplaying]
- Suika.isBGVoicePlaying()
- Suika.setChapterName()
- Suika.getChapterName()
- Suika.setLastMessage()
- Suika.getLastMessage()
- Suika.setTextSpeed()
- Suika.getTextSpeed()
- Suika.setAutoSpeed()
- Suika.getAutoSpeed()
- Suika.markLastEnglishTagIndex()
- Suika.getLastEnglishTagIndex()
- Suika.clearLastEnglishTagIndex()
- Suika.getLastTagName()
- 图像
- 舞台
- Suika.reloadStageImages()
- Suika.reloadStage位置s()
- Suika.getLayerX()
- Suika.getLayerY()
- Suika.setLayer位置()
- Suika.getLayerScaleX()
- Suika.getLayerScaleY()
- Suika.setLayerScale()
- Suika.getLayerRotate()
- Suika.setLayerRotate()
- Suika.getLayerDim()
- Suika.setLayerDim()
- Suika.getLayerAlpha()
- Suika.setLayerAlpha()
- Suika.setLayerBlend()
- Suika.setLayerFileName()
- Suika.setLayerFrame()
- Suika.getLayerText()
- Suika.setLayerText()
- Suika.getSysBtnIdleImage()
- Suika.getSysBtnHoverImage()
- Suika.clearStageBasic()
- Suika.clearStage()
- Suika.chposToLayer()
- Suika.chposToEyeLayer()
- Suika.chposToLipLayer()
- Suika.layerToChpos()
- Suika.renderStage()
- Suika.drawStageToThumb()
- Suika.getThumbImage()
- Suika.getFadeMethod()
- Suika.getAccelMethod()
- Suika.startFade()
- Suika.getShakeOffset()
- Suika.setShakeOffset()
- Suika.isFadeRunning()
- Suika.finishFade()
- Suika.setChNameMapping()
- Suika.getTalkingChpos()
- Suika.setChTalking()
- Suika.getTalkingChpos()
- Suika.updateChDimByTalkingCh()
- Suika.forceChDim()
- Suika.getChDim()
- Suika.updateChDimByTalkingCh()
- Suika.fillMessageBox()
- Suika.showMessageBox()
- [Suika.getMessageBoxRect()](#suikagetmessageboxrect]
- Suika.fillNameBox()
- Suika.showNameBox()
- Suika.getNameBoxRect()
- Suika.showChoosebox()
- Suika.showAutoModeBanner()
- Suika.showSkipModeBanner()
- Suika.renderImage()
- Suika.renderImage3d()
- Suika.setClick位置()
- Suika.showClick()
- [Suika.setClickIndex()](#suikasetclick索引]
- Suika.getClickRect()
- Suika.fillChooseBoxIdleImage()
- Suika.fillChooseBoxHoverImage()
- Suika.getChooseBoxRect()
- Suika.startKirakira()
- Suika.renderKirakira()
- 混音器
- Suika.setMixerInputFile()
- Suika.setMixerVolume()
- Suika.getMixerVolume()
- Suika.setMasterVolume()
- Suika.getMasterVolume()
- Suika.setMixerGlobalVolume()
- Suika.getMixerGlobalVolume()
- Suika.setCharacterVolume()
- Suika.getCharacterVolume()
- Suika.isMixerSoundFinished()
- Suika.getTrackFileName()
- Suika.applyCharacterVolume()
- 系统按钮
- 文本
- 标签
- Suika.getTagCount()
- Suika.moveToTagFile()
- Suika.moveToTagIndex()
- Suika.moveToNextTag()
- Suika.moveToLabelTag()
- Suika.moveToMacroTag()
- Suika.moveToElseTag()
- Suika.moveToEndIfTag()
- Suika.moveToEndMacroTag()
- Suika.getTagFileName()
- Suika.getTagName()
- Suika.getTagPropertyCount()
- Suika.getTagPropertyName()
- Suika.getTagPropertyValue()
- Suika.getTagArgBool()
- Suika.getTagArgInt()
- Suika.getTagArgFloat()
- Suika.getTagArgString()
- Suika.evaluateTag()
- Suika.pushTagStackIf()
- Suika.popTagStackIf()
- Suika.pushTagStackWhile()
- Suika.pushTagStackFor()
- 动画
- Suika.loadAnimeFromFile()
- Suika.newAnimeSequence()
- Suika.addAnimeSequencePropertyF()
- Suika.addAnimeSequencePropertyI()
- Suika.startLayerAnime()
- Suika.isAnimeRunning()
- Suika.isAnimeFinishedForLayer()
- Suika.updateAnimeFrame()
- Suika.loadEyeImageIfExists()
- Suika.reloadEyeAnime()
- Suika.runLipAnime()
- Suika.stopLipAnime()
- Suika.clearLayerAnimeSequence()
- Suika.clearAllAnimeSequence()
- 变量
- Suika.setVariableInt()
- Suika.setVariableFloat()
- Suika.setVariableString()
- Suika.getVariableInt()
- Suika.getVariableFloat()
- Suika.getVariableString()
- Suika.unsetVariable()
- Suika.unsetLocalVariables()
- Suika.makeVariableGlobal()
- Suika.isGlobalVariable()
- Suika.getVariableCount()
- Suika.getVariableName()
- Suika.checkVariableExists()
- Suika.expandStringWithVariable()
- 保存
- Suika.executeSaveGlobal()
- Suika.executeLoadGlobal()
- Suika.executeSaveLocal()
- Suika.executeLoadLocal()
- Suika.checkSaveExists()
- Suika.deleteLocalSave()
- Suika.deleteGlobalSave()
- Suika.checkRightAfterLoad()
- Suika.getSaveTimestamp()
- Suika.getLatestSaveIndex()
- Suika.getSaveChapterName()
- Suika.getSaveLastMessage()
- Suika.getSaveThumbnail()
- 历史
- 已读
- 图形用户界面
- HAL
- Suika.getMillisec()
- Suika.checkFileExists()
- Suika.readFileContent()
- Suika.writeSaveData()
- Suika.readSaveData()
- Suika.installAPI()
- Suika.installTag()
- Suika.getVmInt()
- Suika.setVmInt()
- Suika.callVmFunction()
- Suika.playVideo()
- Suika.stopVideo()
- Suika.isVideoPlaying()
- Suika.isFullScreenSupported()
- Suika.enterFullScreenMode()
- Suika.logInfo()
- Suika.logWarn()
- Suika.logError()
- Suika.speakText()
Suika.loadPlugin()
加载插件。
只有这个 API 接受非字典参数。
参数（直接）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | 插件名称。 |
返回
无返回。
Suika.setConfig()
设置配置。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 配置的键。 |
| 值 | String | 配置的值。 |
返回
无返回。
Suika.getConfigCount()
获取配置键的数量。
参数（字典）
无参数。
返回
代表配置键数量的整数。
Suika.getConfigKey()
获取配置键的索引。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | 配置的索引。 |
返回
代表指定索引处配置键的字符串。
Suika.isGlobalSaveConfig()
检查配置键是否存储到全局保存数据。
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
表示配置是否全局保存的布尔值。
Suika.isLocalSaveConfig()
检查配置键是否存储到本地保存数据。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
表示配置是否本地保存的布尔值。
Suika.getConfigType()
获取配置值类型。("s", "b", "i", "f")
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
以下字符串之一。
| 值 | 含义 |
|---|---|
| "s" | 配置是字符串。 |
| "b" | 配置是布尔值。 |
| "i" | 配置是整数。 |
| "f" | 配置是浮点数。 |
Suika.getStringConfig()
获取字符串配置值。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
配置的字符串值。
Suika.getBoolConfig()
获取布尔配置值。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
配置的布尔值。
Suika.getIntConfig()
获取整数配置值。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
配置的整数值。
Suika.getFloatConfig()
获取浮点配置值。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
配置的浮点值。
Suika.getConfigAsString()
Get a config 值 as a string.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | 键名。 |
返回
Stringified 值 of the config.
Suika.compareLocale()
检查指定的语言环境是否与当前语言环境相同。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| locale | String | Locale 名称. |
返回
表示指定语言环境是否匹配的布尔值 current one.
Suika.getMousePosX()
获取鼠标 X 位置。
参数（字典）
无参数。
返回
代表当前鼠标 X 座标的整数。
Suika.getMousePosY()
获取鼠标 Y 位置。
参数（字典）
无参数。
返回
代表当前鼠标 Y 座标的整数。
Suika.isMouseLeftPressed()
检查鼠标左按钮是否被按下。
参数（字典）
无参数。
返回
表示左按钮是否当前被按住的布尔值.
Suika.isMouseRightPressed()
检查鼠标右按钮是否被按下。
参数（字典）
无参数。
返回
表示右按钮是否当前被按住的布尔值n.
Suika.isMouseLeftClicked()
Check if mouse left button is pressed then released.
参数（字典）
无参数。
返回
Boolean that represents whether a left-click occurred in the current frame.
Suika.isMouseRightClicked()
Check if mouse right button is pressed then released.
参数（字典）
无参数。
返回
Boolean that represents whether a right-click occurred in the current frame.
Suika.isMouseDragging()
Check if mouse is dragging.
参数（字典）
无参数。
返回
Boolean that represents whether the mouse is being moved while a button is pressed.
Suika.isReturnKeyPressed()
Check if return 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isSpaceKeyPressed()
Check if space 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isEscapeKeyPressed()
Check if escape 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isUpKeyPressed()
Check if up 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isDownKeyPressed()
Check if down 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isLeftKeyPressed()
Check if left 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isRightKeyPressed()
Check if right 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isPageUpKeyPressed()
Check if pageup 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isPageDownKeyPressed()
Check if pagedown 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isControlKeyPressed()
Check if control 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isSKeyPressed()
Check if S 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isLKeyPressed()
Check if L 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isHKeyPressed()
Check if H 键 is pressed.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isTouchCanceled()
检查触摸是否被取消。
参数（字典）
无参数。
返回
Boolean 值.
Suika.isSwiped()
Check if swiped.
参数（字典）
无参数。
返回
Boolean 值.
Suika.clearInputState()
Clear input states to avoid further input processing in the current frame.
参数（字典）
无参数。
返回
无返回。
Suika.startCommandRepetition()
Start a multiple-frame command execution.
参数（字典）
无参数。
返回
无返回。
Suika.stopCommandRepetition()
Stop a multiple-frame command execution.
参数（字典）
无参数。
返回
无返回。
Suika.isInCommandRepetition()
Check whether we are in a multiple-frame command execution or not.
参数（字典）
无参数。
返回
Boolean 值.
Suika.setMessageActive()
Set the message showing state to active.
参数（字典）
无参数。
返回
无返回。
Suika.clearMessageActive()
Reset the message showing state.
参数（字典）
无参数。
返回
无返回。
Suika.isMessageActive()
Check whether the message showing state is set or not.
参数（字典）
无参数。
返回
Boolean 值.
Suika.startAutoMode()
Start the auto-mode.
参数（字典）
无参数。
返回
无返回。
Suika.stopAutoMode()
Stop the auto-mode.
参数（字典）
无参数。
返回
无返回。
Suika.isAutoMode()
Check whether we are in the auto-mode or not.
参数（字典）
无参数。
返回
Boolean 值.
Suika.startSkipMode()
Start the skip-mode.
参数（字典）
无参数。
返回
无返回。
Suika.stopSkipMode()
停止跳过模式。
参数（字典）
无参数。
返回
无返回。
Suika.isSkipMode()
检查我们是否在跳过模式中。
参数（字典）
无参数。
返回
Boolean 值.
Suika.setSaveLoad()
设置保存/加载启用设置。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| enable | Boolean | 是否启用保存和加载。 |
返回
无返回。
Suika.isSaveLoadEnabled()
获取保存/加载启用设置。
参数（字典）
无参数。
返回
Boolean 值.
Suika.setNonInterruptible()
Set the non-interruptible mode setting.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| enable | Boolean | Non-interruptible mode. |
返回
无返回。
Suika.isNonInterruptible()
Get the non-interruptible mode setting.
参数（字典）
无参数。
返回
Boolean 值.
Suika.setPenPosition()
Set the pen position for text drawing.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| x | Integer | X coordinate. |
| y | Integer | Y coordinate. |
返回
无返回。
Suika.getPenPositionX()
Get the pen X position.
参数（字典）
无参数。
返回
Integer 值.
Suika.getPenPositionY()
Get the pen Y position.
参数（字典）
无参数。
返回
Integer 值.
Suika.pushForCall()
Push the return point to the call stack.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| file | String | Script file 名称. |
| 索引 | Integer | Command 索引. |
返回
Boolean that represents success or failure.
Suika.popForReturn()
Pop the return point from the call stack.
参数（字典）
无参数。
返回
Returns a dictionary that contains:
- obj.file: File 名称
- obj.索引: Tag 索引
Suika.readCallStack()
Read the call stack element at the specified 索引.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| sp | Integer | Stack element 索引. |
返回
Returns a dictionary that contains:
- obj.file: File 名称
- obj.索引: Tag 索引
Suika.writeCallStack()
Write the call stack element at the specified 索引.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| sp | Integer | Stack element 索引. |
| file | String | Script file 名称. |
| 索引 | Integer | Tag 索引. |
返回
无返回。
Suika.setCallArgument()
Set a calling argument for GUI or anime.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 索引 | Integer | 参数索引。 |
| 值 | String | 参数值。 |
返回
Boolean 值.
Suika.getCallArgument()
Get a calling argument.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 索引 | Integer | 参数索引。 |
返回
String 值.
Suika.isPageMode()
Check if the script page mode is enabled.
参数（字典）
无参数。
返回
返回布尔值。
Suika.appendBufferedMessage()
Append a string to the page mode buffer string.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| message | String | Message. |
返回
无返回。
Suika.getBufferedMessage()
Get the page mode buffer string.
参数（字典）
无参数。
返回
Returns a string.
Suika.clearBufferedMessage()
Clear the page mode buffer string.
参数（字典）
无参数。
返回
无返回。
Suika.resetPageLine()
Reset the message line count in a page.
参数（字典）
无参数。
返回
无返回。
Suika.incPageLine()
Increment the line count in a page.
参数（字典）
无参数。
返回
无返回。
Suika.isPageTop()
Check if we are at the first line in a page.
参数（字典）
无参数。
返回
无返回。
Suika.registerBGVoice()
Register a BGVoice.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| file | String | BGVoice file. |
返回
无返回。
Suika.getBVoice()
Get the BGVoice.
参数（字典）
无参数。
返回
Returns a file 名称 string.
Suika.setBGVoicePlaying()
Set the BGVoice state playing.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| isPlaying | Boolean | State. |
返回
无返回。
Suika.isBGVoicePlaying()
Check if the BGVoice is playing.
参数（字典）
无参数。
返回
返回布尔值。
Suika.setChapterName()
Set the chapter 名称.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | 章节名称。 |
返回
无返回。
Suika.getChapterName()
Get the chapter 名称.
参数（字典）
无参数。
返回
Returns a string.
Suika.setLastMessage()
设置最后一条消息。
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| message | String | Message. |
| isAppend | Boolean | Append or replace. |
返回
无返回。
Suika.getLastMessage()
获取最后一条消息。
参数（字典）
无参数。
返回
Returns a string.
Suika.setTextSpeed()
Set the text speed.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| speed | Float | Text speed. |
返回
无返回。
Suika.getTextSpeed()
Get the text speed.
参数（字典）
无参数。
返回
Returns a float.
Suika.setAutoSpeed()
Set the auto mode speed.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| speed | Float | Auto speed. |
返回
无返回。
Suika.getAutoSpeed()
Get the auto speed.
参数（字典）
无参数。
返回
Returns a float.
Suika.markLastEnglishTagIndex()
Mark the last English 索引.
参数（字典）
无参数。
返回
无返回。
Suika.getLastEnglishTagIndex()
Get the last English 索引.
参数（字典）
无参数。
返回
Returns an integer.
Suika.clearLastEnglishTagIndex()
Clear the last English 索引.
参数（字典）
无参数。
返回
无返回。
Suika.getLastTagName()
Get the last tag 名称.
参数（字典）
无参数。
返回
Returns a string.
Suika.createImageFromFile()
Load an image from a file.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| file | String | Path to the image file. |
返回
An image object, or null on failure.
Suika.createImage()
Create a new blank image.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| width | Integer | 宽度 of the image. |
| height | Integer | 高度 of the image. |
返回
An image object.
Suika.getImage宽度()
获取图像的宽度。
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| img | Object | Image object. |
返回
Integer that represents the width.
Suika.getImage高度()
获取图像的高度。
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| image | Object | Image object. |
返回
Integer that represents the height.
Suika.destroyImage()
Destroy an image and free its memory.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| image | Object | Image object to destroy. |
返回
无返回。
Suika.drawImage()
Copy an image to another image (no blending).
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| dstImage | Object | Destination image. |
| dstLeft | Integer | X coordinate in destination. |
| dstTop | Integer | Y coordinate in destination. |
| srcImage | Object | Source image. |
| dst宽度 | Integer | 宽度 to draw. |
| dst高度 | Integer | 高度 to draw. |
| srcLeft | Integer | X coordinate in source. |
| srcTop | Integer | Y coordinate in source. |
| alpha | Integer | 0-255 |
| blend | Integer | Blending type. |
Blending Types
| Type | Description |
|---|---|
| Suika.BLEND_COPY | Copy. |
| Suika.BLEND_ALPHA | Alpha blending. |
| Suika.BLEND_ADD | Add blending. |
| Suika.BLEND_SUB | Sub blending. |
| Suika.BLEND_DIM | RGB 50% alpha blending. |
| Suika.BLEND_GLYPH | Alpha blending for normal glyphs. |
| Suika.BLEND_EMOJI | Alpha blending for emoji glyphs. |
返回
无返回。
Suika.drawImage3D()
Copy an image to another image (no blending).
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| dstImage | Object | Destination image. |
| x1 | Integer | x1 coordinate in destination. |
| y1 | Integer | y1 coordinate in destination. |
| x2 | Integer | x2 coordinate in destination. |
| y2 | Integer | y2 coordinate in destination. |
| x3 | Integer | x3 coordinate in destination. |
| y3 | Integer | y3 coordinate in destination. |
| x4 | Integer | x4 coordinate in destination. |
| y5 | Integer | y4 coordinate in destination. |
| srcImage | Object | Source image. |
| srcLeft | Integer | X coordinate in source. |
| srcTop | Integer | Y coordinate in source. |
| src宽度 | Integer | 宽度 in source. |
| src高度 | Integer | 高度 in source. |
| alpha | Integer | 0-255 |
| blend | Integer | Blending type. |
Blending Types
| Type | Description |
|---|---|
| Suika.BLEND_ALPHA | Alpha blending. |
| Suika.BLEND_ADD | Add blending. |
| Suika.BLEND_SUB | Sub blending. |
| Suika.BLEND_DIM | RGB 50% alpha blending. |
返回
无返回。
Suika.drawImageAlpha()
Draw an image with alpha blending.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| dstImage | Object | Destination image. |
| dstLeft | Integer | X coordinate in destination. |
| dstTop | Integer | Y coordinate in destination. |
| dst宽度 | Integer | 宽度 to draw. |
| dst高度 | Integer | 高度 to draw. |
| srcImage | Object | Source image. |
| srcLeft | Integer | X coordinate in source. |
| srcTop | Integer | Y coordinate in source. |
| alpha | Integer | Alpha 值 (0-255). |
返回
无返回。
Suika.drawImageAdd()
Draw an image with additive blending.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| dstImage | Object | Destination image. |
| dstLeft | Integer | X coordinate in destination. |
| dstTop | Integer | Y coordinate in destination. |
| dst宽度 | Integer | 宽度 to draw. |
| dst高度 | Integer | 高度 to draw. |
| srcImage | Object | Source image. |
| srcLeft | Integer | X coordinate in source. |
| srcTop | Integer | Y coordinate in source. |
| alpha | Integer | Alpha 值 (0-255). |
返回
无返回。
Suika.drawImageSub()
Draw an image with subtractive blending.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| dstImage | Object | Destination image. |
| dstLeft | Integer | X coordinate in destination. |
| dstTop | Integer | Y coordinate in destination. |
| dst宽度 | Integer | 宽度 to draw. |
| dst高度 | Integer | 高度 to draw. |
| srcImage | Object | Source image. |
| srcLeft | Integer | X coordinate in source. |
| srcTop | Integer | Y coordinate in source. |
| alpha | Integer | Alpha 值 (0-255). |
返回
无返回。
Suika.makeColor()
Create a pixel 值 from RGBA components.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| r | Integer | Red (0-255). |
| g | Integer | Green (0-255). |
| b | Integer | Blue (0-255). |
| a | Integer | Alpha (0-255). |
返回
A pixel 值.
Suika.fillImageRect()
Fill a rectangular area on an image with a color.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| image | Object | Target image. |
| left | Integer | X coordinate. |
| top | Integer | Y coordinate. |
| width | Integer | 宽度. |
| height | Integer | 高度. |
| color | Integer | Color created by Suika.makeColor(). |
返回
无返回。
Suika.reloadStageImages()
Reload the stage images by the config.
参数（字典）
无参数。
返回
Boolean that represents success or failure.
Suika.reloadStage位置s()
Reload the stage positions by the config.
参数（字典）
无参数。
返回
无返回。
Suika.getLayerX()
Get the current position of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
返回
Integer 值 of the coordinate.
Suika.getLayerY()
Get the current position of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
返回
Integer 值 of the coordinate.
Suika.setLayer位置()
Set the position of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| x | Integer | X coordinate. |
| y | Integer | Y coordinate. |
返回
无返回。
Suika.getLayerScaleX()
Get the X scaling factor of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
返回
Float 值 of the scale.
Suika.getLayerScaleY()
Get the Y scaling factor of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
返回
Float 值 of the scale.
Suika.setLayerScale()
Set the scaling factor of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| scale_x | Float | Horizontal scale. |
| scale_y | Float | Vertical scale. |
返回
无返回。
Suika.getLayerRotate()
Get the rotation angle of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
返回
返回浮点数。
Suika.setLayerRotate()
Set the rotation angle of a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| rot | Float | 旋转角度 in radians. |
返回
无返回。
Suika.getLayerDim()
获取特定图层的昏暗状态。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
返回
返回布尔值。
Suika.setLayerDim()
设置特定图层的昏暗状态。
参数（字典） (Set)
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| dim | Boolean | 是否昏暗图层。 |
返回
无返回。
Suika.getLayerAlpha()
获取特定图层的透明度。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
返回
返回整数。
Suika.setLayerAlpha()
设置特定图层的透明度。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| alpha | Integer | Alpha 值 (0-255). |
返回
无返回。
Suika.setLayerBlend()
Set the blending mode for a layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| blend | Integer | Blend mode (Alpha, Add, Sub). |
返回
无返回。
Suika.setLayerFile()
Set a file to be displayed on a layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| file_名称 | String | Path to the image file. |
返回
Boolean that represents success or failure.
Suika.setLayerFrame()
Set the frame 索引 for eye blinking and lip synchronization.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | 舞台图层的索引。 |
| frame | Integer | Frame 索引. |
返回
无返回。
Suika.getLayerText()
Get the string displayed on a text layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the text layer. |
返回
返回字符串。
Suika.setLayerText()
Set the string displayed on a text layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the text layer. |
| text | String | Text message to set. |
返回
无返回。
Suika.getSysBtnIdleImage()
Get the sysbtn idle image.
参数（字典）
无参数。
返回
Returns an image object.
Suika.getSysBtnHoverImage()
Get the sysbtn hover image.
参数（字典）
无参数。
返回
Returns an image object.
Suika.clearStageBasic()
Clear the basic layers.
参数（字典）
无参数。
返回
Returns an image object.
Suika.clearStage()
Clear the stage and make it initial state.
参数（字典）
无参数。
返回
Returns an image object.
Suika.chposToLayer()
Convert a character position to a stage layer 索引.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| chpos | Integer | 字符位置。 |
返回
Returns an integer.
Suika.chposToEyeLayer()
Convert a character position to a stage layer 索引 (character eye).
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| chpos | Integer | 字符位置。 |
返回
Returns an integer.
Suika.chposToLipLayer()
Convert a character position to a stage layer 索引 (character lip).
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| chpos | Integer | 字符位置。 |
返回
Returns an integer.
Suika.layerToChpos()
Convert a stage layer 索引 to a character position.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| layer | Integer | 图层索引。 |
返回
Returns an integer.
Suika.renderStage()
Render the stage with all stage layers.
参数（字典）
无参数。
返回
无返回。
Suika.startFade()
Start a transition effect.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| desc | Array | Fade descriptor. |
| method | String | Fading method. |
| time | Float | Duration in seconds. |
| ruleImage | Object | Rule image object (optional). |
返回
Boolean 值.
Suika.getShakeOffset()
Get the offset for the shake command.
参数（字典）
无参数。
返回
An object that contains:
- x
- y
Suika.setShakeOffset()
Set the offset for the shake command.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| x | Integer | X offset. |
| y | Integer | Y offset. |
返回
无返回。
Suika.isFadeRunning()
Check if the fading is running.
参数（字典）
无参数。
返回
Boolean 值.
Suika.finishFade()
Immediately end the fading effect.
参数（字典）
无参数。
返回
无返回。
Suika.setChNameMapping()
Specify a character 名称 索引 for a character position.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| chpos | Integer | 字符位置。 |
| chNameIndex | Integer | Character 名称 索引. |
返回
无返回。
Suika.getTalkingChpos()
Get the position of the character currently speaking.
参数（字典）
无参数。
返回
Returns an integer.
Suika.setChTalking()
设置正在说话的字符。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| chpos | Integer | 字符位置。 |
返回
无返回。
Suika.getTalkingChpos()
Get the talker character position.
参数（字典）
无参数。
返回
Returns an integer.
Suika.updateChDimByTalkingCh()
Automatically update character dimming based on who is speaking.
参数（字典）
无参数。
返回
无返回。
Suika.forceChDim()
Update the character dimming manually.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| chpos | Integer | 字符位置。 |
| dim | Boolean | Dim or not. |
返回
无返回。
Suika.getChDim()
Get the dimming state.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| chpos | Integer | 字符位置。 |
返回
Returns a boolean.
Suika.fillNameBox()
Fill the 名称 box by the 名称 box image.
参数（字典）
无参数。
返回
无返回。
Suika.getNameBoxRect()
Get the 名称 box position and size.
参数（字典）
无参数。
返回
Object.
- x
- y
- w
- h
Suika.showNameBox()
Show or hides the 名称 box.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| show | Boolean | Show or hide. |
返回
无返回。
Suika.fillMessageBox()
Fill the message box by the message box image.
参数（字典）
无参数。
返回
无返回。
Suika.showMessageBox()
Show or hide the message box.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| show | Boolean | Whether to show the box. |
返回
无返回。
Suika.getMessageBoxRect()
Get the message box rect.
参数（字典）
无参数。
返回
An object that contains:
xywh
Suika.setClick位置()
Set the click animation position.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| x | Integer | X 位置。 |
| y | Integer | Y 位置。 |
返回
无返回。
Suika.showClick()
Show or hide the click animation.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| show | Boolean | Show or hide. |
返回
无返回。
Suika.setClickIndex()
Set the 索引 of the click animation frame.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Frame 索引. |
返回
无返回。
Suika.getClickRect()
Get the click animation rect.
参数（字典）
无参数。
返回
An object that contains:
xywh
Suika.fillChooseBoxIdleImage()
Fill a choose box idle layer by the choose box idle image.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Choose box 索引. |
返回
无返回。
Suika.fillChooseBoxHoverImage()
Fill a choose box hover layer by the choose box hover image.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Choose box 索引. |
返回
无返回。
Suika.showChoosebox()
Show or hide a choice box.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 索引 | Integer | Choice box 索引. (0-7) |
| showIdle | Boolean | Show idle state. |
| showHover | Boolean | Show hover state. |
返回
无返回。
Suika.getChooseBoxRect()
Get the choose box rect.
参数（字典）
无参数。
返回
An object that contains:
xywh
Suika.showAutoModeBanner()
Show or hide the auto mode banner.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| show | Boolean | Show or hide. |
返回
无返回。
Suika.showSkipModeBanner()
Show or hide the skip mode banner.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| show | Boolean | Show or hide. |
返回
无返回。
Suika.renderImage()
Perform direct rendering of an image to the screen.
Note that you should consider using the stage layers for normal rendering. This API is useful for effects.
参数（字典）
| Parameter | Omissible | Type | Description |
|---|---|---|---|
| dstLeft | No | Integer | Destination top-left X position. |
| dstTop | No | Integer | Destination top-left Y position. |
| image | No | Object | Image. |
| srcLeft | No | Integer | Source top-left X position. |
| srcTop | No | Integer | Source top-left Y position. |
| src宽度 | No | Integer | Source width. |
| src高度 | No | Integer | Source height. |
| alpha | No | Integer | Alpha 值. (0-255) |
| blend | No | Integer | Blend type. |
Blend Types
| Name | Description |
|---|---|
| Suika.BLEND_ALPHA | Alpha blending. |
| Suika.BLEND_ADD | Add blending. |
| Suika.BLEND_SUB | Sub blending. |
返回
无返回。
Suika.renderImage3d()
Perform direct rendering of an image to the screen with 3D transformation.
Note that you should consider using the stage layers for normal rendering. This API is useful for effects.
参数（字典）
| Parameter | Omissible | Type | Description |
|---|---|---|---|
| x1 | No | Integer | Destination vertex 1 X position. |
| y1 | No | Integer | Destination vertex 1 Y position. |
| x2 | No | Integer | Destination vertex 2 X position. |
| y2 | No | Integer | Destination vertex 2 Y position. |
| x3 | No | Integer | Destination vertex 3 X position. |
| y3 | No | Integer | Destination vertex 3 Y position. |
| x4 | No | Integer | Destination vertex 4 X position. |
| y4 | No | Integer | Destination vertex 4 Y position. |
| tex | No | Object | Image. |
| srcLeft | No | Integer | Source top-left X position. |
| srcTop | No | Integer | Source top-left Y position. |
| src宽度 | No | Integer | Source width. |
| src高度 | No | Integer | Source height. |
| alpha | No | Integer | Alpha 值. (0-255) |
返回
无返回。
Suika.startKirakira()
Start Kirakira effect.
Kirakira effect is an animation that is shown at the screen position where the mouse cursor is clicked.
参数（字典）
无参数。
返回
无返回。
Suika.renderKirakira()
Render Kirakira effect.
Suika.setMixerInputFile()
Play a sound file on a specific mixer track.
参数（字典）
| Parameter | Omissible | Type | Description |
|---|---|---|---|
| track | No | String | Mixer track 名称. |
| file | No | String | Path to the sound file. |
| isLooped | Yes(false) | Boolean | Whether to loop the playback. |
Track Names
| Name | Description |
|---|---|
| bgm | Background music track. |
| se | Sound effect track. |
| voice | Character voice track. |
| sys | System sound track. |
返回
Boolean that represents whether the file was opened successfully.
Suika.setMixerVolume()
Set the volume for a specific mixer track.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| track | String | Mixer track 名称. |
| vol | Float | 音量级别 (0.0 to 1.0). |
| span | Float | Fade duration in seconds. |
Track Names
| Name | Description |
|---|---|
| bgm | Background music track. |
| se | Sound effect track. |
| voice | Character voice track. |
| sys | System sound track. |
返回
无返回。
Suika.getMixerVolume()
Get the volume for a specific mixer track.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| track | String | Mixer track 名称. |
| volume | Float | 音量级别 (0.0 to 1.0). |
| span | Float | Fade duration in seconds. |
Track Names
| Name | Description |
|---|---|
| bgm | Background music track. |
| se | Sound effect track. |
| voice | Character voice track. |
| sys | System sound track. |
返回
返回浮点数。
Suika.setMasterVolume()
Set the master volume affecting all tracks.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| volume | Float | 主音量 level (0.0 to 1.0). |
返回
无返回。
Suika.getMasterVolume()
Get the master volume affecting all tracks.
参数（字典）
无参数。
返回
返回浮点数。
Suika.setMixerGlobalVolume()
Set the global volume for a track (often used for config settings).
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| track | String | Mixer track 名称. |
| vol | Float | 全局音量 level. |
Track Names
| Name | Description |
|---|---|
| bgm | Background music track. |
| se | Sound effect track. |
| voice | Character voice track. |
| sys | System sound track. |
返回
无返回。
Suika.getMixerGlobalVolume()
Get the global volume for a track (often used for config settings).
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| track | String | Mixer track 名称. |
Track Names
| Name | Description |
|---|---|
| bgm | Background music track. |
| se | Sound effect track. |
| voice | Character voice track. |
| sys | System sound track. |
返回
返回浮点数。
Suika.setCharacterVolume()
Set the volume for a specific character's voice.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Character 名称 索引. |
| vol | Float | 音量级别. |
返回
无返回。
Suika.getCharacterVolume()
获取特定字符声音的音量。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| ch_索引 | Integer | Character 名称 索引. |
返回
返回浮点数。
Suika.isMixerSoundFinished()
检查特定轨道上的播放是否已完成。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| track | Integer | Mixer track 索引. |
返回
Boolean 值.
Suika.getTrackFileName()
Get the file 名称 of the sound currently loaded in a track.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| track | Integer | Mixer track 索引. |
返回
String representing the file path.
Suika.applyCharacterVolume()
Apply a character's specific volume setting to the VOICE track.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| ch | Integer | Character 名称 索引. |
返回
无返回。
Suika.enableSysBtn()
Control the system button.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| isEnabled | Boolean | Enable the system button or not. |
返回
无返回。
Suika.isSysBtnEnabled()
Check if the system button is enabled.
Parameters
无参数。
返回
Returns a boolean 值.
Suika.updateSysBtnState()
Update the mouse tracking for the system button.
Parameters
无参数。
返回
无返回。
Suika.isSysBtnPointed()
Check if the system button is pointed.
Parameters
无参数。
返回
Returns a boolean 值.
Suika.isSysBtnClicked()
Check if the system button is clicked.
Parameters
无参数。
返回
Returns a boolean 值.
Suika.drawTextOnLayer()
Draw a text on a specified layer.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| layer | Integer | Target stage layer 索引. |
| fontType | Integer | Font selection 索引. |
| fontSize | Integer | Size of the font. |
| color | Integer | Color. |
| outline宽度 | Integer | Outline width. |
| outlineColor | Integer | Outline color. |
| lineMargin | Integer | Line margin. |
| charMargin | Integer | Character margin. |
| x | Integer | Bounding box X position. |
| y | Integer | Bounding box Y position. |
| width | Integer | Bounding box width. |
| height | Integer | Bounding box height. |
| text | String | Text. |
返回
无返回。
Suika.getString宽度()
Get the total width of a UTF-8 string.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| fontType | Integer | Font selection 索引. |
| fontSize | Integer | Size of the font. |
| text | String | Text. |
返回
Integer 值 of the width in pixels.
Suika.getString高度()
Get the total height of a UTF-8 string.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| fontType | Integer | Font selection 索引. |
| fontSize | Integer | Size of the font. |
| text | String | Text. |
返回
Integer 值 of the height in pixels.
Suika.drawGlyph()
绘制单个字形 onto an image.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| img | Object | Target image. |
| font_type | Integer | Font selection 索引. |
| font_size | Integer | Rendering font size. |
| base_font_size | Integer | Base font size for metrics. |
| outline_size | Integer | 宽度 of the outline. |
| x | Integer | X coordinate. |
| y | Integer | Y coordinate. |
| color | Pixel | Main text color. |
| outline_color | Pixel | Outline color. |
| codepoint | Integer | UTF-32 code point. |
| is_dim | Boolean | Whether to apply dimming. |
返回
Boolean that represents success.
Suika.createDrawMsg()
Create a complex message drawing context for high-level text rendering.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| image | Integer | Destination image. |
| text | String | Message to draw. |
| fontType | Integer | Font selection. |
| fontSize | Integer | Font size. |
| baseFontSize | Integer | Base font size. |
| rubySize | Integer | Ruby size. |
| outlineSize | Integer | Outline width. |
| penX | Integer | Pen X position. |
| penY | Integer | Pen Y position. |
| area宽度 | Integer | Draw area width. |
| area高度 | Integer | Draw area height. |
| leftMargin | Integer | Left margin. |
| rightMargin | Integer | Right margin. |
| topMargin | Integer | Top margin. |
| bottomMargin | Integer | Bottom margin. |
| lineMargin | Integer | Line margin. |
| charMargin | Integer | Character margin. |
| color | Integer | Color. |
| outlineColor | Integer | Outline color. |
| bgColor | Integer | Background color. |
| fillBg | Boolean | Fill background? |
| dim | Boolean | Dim? |
| ignoreLF | Boolean | Ignore LF? |
| ignoreFont | Boolean | Ignore font change? |
| ignoreOutline | Boolean | Ignore outline change? |
| ignoreColor | Boolean | Ignore color change? |
| ignoreSize | Boolean | Ignore size change? |
| ignore位置 | Boolean | Ignore cursor change? |
| ignoreRuby | Boolean | Ignore ruby? |
| ignoreWait | Boolean | Ignore inline wait? |
| inlineWaitHook | Function | Inline wait hook. |
| tategaki | Boolean | Use tategaki? |
返回
A message drawing context object.
Suika.destroyDrawMsg()
Destroy a message drawing context.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| context | Object | Draw message context. |
返回
无返回。
Suika.countDrawMsgChars()
Count the remaining characters excluding escape sequences.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| context | Object | Draw message context. |
返回
Returns an integer.
Suika.drawMessage()
Draw characters in a message up to (maxChars) characters.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| context | Object | Draw message context. |
| maxChars | Integer | Max chars. |
返回
Returns an integer that indicates the count of characters drawn in the call.
Suika.getDrawMsgPenPosition()
Get the current pen position from a drawing context.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| context | Object | Drawing context. |
返回
An object containing x and y.
Suika.isEscapeSequenceChar()
Check if a character is part of an escape sequence.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| c | String | Character to check. |
返回
Boolean 值.
Suika.moveToTagFile()
Load a new tag file and move the execution point to its beginning.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| file | String | Path to the .novel or script file. |
返回
Boolean that represents success or failure.
Suika.getTagCount()
Get the total number of tags in the current script file.
参数（字典）
无参数。
返回
Integer representing the tag count.
Suika.moveToTagIndex()
Move the execution pointer to a specific tag 索引.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Target tag 索引. |
返回
Boolean 值.
Suika.moveToNextTag()
Move the execution pointer to the very next tag.
参数（字典）
无参数。
返回
Boolean 值.
Suika.moveToLabelTag()
Jump to a specific label.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Target label 名称. |
返回
Boolean 值.
Suika.moveToMacroTag()
Jump to a specific macro by 名称.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Target macro 名称. |
返回
Boolean 值.
Suika.moveToElseTag()
Jump to a correspoinding else/elseif/endif tag.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Target macro 名称. |
返回
Boolean 值.
Suika.moveToEndIfTag()
Jump to a correspoinding endif tag.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Target macro 名称. |
返回
Boolean 值.
Suika.moveToEndMacroTag()
Jump to a correspoinding endmacro tag.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Target macro 名称. |
返回
Boolean 值.
Suika.getTagFileName()
Get the current script file 名称 current tag.
参数（字典）
无参数。
返回
String representing the file 名称.
Suika.getTagName()
获取当前标签的名称。
参数（字典）
无参数。
返回
String representing the tag 名称.
Suika.getTagPropertyCount()
Get the number of the properties of the current tag.
参数（字典）
无参数。
返回
String representing the 名称 or 值.
Suika.getTagPropertyName()
Iterate through and retrieve the properties (arguments) of the current tag.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 索引 | Integer | Property 索引. |
返回
String representing the 名称.
Suika.getTagPropertyValue()
Iterate through and retrieve the properties (arguments) of the current tag.
参数（字典） (for PropertyName/Value)
| Parameter | Type | Description |
|---|---|---|
| 索引 | Integer | Property 索引. |
返回
String representing the 值.
Suika.getTagArgBool()
Get a specific argument of the current tag, with support for default 值s and optionality.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the argument. |
| omissible | Boolean | Whether the argument is optional. |
| defVal | Boolean | Default 值 if missing. |
返回
The 值 of the argument in the requested type.
Suika.getTagArgInt()
Get a specific argument of the current tag, with support for default 值s and optionality.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the argument. |
| omissible | Boolean | Whether the argument is optional. |
| defVal | Integer | Default 值 if missing. |
返回
The 值 of the argument in the requested type.
Suika.getTagArgFloat()
Get a specific argument of the current tag, with support for default 值s and optionality.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the argument. |
| omissible | Boolean | Whether the argument is optional. |
| defVal | Float | Default 值 if missing. |
返回
The 值 of the argument in the requested type.
Suika.getTagArgString()
Get a specific argument of the current tag, with support for default 值s and optionality.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the argument. |
| omissible | Boolean | Whether the argument is optional. |
| defVal | String | Default 值 if missing. |
返回
The 值 of the argument in the requested type.
Suika.evaluateTag()
Evaluate the property 值s of the current tag to expand inline
variables. (${var名称} form)
Calling this API updates the cache for the property 值s.
参数（字典）
无参数。
返回
Boolean 值.
Suika.pushTagStackIf()
Manage the internal stack for [if] conditional blocks.
This API marks the if block position for nested block processing.
参数（字典）
无参数。
返回
无返回。
Suika.popTagStackIf()
Manage the internal stack for if conditional blocks.
This API marks the end of if block for nested block processing.
参数（字典）
无参数。
返回
无返回。
Suika.pushTagStackWhile()
Manage the internal stack for loops (while).
This API marks the while block for nested block processing.
参数（字典）
无参数。
返回
Boolean 值.
Suika.popTagStackWhile()
Manage the internal stack for loops (while).
This API marks the end of while block for nested block processing.
参数（字典）
无参数。
返回
Boolean 值.
Suika.pushTagStackFor()
Manage the internal stack for loops (for).
This API marks the for block for nested block processing.
参数（字典）
无参数。
返回
Boolean 值.
Suika.popTagStackFor()
Manage the internal stack for loops (for).
This API marks the end of for block for nested block processing.
参数（字典）
无参数。
返回
Boolean 值.
Suika.loadAnimeFromFile()
Load an animation definition from a file and register it.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| file | String | Path to the anime file. |
| reg_名称 | String | Registration 名称 for the anime. |
返回
An array of boolean that indicate each layer is loaded or not.
Suika.newAnimeSequence()
Begin describing a new animation sequence for a specific layer. This API is used for manually generated animations.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | Target stage layer 索引. |
返回
Boolean that represents success.
Suika.addAnimeSequencePropertyF()
Add a float property (e.g., position, alpha) to the current anime sequence. This API is used for manually generated animations.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | Property 键 (e.g., "x", "y", "a"). |
| val | Float | Target 值. |
返回
Boolean 值.
Suika.addAnimeSequencePropertyI()
Add an integer property (e.g., position, alpha) to the current anime sequence. This API is used for manually generated animations.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | Property 键 (e.g., "x", "y", "a"). |
| val | Integer | Target 值. |
返回
Boolean 值.
Suika.startLayerAnime()
Start the registered animation sequence for a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | Target stage layer 索引. |
返回
Boolean 值.
Suika.isAnimeRunning()
Check the overall animation status.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isAnimeFinishedForLayer()
Check if a specific layer's animation has ended.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | Target stage layer 索引. |
返回
Boolean 值.
Suika.updateAnimeFrame()
Update the animation frame state. Usually called once per frame.
参数（字典）
无参数。
返回
无返回。
Suika.loadEyeImageIfExists()
Manage eye-blinking (eye-patch) image and animation for a character position.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| chpos | Integer | Character position (Left, Center, etc.). |
| file | String | Path to the eye image file. |
返回
Boolean 值.
Suika.reloadEyeAnime()
Restart the eye-blinking (eye-patch) animation for a character position.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| chpos | Integer | Character position (Left, Center, etc.). |
返回
Boolean 值.
Suika.runLipAnime()
Start lip-sync animation based on the message content for a character.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| chpos | Integer | 字符位置。 |
| text | String | The message text to sync with. |
返回
无返回。
Suika.stopLipAnime()
Stop lip-sync animation.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| chpos | Integer | 字符位置。 |
返回
无返回。
Suika.clearLayerAnimeSequence()
Clear animation sequences for a specific layer.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| layer | Integer | Target stage layer 索引. |
返回
无返回。
Suika.clearAllAnimeSequence()
Clear animation sequences for all layers.
参数（字典）
无参数。
返回
无返回。
Suika.setVariableInt()
Set a 值 to a local or global variable.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Name of the variable. |
| 值 | Integer | Value to set |
返回
Boolean that represents success or failure.
Suika.setVariableFloat()
Set a 值 to a local or global variable.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Name of the variable. |
| 值 | Float | Value to set |
返回
Boolean that represents success or failure.
Suika.setVariableString()
Set a 值 to a local or global variable.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Name of the variable. |
| 值 | String | Value to set |
返回
Boolean that represents success or failure.
Suika.getVariableInt()
Get the current 值 of a variable.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the variable. |
返回
The 值 of the variable in integer.
Suika.getVariableFloat()
Get the current 值 of a variable.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the variable. |
返回
The 值 of the variable in float.
Suika.getVariableString()
Get the current 值 of a variable.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the variable. |
返回
The 值 of the variable in string
Suika.unsetVariable()
取消设置 (delete) a specific variable.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the variable to unset. |
返回
无返回。
Suika.unsetLocalVariables()
取消设置 (delete) all local variables.
参数（字典）
无参数。
返回
无返回。
Suika.makeVariableGlobal()
Set a variable to be global (persistent across saves).
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the variable. |
| is_global | Boolean | Whether to make it global. |
返回
Boolean 值.
Suika.isGlobalVariable()
Check the variable's global status.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name of the variable. |
返回
Boolean 值.
Suika.getVariableCount()
Get the number of variables.
参数（字典）
无参数。
返回
Integer for count.
Suika.getVariableName()
Iterate through the registered variables.
参数（字典） (for getVariableName)
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the variable. |
返回
String for 名称.
Suika.checkVariableExists()
Check if a variable with the specified 名称 exists.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 名称 | String | Name to check. |
返回
Boolean 值.
Suika.executeSaveGlobal()
Execute a global save. Global data typically includes persistent settings.
参数（字典）
无参数。
返回
Boolean that represents success or failure.
Suika.executeLoadGlobal()
Execute a global load. Global data typically includes persistent settings.
参数（字典）
无参数。
返回
Boolean that represents success or failure.
Suika.executeSaveLocal()
Save the game progress to a specific slot.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
Boolean that represents success or failure.
Suika.executeLoadLocal()
Load game progress from a specific slot.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
Boolean that represents success or failure.
Suika.checkSaveExists()
Check if the save data exists for the specified slot 索引.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
Boolean 值.
Suika.deleteLocalSave()
Delete a local save slot.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
无返回。
Suika.deleteGlobalSave()
Delete the entire global save data.
参数（字典）
无参数。
返回
无返回。
Suika.checkRightAfterLoad()
Check if the current frame is immediately following a successful load operation.
参数（字典）
无参数。
返回
Boolean 值.
Suika.getSaveTimestamp()
Get the timestamp (Unix time) when the save data was created.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
Integer (timestamp).
Suika.getLatestSaveIndex()
Get the 索引 of the most recently updated save slot.
参数（字典）
无参数。
返回
Integer representing the slot 索引.
Suika.getSaveChapterName()
Retrieve the chapter title stored in a save slot.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
String representing the chapter 名称.
Suika.getSaveLastMessage()
Retrieve the last displayed message stored in a save slot.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
String representing the message.
Suika.getSaveThumbnail()
Get the thumbnail image associated with a save slot.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index of the save slot. |
返回
An image object.
Suika.clearHistory()
Clear all messages from the history (backlog).
参数（字典）
无参数。
返回
无返回。
Suika.addHistory()
Add a new entry to the history.
参数（字典）
| Parameter | Type | Description |
|---|---|---|
| 名称 | String | Character 名称. |
| 消息 | String | 消息文本。 |
| voice | String | Path to the voice file. |
| bodyColor | Integer | Body color. |
| bodyOutlineColor | Integer | Body outline color. |
| 名称Color | Integer | Name color. |
| 名称OutlineColor | Integer | Name outline color. |
返回
Boolean that represents success.
Suika.getHistoryCount()
Get the total number of entries currently in the history.
参数（字典）
无参数。
返回
Integer representing the history count.
Suika.getHistoryName()
Retrieve the 名称 at a specific history 索引.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index in the history. |
返回
String 值.
Suika.getHistoryMessage()
Retrieve the message at a specific history 索引.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index in the history. |
返回
String 值.
Suika.getHistoryVoice()
Retrieve the voice path at a specific history 索引.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 索引 | Integer | Index in the history. |
返回
String 值.
Suika.loadSeen()
Load the seen (read) flags for the current script file.
参数（字典）
无参数。
返回
Boolean that represents success.
Suika.saveSeen()
Save the seen (read) flags for the current script file.
参数（字典）
无参数。
返回
Boolean that represents success.
Suika.getSeenFlags()
Get the seen status for the current tag.
参数（字典）
无参数。
返回
Get returns Integer.
For a [text] tag, 0 means unread and 1 means read.
For a [choose] tag, each bit indicates the option is selected before.
Suika.setSeenFlags()
Set the seen status for the current tag.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| flag | Integer | Seen status flag. |
返回
无返回。
Suika.loadGUIFile()
Load a GUI definition file and prepare it for execution.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| file | String | Path to the .gui file. |
| sys | Boolean | Whether it's a system GUI (Save/Load/etc). |
What is System GUI
System GUI is typically called when [text] or [choose] is running,
and the control will return to the interrupted tag.
返回
Boolean that represents success or failure.
Suika.startGUI()
Start the loaded GUI.
参数（字典）
无参数。
返回
无返回。
Suika.stopGUI()
Stop the currently running GUI.
参数（字典）
无参数。
返回
无返回。
Suika.isGUIRunning()
Check if a GUI is currently active.
参数（字典）
无参数。
返回
Boolean 值.
Suika.isGUIFinished()
Check if a GUI has completed its operation.
参数（字典）
无参数。
返回
Boolean 值.
Suika.getGUIResultLabel()
Get the label of the button that was selected to finish the GUI.
参数（字典）
无参数。
返回
String representing the result label.
Suika.isGUIResultTitle()
Check if the GUI was closed with a "back to title" action.
参数（字典）
无参数。
返回
Boolean 值.
Suika.checkIfSavedInGUI()
Check if a save operation was performed while the GUI was active.
参数（字典）
无参数。
返回
Boolean 值.
Suika.checkIfLoadedInGUI()
Check if a load operation was performed while the GUI was active.
参数（字典）
无参数。
返回
Boolean 值.
Suika.checkRightAfterSysGUI()
Check if the current frame is immediately following a return from a system GUI.
参数（字典）
无参数。
返回
Boolean 值.
Suika.getMillisec()
Get a lap time since the time origin in milliseconds.
参数（字典）
无参数。
返回
Integer in milliseconds.
Suika.checkFileExists()
Check if a file exists.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| file | String | Path to the file. |
返回
返回布尔值。
Suika.readFileContent()
Read an entire file content.
参数（字典） (for readFileContent)
| 参数 | 类型 | 说明 |
|---|---|---|
| file | String | Path to the file. |
返回
Returns a string.
Suika.writeSaveData()
Directly write raw save data associated with a 键.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | Unique 键 for the data. |
| data | String | Data to write/read. |
返回
Boolean that represents success or failure.
Suika.readSaveData()
Directly read raw save data associated with a 键.
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 键 | String | Unique 键 for the data. |
返回
Boolean that represents success or failure.
Suika.playVideo()
Control video playback.
参数（字典） (for playVideo)
| Parameter | Type | Description |
|---|---|---|
| file | String | Path to the video file. |
| is_skippable | Boolean | Whether the user can skip the video. |
返回
Play 返回布尔值；IsPlaying 返回布尔值。
Suika.stopVideo()
停止视频播放。
参数（字典）
无参数。
返回
无返回。
Suika.isVideoPlaying()
检查视频是否正在播放。
参数（字典）
无参数。
返回
返回布尔值。
Suika.isFullScreenSupported()
检查全屏模式能力。
参数（字典）
无参数。
返回
布尔值。
Suika.enterFullScreenMode()
进入全屏模式。
参数（字典）
无参数。
返回
无返回。
Suika.speakText()
执行给定消息的文本到语音(TTS)。
参数（字典）
| 参数 | 类型 | 说明 |
|---|---|---|
| 消息 | String | 要朗读的文本。 |
返回
无返回。