言語の要点を 1 ページにまとめます。各節から詳しい規則のある章へリンクしています。
関数種別
| 種別 | 呼び出せるもの | 実行時に保持できるもの | ステップ | 物語変数 |
|---|---|---|---|---|
fn | fn、const fn。nav::start でエントリーシーンを開始 | 何でも | 不可 | 不可 |
#[scene] pushdown fn（シーン） | シーン、即時手続き、const fn（定数または有限な引数） | 有限型 | 可 | 読み書き |
pushdown fn（即時手続き） | 即時手続き、const fn。再帰なし、有界な for ループのみ | 有限型 | 不可 | 読み書き |
const fn | const fn | 何でも | 不可 | 不可 |
ステップの実行、シーンの呼び出し、rng_choose の呼び出しができるのはシーンだけです。pushdown がキーワードになるのは fn または Fn の直前だけで、scene はポインタ型 scene fn(…) -> … の中だけです。関数種別を参照してください。
| ポインタ型 | 指す先 | クロージャ型 |
|---|---|---|
fn(A) -> B | fn | Fn(A) -> B |
const fn(A) -> B | const fn または何もキャプチャしないクロージャ | const Fn(A) -> B |
pushdown fn(A) -> B | 即時手続き | pushdown Fn(A) -> B |
scene fn(A) -> B | シーン | なし |
属性
| 属性 | 対象 | 意味 |
|---|---|---|
#[scene] | pushdown fn | シーン：ステップの実行、シーンの呼び出し、乱数の取得ができる |
#[entry] | 引数型と戻り値型が有限で Text を含まない #[scene] | システムがここから物語を開始できる |
#[must_use] | struct、enum | 値を捨てる、または完了させないと警告 W3023 |
#[shader_arg] | シェーダーが読める型の名前付きフィールドを持つ struct | その構造体をシェーダーの引数にできる |
#[builtin] | 関数、構造体、トレイト | コンパイラとエンジンが実装する。標準ライブラリのみ |
引数を取る属性はありません。属性を参照してください。
特別な型
| 型 | 有限 | Eq | 備考 |
|---|---|---|---|
bool、()、Int<lo, hi> | はい | はい | Int<lo, hi> は物語の整数型 |
Rust の整数、Rat、Decimal | いいえ | はい | 0.5 は Decimal |
Text | はい | はい | 文字列リテラルと t![…] の型 |
| アセット型 | はい | はい | 値はアセット定数 |
Option<T>、構造体、列挙型、タプル、配列 | すべての構成要素が有限なら | すべての構成要素が Eq なら | 物語では再帰型は不可 |
scene fn、pushdown fn、const fn のポインタ、Render | はい | はい（同一性） | |
fn のポインタ | いいえ | はい（同一性） | |
| クロージャ | いいえ | いいえ | 物語では第二級 |
String、Vec<T>、Duration、Color、EntityId | いいえ | はい（Vec は T: Eq なら） | 定数としてなら物語でも使える |
Screen | いいえ | はい | レンダーが変換する型 |
Setting<T>、Meta<T>、Narrative、Element、画面の部品 | いいえ | いいえ | 不透明なハンドルと値 |
フォーム（.kix のみ）
| 区切り | 受け付けるもの |
|---|---|
name!( … ) | 属性、続いて決まった数の要素 |
name![ … ] | 要素のみ、任意の数 |
name!{ … } | 属性、続いて任意の数の要素 |
属性は key = expr の形で、要素より前に、それぞれ一度だけ書きます。要素はカンマで区切りますが、t![…] の項目だけは並べて書きます。
| フォーム | 脱糖先 | 値 | 属性 | 要素 |
|---|---|---|---|---|
s!(…) | push_step(Say { … }) | () | who、voice、render、history | t![…] を最大一つ |
choice!{…} | push_step(Choice { … }) | アームの値の型 | id（必須、文字列リテラル）、render | アーム t![…] => V と t![…] if cond => V |
t![…] | ruby、mono_ruby、effect、to_text の呼び出しを並べた concat([…]) | Text | なし | "…"、["基"]("よみ")、["漢字"]("かん"|"じ")、、{expr} |
column![…]、row![…]、layer![…] | ui::column、ui::row、ui::layer | Element | なし | 任意の数 |
text!(…) | ui::text | Element | style | ちょうど一つ |
image!(…) | ui::image | Element | fit | ちょうど一つ |
game_screen!(…) | ui::game_screen | Element | game（必須） | なし |
button!{…} | ui::button | Element | on_click、disabled、style | 任意の数 |
slider!{…} | ui::slider | Element | value（必須）、on_change、step、disabled、style | なし |
toggle!{…} | ui::toggle | Element | value（必須）、on_change、disabled、style | 任意の数 |
select!{…} | ui::select | Element | value（必須）、on_change、disabled、style | 任意の数 |
s! と choice! はシーンの中でのみ使えます。UI フォームは fn の関数を呼ぶので、fn のコードで使います。フォームとステップを参照してください。
物語のアイテム
| アイテム | 書き方 |
|---|---|
| シーン | #[scene] pushdown fn Name(…) -> R { … } |
| エントリーシーン | #[scene] #[entry] pub pushdown fn Main(…) -> Ending { … } |
| 即時手続き | pushdown fn name(…) -> R { … } |
| 物語変数 | static mut NAME: FiniteType = constant; |
| 設定 | static NAME: Setting<T> = setting(init); |
| メタフィールド | static NAME: Meta<T> = meta(init); |
| アセット | const NAME: ImageAsset = asset("path");。AudioAsset、VoiceAsset、VideoAsset、FontAsset も同様 |
| シェーダー | const NAME: ColorShader<Args> = asset("name.wgsl");。MixShader、TextureShader、MaskShader、LocalMotionShader、TransitionalMotionShader も同様。Args は () か #[shader_arg] 構造体 |
| システムフォント | const NAME: FontAsset = system_font("path"); |
| エンティティ ID | const NAME: EntityId = EntityId(n);。n は 1 以上（0 は BACKGROUND） |
| レンダー | const fn name(mut screen: Screen) -> Screen { …; screen } |
| プログラム | ルートモジュールの fn main() -> System { … } |
物語の制御フロー
| したいこと | 書き方 |
|---|---|
| 台詞を表示する | s!(who = "Mio", t!["…"]); |
| 質問する | match choice!{id = "ask", t!["Yes"] => Answer::Yes, t!["No"] => Answer::No} { … } |
| アームを隠す | t!["…"] if condition => V |
| シーンを呼ぶ | Name(x); または let v = Name(x); |
| シーンを抜ける | return; / return value;、またはブロックの最後の式 |
| 分岐する | if、if let、match（網羅的。範囲とタプルが使える） |
| ハブや繰り返しの選択肢 | loop { match choice!{…} { … } } と break |
| 有界な繰り返し | 定数の範囲で for i in 0..n |
| カウンターを変える | x += 1;（Int の範囲で飽和） |
| 物語の状態から計算する | const fn を呼ぶ。有限な実行時引数は表化される |
| メタを書く | META_FIELD.write(v); |
| 乱数を引く（シーンのみ） | rng_choose::<T>()。T はフィールドのない列挙型か Int<lo, hi> |
| 物語を終える | エントリーシーンから戻る。値は nav::start の on_exit に渡る |
よく使う std の呼び出し
| したいこと | 呼び出し | 種別 |
|---|---|---|
| 時間 | ms(500)、secs(2) | const fn |
| 色 | rgb(200, 0, 0)、hex(0xC80000)、BLACK、WHITE、TRANSPARENT | const fn |
| 位置 | point(640, 360)、offset(0, -20) | const fn |
| 背景を変える | screen.background().change(BG_ROOF).apply_animation(fade(ms(500))); | const fn |
| 立ち絵を差し替える | screen.entity(MIO).image().change(MIO_SMILE).apply_animation(cut()); | const fn |
| エンティティをフェードインする | screen.entity(MIO).opacity().change(1.0).apply_animation(tween(ms(300))); | const fn |
| モーションを再生する | screen.entity(MIO).apply_animation(jump(20, ms(300))); | const fn |
| キャラクターを表示する | character(MIO).show(&mut screen, MIO_SMILE, point(320, 0), tween(ms(300))); | const fn |
| BGM を変える | screen.music().change(looped(THEME)).apply_animation(crossfade(secs(1))); | const fn |
| 効果音を鳴らす | screen.play(sound(CHIME)); | const fn |
| レンダーの中で待つ | screen.wait(ms(500)); | const fn |
| テキストを装飾する | t)) )] | t![…] の中 |
| 整数を変換する | x.into()、x.saturate() | const fn |
| 設定を読む・変える | MUSIC.get()、MUSIC.set(v) | fn |
| メタを読む | CLEARED.get() | fn |
| 物語を開始する | nav::start(story::Main, (CLEARED.get(),), on_ending) | fn |
| モードを切り替える | nav::call(Config)、nav::dialog(Confirm)、nav::back()、nav::goto(Title)、nav::load(slot)、nav::quit() | fn |
| リアクティブな値 | let (count, set_count) = signal(0u32); | fn |
スタジオ自身の定数（BG_ROOF、MIO など）を除き、上の名前はプレリュードにあります。API の全体は STD Reference にあります。
最終更新日 2026年10月29日