API Reference

完全なAPIリファレンス

エディタ内でもショートフォームで利用可能です:

アセットコンストラクタ

コンストラクタは、エディタで使用される主要なアセットタイプを作成します。変数に割り当てると、エディタがそれを認識し、Ctrl+Clickで対応するアセットエディタを開くことができます。

リストメソッド

[] または [value1, value2, ...] でリストを作成します。list[index] でエントリを読み取り上書きし、for (var i = 0; i < list.length(); i = i + 1) で反復します。

演算子

演算子は、一般的な計算を行う小さな記号です。剰余演算子は、タイマー、インデックス、アニメーションステップ、または繰り返しパターンをラップするのに特に便利です。

オブジェクトプロパティ

オブジェクトは、スクリプトが通常ゲーム中に移動や変更を行うものです。これらの関数は、オブジェクトの位置、スプライト、衝突挙動、レイヤー、および視覚的な色合いを読み取ったり更新したりします。

スプライト関数

スプライト関数は、スプライトのピクセルデータやアニメーション速度を検査または変更するためのものです。ほとんどのゲームはエディタでスプライトを描画しますが、これらの関数は手続き的な効果、デバッグ、または単純なランタイム変更に便利です。

アニメーション関数

アニメーション関数は、複数のフレームを持つスプライトを使用するオブジェクトで機能します。コードによって現在のアニメーションフレームを検査または強制したい場合に使用します。

変換関数 (反転/回転)

変換関数は、オブジェクトのスプライトが描画される方法を変更しますが、スプライト自体は編集しません。複数の方向で1つのスプライトを再利用するのに適しています。

注: これらの変換はレンダー時のみ適用されます。衝突ボックスや実際のスプライトピクセルデータには影響しません。

衝突タイプ

衝突タイプは、オブジェクトが衝突チェックにどのように参加するかを決定します。オブジェクトの役割に基づいてタイプを選択します: 壁は通常静的で、プレイヤーは通常動的で、ピックアップはしばしばトリガーとなります。

シーン関数

シーン関数は、どのシーンがアクティブで、どのオブジェクトがその中に属しているか、背景色や重力などのシーン全体の設定を制御します。また、位置や名前でオブジェクトを検索するためのヘルパーも提供します。

オーディオ再生

オーディオ再生関数は、スクリプトからオーディオアセットを開始および停止します。playAudio()はハンドルを返すので、後でその特定の再生インスタンスを停止またはチェックできます。

スクリーン関数

スクリーン関数は、ウィンドウサイズを知ったり、スクリーンピクセルとワールド位置間を変換したりする際に役立ちます。これは、マウスの照準、クリック検出、およびカメラ意識のUIに便利です。

ウィンドウモード

エクスポートされたゲームのウィンドウモードを制御します。これらの関数は、エディタでプレイする場合には効果がなく (エディタがウィンドウ状態に対して高い権限を持っているため)、エクスポートされたゲームにのみ効果があります。

例:

func start() {
    // ウィンドウモードを設定します (WINDOW_MAXIMIZEDはエクスポートされたゲームのデフォルトです)
    setWindowMode(WINDOW_MAXIMIZED())
}

注: エクスポートされたゲームでsetWindowMode()が呼び出されない場合、デフォルトは WINDOW_MAXIMIZED です。

UI関数

UIは仮想スクリーンスペース解像度を使用します。デフォルトのUIスペースは100 x 100です。 フォントサイズは、uiPushFontSize(size)を使用して後続のテキストウィジェットにプッシュでき、uiPopFontSize()で復元できます。フォントカラーは、uiPushFontColor(r, g, b[, a])でスタックでき、UIエレメントの塗りもuiPushElementColor(r, g, b[, a])でスタックできます。その他の即時モードUIと同様に、これらのオーバーライドは、現在のフレームのUIを構築する際に適用されます。プッシュされたサイズが 0 かそれ以下の場合、エンジンは自動サイズを使用します。

UI状態定数

UI関数は状態定数を返し、スクリプトがウィジェットがアイドル中、ホバー中、保持中、またはクリックされたかを判断できるようにします。通常、ボタンアクションのためにチェックする値は UI_CLICKED() です。

カメラ関数

カメラの位置はビューの中心を表します。ズームは画面のサイズに関係なく一貫した垂直ワールドビューを維持します。

ズームの挙動： ズームはウィンドウのサイズやアスペクト比に関係なく、一貫した垂直ワールドビューを維持します。ワイドな画面では水平方向により多く表示されますが、垂直方向では同じ量が表示されます。

入力関数

入力関数はゲームがキーボードおよびマウスの状態に反応できるようにします。Pressedはワンフレームのアクションに、Heldは連続的な動きに、Releasedはボタンが放されたときに発生するアクションに使用します。

マウスボタン定数

マウスボタン定数はマウス入力関数に渡されます。これは生の数値よりもコードを読みやすくします。

キー定数

キー定数はキーボード入力関数に渡されます。エンジンは文字、数字、ファンクションキー、矢印、小さなセットの一般的な特殊キーを公開しています。

文字: KEY_A() から KEY_Z()

数字: KEY_0() から KEY_9()

ファンクションキー: KEY_F1() から KEY_F12()

特殊キー: | 定数 | キー | |----------|-----| | KEY_SPACE() | スペースバー | | KEY_ENTER() | エンター/リターン | | KEY_ESCAPE() | エスケープ | | KEY_TAB() | タブ | | KEY_BACKSPACE() | バックスペース | | KEY_DELETE() | 削除 | | KEY_SHIFT() | シフト | | KEY_CTRL() | コントロール | | KEY_ALT() | アルト | | KEY_LEFT() | 左矢印 | | KEY_RIGHT() | 右矢印 | | KEY_UP() | 上矢印 | | KEY_DOWN() | 下矢印 | | KEY_HOME() | ホーム | | KEY_END() | エンド |

数学関数

数学ヘルパーは移動、アニメーション、乱数、値の制限でよく使われる計算をカバーします。スクリプトを短く、読みやすくします。

ユーティリティ関数

ユーティリティ関数は特定のアセットタイプに属さない一般的なヘルパーです。print() は学習中に特に便利で、スクリプトが何をしているのかを表示します。

文字列関数

文字列関数はテキスト値で機能します。今のところ、このセクションは意図的に小さいです。

ストレージ関数

ゲームデータをファイルに保存および読み込みます。数字、文字列、ブール値、リスト（ネストされたリストを含む）をサポートします。スプライト、シーン、オブジェクト、またはオーディオ値はサポートしていません。

例: プレイヤー進捗の保存と読み込み

// プレイヤーデータを保存
var playerData = [100, "Player1", true, [1, 2, 3]]
var savePath = getAppDataPath() + "/MyGame/save.dat"
if (save(savePath, playerData)) {
    print("ゲームが保存されました!")
}

// プレイヤーデータを読み込み
if (fileExists(savePath)) {
    var loaded = load(savePath)
    if (loaded != null) {
        var health = loaded[0]
        var name = loaded[1]
        var hasKey = loaded[2]
        var inventory = loaded[3]
    }
}

// 暗号化された保存（カジュアルな検査からデータを隠すため）
var secretData = ["secret", 12345]
save(getAppDataPath() + "/MyGame/config.dat", secretData, "binary", "mySecretKey")
var decrypted = load(getAppDataPath() + "/MyGame/config.dat", "mySecretKey")

// テキスト形式（人間が読める、デバッグに便利）
save(getAppDataPath() + "/MyGame/debug.txt", playerData, "text")

注意:

• バイナリ形式（デフォルト）はコンパクトで高速です
• テキスト形式は人間が読めるため、デバッグに便利です
• 間違った暗号化キーは null を返し（データはゴミになります）
• 保存時にディレクトリが自動的に作成されます