【UEFN】プレイヤーをフリーズさせる方法【Verseチュートリアル】

@editable
Trigger: trigger_device = trigger_device{}
# Runs when the device is started in a running game
FreezePlayer(Agent: ?agent): void =
    Print("時よ、止まれ！！！")

• @editable：
  • この行は、コードが編集可能な状態であることを示す属性です。
  • この属性が付けられたコードは、編集可能な状態でゲームやアプリケーションに組み込むことができます。
• Trigger: trigger_device = trigger_device{}：これは変数の宣言と初期化です。
  • Trigger という変数を trigger_device 型として宣言し、空の trigger_device オブジェクトで初期化しています。
  • trigger_device は、ゲーム内の特定のイベントが発生したタイミングをトリガーとして扱うためのデバイスです。
• FreezePlayer(Agent: ?agent): void：これは関数の宣言です。
  • FreezePlayer という名前の関数を定義しており、引数として Agent という名前の不特定の型の変数を受け取ります。
  • また、関数は戻り値として何も返さないことを示す void 型を持っています。
• Print("時よ、止まれ！！！")：これは関数の本体です。
  • 関数が実行されると、指定された文言 "時よ、止まれ！！！" を表示するために Print 関数が呼び出されます。

このコードの目的は、特定のデバイスのトリガーイベントが発生した際に、プレイヤーを凍結する（停止させる）という動作を行う関数 FreezePlayer を定義しています。

具体的な処理内容は、「時よ、止まれ！！！」という文言を表示するだけですが、この部分は他のプログラムやゲームメカニクスと組み合わせて利用されることが想定されます。

• PlayerAgent := Agent?, FortCharacter := PlayerAgent.GetFortCharacter[]：
  • この行は、PlayerAgent という変数を Agent の値として設定し、同時に FortCharacter という変数を PlayerAgent.GetFortCharacter[] の結果として設定します。
  • := は変数の定義と代入を同時に行うための演算子です。
  • Agent? は Agent の値が存在する場合に真（True）を返し、存在しない場合に偽（False）を返します。
  • PlayerAgent.GetFortCharacter[] は、PlayerAgent の持つ GetFortCharacter という関数を呼び出し、その結果を返します。
• FortCharacter.PutInStasis(stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true})：
  • この行は、FortCharacter の PutInStasis という関数を呼び出します。
  • PutInStasis 関数は、指定した引数（stasis_args）を使用してキャラクターを静止させる操作を実行します。
  • stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true} は、静止させる際の追加の設定パラメータを含んだオブジェクトです。
  • この例では「AllowTurning」、「AllowFalling」、「AllowEmotes」を true に設定しています。

つまり、この条件文の構造は、Agent が存在し、かつ Agent から取得した FortCharacter が存在する場合に、FortCharacter を静止させる処理が実行されます。これにより、プレイヤーキャラクターを静止させる前に、必要な条件を確認しているのです。

if(PlayerAgent := Agent?, FortCharacter := PlayerAgent.GetFortCharacter[]):

このコードの計算式は、条件演算子（ternary operator）と呼ばれる特殊な演算子を使用しています。

条件演算子は次の形式を持ちます：

条件式 ? 真の場合の値 : 偽の場合の値

この演算子は、条件式が真（True）の場合は真の場合の値が返され、偽（False）の場合は偽の場合の値が返されます。

具体的に下記のコードを見てみましょう：

PlayerAgent := Agent?
FortCharacter := PlayerAgent.GetFortCharacter[]

この行では、まずはじめに PlayerAgent という変数に Agent の値を代入します。そして、条件式 PlayerAgent := Agent? が評価されます。

この条件式は、Agent の値が存在するかどうかを判定します。

もし Agent の値が存在する場合は、条件式は真（True）を返し、PlayerAgent に Agent の値が代入されます。逆に、Agent の値が存在しない場合は、条件式は偽（False）を返し、PlayerAgent には何も代入されません。

次に、条件演算子の真の場合の値と偽の場合の値が登場します：

FortCharacter := PlayerAgent.GetFortCharacter[]

この行では、条件演算子が評価され、真の場合の値として PlayerAgent.GetFortCharacter[] が使われます。この部分は、PlayerAgent という変数が持つ GetFortCharacter という関数を呼び出しています。

なお、関数名の末尾の [] は関数を実行することを意味します。

つまり、条件演算子の結果として、もし Agent の値が存在する場合は PlayerAgent.GetFortCharacter[] の結果、すなわち PlayerAgent から GetFortCharacter を呼び出した結果が FortCharacter に代入されます。

逆に、Agent の値が存在しない場合は、 FortCharacter には何も代入されません。

このように、条件演算子を使用することで、条件に応じて変数に異なる値を代入することができます。

(InAgent:agent).GetFortCharacter 拡張機能についての詳細を解説します。

この拡張機能は、「InAgent」という引数（パラメータ）を受け取り、それに対応する「fort_character」を返します。ただし、もし「InAgent」が「fort_character」でない場合は、処理が失敗します。

以下に解説の詳細を示します：

• 引数（パラメータ）：
  • GetFortCharacter 拡張機能は、1つの引数「InAgent」を受け取ります。
  • この引数は「agent」というデータ型を持ちます。
  • 引数「InAgent」は、fort_character の取得対象となるエージェント（キャラクター）を指定します。
• 返り値（結果）：
  • この拡張機能の結果として、指定されたエージェント（InAgent）に関連する「fort_character」が返されます。
  • 「fort_character」は、Fortnite（フォートナイト）と呼ばれるゲーム内のキャラクターを表します。
• 失敗時の処理：
  • この拡張機能は、もし与えられたエージェント（InAgent）が「fort_character」でない場合、処理が失敗します。
  • つまり、指定したエージェントがゲーム内のキャラクターであるかを確認しています。

この拡張機能は、ゲームプログラムで特定のエージェント（キャラクター）の「fort_character」を取得するために使用されます。

それによって、ゲーム内のキャラクターに関する情報や操作を行うことができます。

あすか

"PlayerAgent.GetFortCharacter[]"に[]をつける理由は、GetFortCharacterが関数（メソッド）であるためです。

一般的に、プログラミング言語では関数を呼び出す際に、関数名の後ろに「()」をつけます。この「()」内には、関数への引数を指定することがあります。

しかし、一部のプログラミング言語（特にPythonやJavaScript）では、関数の呼び出し時に「()」を省略して、関数自体をオブジェクトとして扱うこともできます。この場合、関数名の後ろに「[]」をつけることで、関数を呼び出すことができます。

したがって、"PlayerAgent.GetFortCharacter[]"は、PlayerAgentオブジェクトのGetFortCharacter関数を呼び出すための表記法です。この場合、GetFortCharacter関数に引数がない場合は、空の「[]」が付けられます。

つまり、「PlayerAgent.GetFortCharacter[]」は、「PlayerAgentオブジェクトのGetFortCharacter関数を呼び出す」という意味です。[]をつけることで、関数の呼び出しを明示的に表現しています。

FortCharacter.PutInStasis(stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true})

この行は、FortCharacterというオブジェクト（キャラクター）に対して、PutInStasisという処理を行います。つまり、プレイヤーキャラクターをスタシス（一時停止状態）に置くことを意味します。

ここで、PutInStasisに渡される引数は、stasis_argsというデータ構造体です。データ構造体は、関連するデータをまとめて管理するために使用されます。

この引数は、中括弧（{}）の中に書かれたフィールドとその値のセットで構成されます。

具体的には、以下のフィールドが設定されています：

• AllowTurning（回転を許可するか）：true（真）に設定されています。
• AllowFalling（落下を許可するか）：true（真）に設定されています。
• AllowEmotes（感情表現（エモート）を許可するか）：true（真）に設定されています。

これにより、プレイヤーキャラクターをスタシスに置く際に、回転、落下、感情表現がすべて許可される状態になります。

PutInStasis関数が正常に実行されると、プレイヤーキャラクターは一時的に動けなくなり、指定された設定に応じて動作が制限されます。

なお、 := は、一部のプログラミング言語で採用されている代入演算子です。この演算子を使うことで、変数に値を代入しながらその値を返すことができます。

1. stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true}:
   • これは、stasis_argsというデータ型のインスタンスを作成しています。
   • 中括弧内のフィールドとその値が設定されています。
   • 具体的には、AllowTurningフィールドにはtrue（真）が、AllowFallingフィールドにはtrue（真）が、AllowEmotesフィールドにはtrue（真）が設定されています。
2. FortCharacter.PutInStasis(...):
   • これは、FortCharacter（フォートナイトのキャラクターオブジェクト）に対してPutInStasis関数を呼び出しています。
   • この関数は、キャラクターをスタシス（一時停止状態）にするためのものです。
3. 実際の関数呼び出しは、PutInStasis関数への引数として、先ほど作成したstasis_argsインスタンスが渡されます。
   • つまり、関数呼び出しの中身は次のようになります:
   • FortCharacter.PutInStasis(stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true})。

以上が、上記のコードの計算式の論理と計算順序の説明です。まず、stasis_argsインスタンスを作成し、それを引数としてPutInStasis関数を呼び出しています。このような順序でプログラムが実行されます。

PutInStasis関数は、Fortnite（フォートナイト）のキャラクターオブジェクト（fort_character）をスタシス（一時停止状態）にするための機能です。スタシスにすることで、キャラクターの特定の移動が制限されます。

PutInStasis関数の詳細は以下の通りです：

関数名: PutInStasis
公開修飾子: public（公開された関数として使用可能）
引数: Args（stasis_argsというデータ型）
戻り値: なし（void）

引数の詳細:

• Args: stasis_argsというデータ型の引数を取ります。
• この引数は、キャラクターのスタシスに関する詳細な設定を格納するためのものです。

スタシスに関する詳細:

スタシスによってキャラクターの移動が制限され、以下のような設定が可能です（stasis_argsデータ型のフィールド）：

• AllowTurning: キャラクターの回転を許可するかどうかを表すフィールドです。
• AllowFalling: キャラクターの落下を許可するかどうかを表すフィールドです。
• AllowEmotes: キャラクターの感情表現（エモート）を許可するかどうかを表すフィールドです。

このように、PutInStasis関数を使用することで、キャラクターの特定の移動や操作を一時的に制限することができます。

stasis_argsは、fort_character.PutInStasis関数のパラメータとして使用されるデータの集合体です。

stasis_args structの詳細は以下のとおり。

メンバー（Members）:

• このstructはデータメンバー（data members）を持っていますが、関数は持っていません。
• つまり、データを保持するための変数やフィールドが定義されています。

データ（Data）:

以下のデータメンバーがstasis_args struct内に定義されています：

• AllowTurning（logic型）:
  • fort_character（フォートナイトのキャラクターオブジェクト）がスタシス（一時停止状態）になっている間でも、回転が許可されるかどうかを制御します。
  • この変数の値は、真（true）または偽（false）で表されます。
• AllowFalling（logic型）:
  • fort_characterがスタシスになっている間でも、落下が許可されるかどうかを制御します。
  • この変数の値も真か偽で表されます。
• AllowEmotes（logic型）:
  • fort_characterがスタシスになっている間でも、エモート（感情表現）を実行することが許可されるかどうかを制御します。
  • この変数の値も真か偽で表されます。

つまり、stasis_args structは、PutInStasis関数に渡される引数として使用され、キャラクターがスタシスになっている間に許可される操作（回転、落下、エモート）を制御します。

PutInStasis関数とstasis_args構造体は、関数とその引数の関係を表しています。

PutInStasis関数は、fort_character（フォートナイトのキャラクターオブジェクト）をスタシス（一時停止状態）にするための関数です。この関数は、以下のような形式で定義される可能性があります：

void PutInStasis(fort_character character, stasis_args args)
{
    // スタシスの処理
    // argsのフラグに基づいて操作を制御
}

PutInStasis関数は、fort_characterを引数として受け取り、さらにstasis_args構造体の引数argsも受け取ります。stasis_args構造体は、特定のフラグ（AllowTurning、AllowFalling、AllowEmotes）を指定することで、スタシス中のfort_characterの動作を制御します。

PutInStasis関数内部では、argsのフラグの値に基づいてキャラクターの振る舞いを制御します。フラグの値がtrueの場合、キャラクターはスタシス中でも対応する動作を行うことができます。

例えば、AllowTurningフラグがtrueの場合、PutInStasis関数内でキャラクターが回転可能かどうかをチェックして、回転処理を行うかどうかを制御します。同様に、AllowFallingフラグとAllowEmotesフラグも対応する処理を制御するために使用されます。

簡潔に言えば、PutInStasis関数はキャラクターをスタシス状態にするための関数であり、stasis_args構造体の引数argsによってスタシス中のキャラクターの動作が制御されるという関係性があります。

PutInStasis関数はキャラクターを静止状態にするために使用されます。

具体的には、FreezePlayer関数内でFortCharacter.PutInStasisが呼び出され、stasis_args構造体が引数として渡されます。

この構造体にはAllowTurning, AllowFalling, AllowEmotesのフラグが含まれており、それぞれがtrueである場合、キャラクターは静止状態で回転や落下、エモートが許可されます。

optionキーワードを使用する場合とクエリ演算子を使用する場合の主な違いは、オプション変数へのアクセス方法です。

1. optionキーワードを使用する場合:

• オプション変数を値とともに初期化することができます。
• オプション変数が値を持っていることを示すため、明示的に値を指定します。
• オプション変数が値を持つかどうかを判断するために、値が存在するかどうかを確認するためにクエリ演算子を使用する必要はありません。 例:

   MaybeANumber: ?int = option{42}  # 値42で初期化する

2. クエリ演算子を使用する場合:

• オプション変数に値が格納されているかどうかを確認するために、クエリ演算子「?」を使います。
• 値が存在する場合、クエリ演算子を使用してその値にアクセスできます。 例:

   if (Number := MaybeANumber?):
       Number  # MaybeANumberが空でない場合、その値はNumberに格納されます。

要するに、optionキーワードはオプション変数の初期化に使用され、クエリ演算子はオプション変数の値の存在を確認し、値を取得するために使用されます。

あすか

(CreativeObject:creative_object_interface).GetPlayspaceは、与えられたCreativeObjectが所属しているfort_playspaceを返す拡張メソッドです。

拡張メソッドは、既存の型に新しいメソッドを追加する機能です。この場合、creative_object_interface型に新しいメソッドであるGetPlayspaceが追加されています。

GetPlayspaceメソッドは、CreativeObjectが所属しているFortniteのプレイスペース（fort_playspace）を返します。プレイスペースは、ゲーム内の特定の領域やエリアを表します。

このメソッドは以下のようなシグネチャを持っています：

(CreativeObject:creative_object_interface).GetPlayspace<native><public>()<varies><transacts>:fort_playspace

解説する各項目の意味は次の通りです：

• (CreativeObject:creative_object_interface)：型creative_object_interfaceのCreativeObjectに対しての拡張メソッドであることを示します。
• .GetPlayspace：メソッド名であり、CreativeObjectが所属しているプレイスペースを取得するためのメソッドです。
• <native>：メソッドがNativeコードで実装されていることを示します。
• <public>：メソッドがパブリックであることを示します。つまり、他のコードからアクセス可能です。
• ()<varies>：メソッドは何らかの値を返す可能性があります。具体的な返り値の型は変動する可能性があります。
• <transacts>：メソッドはトランザクションを伴う可能性があります。トランザクションは複数のデータベース操作をまとめて処理することを指します。
• :fort_playspace：メソッドの返り値の型がfort_playspaceであることを示します。

したがって、この拡張メソッドを使用すると、CreativeObjectが所属しているプレイスペースを取得することができます。

using { /Fortnite.com/Devices }
using { /Verse.org/Simulation }
using { /UnrealEngine.com/Temporary/Diagnostics }
using { /Fortnite.com/Characters }

# See https://dev.epicgames.com/documentation/en-us/uefn/create-your-own-device-in-verse for how to create a verse device.

# A Verse-authored creative device that can be placed in a level
freeze_device := class(creative_device):

    @editable
    Trigger : trigger_device = trigger_device{}
    # Runs when the device is started in a running game
    FreezePlayer(Agent: ?agent):void=
        Print("時よ、止まれ！！！")
        if(PlayerAgent := Agent?, FortCharacter := PlayerAgent.GetFortCharacter[]):
            FortCharacter.PutInStasis(stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true})
            spawn:
                UnfreezePlayer(FortCharacter)

    UnfreezePlayer(FortCharacter : fort_character)<suspends> :void=
        Sleep(5.0)
        FortCharacter.ReleaseFromStasis()

    OnBegin<override>()<suspends>:void=
        # TODO: Replace this with your code
        Trigger.TriggeredEvent.Subscribe(FreezePlayer)
        Print("Hello World")

プレイヤーが一人だけ存在する場合は、プレイヤーの取得に関してGetPlayspace().GetPlayers()メソッドを使用する必要はありません。

代わりに、プレイヤーを表すエージェントそのものを取得して使用することができます。

提供されたコードでは、Agentという変数を介してプレイヤーエージェントにアクセスし、GetFortCharacter()メソッドを使用してプレイヤーキャラクターを取得しています。

プレイヤーが複数いる場合、通常はプレイヤーを管理するためにGetPlayspace().GetPlayers()メソッドを使用することが一般的です。

もし、FortCharacterに代入しない場合、後続のコードでFortCharacterに関連する処理を行うことはできません。

FortCharacterは、プレイヤーエージェントに関連付けられたFortniteゲーム内のキャラクターオブジェクトを表しています。

もしFortCharacterに代入しない場合、以下のような問題が発生する可能性があります。

1. FortCharacter.PutInStasis()の呼び出しやFortCharacter.ReleaseFromStasis()の呼び出しといった、FortCharacterを用いたステータス操作が実行できません。
   • これにより、「時よ、止まれ！！！」といったメッセージを表示してプレイヤーを一時停止させたり、一定時間後にプレイヤーを解放するといった処理が機能しなくなります。
2. もしOnBeginメソッド内のFortCharacterを使用する他の後続のコードがある場合、そのコードはFortCharacterにアクセスすることができず、予期しない結果やエラーが発生する可能性があります。

このため、提供されたコードの意図に合わせてFortCharacterに代入することが重要です。FortCharacterを使用する具体的な目的や後続のコードの内容に応じて、適切な処理を指定することが求められます。

1. spawnキーワード:
   • spawnキーワードは、非同期的な処理（サブルーチンまたは関数）を実行するためのものです。
   • spawnキーワードによって、UnfreezePlayer関数が非同期的に実行されます。
2. UnfreezePlayer関数:
   • UnfreezePlayer関数は、指定された時間の間、プレイヤーを一時停止（Stasis）状態から解放するための処理を行います。
   • FortCharacter : fort_character:
   • この関数は、fort_character型の引数 FortCharacter を受け取ります。
   • この引数は、Fortniteゲーム内のキャラクターオブジェクトを表します。
   • <suspends>:
     <suspends>は、関数がスリープ（Sleep）などの非同期操作を含む可能性があることを示します。この場合、Sleep(5.0)メソッドによって5秒間待機します。
   • :void=:
     関数の戻り値の型がvoid（なし）であることを示します。つまり、この関数は戻り値を返さないことを意味します。
   • Sleep(5.0):
     Sleep(5.0)は、5秒間処理を一時停止するためのコードです。ここでは、プレイヤーが一時停止状態から解放されるまでの待機時間を設定しています。
   • FortCharacter.ReleaseFromStasis():
     FortCharacter.ReleaseFromStasis()は、プレイヤーを一時停止状態から解放するためのメソッドです。この呼び出しにより、プレイヤーが再び動けるようになります。

このコードの目的は、プレイヤーを一時停止させることで、特定のイベントや条件に応じてプレイヤーを制御することです。上記のコードは5秒間プレイヤーを一時停止させた後、プレイヤーを再び解放します。

なお、初心者向けの説明としては、この処理は「プレイヤーを止めて、5秒後に動かす」といったように理解できます。一時停止（Stasis）という概念や非同期処理に慣れていない場合でも、この説明で理解することができるかと思います。

        FortCharacter.ReleaseFromStasis()

上記のコードは、Fortnite（フォートナイト）というゲーム内のキャラクターを「ステータス異常から解放する」ための関数である、ReleaseFromStasis関数に関する情報を提供しています。

解説：

• 関数名: ReleaseFromStasis
• 形式: 引数なしの関数（パラメーターを受け取らない）
• 明示的なアクセス修飾子: public（外部からアクセス可能）
• 返り値: void（何も返さない）

この関数は、Fortniteのキャラクターをステータス異常（ステータス上の問題）から解放するために使用されます。具体的には、キャラクターをステータス異常の状態（「スタシス」と呼ばれる）から解放します。

フリーズから解放してあげるための関数です。

あすか

上記のコードは、イベントのトリガーに対して特定の処理を実行し、その後に "Hello World" を表示するという処理を行います。

Trigger.TriggeredEvent.Subscribe(FreezePlayer):

この行は、TriggeredEventというイベントが発生した時に、FreezePlayerという処理を実行するように設定しています。

• Trigger.TriggeredEvent:
  • Trigger.TriggeredEventは、特定の条件やイベントが発生した際に通知するイベントオブジェクトです。
  • このイベントが発生した時に、後続の処理が実行されます。
• .Subscribe(FreezePlayer):
  • .Subscribe(FreezePlayer)は、TriggeredEventに対してFreezePlayerという処理を登録（購読）するためのメソッドです。
  • つまり、イベントが発生すると、FreezePlayerが実行されます。

Print("Hello World"):（なくても大丈夫〇）

この行は、"Hello World" というメッセージを表示するための処理です。

• Print("Hello World"):
  • Print("Hello World")は、コンソールや出力画面に指定された文字列を表示するための関数です。
  • この場合、"Hello World" というメッセージが表示されます。

このコードの目的は、特定のイベントをトリガーとして、関連する処理を実行し、その後にメッセージを表示することです。

上記のコードでは、イベントトリガーの購読（Subscribe）として FreezePlayer の処理が登録され、イベントが発生した時に処理が実行されます。その後、"Hello World" というメッセージが表示されます。

初心者向けの説明としては、この処理は「特定のイベントが発生したら、プレイヤーを凍結する処理（FreezePlayer関数）を実行し、その後に「Hello World」と表示する」といったように理解できますね。

2つのコードの違いは以下の部分です。

FreezePlayer(Agent: ?agent):void=
    Print("時よ、止まれ！！！")
    if(PlayerAgent := Agent?, FortCharacter := PlayerAgent.GetFortCharacter[]):
        FortCharacter.PutInStasis(stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true})
        spawn:
            UnfreezePlayer(FortCharacter)

1つ目のコードでは、FortCharacter.PutInStasis() の引数として stasis_args{AllowTurning := true, AllowFalling := true, AllowEmotes := true} が使用されています。

この引数は、プレイヤーキャラクター（FortCharacter）を一時停止状態にする際に、回転、落下、エモートを許可するための設定を行っています。

    FreezePlayer(Agent: ?agent):void=
        Print("時よ、止まれ！！！")
        if(PlayerAgent := Agent?, FortCharacter := PlayerAgent.GetFortCharacter[]):
            FortCharacter.PutInStasis(stasis_args{})
            spawn:
                UnfreezePlayer(FortCharacter)

一方、2つ目のコードでは、FortCharacter.PutInStasis() の引数には何も指定されておらず、デフォルトの設定（引数なし）が使用されています。

この場合、プレイヤーキャラクター（FortCharacter）は一時停止されますが、回転、落下、エモートは制限されます。

したがって、1つ目のコードはプレイヤーキャラクターの一時停止時に回転、落下、エモートが許可されるのに対し、2つ目のコードではそれが制限されるという違いがあります。