Lua Script API: 一般関数 - Oren-LuckyJackpots/FNF-PsychEngine-JP GitHub Wiki

キャラクター関数

characterPlayAnim(character:String, anim:String, forced:Bool = false)

  • character - boyfriend、dad、またはgf

  • anim - 再生されるアニメーション名．

  • forced:trueまたはfalseを指定します。trueを指定すると、現在のアニメーションと再生するアニメーションが同じ場合、強制的にリセットされます。

characterDance(character:String)

キャラクターにアイドルダンスをさせる

  • character - boyfriend、dad、またはgf

getCharacterX(type:String)

キャラクターの一般的なXの位置をtypeから取得します。

  • type - boyfriend、dad、またはgfを指定します。

setCharacterX(type:String)

型から文字の一般的なX位置を設定する。これは、同じ型からキャッシュされた全ての文字を、希望する位置に移動させる

  • type - boyfriend、dad、またはgfを指定します。

getCharacterY(type:String)

型から文字の一般的なY位置を取得する。

  • type - boyfriend、dad、またはgfを指定します。

setCharacterY(type:String)

型から文字の一般的なY位置を設定する。これは、同じ型からキャッシュされた全ての文字を、希望する位置に移動させる

  • type - boyfriend、dad、またはgfを指定します。

スコア/精度関数

addScore(value:Int = 0)

現在の曲のスコアに値を追加し、評価を再計算する ## setcore(value:Int = 0)

setScore(value:Int = 0)

現在の曲のスコアをvalueに設定し、レーティングを再計算する ## addSmisses(value:Int = 0)

addMisses(value:Int = 0)

現在の曲のミス合計に値を追加し、レーティングを再計算する

setMisses(value:Int = 0)

現在の曲のミス合計をvalueに設定し、レーティングを再計算する

addHits(value:Int = 0)

現在の曲のヒット数の合計に値を追加し、レーティングを再計算する

setHits(value:Int = 0)

現在の曲のヒット数の合計を値に設定し、レーティングを再計算する

setRatingPercent(value:Float)

独自のレーティング計算を行いたい場合に備えて、レーティングのパーセンテージを設定する

setRatingPercent(value:Float)

  • value(値) - 0から1までの値を指定するが、実際には好きな値を指定できる。

setRatingString(value:String)

独自のレーティング計算をしたい場合に備えて、レーティング名をvalueに設定する。

characterPlayAnim(character:String, anim:String, forced:Bool = false)

  • character - boyfriend、dad、またはgf

  • anim - 再生するアニメーションの名前

  • forced:trueまたはfalseを指定します。trueを指定すると、現在のアニメーションと再生するアニメーションが同じ場合、強制的にリセットされます。

characterDance(character:String)

キャラクターにアイドルダンスをさせる

  • character - boyfriend、dad、またはgf

getCharacterX(type:String)

タイプからキャラクターの一般的なX位置を取得する。

  • type - boyfriend、dad、またはgf

setCharacterX(type:String)

type型の文字の一般的なXの位置を設定する。

  • type - boyfriend、dad、またはgf

getCharacterY(type:String)

一般的なY位置を取得する

  • type - boyfriend、dad、またはgf

getCharacterY(type:String)

文字の一般的なY位置をtypeから取得する。

  • type - boyfriend、dad、またはgf

setCharacterY(type:String)

型から文字の一般的なY位置を設定する。これは、同じ型からキャッシュされた全ての文字を、希望する位置に移動させる

  • type - boyfriend、dad、またはgf

キー押下関数

keyJustPressed(name:String)

現在のフレームでキーが押されたかどうかを取得する。

キー: 'left', 'down', 'up', 'right', 'accept', 'back', 'pause', 'reset', 'space'.

keyPressed(name:String)

現在のフレームでキーが押されているかどうかを取得する。

キー: 'left', 'down', 'up', 'right', 'space'.

keyReleased(name:String)

キー名が現在のフレームで解放されたかどうかを取得します。

キー: 'left', 'down', 'up', 'right', 'space'.

マウスクリック関数

マウスクリック関数 ## mouseClicked(name:String) マウスボタン名が現在のフレームで押されたかどうかを取得します。

ボタン: 'left', 'right', 'middle'

mousePressed(name:String)

現在のフレームでマウスボタンが押されているかどうかを取得します。

ボタン: 'left', 'right', 'middle'

mouseReleased(name:String)

現在のフレームでマウスボタン名が離されたかどうかを取得する。

ボタン: 'left', 'right', 'middle'

マウス位置関数

getMouseX(camera:String)

指定したカメラにおけるマウスのX相対位置を返します。

  • camera - game、hud、otherのいずれかを指定します。

getMouseY(camera:String)

指定したカメラにおけるマウスのY相対位置を返します。

  • camera - game、hud、otherのいずれかを指定します。

その他の関数

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

チャートを作成することなくイベントをトリガーします。

  • name - チャートエディタ上のイベント名
  • arg1 - チャート・エディタ上の値1
  • arg2 - チャート・エディタ上の値2

addLuaScript(path:String)

別の.luaスクリプトをロードします。

  • path - ベースフォルダからの相対パス．

getColorFromHex(color:String)

16進数値(色)から色の10進数IDを取得します。

  • 例: オレンジ色を取得するには getColorFromHex('FF7800') または getColorFromHex('0xFFFF7800') を使用する。

getSongPosition()

現在の曲の位置を返す。getPropertyClass('Conductor', 'songPosition')`のショートカット。

カメラ関数

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

  • camera - "game"、"hud"、または "other"。
  • intensity - 揺れる距離、推奨値は0.05です。
  • duration - 揺れる時間．

cameraSetTarget(target:String)

カメラを特定のターゲットにフォーカスさせます。

  • target - ターゲットはboyfriendでもdadでも構いません．

カメラフラッシュ(camera:String, color:String, duration:Float,forced:Bool)

  • camera - "game"、"hud"、または "other"。
  • color - フラッシュの色です。
  • duration - フラッシュする時間です。
  • forced - フラッシュを再開するか否か．

カメラフェード(camera:String, color:String, duration:Float,forced:Bool)

  • camera - "game"、"hud"、または "other"。
  • color - フェードの色です。
  • duration - フェードする時間です。
  • forced - フェードを再開するかどうか

デバッグ関数

debugPrint(text1, text2, text3, text4, text5)

  • Prints a debug message on the top-left corner of the screen

  • All values are optional

  • You can have up to 5 values to be printed.

Example: debugPrint("Current boyfriend character: ", getProperty("boyfriend.curCharacter"));

This will print the following message: Current boyfriend character: bf

close(printMessage:Bool)

Stops your script in the next 100 miliseconds.

  • printMessage - Wether you want a warning to show on the top-left corner of the screen or not