Skip to content

角色函数

characterDance(character:String)

让一个角色跳待机舞蹈。

  • character - 要使用的角色类型;可以是:boyfrienddadgf

setCharacterX(type:String, value:Float)

将角色组的当前 x 位置值 设置为一个新值。 这也会将来自同一类型的所有预缓存角色移动到您想要的位置。

  • type - 要使用的角色类型;可以是:boyfrienddadgf
  • value - 角色位置的新的 x 值。

setCharacterY(type:String, value:Float)

将角色组的当前 y 位置值 设置为一个新值。 这也会将来自同一类型的所有预缓存角色移动到您想要的位置。

  • type - 要使用的角色类型;可以是:boyfrienddadgf
  • value - 角色位置的新的 y 值。

getCharacterX(type:String)

获取角色组的当前 x 位置值;返回一个 float 数字。

  • type - 要使用的角色类型;可以是:boyfrienddadgf

getCharacterY(type:String)

获取角色组的当前 y 位置值;返回一个 float 数字。

  • type - 要使用的角色类型;可以是:boyfrienddadgf

精准度条函数

addScore(value:Int = 0)

value 参数添加到当前的 歌曲总分 并重新计算评级;默认值:0

addMisses(value:Int = 0)

value 参数添加到当前的 歌曲失误总数 并重新计算评级;默认值:0

addHits(value:Int = 0)

value 参数添加到当前的 歌曲击中总数 并重新计算评级;默认值:0

addHealth(value:Float = 0)

value 参数添加到当前的 歌曲生命值总数;默认值:0


setScore(value:Int = 0)

使用新值设置当前 歌曲总分value 参数并重新计算评级;默认值:0

setMisses(value:Int = 0)

使用新值设置当前 歌曲失误总数value 参数并重新计算评级;默认值:0

setHits(value:Int = 0)

使用新值设置当前 歌曲击中总数value 参数并重新计算评级;默认值:0

setHealth(value:Int = 0)

使用新值设置当前 歌曲生命值总数value 参数;默认值:0


setRatingPercent(value:Float)

将当前的 评级百分比 设置为一个新值,以防您想进行自己的评级计算。

  • value - 新的精度评级百分比,范围从 01

setRatingName(value:String)

将当前的 评级名称 设置为一个新值,以防您想进行自己的评级计算。

  • value - 新的评级字符串名称。

setRatingFC(value:String)

将当前的 评级连击名称 设置为一个新值。

  • value - 新的评级连击名称。

getScore()

获取当前的 歌曲总分 当前值;返回一个 int 数字。

getMisses()

获取当前的 歌曲失误总数 当前值;返回一个 int 数字。

getHits()

获取当前的 歌曲击中总数 当前值;返回一个 int 数字。

getHealth()

获取当前的 歌曲生命值总数 当前值;返回一个 float 数字。


相机函数

cameraSetTarget(target:String)

使 相机聚焦 于目标。

  • target - 要瞄准的角色类型;可以是:boyfrienddad

cameraShake(camera:String, intensity:Float, duration:Float)

使 相机抖动

  • camera - 要设置的相机状态;可以是:camGamecamHUDcamOther
  • intensity - 相机抖动的强度,建议值为 0.05
  • duration - 相机抖动的持续时间。

cameraFlash(camera:String, color:String, duration:Float, forced:Bool)

使 相机闪光

  • camera - 要设置的相机状态;可以是:camGamecamHUDcamOther
  • color - 闪光的颜色。
  • duration - 相机闪光的持续时间。
  • forced - 如果设置为 true,如果当前已经有闪光发生,则闪光将重新开始。

cameraFade(camera:String, color:String, duration:Float, forced:Bool)

使 相机淡入颜色

  • camera - 要设置的相机状态;可以是:camGamecamHUDcamOther
  • color - 淡入的颜色。
  • duration - 相机淡入的持续时间。
  • forced - 如果设置为 true,如果当前已经有淡入发生,则淡入将重新开始。

对话/过场动画函数

startDialogue(dialogueFile:String, music:String = null)

启动 对话内容,它将加载相对于 data/your-song-name/ 文件夹的 json 文件。 当 对话结束 时,将根据您开始对话的位置调用 startCountdown()endSong() 函数。

如果 对话行已完成,则将调用 onNextDialogue()。 如果它被 跳过,则将调用 onSkipDialogue()

  • dialogueFile - 对话 json 文件的名称。
  • music - 可选参数,要播放的 ogg 音乐文件;必须相对于 mods/musicassets/music 文件夹;默认值:nil

startVideo(videoFile:String)

启动 视频

  • videoFile - 视频 mp4 文件的名称;必须相对于 mods/videos 文件夹。

startCountdown()

启动 倒计时,如果您想手动跳过烦人的对话或视频,请使用它。


歌曲函数

loadSong(?name:String = null, ?difficultyNum:Int = -1)

加载一首新歌。

[!WARNING] 如果歌曲的周 json 难度名称与当前名称不同,则无法加载歌曲。

  • name - 可选参数,要加载的歌曲的名称;默认值:nil。(表示它将选择当前的歌曲名称)
  • difficultyNum - 可选参数,歌曲的难度 ID 号;默认值:-1。(表示它将选择歌曲正在播放的当前难度号)

restartSong(?skipTransition:Bool = false)

重新开始歌曲。

  • skipTransition - 可选参数,歌曲重新开始时是否会有过渡;默认值:false

exitSong(?skipTransition:Bool = false)

退出歌曲,可以选择是否使用过渡效果;不要与 endSong() 函数混淆。

  • skipTransition - 可选参数,歌曲退出时是否会有过渡;默认值:false

endSong()

手动结束歌曲。


调试函数

debugPrint(text:Dynamic = '', color:String = 'WHITE')

这将在 屏幕左上角 显示一条调试消息。

  • text - 要显示的文本。
  • color - 可选参数,用来显示文本的指定颜色。

示例:debugPrint("Current boyfriend character: ", getProperty('boyfriend.curCharacter') 这将使用 getProperty() 函数获取当前的 bf 角色,并打印 Current boyfriend character: 'bf'

close()

停止使用此函数的脚本。建议将其放在 舞台脚本 上,因为它们通常不再使用;如果脚本需要不断更新或有不断更新的内容,请不要将此函数放在任何地方;例如 onUpdate()onStepHit


颜色函数

getColorFromHex(color:String)

获取 特定的十六进制颜色。这在设置/获取特定的十六进制颜色时非常有用,说实话真的很有用。

  • color - 指定的十六进制颜色,不用多说了吧。

getColorFromName(color:String)

从名称获取颜色。此函数还有其他可用的名称:FlxColor()getColorFromString()

  • color - 颜色名称。

setHealthBarColors(leftHex:String, rightHex:String)

更改 生命条 的背景颜色。

  • leftHex - 生命条的对手十六进制颜色。
  • rightHex - 生命条的玩家十六进制颜色。

setTimeBarColors(leftHex:String, rightHex:String)

更改 时间条 的背景颜色。

  • leftHex - 时间条的百分比条十六进制颜色。
  • rightHex - 时间条的背景颜色十六进制颜色。

getPixelColor(obj:String, x:Int, y:Int)

按像素获取对象的十六进制颜色;返回一个 number,当转换为十六进制时,格式为 FFFFFFFFAARRGGBB

  • obj - 要使用的对象标签名称。
  • x - 以像素为单位的 x 坐标值。
  • y - 以像素为单位的 y 坐标值。

其他函数

triggerEvent(name:String, arg1:Dynamic, arg2:Dynamic)

触发事件,无需将事件插入图表编辑器。

  • name - 事件的名称。
  • arg1 - 值 1 上的值。
  • arg2 - 值 2 上的值。

getModSetting(saveTag:String, ?modName:String = null)

从模组 data 文件夹内的设置 json 中获取设置值。

  • saveTag - json 中指定的设置名称标签。
  • modName - 可选参数,给定的模组名称;默认值:nil

changePresence(details:String, state:Null\<String>, ?smallImageKey:String, ?hasStartTimestamp:Bool, ?endTimestamp:Float)

更改您的 Discord RPC 状态。

  • details - 您在游戏中正在做的事情的详细信息。
  • state - 对 details 的描述。
  • smallImageKey - 可选参数,要显示在左下角的图像键。
  • hasStartTimestamp - 可选参数,您的 Discord RPC 是否应该有时间戳。
  • endTimestamp - 可选参数,要显示多少个小数位。

getSongPosition()

以毫秒为单位返回当前歌曲位置;getPropertyFromClass('backend.Conductor', 'songPosition') 的快捷方式。

已弃用:getPropertyFromClass('Conductor', 'songPosition')