トリガー コンポーネントとトリガー可能な子クラス

このページでは、trigger_component という Scene Graph コンポーネントを新規作成する方法について説明します。 このコンポーネントは、triggerable インターフェースを実装する Scene Graph コンポーネントがあるエンティティに対してアクションをトリガーします。 trigger_component は、volume_device を介して Scene Graph とインタラクトする手段をエージェントに提供します。 エージェントが volume_device に入ったときまたは出たときに、該当する AgentEnteredEvent および AgentExitedEvent に通知され、該当するコールバックが呼び出されて、Scene Graph コンポーネントとエンティティに対してアクションが行われます。

次の画像では、地面にある白い台が Scene Graph エンティティであり、台の周りに trigger_component と見えない volume_device があります。

プレイヤーが台を踏むと、trigger_component が右端の 2 つのライトをトリガーします。

プレイヤーが台から降りて volume_device を離れても、ライトは点灯したままです。

このページで使用されている Verse 言語機能の詳細については、以下のドキュメントを参照してください。

• Verse のインターフェース

• Verse を使用して独自のコンポーネントを作成する

トリガー コンポーネントを定義する

1. Verse Explorer に移動し、プロジェクト名を右クリックして [Add new Verse file to project (新規 Verse ファイルをプロジェクトに追加)] を選択します。

   

2. 「Scene Graph Component」テンプレートを選択し、[Component Name (コンポーネント名)] を「trigger_component」に変更します。

   

3. trigger_component クラスを定義し、関連付けられている volume_device を参照するフィールド、このコンポーネントが子だけをトリガーするか、トリガー可能なすべての子孫をトリガーするかを指定するフィールド、このコンポーネントとインタラクトするすべてのエージェントを参照する配列のフィールドを追加します。

   Verse

   trigger_component := class<final_super>(component):
   
       # volume_device associated with this trigger_component
       @editable
       InteractionVolume<private>:volume_device = volume_device{}
   
       # whether or not this triggers on components on child entities
       @editable
       OnlyTriggerChildren:logic = false
   
   
   Expand code Copy full snippet(12 lines long)

4. エージェントがこのコンポーネントと関連付けられている volume_device に入ったときおよび出たときにどうなるかを定義する、OnAgentEntersVolume と OnAgentExitsVolume という関数を追加します。 エージェントがボリュームに入ったときに、インタラクトしているエージェントを記録し、triggerable インターフェースを実装しているコンポーネントがある子孫エンティティを探し、それらのエンティティのコンポーネントをトリガーします。 エージェントがボリュームに入ったときに、インタラクトしているエージェントを、このボリュームとインタラクトしているエージェントのリストから削除します。

   Verse

       # Event that is triggered when an Agent enters the InteractionVolume
       OnAgentEntersVolume(Agent:agent):void=
           for:
               ChosenEntity : Entity.FindDescendantEntities(entity)
               ChosenEntityComponent : ChosenEntity.GetComponents()
               CastToInterface := triggerable[ChosenEntityComponent]
           do:
               if (OnlyTriggerChildren?):
                   if (Entity = ChosenEntity.GetParent[]):
                       CastToInterface.Trigger()
   
   Expand code Copy full snippet(17 lines long)

5. OnAgentEntersVolume 関数と OnAgentExitsVolume 関数を volume_device に接続します。そうするには、それらの関数を、このコンポーネントの OnSimulate 関数内で、AgentEntersEvent と AgentExitsEvent のコールバック関数として登録します。

   Verse

       # Runs when the component should start simulating in a running game.
       OnBeginSimulation<override>():void =
           # Run OnBeginSimulation from the parent class before
           # running this component's OnBeginSimulation logic
           (super:)OnBeginSimulation()
   
       # Runs when the component should start simulating in a running game.
       # Can be suspended throughout the lifetime of the component. Suspensions
       # will be automatically cancelled when the component is disposed or the
       # game ends.
   
   Expand code Copy full snippet(15 lines long)

トリガー可能コンポーネントを定義する

次に、前に作成した triggerable インターフェースを実装するコンポーネントを定義します。 これらは、puzzle_component があるエンティティの子孫であり、trigger_component がある祖先エンティティによってトリガーされる、Scene Graph エンティティに追加されるコンポーネントです。 このチュートリアルでは、以下の 3 つの異なる triggerable コンポーネントを定義します。

• triggerable_mesh_component：エンティティの mesh_component の可視性を切り替えます。

• triggerable_light_component：エンティティの sphere_light_component のオン/オフを切り替え、ライトがオン/オフのどちらであるかに応じて、エンティティの mesh_component を、エミッシブ カラーありまたはなしのものに交換します。

• triggerable_movement_component：keyframed_movement_component を使用して、エンティティの mesh_component のトランスフォーメーションをトリガーします。

これら 3 つの異なるコンポーネントでは、多くの機能が共有され、多数の関数が同じように定義されます。 まず、「TriggerableComponents.verse」という空の Verse ファイルを新規作成します。

1. 以下のモジュールをインクルードします。

   • /Verse.org/SceneGraph：このファイルで Scene Graph コンポーネントとシーン イベントを使用しているため。

   • /Verse.org/SceneGraph/KeyframedMovement：このファイルで keyframed_movement_delta を使用しているため。

   • /Verse.org/Simulation：このファイルで @editable 属性を使用しているため。

   • /Verse.org/SpatialMath：このファイルで Verse トランスフォームを使用しているため。

   Verse

   using { /Verse.org/SceneGraph }
   using { /Verse.org/SceneGraph/KeyframedMovement }
   using { /Verse.org/Simulation }
   using { /Verse.org/SpatialMath }
   

   Copy full snippet(4 lines long)

2. 3 つのコンポーネント triggerable_mesh_component、triggerable_light_component、triggerable_movement_component を定義します。 これらのコンポーネントはすべて、基本コンポーネント クラスを継承しており、triggerable インターフェースを実装しています。

3. 3 つのコンポーネントすべてで、次の 3 つの同じイベントを実装します。

   • OnReceive：このコンポーネントがシーン イベントを受け取ったときに呼び出されます。

   • OnBeginSimulation：コンポーネントがシミュレートを開始する必要があるときに呼び出されます。

   • OnSimulate：コンポーネントがシミュレートを開始するときに呼び出されます。

   3 つのコンポーネントすべてに以下の実装を追加します。

   Verse

       # Runs when this component receives a scene event
       OnReceive<override>(SceneEvent:scene_event):logic=
           if (PuzzleSolvedEvent := puzzle_solved_event[SceneEvent], not PuzzlePiece?):
               Trigger()
               true
           false
     
       # Runs when the component should start simulating in a running game.
       OnBeginSimulation<override>():void =
           # Run OnBeginSimulation from the parent class before
   
   Expand code Copy full snippet(20 lines long)

4. 3 つのコンポーネントすべてで、triggerable インターフェースの PostTrigger オーバーライドも同様の方法で実装します。これを行うには、triggerable コンポーネントがパズル ピースである場合に triggered_event を送ります。 triggerable インターフェース自体の内部で、これを実現することはできません。その理由は、どのエンティティがトリガーされているかを Verse が把握している必要がありますが、[Entity (エンティティ)] フィールドは、コンポーネント クラスの一部であるため、そのコンポーネント クラスに対する依存関係を追加することなく triggerable インターフェースで利用することはできないためです。

   Verse

       PostTrigger<override>():void =
           if (PuzzlePiece?):
               Event := triggered_event:
                   Triggered := Triggered
                   TriggeredEntity := option{Entity}
               Entity.SendUp(Event)

   Copy full snippet(6 lines long)

トリガー可能メッシュ コンポーネント

triggerable_mesh_component は、エンティティの mesh_component の可視性を切り替えます。 そうするには、triggerable インターフェースの以下の関数に対するオーバーライドを提供する必要があります。

• SetInitialTriggeredState

• PerformAction

• PerformReverseAction

1. トリガー状態の初期値は、メッシュ コンポーネントの詳細パネルでの設定に応じてメッシュがゲーム ワールドで見える状態で開始されるかどうかをチェックすることよって決まります。

2. triggerable_mesh_component に対するアクションは、mesh_component メッシュを見えるようにすることです。 そうするには、該当するエンティティの mesh_component を取得し、そのメッシュを見えるように設定してから、triggerable_mesh_component を、トリガーされている状態に設定します。

   Verse

       # Determine the initial triggered state of this component
       SetInitialTriggeredState<override>():void=
           if (MeshComponent := Entity.GetComponent[mesh_component], MeshComponent.Visible?):
                   set Triggered = true

   Copy full snippet(4 lines long)

3. triggerable_mesh_component に対する逆のアクションは、mesh_component メッシュを見えないようにすることです。 そうするには、該当するエンティティの mesh_component を取得し、そのメッシュを見えないように設定してから、triggerable_mesh_component を、トリガーされていない状態に設定します。

   Verse

       PerformReverseAction<override>():void =
           if (MeshComponent := Entity.GetComponent[mesh_component]):
               if (MeshComponent.Visible?):
                   set MeshComponent.Visible = false
                   set Triggered = false

   Copy full snippet(5 lines long)

トリガー可能移動コンポーネント

triggerable_movement_component は、keyframed_movement_component を使用して、エンティティをトリガーして、ある位置から他の一連の位置に順番に移動させます。 そうするには、triggerable インターフェースの以下の関数に対するオーバーライドを提供する必要があります。

• SetInitialTriggeredState

• PerformAction

• PerformReverseAction

また、このコンポーネントは以下のヘルパー関数を使用します。

• GetMovementStates：このエンティティに対する一連のトランスフォーメーションを定義している子エンティティのトランスフォームを取得します。

• MakeDeltaTransform：2 つの入力トランスフォームの間のデルタ トランスフォームを作成します。

• ConstructKeyframeDeltas：keyframed_movement_component への入力用の、keyframed_movement_delta オブジェクトの配列を作成します。

• SetAndPlayAnimation：キーフレームを割り当てて、移動アニメーションを再生します。

1. キーフレーム化されたアニメーションの持続時間を決定する編集可能な float 値をこのクラスに追加します。

   Verse

       @editable
       Duration:float = 2.0
   

   Copy full snippet(2 lines long)

2. このクラスは triggerable インターフェースを実装するため、PerformAction 関数と PerformReverseAction 関数に対するオーバーライドを提供する必要があります。これらの関数にはデフォルトの実装はありません。 トリガー状態の初期値はなく、アクションは位置の間の移動であるため、トリガー状態のデフォルトの初期値は false です。 これは、triggerable インターフェースの基本実装で行われることであるため、このコンポーネント クラスではこの関数のオーバーライドは必要ありません。

3. triggerable_movement_component に対するアクションは、子エンティティで定義されている一連のトランスフォームに沿ってエンティティを動かすことです。

   Verse

       PerformAction<override>():void =
           MovementStates := GetMovementStates()
           AnimationFrames:[]keyframed_movement_delta = ConstructKeyframeDeltas(MovementStates)
           SetAndPlayAnimation(AnimationFrames)
   

   Copy full snippet(4 lines long)

4. triggerable_movement_component に対する逆のアクションは、子エンティティで定義されている一連のトランスフォームに沿って逆の順序でエンティティを動かすことです。 この関数は、PerformAction と似ていますが、トランスフォーム配列が逆の順序になっています。

   Verse

       PerformReverseAction<override>():void =
           MovementStates := GetMovementStates()
           ReversedMovementStates := for:
               Index := 0..MovementStates.Length - 1
               ReversedElement := MovementStates[MovementStates.Length - 1 - Index]
           do:
               ReversedElement
           AnimationFrames := ConstructKeyframeDeltas(ReversedMovementStates)
           SetAndPlayAnimation(AnimationFrames)
   

   Copy full snippet(9 lines long)

5. このコンポーネントが使用するヘルパー関数を定義します。 まず、この移動先であるトランスフォームを取得する、GetMovementStates という関数を作成します。

   Verse

       GetMovementStates():[]transform=
           for (ChildEntity : Entity.FindDescendantEntities(entity), Entity = ChildEntity.GetParent[]):
               ChildEntity.GetGlobalTransform()
   

   Copy full snippet(3 lines long)

6. 2 つのトランスフォームの間のデルタ トランスフォームを作成する、MakeDeltaTransform というヘルパー関数を定義します。 トランスフォーム A からトランスフォーム B へのデルタ トランスフォーム D は、トランスフォーム A にトランスフォーム D が適用されたときにトランスフォーム B となるようなトランスフォームです。 

   これを拡張するために、現在のトランスフォームが A である Scene Graph エンティティがあり、トランスフォーム B になるようにそのエンティティをスケール、回転、平行移動させると想定します。 デルタ トランスフォーム D は、keyframed_movement_delta がトランスフォーム A からトランスフォーム B までのエンティティの動きをアニメートするのに必要とされるトランスフォームです。  

   Verse

       MakeDeltaTransform(InTransformOne:transform, InTransformTwo:transform):transform =
           transform:
               Translation := InTransformTwo.Translation - InTransformOne.Translation
               Rotation := MakeComponentWiseDeltaRotation(InTransformOne.Rotation, InTransformTwo.Rotation)
               Scale := vector3:
                   Forward := InTransformTwo.Scale.Forward / InTransformOne.Scale.Forward
                   Right := InTransformTwo.Scale.Right / InTransformOne.Scale.Right
                   Up := InTransformTwo.Scale.Up / InTransformTwo.Scale.Up
   

   Copy full snippet(8 lines long)

7. keyframed_movement_component アニメーションへの入力用の keyframed_movement_delta オブジェクトの配列を作成する、ConstructKeyframeDelta というヘルパー関数を定義します。

   Verse

       ConstructKeyframeDeltas<public>(MovementStates:[]transform):[]keyframed_movement_delta =
           var LastTransform:transform = Entity.GetGlobalTransform()
           for (EntityIndex -> CurrentTransform : MovementStates):
               DeltaTransform := MakeDeltaTransform(LastTransform, CurrentTransform)
               set LastTransform = CurrentTransform
               keyframed_movement_delta:
                   Transform := DeltaTransform
                   Duration := Duration
                   Easing := if (MovementStates.Length > 1):
                       if (EntityIndex = 0):
   
   Expand code Copy full snippet(17 lines long)

8. keyframed_movement_delta 配列を keyframed_movement_component アニメーションに割り当ててそれを再生する、SetAndPlayAnimation という関数を作成します。

   Verse

       SetAndPlayAnimation<private>(Frames:[]keyframed_movement_delta):void =
           if (KeyframedMovementComponent := Entity.GetComponent[keyframed_movement_component]):
               KeyframedMovementComponent.SetKeyframes(Frames, oneshot_keyframed_movement_playback_mode{})
               KeyframedMovementComponent.Play()
   

   Copy full snippet(4 lines long)

トリガー可能ライト コンポーネント

triggerable_light_component は、ライトのオン/オフを切り替えます。 そうするには、triggerable インターフェースの以下の関数に対するオーバーライドを提供する必要があります。

• SetInitialTriggeredState

• PerformAction

• PerformReverseAction

1. ライトのトリガー状態の初期値はライトがオンであるかどうかによって決まるため、SetInitialTriggeredState は、ライトがすでにオンであるかどうかをチェックし、オンであれば、それをトリガー状態の初期値に設定します。

   Verse

       # Determine the initial triggered state of this light
       SetInitialTriggeredState<override>():void=
           for:
               DescendantEntity : Entity.FindDescendantEntities(entity)
               Entity = DescendantEntity.GetParent[]
               MeshComponent := DescendantEntity.GetComponent[mesh_component]
               LightComponent := DescendantEntity.GetComponent[light_component]
               MeshComponent.IsEnabled[]
               LightComponent.IsEnabled[]
           do:
   
   Expand code Copy full snippet(11 lines long)

2. triggerable_light_component が行うアクションは、ライトをオンにし、ライトがオンであることを表すメッシュに切り替えることです。

   Verse

       PerformAction<override>():void=
           if (not IsLightOn?):
               for (DescendantEntity:Entity.FindDescendantEntities(entity), Entity = DescendantEntity.GetParent[]):
                   if (MeshComponent := DescendantEntity.GetComponent[mesh_component]):
                       if (LightComponent := DescendantEntity.GetComponent[light_component]):
                           MeshComponent.Enable()
                           LightComponent.Enable()
                       else:
                           MeshComponent.Disable()
               set IsLightOn = true
   
   Expand code Copy full snippet(11 lines long)

3. triggerable_light_component が行うアクションは、ライトをオフにし、エミッシブでない mesh_component を見えるように設定することです。

   Verse

       PerformReverseAction<override>():void=
           if (IsLightOn?):
               for (DescendantEntity:Entity.FindDescendantEntities(entity), Entity = DescendantEntity.GetParent[]):
                   if (MeshComponent := DescendantEntity.GetComponent[mesh_component]):
                       if (LightComponent := DescendantEntity.GetComponent[light_component]):
                           MeshComponent.Disable()
                           LightComponent.Disable()
                       else:
                           MeshComponent.Enable()
               set IsLightOn = false
   
   Expand code Copy full snippet(11 lines long)

次のステップ

ここまでで、すべての Verse コードを記述したので、Verse コードをビルドします。 次は、パズル体験を作成するために UEFN で再利用できるベース エンティティとコンポーネントを使用して、プレハブを構築します。

最終コード

TriggerComponent.verse

using { /Fortnite.com/Devices }
using { /Verse.org/Simulation }
using { /Verse.org/SceneGraph }
using { Logging }

trigger_component<public> := class<final_super>(component):

    @editable
    InteractionVolume<private>:volume_device = volume_device{}

TriggerableComponents.verse

using { /Verse.org/SceneGraph }
using { /Verse.org/SceneGraph/KeyframedMovement }
using { /Verse.org/Simulation }
using { /Verse.org/SpatialMath }

EnabledToolTip<public><localizes>:message = "Whether or not this component is enabled."

triggerable_mesh_component<public> := class<final_super>(component, triggerable):

    <# Triggerable interface #>

• 

  プレハブを構築する

  前に定義したコンポーネントを使用して、プレハブを構築し、パズルを作成します。