unreal.FunctionalAITest

class unreal.FunctionalAITest(outer=None, name='None')

Bases: unreal.FunctionalTest

Functional AITest

C++ Source:

  • Module: FunctionalTesting
  • File: FunctionalAITest.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allow_tick_before_begin_play (bool): [Read-Write] Whether we allow this Actor to tick before it receives the BeginPlay event. Normally we don’t tick actors until after BeginPlay; this setting allows this behavior to be overridden. This Actor must be able to tick for this setting to be relevant.
  • always_relevant (bool): [Read-Write] Always relevant for network (overrides bOnlyRelevantToOwner).
  • author (str): [Read-Write] The author is the group or person responsible for the test. Generally you should use a group name like ‘Editor Team’ or ‘Rendering Team’. When a test fails it may not be obvious who should investigate so this provides a associate responsible groups with tests.
  • auto_destroy_when_finished (bool): [Read-Write] If true then destroy self when “finished”, meaning all relevant components report that they are done and no timelines or timers are in flight.
  • auto_receive_input (AutoReceiveInput): [Read-Write] Automatically registers this actor to receive input from a player.
  • block_input (bool): [Read-Write] If true, all input on the stack below this actor will not be considered
  • can_be_damaged (bool): [Read-Write] Whether this actor can take damage. Must be true for damage events (e.g. ReceiveDamage()) to be called. https://www.unrealengine.com/blog/damage-in-ue4: TakeDamage(), ReceiveDamage():
  • can_be_in_cluster (bool): [Read-Write] If true, this actor can be put inside of a GC Cluster to improve Garbage Collection performance
  • current_spawn_set_index (int32): [Read-Write] Current Spawn Set Index
  • current_spawn_set_name (str): [Read-Write] Current Spawn Set Name
  • custom_time_dilation (float): [Read-Write] Allow each actor to run at a different time speed. The DeltaTime for a frame is multiplied by the global TimeDilation (in WorldSettings) and this CustomTimeDilation for this actor’s tick.
  • debug_nav_mesh_on_timeout (bool): [Read-Write] if set, ftest will postpone start until navmesh is fully generated
  • description (str): [Read-Write] A description of the test, like what is this test trying to determine.
  • enable_auto_lod_generation (bool): [Read-Write] If true, and if World setting has bEnableHierarchicalLOD equal to true, then it will generate LODActor from groups of clustered Actor
  • find_camera_component_when_view_target (bool): [Read-Write] If true, this actor should search for an owned camera component to view through when used as a view target.
  • generate_overlap_events_during_level_streaming (bool): [Read-Write] If true, this actor will generate overlap events when spawned as part of level streaming. You might enable this is in the case where a streaming level loads around an actor and you want overlaps to trigger.
  • hidden (bool): [Read-Write] Allows us to only see this Actor in the Editor, and not in the actual game. SetActorHiddenInGame():
  • ignores_origin_shifting (bool): [Read-Write] Whether this actor should not be affected by world origin shifting.
  • initial_life_span (float): [Read-Write] How long this Actor lives before dying, 0=forever. Note this is the INITIAL value and should not be modified once play has begun.
  • input_priority (int32): [Read-Write] The priority of this input component when pushed in to the stack.
  • instigator (Pawn): [Read-Write] Pawn responsible for damage and other gameplay events caused by this actor.
  • is_editor_only_actor (bool): [Read-Write] Whether this actor is editor-only. Use with care, as if this actor is referenced by anything else that reference will be NULL in cooked builds
  • is_enabled_value (bool): [Read-Write] Allows a test to be disabled. If a test is disabled, it will not appear in the set of runnable tests (after saving the map).
  • min_net_update_frequency (float): [Read-Write] Used to determine what rate to throttle down to when replicated properties are changing infrequently
  • nav_mesh_debug_extent (Vector): [Read-Write] navmesh debug: extent around NavMeshDebugOrigin
  • nav_mesh_debug_origin (Vector): [Read-Write] navmesh debug: log navoctree modifiers around this point
  • net_cull_distance_squared (float): [Read-Write] Square of the max distance from the client’s viewpoint that this actor is relevant and will be replicated.
  • net_dormancy (NetDormancy): [Read-Write] Dormancy setting for actor to take itself off of the replication list without being destroyed on clients.
  • net_load_on_client (bool): [Read-Write] This actor will be loaded on network clients during map load
  • net_priority (float): [Read-Write] Priority for this actor when checking for replication in a low bandwidth or saturated situation, higher priority means it is more likely to replicate
  • net_update_frequency (float): [Read-Write] How often (per second) this actor will be considered for replication, used to determine NetUpdateTime
  • net_use_owner_relevancy (bool): [Read-Write] If actor has valid Owner, call Owner’s IsNetRelevantFor and GetNetPriority
  • observation_point (Actor): [Read-Write] Allows you to specify another actor to view the test from. Usually this is a camera you place in the map to observe the test. Not useful when running on a build farm, but provides a handy way to observe the test from a different location than you place the functional test actor.
  • on_actor_begin_overlap (ActorBeginOverlapSignature): [Read-Write] Called when another actor begins to overlap this actor, for example a player walking into a trigger. For events when objects have a blocking collision, for example a player hitting a wall, see ‘Hit’ events. Components on both this and the other Actor must have bGenerateOverlapEvents set to true to generate overlap events.:
  • on_actor_end_overlap (ActorEndOverlapSignature): [Read-Write] Called when another actor stops overlapping this actor. Components on both this and the other Actor must have bGenerateOverlapEvents set to true to generate overlap events.:
  • on_actor_hit (ActorHitSignature): [Read-Write] Called when this Actor hits (or is hit by) something solid. This could happen due to things like Character movement, using Set Location with ‘sweep’ enabled, or physics simulation. For events when objects overlap (e.g. walking into a trigger) see the ‘Overlap’ event. For collisions during physics simulation to generate hit events, ‘Simulation Generates Hit Events’ must be enabled.:
  • on_ai_spawned (FunctionalTestAISpawned): [Read-Write] Called when a single AI finished spawning
  • on_all_ais_pawned (FunctionalTestEventSignature): [Read-Write] Called when a all AI finished spawning
  • on_begin_cursor_over (ActorBeginCursorOverSignature): [Read-Write] Called when the mouse cursor is moved over this actor if mouse over events are enabled in the player controller.
  • on_clicked (ActorOnClickedSignature): [Read-Write] Called when the left mouse button is clicked while the mouse is over this actor and click events are enabled in the player controller.
  • on_destroyed (ActorDestroyedSignature): [Read-Write] Event triggered when the actor has been explicitly destroyed.
  • on_end_cursor_over (ActorEndCursorOverSignature): [Read-Write] Called when the mouse cursor is moved off this actor if mouse over events are enabled in the player controller.
  • on_end_play (ActorEndPlaySignature): [Read-Write] Event triggered when the actor is being deleted or removed from a level.
  • on_input_touch_begin (ActorOnInputTouchBeginSignature): [Read-Write] Called when a touch input is received over this actor when touch events are enabled in the player controller.
  • on_input_touch_end (ActorOnInputTouchEndSignature): [Read-Write] Called when a touch input is received over this component when touch events are enabled in the player controller.
  • on_input_touch_enter (ActorBeginTouchOverSignature): [Read-Write] Called when a finger is moved over this actor when touch over events are enabled in the player controller.
  • on_input_touch_leave (ActorEndTouchOverSignature): [Read-Write] Called when a finger is moved off this actor when touch over events are enabled in the player controller.
  • on_released (ActorOnReleasedSignature): [Read-Write] Called when the left mouse button is released while the mouse is over this actor and click events are enabled in the player controller.
  • on_take_any_damage (TakeAnyDamageSignature): [Read-Write] Called when the actor is damaged in any way.
  • on_take_point_damage (TakePointDamageSignature): [Read-Write] Called when the actor is damaged by point damage.
  • on_take_radial_damage (TakeRadialDamageSignature): [Read-Write] Called when the actor is damaged by radial damage.
  • on_test_finished (FunctionalTestEventSignature): [Read-Write] Called when the test is finished. Use it to clean up
  • on_test_prepare (FunctionalTestEventSignature): [Read-Write] Called when the test is ready to prepare
  • on_test_start (FunctionalTestEventSignature): [Read-Write] Called when the test is started
  • only_relevant_to_owner (bool): [Read-Write] If true, this actor is only relevant to its owner. If this flag is changed during play, all non-owner channels would need to be explicitly closed.
  • optimize_bp_component_data (bool): [Read-Write] Whether to cook additional data to speed up spawn events at runtime for any Blueprint classes based on this Actor. This option may slightly increase memory usage in a cooked build.
  • pending_delayed_spawns (Array(PendingDelayedSpawn)): [Read-Write] Pending Delayed Spawns
  • pivot_offset (Vector): [Read-Write] Local space pivot offset for the actor, only used in the editor
  • preparation_time_limit (float): [Read-Write] The Test’s time limit for preparation, this is the time it has to return true when checking IsReady(). ‘0’ means no limit.
  • primary_actor_tick (ActorTickFunction): [Read-Write] Primary Actor tick function, which calls TickActor(). Tick functions can be configured to control whether ticking is enabled, at what time during a frame the update occurs, and to set up tick dependencies. https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/Engine/FTickFunction/: AddTickPrerequisiteActor(), AddTickPrerequisiteComponent():
  • random_numbers_stream (RandomStream): [Read-Write] A random number stream that you can use during testing. This number stream will be consistent every time the test is run.
  • relevant_for_level_bounds (bool): [Read-Write] If true, this actor’s component’s bounds will be included in the level’s bounding box unless the Actor’s class has overridden IsLevelBoundsRelevant
  • replay_rewindable (bool): [Read-Write] If true, this actor will only be destroyed during scrubbing if the replay is set to a time before the actor existed. Otherwise, RewindForReplay will be called if we detect the actor needs to be reset. Note, this Actor must not be destroyed by gamecode, and RollbackViaDeletion may not be used.
  • replicate_movement (bool): [Read-Write] If true, replicate movement/location related properties. Actor must also be set to replicate. SetReplicates(): https://docs.unrealengine.com/latest/INT/Gameplay/Networking/Replication/:
  • replicated_movement (RepMovement): [Read-Write] Used for replication of our RootComponent’s position and velocity
  • replicates (bool): [Read-Write] If true, this actor will replicate to remote machines SetReplicates():
  • result (FunctionalTestResult): [Read-Write] Result
  • root_component (SceneComponent): [Read-Write] The component that defines the transform (location, rotation, scale) of this Actor in the world, all other components must be attached to this one somehow
  • spawn_collision_handling_method (SpawnActorCollisionHandlingMethod): [Read-Write] Controls how to handle spawning this actor in a situation where it’s colliding with something else. “Default” means AlwaysSpawn here.
  • spawn_location_randomization_range (float): [Read-Write] Spawn Location Randomization Range
  • spawn_sets (Array(AITestSpawnSet)): [Read-Write] Spawn Sets
  • spawned_pawns (Array(Pawn)): [Read-Write] Spawned Pawns
  • sprite_scale (float): [Read-Write] The scale to apply to any billboard components in editor builds (happens in any WITH_EDITOR build, including non-cooked games).
  • tags (Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing.
  • time_limit (float): [Read-Write] Test’s time limit. ‘0’ means no limit
  • times_up_message (Text): [Read-Write] Times Up Message
  • times_up_result (FunctionalTestResult): [Read-Write] If test is limited by time this is the result that will be returned when time runs out
  • total_time (float): [Read-Write] Total Time
  • wait_for_nav_mesh (bool): [Read-Write] if set, ftest will postpone start until navmesh is fully generated
  • warnings_as_errors_value (bool): [Read-Write] If this is enabled, any warning logged while this functional test is running is treated as an error.
current_spawn_set_index

(int32) – [Read-Only] Current Spawn Set Index

current_spawn_set_name

(str) – [Read-Only] Current Spawn Set Name

is_one_of_spawned_pawns(actor) → bool

Is One Of Spawned Pawns

Parameters:actor (Actor) –
Returns:
Return type:bool
on_ai_spawned

(FunctionalTestAISpawned) – [Read-Write] Called when a single AI finished spawning

on_all_ais_pawned

(FunctionalTestEventSignature) – [Read-Write] Called when a all AI finished spawning

pending_delayed_spawns

(Array(PendingDelayedSpawn)) – [Read-Only] Pending Delayed Spawns

spawn_location_randomization_range

(float) – [Read-Only] Spawn Location Randomization Range

spawn_sets

(Array(AITestSpawnSet)) – [Read-Only] Spawn Sets

spawned_pawns

(Array(Pawn)) – [Read-Only] Spawned Pawns

wait_for_nav_mesh

(bool) – [Read-Only] if set, ftest will postpone start until navmesh is fully generated