Skip to content

AdvancedEventTester

Thomas Iché edited this page Oct 29, 2022 · 2 revisions

VFX Advanced Event Tester

The VFX Advanced Event Tester enables making test configurations for your effects, especially effects that require code to run in your game. It can simulate events and compute VFXEventAttribute payloads.

image

Usage

The VFX Event Tester Window can be opened using the Window/Visual Effects/VFX Advanced Event Tester.

Upon opening, the window displays this header, in wait for selecting a Visual Effect in the scene.

image

Upon selecting Game Objects with Visual Effect Components, the Target property field changes to match Selection. Using the lock button, you can prevent selection to change the target.

image

In order to start testing events on the Visual Effect, click the "Create Test Component on Game Object" to add a VFX Event Test Container component . When Created, the button is replaced by the actual inspector.

image

When the VFXEventTest component is added to the game object a list is prompted to add VFX Event Tests.

VFX Event Tests

image

VFX Event Tests provides a single test case for events in VFX, it is composed by:

  • Events that can be fired by an Update Behaviour

    • A Single Event : For instance an explosion
    • An event launched at the start of the Behaviour
    • An event launched at the end of the Behaviour
  • Optional Update Loop

  • Optional Single Event

  • The Update Behaviour is defined in its own category, you can change it using the ... button on the right side of the header bar

image

  • Finally a list Event Attribute Modifiers that enable to compute Event Attributes.

image

in order to add an event attribute modifier, click the + button of the list

image

VFX Event Test Container components

The VFXEventTest component is a component that holds configuration for the tests. It is editor-only.

image

These components can be added next to the Visual Effects by the VFX Advanced Event Tester.

API

You can create Update Behaviors and Event Attribute Modifiers by extending the classes VFXEventSendUpdateBehavior and VFXEventAttributeSetup classes.