AttachmentInterface

Inherits from ScriptInterface

States:

• attach_on_reset bool

Inputs:

• attachment ReferenceFramePtr

Parameters:

• position Position

Methods:

BooleanLogicInterface

Inherits from EvaluatorInterface

Targets:

• on_true
• on_false

Inputs:

• LHS bool
• RHS bool

Outputs:

• Result bool

Methods:

CameraBehaviorInterface

Inherits from EntityInterface

States:

• start_on_reset bool
• pause_on_reset bool
• enable_on_reset bool

Inputs:

• linked_cameras CAMERA_INSTANCE

Parameters:

• behavior_name String
• priority int
• threshold float
• blend_in float
• duration float
• blend_out float

Methods:

CloseableInterface

Inherits from ScriptInterface

States:

• open_on_reset bool

Methods:

CompositeInterface

Inherits from AttachmentInterface

States:

• is_template bool
• local_only bool
• suspend_on_reset bool
• deleted bool
• is_shared bool
• requires_script_for_current_gen bool
• requires_script_for_next_gen bool
• convert_to_physics bool
• delete_standard_collision bool
• delete_ballistic_collision bool

Parameters:

• disable_display bool
• disable_collision bool
• disable_simulation bool
• mapping FilePath
• include_in_planar_reflections bool

Methods:

EntityInterface

EvaluatorInterface

Inherits from InspectorInterface

Methods:

GateInterface

Inherits from ScriptInterface

States:

• open_on_reset bool
• lock_on_reset bool

Methods:

GateResourceInterface

Inherits from ScriptInterface

Targets:

• gate_status_changed

Inputs:

• request_open_on_reset bool
• request_lock_on_reset bool
• force_open_on_reset bool
• force_close_on_reset bool
• is_auto bool
• auto_close_delay float

Outputs:

• is_open bool
• is_locked bool
• gate_status int

Methods:

GetComponentInterface

Inherits from EvaluatorInterface

Inputs:

• Input Direction

Outputs:

• Result float

Methods:

InspectorInterface

Inherits from ScriptInterface

Methods:

ModifierInterface

Inherits from InspectorInterface

Methods:

ProxyInterface

Inherits from ScriptInterface

States:

• proxy_filter_targets bool
• proxy_enable_on_reset bool

Methods:

ScriptInterface

Inherits from EntityInterface

States:

• delete_me bool

Parameters:

• name String

SensorAttachmentInterface

Inherits from AttachmentInterface

States:

• start_on_reset bool
• pause_on_reset bool

Methods:

SensorInterface

Inherits from ScriptInterface

States:

• start_on_reset bool
• pause_on_reset bool

Methods:

TransformerInterface

Inherits from SensorInterface

Methods:

ZoneInterface

Inherits from ScriptInterface

Targets:

• on_loaded
• on_unloaded
• on_streaming

Parameters:

• force_visible_on_load bool

Methods:

AccessTerminal

Inherits from ScriptInterface

Targets:

• closed
• all_data_has_been_read
• ui_breakout_triggered

States:

• light_on_reset bool

Inputs:

• folder0 TERMINAL_FOLDER_DETAILS
• folder1 TERMINAL_FOLDER_DETAILS
• folder2 TERMINAL_FOLDER_DETAILS
• folder3 TERMINAL_FOLDER_DETAILS

Outputs:

• all_data_read bool

Parameters:

• location TERMINAL_LOCATION

Methods:

AchievementMonitor

Inherits from ScriptInterface

Parameters:

• achievement_id ACHIEVEMENT_ID

Methods:

AchievementStat

Inherits from ScriptInterface

Parameters:

• achievement_id ACHIEVEMENT_STAT_ID

Methods:

AchievementUniqueCounter

Inherits from ScriptInterface

Parameters:

• achievement_id ACHIEVEMENT_STAT_ID
• unique_object Object

Methods:

AddExitObjective

Inherits from ScriptInterface

Inputs:

• marker Position

Parameters:

• level_name EXIT_WAYPOINT

Methods:

AddItemsToGCPool

Inherits from ScriptInterface

Inputs:

• items INVENTORY_ITEM_QUANTITY

Methods:

AddToInventory

Inherits from ScriptInterface

Targets:

• success
• fail

Inputs:

• items Object

Methods:

AILightCurveSettings

Inherits from InspectorInterface

Parameters:

• y0 float
• x1 float
• y1 float
• x2 float
• y2 float
• x3 float

Methods:

AIMED_ITEM

Inherits from EQUIPPABLE_ITEM

Targets:

• on_started_aiming
• on_stopped_aiming
• on_display_on
• on_display_off
• on_effect_on
• on_effect_off

Outputs:

• target_position Position
• average_target_distance float
• min_target_distance float

Parameters:

• fixed_target_distance_for_local_player float

Methods:

AIMED_WEAPON

Inherits from AIMED_ITEM

Targets:

• on_fired_success
• on_fired_fail
• on_fired_fail_single
• on_impact
• on_reload_started
• on_reload_another
• on_reload_empty_clip
• on_reload_canceled
• on_reload_success
• on_reload_fail
• on_shooting_started
• on_shooting_wind_down
• on_shooting_finished
• on_overheated
• on_cooled_down
• on_charge_complete
• on_charge_started
• on_charge_stopped
• on_turned_on
• on_turned_off
• on_torch_on_requested
• on_torch_off_requested

Outputs:

• ammoRemainingInClip int
• ammoToFillClip int
• ammoThatWasInClip int
• charge_percentage float
• charge_noise_percentage float

Parameters:

• weapon_type WEAPON_TYPE
• requires_turning_on bool
• ejectsShellsOnFiring bool
• aim_assist_scale float
• default_ammo_type AMMO_TYPE
• starting_ammo int
• clip_size int
• consume_ammo_over_time_when_turned_on float
• max_auto_shots_per_second float
• max_manual_shots_per_second float
• wind_down_time_in_seconds float
• maximum_continous_fire_time_in_seconds float
• overheat_recharge_time_in_seconds float
• automatic_firing bool
• overheats bool
• charged_firing bool
• charging_duration float
• min_charge_to_fire float
• overcharge_timer float
• charge_noise_start_time float
• reloadIndividualAmmo bool
• alwaysDoFullReloadOfClips bool
• movement_accuracy_penalty_per_second float
• aim_rotation_accuracy_penalty_per_second float
• accuracy_penalty_per_shot float
• accuracy_accumulated_per_second float
• player_exposed_accuracy_penalty_per_shot float
• player_exposed_accuracy_accumulated_per_second float
• recoils_on_fire bool
• alien_threat_aware bool

Methods:

ALLIANCE_ResetAll

Inherits from ScriptInterface

Methods:

ALLIANCE_SetDisposition

Inherits from ScriptInterface

Parameters:

• A ALLIANCE_GROUP
• B ALLIANCE_GROUP
• Disposition ALLIANCE_STANCE

Methods:

AllocateGCItemFromPoolBySubset

Inherits from ScriptInterface

Targets:

• on_success
• on_failure

Inputs:

• selectable_items Object

Outputs:

• item_name String
• item_quantity int

Parameters:

• force_usage bool
• distribution_bias float

Methods:

AllocateGCItemsFromPool

Inherits from ScriptInterface

Targets:

• on_success
• on_failure

Inputs:

• items INVENTORY_ITEM_QUANTITY

Parameters:

• force_usage_count int
• distribution_bias float

Methods:

AllPlayersReady

Inherits from SensorInterface

Targets:

• on_all_players_ready

States:

• start_on_reset bool
• pause_on_reset bool

Parameters:

• activation_delay float

Methods:

AnimatedModelAttachmentNode

Inherits from ScriptInterface

States:

• attach_on_reset bool

Inputs:

• animated_model Object
• attachment ReferenceFramePtr

Parameters:

• bone_name String
• use_offset bool
• offset Position

Methods:

AnimationMask

Inherits from ScriptInterface

Parameters:

• maskHips bool
• maskTorso bool
• maskNeck bool
• maskHead bool
• maskFace bool
• maskLeftLeg bool
• maskRightLeg bool
• maskLeftArm bool
• maskRightArm bool
• maskLeftHand bool
• maskRightHand bool
• maskLeftFingers bool
• maskRightFingers bool
• maskTail bool
• maskLips bool
• maskEyes bool
• maskLeftShoulder bool
• maskRightShoulder bool
• maskRoot bool
• maskPrecedingLayers bool
• maskSelf bool
• maskFollowingLayers bool
• weight float

Internals:

• resource ANIMATION_MASK_RESOURCE

ApplyRelativeTransform

Inherits from ScriptInterface

Inputs:

• origin Position
• destination Position
• input Position

Outputs:

• output Position

Parameters:

• use_trigger_entity bool

Methods:

AreaHitMonitor

Inherits from SensorInterface

Targets:

• on_flamer_hit
• on_shotgun_hit
• on_pistol_hit

Inputs:

• SpherePos Position
• SphereRadius float

Methods:

AssetSpawner

Inherits from AttachmentInterface

Targets:

• finished_spawning
• callback_triggered
• forced_despawn

States:

• spawn_on_reset bool

Inputs:

• asset Object

Parameters:

• spawn_on_load bool
• allow_forced_despawn bool
• persist_on_callback bool
• allow_physics bool

Methods:

Benchmark

Inherits from ScriptInterface

Parameters:

• benchmark_name String
• save_stats bool

Methods:

BindObjectsMultiplexer

Inherits from ModifierInterface

Targets:

• Pin1_Bound
• Pin2_Bound
• Pin3_Bound
• Pin4_Bound
• Pin5_Bound
• Pin6_Bound
• Pin7_Bound
• Pin8_Bound
• Pin9_Bound
• Pin10_Bound

Inputs:

• objects Object

Methods:

BlendLowResFrame

Inherits from PostprocessingSettings

Parameters:

• blend_value float

Methods:

BloomSettings

Inherits from PostprocessingSettings

Inputs:

• frame_buffer_scale float
• frame_buffer_offset float
• bloom_scale float
• bloom_gather_exponent float
• bloom_gather_scale float

Methods:

BoneAttachedCamera

Inherits from CameraBehaviorInterface

Inputs:

• character Object

Parameters:

• position_offset Direction
• rotation_offset Direction
• movement_damping float
• bone_name String

Methods:

BooleanLogicOperation

Inherits from EvaluatorInterface

Inputs:

• Input bool

Outputs:

• Result bool

Methods:

Box

Inherits from AttachmentInterface

Targets:

• event

States:

• enable_on_reset bool

Parameters:

• half_dimensions Direction
• include_physics bool

Methods:

BroadcastTrigger

Inherits from ScriptInterface

Targets:

• on_triggered

Methods:

BulletChamber

Inherits from ScriptInterface

Inputs:

• Slot1 Object
• Slot2 Object
• Slot3 Object
• Slot4 Object
• Slot5 Object
• Slot6 Object
• Weapon Object
• Geometry Object

Methods:

ButtonMashPrompt

Inherits from ScriptInterface

Targets:

• on_back_to_zero
• on_degrade
• on_mashed
• on_success

Outputs:

• count int

Parameters:

• mashes_to_completion int
• time_between_degrades float
• use_degrade bool
• hold_to_charge bool

Methods:

CAGEAnimation

Inherits from TransformerInterface

Targets:

• animation_finished
• animation_interrupted
• animation_changed
• cinematic_loaded
• cinematic_unloaded

States:

• enable_on_reset bool

Inputs:

• external_time float

Outputs:

• current_time float

Parameters:

• use_external_time bool
• rewind_on_stop bool
• jump_to_the_end bool
• playspeed float
• anim_length float
• is_cinematic bool
• is_cinematic_skippable bool
• skippable_timer float
• capture_video bool
• capture_clip_name String

Internals:

• playback float

Methods:

CameraAimAssistant

Inherits from EntityInterface

States:

• enable_on_reset bool

Parameters:

• activation_radius float
• inner_radius float
• camera_speed_attenuation float
• min_activation_distance float
• fading_range float

Methods:

CameraCollisionBox

Inherits from Box

Methods:

CameraDofController

Inherits from CameraBehaviorInterface

Inputs:

• character_to_focus Object
• focal_length_mm float
• focal_plane_m float
• fnum float
• focal_point Position

Parameters:

• focal_point_offset Direction
• bone_to_focus String

CameraFinder

Inherits from EntityInterface

Parameters:

• camera_name String

Methods:

CameraPath

Inherits from EntityInterface

Inputs:

• linked_splines SPLINE

Parameters:

• path_name String
• path_type CAMERA_PATH_TYPE
• path_class CAMERA_PATH_CLASS
• is_local bool
• relative_position Position
• is_loop bool
• duration float

Methods:

CameraPathDriven

Inherits from CameraBehaviorInterface

Inputs:

• position_path SPLINE
• target_path SPLINE
• reference_path SPLINE
• position_path_transform Position
• target_path_transform Position
• reference_path_transform Position
• point_to_project Direction

Parameters:

• path_driven_type PATH_DRIVEN_TYPE
• invert_progression bool
• position_path_offset float
• target_path_offset float
• animation_duration float

Methods:

CameraPlayAnimation

Inherits from SensorInterface

Targets:

• on_animation_finished

Inputs:

• animated_camera Object
• position_marker Position
• character_to_focus Object
• focal_length_mm float
• focal_plane_m float
• fnum float
• focal_point Position

Outputs:

• animation_length float
• frames_count int
• result_transformation Position

Parameters:

• data_file String
• start_frame int
• end_frame int
• play_speed float
• loop_play bool
• clipping_planes_preset CLIPPING_PLANES_PRESETS
• is_cinematic bool
• dof_key int
• shot_number int
• override_dof bool
• focal_point_offset Direction
• bone_to_focus String

Methods:

CameraResource

Inherits from AttachmentInterface

Targets:

• on_enter_transition_finished
• on_exit_transition_finished

States:

• enable_on_reset bool

Parameters:

• camera_name String
• is_camera_transformation_local bool
• camera_transformation Position
• fov float
• clipping_planes_preset CLIPPING_PLANES_PRESETS
• is_ghost bool
• converge_to_player_camera bool
• reset_player_camera_on_exit bool
• enable_enter_transition bool
• transition_curve_direction TRANSITION_DIRECTION
• transition_curve_strength float
• transition_duration float
• transition_ease_in float
• transition_ease_out float
• enable_exit_transition bool
• exit_transition_curve_direction TRANSITION_DIRECTION
• exit_transition_curve_strength float
• exit_transition_duration float
• exit_transition_ease_in float
• exit_transition_ease_out float

Methods:

CameraShake

Inherits from CameraBehaviorInterface

Inputs:

• relative_transformation Position
• impulse_intensity float
• impulse_position Direction

Parameters:

• shake_type SHAKE_TYPE
• shake_frequency Direction
• max_rotation_angles Direction
• max_position_offset Direction
• shake_rotation bool
• shake_position bool
• bone_shaking bool
• override_weapon_swing bool
• internal_radius float
• external_radius float
• strength_damping float
• explosion_push_back bool
• spring_constant float
• spring_damping float

Methods:

CamPeek

Inherits from CameraBehaviorInterface

Outputs:

• pos Position
• x_ratio float
• y_ratio float

Parameters:

• range_left float
• range_right float
• range_up float
• range_down float
• range_forward float
• range_backward float
• speed_x float
• speed_y float
• damping_x float
• damping_y float
• focal_distance float
• focal_distance_y float
• roll_factor float
• use_ik_solver bool
• use_horizontal_plane bool
• stick SIDE
• disable_collision_test bool

Character

Inherits from ScriptInterface

Targets:

• finished_spawning
• finished_respawning
• dead_container_take_slot
• dead_container_emptied
• on_ragdoll_impact
• on_footstep
• on_despawn_requested

States:

• spawn_on_reset bool
• show_on_reset bool

Inputs:

• contents_of_dead_container INVENTORY_ITEM_QUANTITY

Parameters:

• PopToNavMesh bool
• is_cinematic bool
• disable_dead_container bool
• allow_container_without_death bool
• container_interaction_text String
• anim_set ANIM_SET
• anim_tree_set ANIM_TREE_SET
• attribute_set ATTRIBUTE_SET
• is_player bool
• is_backstage bool
• force_backstage_on_respawn bool
• character_class CHARACTER_CLASS
• alliance_group ALLIANCE_GROUP
• dialogue_voice DIALOGUE_VOICE_ACTOR
• spawn_id int
• position Position
• display_model String
• reference_skeleton CHR_SKELETON_SET
• torso_sound SOUND_TORSO_GROUP
• leg_sound SOUND_LEG_GROUP
• footwear_sound SOUND_FOOTWEAR_GROUP
• custom_character_type CUSTOM_CHARACTER_TYPE
• custom_character_accessory_override CUSTOM_CHARACTER_ACCESSORY_OVERRIDE
• custom_character_population_type CUSTOM_CHARACTER_POPULATION
• named_custom_character String
• named_custom_character_assets_set CUSTOM_CHARACTER_ASSETS
• gcip_distribution_bias float
• inventory_set PLAYER_INVENTORY_SET

Methods:

CharacterAttachmentNode

Inherits from ScriptInterface

States:

• attach_on_reset bool

Inputs:

• character CHARACTER
• attachment ReferenceFramePtr

Parameters:

• Node CHARACTER_NODE
• AdditiveNode CHARACTER_NODE
• AdditiveNodeIntensity float
• UseOffset bool
• Translation Direction
• Rotation Direction

Methods:

CharacterCommand

Inherits from ScriptInterface

Targets:

• command_started

Parameters:

• override_all_ai bool

CharacterShivaArms

Inherits from ScriptInterface

Methods:

CharacterTypeMonitor

Inherits from ScriptInterface

Targets:

• spawned
• despawned
• all_despawned

Outputs:

• AreAny bool

Parameters:

• character_class CHARACTER_CLASS_COMBINATION
• trigger_on_start bool
• trigger_on_checkpoint_restart bool

Methods:

Checkpoint

Inherits from ModifierInterface

Targets:

• on_checkpoint
• on_captured
• on_saved
• finished_saving
• finished_loading
• cancelled_saving
• finished_saving_to_hdd

Inputs:

• player_spawn_position Position

Parameters:

• is_first_checkpoint bool
• is_first_autorun_checkpoint bool
• section String
• mission_number float
• checkpoint_type CHECKPOINT_TYPE

Methods:

CheckpointRestoredNotify

Inherits from ScriptInterface

Targets:

• restored

ChokePoint

Inherits from AttachmentInterface

Internals:

• resource CHOKE_POINT_RESOURCE

Methods:

CHR_DamageMonitor

Inherits from MonitorBase

Targets:

• damaged

Inputs:

• InstigatorFilter bool

Outputs:

• DamageDone int
• Instigator Object

Parameters:

• DamageType DAMAGE_EFFECTS

CHR_DeathMonitor

Inherits from MonitorBase

Targets:

• dying
• killed

Inputs:

• KillerFilter bool

Outputs:

• Killer Object

Parameters:

• DamageType DAMAGE_EFFECTS

CHR_DeepCrouch

Inherits from ScriptInterface

Parameters:

• crouch_amount float
• smooth_damping float
• allow_stand_up bool

Methods:

CHR_GetAlliance

Inherits from ScriptInterface

Outputs:

• Alliance Enum

Methods:

CHR_GetHealth

Inherits from ScriptInterface

Outputs:

• Health int

Methods:

CHR_GetTorch

Inherits from ScriptInterface

Targets:

• torch_on
• torch_off

Outputs:

• TorchOn bool

Methods:

CHR_HasWeaponOfType

Inherits from ScriptInterface

Targets:

• on_true
• on_false

Outputs:

• Result bool

Parameters:

• weapon_type WEAPON_TYPE
• check_if_weapon_draw bool

Methods:

CHR_HoldBreath

Inherits from ScriptInterface

Parameters:

• ExhaustionOnStop float

Methods:

CHR_IsWithinRange

Inherits from ScriptInterface

Targets:

• In_range
• Out_of_range

Inputs:

• Position Position
• Radius float
• Height float

Parameters:

• Range_test_shape RANGE_TEST_SHAPE

Methods:

CHR_KnockedOutMonitor

Inherits from MonitorBase

Targets:

• on_knocked_out
• on_recovered

CHR_LocomotionDuck

Inherits from ScriptInterface

Parameters:

• Height DUCK_HEIGHT

Methods:

CHR_LocomotionEffect

Inherits from ModifierInterface

Parameters:

• Effect ANIMATION_EFFECT_TYPE

Methods:

CHR_LocomotionModifier

Inherits from ModifierInterface

Parameters:

• Can_Run bool
• Can_Crouch bool
• Can_Aim bool
• Can_Injured bool
• Must_Walk bool
• Must_Run bool
• Must_Crouch bool
• Must_Aim bool
• Must_Injured bool
• Is_In_Spacesuit bool

Methods:

CHR_ModifyBreathing

Inherits from ScriptInterface

Parameters:

• Exhaustion float

Methods:

Chr_PlayerCrouch

Inherits from ScriptInterface

Parameters:

• crouch bool

Methods:

CHR_PlayNPCBark

Inherits from ScriptInterface

Targets:

• on_speech_started
• on_speech_finished

Parameters:

• queue_time float
• sound_event SOUND_EVENT
• speech_priority SPEECH_PRIORITY
• dialogue_mode SOUND_ARGUMENT
• action SOUND_ARGUMENT

Methods:

CHR_PlaySecondaryAnimation

Inherits from ScriptInterface

Targets:

• Interrupted
• finished
• on_loaded

Inputs:

• Marker Object
• OptionalMask Object
• ExternalStartTime Object
• ExternalTime Object

Outputs:

• animationLength float

Parameters:

• AnimationSet String
• Animation String
• StartFrame int
• EndFrame int
• PlayCount int
• PlaySpeed float
• StartInstantly bool
• AllowInterruption bool
• BlendInTime float
• GaitSyncStart bool
• Mirror bool
• AnimationLayer SECONDARY_ANIMATION_LAYER
• AutomaticZoning bool
• ManualLoading bool

Methods:

CHR_RetreatMonitor

Inherits from MonitorBase

Targets:

• reached_retreat
• started_retreating

CHR_SetAlliance

Inherits from ScriptInterface

Parameters:

• Alliance ALLIANCE_GROUP

Methods:

CHR_SetAndroidThrowTarget

Inherits from ScriptInterface

Targets:

• thrown

Inputs:

• throw_position Position

Methods:

CHR_SetDebugDisplayName

Inherits from ScriptInterface

Parameters:

• DebugName String

Methods:

CHR_SetFacehuggerAggroRadius

Inherits from ScriptInterface

Parameters:

• radius float

Methods:

CHR_SetFocalPoint

Inherits from ScriptInterface

Inputs:

• focal_point Position

Parameters:

• priority PRIORITY
• speed LOOK_SPEED
• steal_camera bool
• line_of_sight_test bool

Methods:

CHR_SetHeadVisibility

Inherits from ScriptInterface

Parameters:

• is_visible bool

Methods:

CHR_SetHealth

Inherits from ScriptInterface

Parameters:

• HealthPercentage int
• UsePercentageOfCurrentHeath bool

Methods:

CHR_SetInvincibility

Inherits from ScriptInterface

Parameters:

• damage_mode DAMAGE_MODE

Methods:

CHR_SetMood

Inherits from ModifierInterface

Parameters:

• mood MOOD
• moodIntensity MOOD_INTENSITY
• timeOut float

Methods:

CHR_SetShowInMotionTracker

Inherits from ScriptInterface

Methods:

CHR_SetSubModelVisibility

Inherits from ScriptInterface

Parameters:

• is_visible bool
• matching String

Methods:

CHR_SetTacticalPosition

Inherits from ScriptInterface

Inputs:

• tactical_position Position

Parameters:

• sweep_type AREA_SWEEP_TYPE
• fixed_sweep_radius float

Methods:

CHR_SetTacticalPositionToTarget

Inherits from ScriptInterface

Methods:

CHR_SetTorch

Inherits from ScriptInterface

Parameters:

• TorchOn bool

Methods:

CHR_TakeDamage

Inherits from ScriptInterface

Parameters:

• Damage int
• DamageIsAPercentage bool
• AmmoType AMMO_TYPE

Methods:

CHR_TorchMonitor

Inherits from MonitorBase

Targets:

• torch_on
• torch_off

Outputs:

• TorchOn bool

Parameters:

• trigger_on_start bool
• trigger_on_checkpoint_restart bool

CHR_VentMonitor

Inherits from MonitorBase

Targets:

• entered_vent
• exited_vent

Outputs:

• IsInVent bool

Parameters:

• trigger_on_start bool
• trigger_on_checkpoint_restart bool

CHR_WeaponFireMonitor

Inherits from MonitorBase

Targets:

• fired

ChromaticAberrations

Inherits from PostprocessingSettings

Parameters:

• aberration_scalar float

Methods:

ClearPrimaryObjective

Inherits from ScriptInterface

Parameters:

• clear_all_sub_objectives bool

Methods:

ClearSubObjective

Inherits from ScriptInterface

Parameters:

• slot_number int

Methods:

ClipPlanesController

Inherits from CameraBehaviorInterface

Inputs:

• near_plane float
• far_plane float
• update_near bool
• update_far bool

CMD_AimAt

Inherits from CharacterCommand

Targets:

• finished

Inputs:

• AimTarget Object

Parameters:

• Raise_gun bool
• use_current_target bool

Methods:

CMD_AimAtCurrentTarget

Inherits from CharacterCommand

Targets:

• succeeded

Parameters:

• Raise_gun bool

Methods:

CMD_Die

Inherits from CharacterCommand

Inputs:

• Killer Object

Parameters:

• death_style DEATH_STYLE

Methods:

CMD_Follow

Inherits from CharacterCommand

Targets:

• entered_inner_radius
• exitted_outer_radius
• failed

Inputs:

• Waypoint Position

Parameters:

• idle_stance IDLE
• move_type MOVE
• inner_radius float
• outer_radius float
• prefer_traversals bool

Methods:

CMD_FollowUsingJobs

Inherits from CharacterCommand

Targets:

• failed

Inputs:

• target_to_follow Position
• who_Im_leading Object

Parameters:

• fastest_allowed_move_type MOVE
• slowest_allowed_move_type MOVE
• centre_job_restart_radius float
• inner_radius float
• outer_radius float
• job_select_radius float
• job_cancel_radius float
• teleport_required_range float
• teleport_radius float
• prefer_traversals bool
• avoid_player bool
• allow_teleports bool
• follow_type FOLLOW_TYPE
• clamp_speed bool

Methods:

CMD_ForceMeleeAttack

Inherits from ScriptInterface

Parameters:

• melee_attack_type MELEE_ATTACK_TYPE
• enemy_type ENEMY_TYPE
• melee_attack_index int

Methods:

CMD_ForceReloadWeapon

Inherits from ScriptInterface

Targets:

• success

Methods:

CMD_GoTo

Inherits from CharacterCommand

Targets:

• succeeded
• failed

Inputs:

• Waypoint Position
• AimTarget Object

Parameters:

• move_type MOVE
• enable_lookaround bool
• use_stopping_anim bool
• always_stop_at_radius bool
• stop_at_radius_if_lined_up bool
• continue_from_previous_move bool
• disallow_traversal bool
• arrived_radius float
• should_be_aiming bool
• use_current_target_as_aim bool
• allow_to_use_vents bool
• DestinationIsBackstage bool
• maintain_current_facing bool
• start_instantly bool

Methods:

CMD_GoToCover

Inherits from CharacterCommand

Targets:

• succeeded
• failed
• entered_cover

Inputs:

• CoverPoint Position
• AimTarget Object

Parameters:

• move_type MOVE
• SearchRadius float
• enable_lookaround bool
• duration float
• continue_from_previous_move bool
• disallow_traversal bool
• should_be_aiming bool
• use_current_target_as_aim bool

Methods:

CMD_HolsterWeapon

Inherits from ScriptInterface

Targets:

• failed
• success

Parameters:

• should_holster bool
• skip_anims bool
• equipment_slot EQUIPMENT_SLOT
• force_player_unarmed_on_holster bool
• force_drop_held_item bool

Methods:

CMD_Idle

Inherits from CharacterCommand

Targets:

• finished
• interrupted

Inputs:

• target_to_face Position

Parameters:

• should_face_target bool
• should_raise_gun_while_turning bool
• desired_stance CHARACTER_STANCE
• duration float
• idle_style IDLE_STYLE
• lock_cameras bool
• anchor bool
• start_instantly bool

Methods:

CMD_LaunchMeleeAttack

Inherits from CharacterCommand

Targets:

• finished

Parameters:

• melee_attack_type MELEE_ATTACK_TYPE
• enemy_type ENEMY_TYPE
• melee_attack_index int
• skip_convergence bool

Methods:

CMD_ModifyCombatBehaviour

Inherits from ScriptInterface

Parameters:

• behaviour_type COMBAT_BEHAVIOUR
• status bool

Methods:

CMD_MoveTowards

Inherits from CharacterCommand

Targets:

• succeeded
• failed

Inputs:

• MoveTarget Position
• AimTarget Object

Parameters:

• move_type MOVE
• disallow_traversal bool
• should_be_aiming bool
• use_current_target_as_aim bool
• never_succeed bool

Methods:

CMD_PlayAnimation

Inherits from CharacterCommand

Targets:

• Interrupted
• finished
• badInterrupted
• on_loaded

Inputs:

• SafePos Object
• Marker Object
• ExitPosition Object
• ExternalStartTime Object
• ExternalTime Object
• OverrideCharacter Object
• OptionalMask Object

Outputs:

• animationLength float

Parameters:

• AnimationSet String
• Animation String
• StartFrame int
• EndFrame int
• PlayCount int
• PlaySpeed float
• AllowGravity bool
• AllowCollision bool
• Start_Instantly bool
• AllowInterruption bool
• RemoveMotion bool
• DisableGunLayer bool
• BlendInTime float
• GaitSyncStart bool
• ConvergenceTime float
• LocationConvergence bool
• OrientationConvergence bool
• UseExitConvergence bool
• ExitConvergenceTime float
• Mirror bool
• FullCinematic bool
• RagdollEnabled bool
• NoIK bool
• NoFootIK bool
• NoLayers bool
• PlayerAnimDrivenView bool
• ExertionFactor float
• AutomaticZoning bool
• ManualLoading bool
• IsCrouchedAnim bool
• InitiallyBackstage bool
• Death_by_ragdoll_only bool
• dof_key int
• shot_number int
• UseShivaArms bool

Internals:

• resource PLAY_ANIMATION_DATA_RESOURCE

Methods:

CMD_Ragdoll

Inherits from ScriptInterface

Targets:

• finished

Inputs:

• actor CHARACTER
• impact_velocity Direction

Methods:

CMD_ShootAt

Inherits from CharacterCommand

Targets:

• succeeded
• failed

Inputs:

• Target Object

Methods:

CMD_StopScript

Inherits from CharacterCommand

Methods:

CollectIDTag

Inherits from ScriptInterface

Parameters:

• tag_id IDTAG_ID

Methods:

CollectNostromoLog

Inherits from ScriptInterface

Parameters:

• log_id NOSTROMO_LOG_ID

Methods:

CollectSevastopolLog

Inherits from ScriptInterface

Parameters:

• log_id SEVASTOPOL_LOG_ID

Methods:

CollisionBarrier

Inherits from Box

Targets:

• on_damaged

States:

• deleted bool

Parameters:

• collision_type COLLISION_TYPE
• static_collision bool

Methods:

ColourCorrectionTransition

Inherits from TransformerInterface

Inputs:

• interpolate float

Parameters:

• colour_lut_a String
• colour_lut_b String
• lut_a_contribution float
• lut_b_contribution float

Internals:

• colour_lut_a_index int
• colour_lut_b_index int

Methods:

ColourSettings

Inherits from PostprocessingSettings

Inputs:

• brightness float
• contrast float
• saturation float
• red_tint float
• green_tint float
• blue_tint float

Methods:

CompoundVolume

Inherits from InspectorInterface

Targets:

• event

Methods:

ControllableRange

Inherits from CameraBehaviorInterface

Parameters:

• min_range_x float
• max_range_x float
• min_range_y float
• max_range_y float
• min_feather_range_x float
• max_feather_range_x float
• min_feather_range_y float
• max_feather_range_y float
• speed_x float
• speed_y float
• damping_x float
• damping_y float
• mouse_speed_x float
• mouse_speed_y float

Convo

Inherits from ScriptInterface

Targets:

• everyoneArrived
• playerJoined
• playerLeft
• npcJoined

Inputs:

• members LOGIC_CHARACTER

Outputs:

• speaker Object

Parameters:

• alwaysTalkToPlayerIfPresent bool
• playerCanJoin bool
• playerCanLeave bool
• positionNPCs bool
• circularShape bool
• convoPosition Object
• personalSpaceRadius float

Methods:

Counter

Inherits from ModifierInterface

Targets:

• on_under_limit
• on_limit
• on_over_limit

Outputs:

• Count int

Parameters:

• is_limitless bool
• trigger_limit int

Methods:

CoverExclusionArea

Inherits from ScriptInterface

Parameters:

• position Position
• half_dimensions Direction
• exclude_cover bool
• exclude_vaults bool
• exclude_mantles bool
• exclude_jump_downs bool
• exclude_crawl_space_spotting_positions bool
• exclude_spotting_positions bool
• exclude_assault_positions bool

CoverLine

Inherits from ScriptInterface

States:

• enable_on_reset bool

Inputs:

• LinePath SPLINE
• low bool

Internals:

• resource CATHODE_COVER_SEGMENT
• LinePathPosition Position

Methods:

Custom_Hiding_Controller

Inherits from ScriptInterface

Targets:

• Started_Idle
• Started_Exit
• Got_Out
• Prompt_1
• Prompt_2
• Start_choking
• Start_oxygen_starvation
• Show_MT
• Hide_MT
• Spawn_MT
• Despawn_MT
• Start_Busted_By_Alien
• Start_Busted_By_Android
• End_Busted_By_Android
• Start_Busted_By_Human
• End_Busted_By_Human

Inputs:

• Enter_Anim PLAY_ANIMATION_DATA_RESOURCE
• Idle_Anim PLAY_ANIMATION_DATA_RESOURCE
• Exit_Anim PLAY_ANIMATION_DATA_RESOURCE
• has_MT bool
• is_high bool
• AlienBusted_Player_1 PLAY_ANIMATION_DATA_RESOURCE
• AlienBusted_Alien_1 PLAY_ANIMATION_DATA_RESOURCE
• AlienBusted_Player_2 PLAY_ANIMATION_DATA_RESOURCE
• AlienBusted_Alien_2 PLAY_ANIMATION_DATA_RESOURCE
• AlienBusted_Player_3 PLAY_ANIMATION_DATA_RESOURCE
• AlienBusted_Alien_3 PLAY_ANIMATION_DATA_RESOURCE
• AlienBusted_Player_4 PLAY_ANIMATION_DATA_RESOURCE
• AlienBusted_Alien_4 PLAY_ANIMATION_DATA_RESOURCE
• AndroidBusted_Player_1 PLAY_ANIMATION_DATA_RESOURCE
• AndroidBusted_Android_1 PLAY_ANIMATION_DATA_RESOURCE
• AndroidBusted_Player_2 PLAY_ANIMATION_DATA_RESOURCE
• AndroidBusted_Android_2 PLAY_ANIMATION_DATA_RESOURCE

Outputs:

• MT_pos Position

Methods:

Custom_Hiding_Vignette_controller

Inherits from ScriptInterface

Targets:

• StartFade
• StopFade

Inputs:

• Breath int
• Blackout_start_time int
• run_out_time int

Outputs:

• Vignette float
• FadeValue float

Methods:

DayToneMappingSettings

Inherits from TransformerInterface

Inputs:

• black_point float
• cross_over_point float
• white_point float
• shoulder_strength float
• toe_strength float
• luminance_scale float

Methods:

DEBUG_SenseLevels

Inherits from InspectorInterface

Targets:

• no_activation
• trace_activation
• lower_activation
• normal_activation
• upper_activation

Parameters:

• Sense SENSORY_TYPE

Methods:

DebugCamera

Inherits from SensorInterface

Inputs:

• linked_cameras Object

Methods:

DebugCaptureCorpse

Inherits from EntityInterface

Targets:

• finished_capturing

Inputs:

• character Object

Parameters:

• corpse_name String

Methods:

DebugCaptureScreenShot

Inherits from AttachmentInterface

Targets:

• finished_capturing

Parameters:

• wait_for_streamer int
• capture_filename String
• fov float
• near float
• far float

Methods:

DebugCheckpoint

Inherits from ModifierInterface

Targets:

• on_checkpoint

Parameters:

• section String
• level_reset bool

Methods:

DebugEnvironmentMarker

Inherits from SensorInterface

Inputs:

• target Object
• float_input float
• int_input int
• bool_input bool
• vector_input Direction
• enum_input Enum

Parameters:

• text String
• namespace String
• size float
• colour Direction
• world_pos Position
• duration float
• scale_with_distance bool
• max_string_length int
• scroll_speed float
• show_distance_from_target bool

Methods:

DebugGraph

Inherits from SensorInterface

Inputs:

• Inputs float

Parameters:

• scale float
• duration float
• samples_per_second float
• auto_scale bool
• auto_scroll bool

Methods:

DebugLoadCheckpoint

Inherits from ModifierInterface

Parameters:

• previous_checkpoint bool

Methods:

DebugMenuToggle

Inherits from EntityInterface

Parameters:

• debug_variable String
• value bool

Methods:

DebugObjectMarker

Inherits from ScriptInterface

Parameters:

• marked_object Object
• marked_name String

DebugPositionMarker

Parameters:

• world_pos Position

DebugText

Inherits from SensorInterface

Targets:

• duration_finished

Inputs:

• float_input float
• int_input int
• bool_input bool
• vector_input Direction
• enum_input Enum
• text_input String

Parameters:

• text String
• namespace String
• size int
• colour Direction
• alignment TEXT_ALIGNMENT
• duration float
• pause_game bool
• cancel_pause_with_button_press bool
• priority int
• ci_type CI_MESSAGE_TYPE

Methods:

DebugTextStacking

Inherits from SensorInterface

Inputs:

• float_input float
• int_input int
• bool_input bool
• vector_input Direction
• enum_input Enum

Parameters:

• text String
• namespace String
• size int
• colour Direction
• ci_type CI_MESSAGE_TYPE
• needs_debug_opt_to_render bool

Methods:

DeleteBlankPanel

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM

DeleteButtonDisk

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM
• button_type BUTTON_TYPE

DeleteButtonKeys

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM
• button_type BUTTON_TYPE

DeleteCuttingPanel

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM

DeleteHacking

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM

DeleteHousing

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM
• is_door bool

DeleteKeypad

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM

DeletePullLever

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM
• lever_type LEVER_TYPE

DeleteRotateLever

Inherits from Filter

Parameters:

• door_mechanism DOOR_MECHANISM
• lever_type LEVER_TYPE

DepthOfFieldSettings

Inherits from PostprocessingSettings

Inputs:

• focal_length_mm float
• focal_plane_m float
• fnum float
• focal_point Position

Parameters:

• use_camera_target bool

Methods:

DespawnCharacter

Inherits from ScriptInterface

Targets:

• despawned

Methods:

DespawnPlayer

Inherits from ScriptInterface

Targets:

• despawned

Methods:

Display_Element_On_Map

Inherits from ScriptInterface

Parameters:

• map_name String
• element_name String

Methods:

DisplayMessage

Inherits from ScriptInterface

Parameters:

• title_id String
• message_id String

Methods:

DisplayMessageWithCallbacks

Inherits from ScriptInterface

Targets:

• on_yes
• on_no
• on_cancel

Parameters:

• title_text String
• message_text String
• yes_text String
• no_text String
• cancel_text String
• yes_button bool
• no_button bool
• cancel_button bool

Methods:

DistortionOverlay

Inherits from TransformerInterface

Inputs:

• intensity float
• time float

Parameters:

• distortion_texture String
• alpha_threshold_enabled bool
• threshold_texture String
• range float
• begin_start_time float
• begin_stop_time float
• end_start_time float
• end_stop_time float

Methods:

DistortionSettings

Inherits from PostprocessingSettings

Inputs:

• radial_distort_factor float
• radial_distort_constraint float
• radial_distort_scalar float

Methods:

Door

Inherits from GateResourceInterface

Targets:

• started_opening
• started_closing
• finished_opening
• finished_closing
• used_locked
• used_unlocked
• used_forced_open
• used_forced_closed
• waiting_to_open
• highlight
• unhighlight

Inputs:

• zone_link ZoneLinkPtr
• animation ANIMATED_MODEL
• trigger_filter bool
• icon_pos Position
• icon_usable_radius float
• show_icon_when_locked bool
• nav_mesh NAV_MESH_BARRIER_RESOURCE
• wait_point_1 int
• wait_point_2 int
• geometry Object
• is_scripted bool
• wait_to_open bool

Outputs:

• is_waiting bool

Parameters:

• unlocked_text String
• locked_text String
• icon_keyframe UI_ICON_ICON
• detach_anim bool
• invert_nav_mesh_barrier bool

Methods:

DoorStatus

Inherits from ScriptInterface

Parameters:

• hacking_difficulty int
• door_mechanism DOOR_MECHANISM
• gate_type UI_KEYGATE_TYPE
• has_correct_keycard bool
• cutting_tool_level int
• is_locked bool
• is_powered bool
• is_cutting_complete bool

Methods:

DurangoVideoCapture

Inherits from TransformerInterface

Parameters:

• clip_name String

Methods:

EFFECT_DirectionalPhysics

Inherits from SensorAttachmentInterface

Parameters:

• relative_direction Direction
• effect_distance float
• angular_falloff float
• min_force float
• max_force float

Methods:

EFFECT_EntityGenerator

Inherits from AttachmentInterface

Inputs:

• entities Object

Parameters:

• trigger_on_reset bool
• count int
• spread float
• force_min float
• force_max float
• force_offset_XY_min float
• force_offset_XY_max float
• force_offset_Z_min float
• force_offset_Z_max float
• lifetime_min float
• lifetime_max float
• use_local_rotation bool

Methods:

EFFECT_ImpactGenerator

Inherits from AttachmentInterface

Targets:

• on_impact
• on_failed

Parameters:

• trigger_on_reset bool
• min_distance float
• distance float
• max_count int
• count int
• spread float
• skip_characters bool
• use_local_rotation bool

Methods:

EggSpawner

Inherits from ScriptInterface

Parameters:

• egg_position Position
• hostile_egg bool

Methods:

ElapsedTimer

Inherits from ScriptInterface

Methods:

EnableMotionTrackerPassiveAudio

Inherits from ScriptInterface

Methods:

EndGame

Inherits from ScriptInterface

Targets:

• on_game_end_started
• on_game_ended

Inputs:

• success bool

Methods:

ENT_Debug_Exit_Game

Inherits from InspectorInterface

Parameters:

• FailureText String
• FailureCode int

Methods:

EnvironmentMap

Inherits from AttachmentInterface

Inputs:

• Entities Object

Parameters:

• Priority int
• ColourFactor Direction
• EmissiveFactor float
• Texture String

Internals:

• Texture_Index int
• environmentmap_index int

Methods:

EnvironmentModelReference

Inherits from AttachmentInterface

Internals:

• resource ANIMATED_MODEL

EQUIPPABLE_ITEM

Inherits from ScriptInterface

Targets:

• finished_spawning
• equipped
• unequipped
• on_pickup
• on_discard
• on_melee_impact
• on_used_basic_function

States:

• spawn_on_reset bool

Inputs:

• item_animated_asset Object

Outputs:

• owner Object
• has_owner bool

Parameters:

• character_animation_context String
• character_activate_animation_context String
• left_handed bool
• inventory_name String
• equipment_slot EQUIPMENT_SLOT
• holsters_on_owner bool
• holster_node String
• holster_scale float
• weapon_handedness WEAPON_HANDEDNESS

Methods:

ExclusiveMaster

Inherits from ScriptInterface

Inputs:

• active_objects Object
• inactive_objects Object

Internals:

• resource EXCLUSIVE_MASTER_STATE_RESOURCE

Methods:

Explosion_AINotifier

Inherits from ScriptInterface

Targets:

• on_character_damage_fx

Parameters:

• ExplosionPos Direction
• AmmoType AMMO_TYPE

Methods:

ExternalVariableBool

Inherits from ScriptInterface

Parameters:

• game_variable GAME_VARIABLE

FakeAILightSourceInPlayersHand

Inherits from ScriptInterface

Parameters:

• radius float

Methods:

FilmGrainSettings

Inherits from PostprocessingSettings

Inputs:

• low_lum_amplifier float
• mid_lum_amplifier float
• high_lum_amplifier float
• low_lum_range float
• mid_lum_range float
• high_lum_range float
• noise_texture_scale float
• adaptive bool
• adaptation_scalar float
• adaptation_time_scalar float
• unadapted_low_lum_amplifier float
• unadapted_mid_lum_amplifier float
• unadapted_high_lum_amplifier float

Methods:

Filter

Inherits from ScriptInterface

FilterAbsorber

Inherits from SensorInterface

Outputs:

• output float

Parameters:

• factor float
• start_value float
• input float

Methods:

FilterAnd

Inherits from Filter

Inputs:

• filter bool

FilterBelongsToAlliance

Inherits from Filter

Parameters:

• alliance_group ALLIANCE_GROUP

FilterCanSeeTarget

Inherits from Filter

Inputs:

• Target Object

FilterHasBehaviourTreeFlagSet

Inherits from Filter

Parameters:

• BehaviourTreeFlag BEHAVIOUR_TREE_FLAGS

FilterHasPlayerCollectedIdTag

Inherits from Filter

Parameters:

• tag_id IDTAG_ID

FilterHasWeaponEquipped

Inherits from Filter

Parameters:

• weapon_type WEAPON_TYPE

FilterHasWeaponOfType

Inherits from Filter

Parameters:

• weapon_type WEAPON_TYPE

FilterIsACharacter

Inherits from Filter

FilterIsAgressing

Inherits from Filter

Inputs:

• Target Object

FilterIsAnySaveInProgress

Inherits from Filter

FilterIsAPlayer

Inherits from Filter

FilterIsCharacter

Inherits from Filter

Inputs:

• character Object

FilterIsCharacterClass

Inherits from Filter

Parameters:

• character_class CHARACTER_CLASS

FilterIsCharacterClassCombo

Inherits from Filter

Parameters:

• character_classes CHARACTER_CLASS_COMBINATION

FilterIsDead

Inherits from Filter

FilterIsEnemyOfAllianceGroup

Inherits from Filter

Parameters:

• alliance_group ALLIANCE_GROUP

FilterIsEnemyOfCharacter

Inherits from Filter

Inputs:

• Character Object

Parameters:

• use_alliance_at_death bool

FilterIsEnemyOfPlayer

Inherits from Filter

FilterIsFacingTarget

Inherits from Filter

Inputs:

• target Direction

Parameters:

• tolerance float

FilterIsHumanNPC

Inherits from Filter

FilterIsInAGroup

Inherits from Filter

FilterIsInAlertnessState

Inherits from Filter

Parameters:

• AlertState ALERTNESS_STATE

FilterIsinInventory

Inherits from Filter

Inputs:

• ItemName String

FilterIsInLocomotionState

Inherits from Filter

Parameters:

• State LOCOMOTION_STATE

FilterIsInWeaponRange

Inherits from Filter

Inputs:

• weapon_owner Object

Methods:

FilterIsLocalPlayer

Inherits from Filter

FilterIsNotDeadManWalking

Inherits from Filter

FilterIsObject

Inherits from Filter

Inputs:

• objects Object

FilterIsPhysics

Inherits from Filter

FilterIsPhysicsObject

Inherits from Filter

Inputs:

• object Object

FilterIsPlatform

Inherits from Filter

Parameters:

• Platform PLATFORM_TYPE

FilterIsUsingDevice

Inherits from Filter

Parameters:

• Device INPUT_DEVICE_TYPE

FilterIsValidInventoryItem

Inherits from Filter

Inputs:

• item INVENTORY_ITEM_QUANTITY

FilterIsWithdrawnAlien

Inherits from Filter

FilterNot

Inherits from Filter

Inputs:

• filter bool

FilterOr

Inherits from Filter

Inputs:

• filter bool

FilterSmallestUsedDifficulty

Inherits from Filter

Parameters:

• difficulty DIFFICULTY_SETTING_TYPE

FixedCamera

Inherits from CameraBehaviorInterface

Parameters:

• use_transform_position bool
• transform_position Position
• camera_position Direction
• camera_target Direction
• camera_position_offset Direction
• camera_target_offset Direction
• apply_target bool
• apply_position bool
• use_target_offset bool
• use_position_offset bool

Methods:

FlareSettings

Inherits from PostprocessingSettings

Inputs:

• flareOffset0 float
• flareIntensity0 float
• flareAttenuation0 float
• flareOffset1 float
• flareIntensity1 float
• flareAttenuation1 float
• flareOffset2 float
• flareIntensity2 float
• flareAttenuation2 float
• flareOffset3 float
• flareIntensity3 float
• flareAttenuation3 float

Methods:

FlareTask

Inherits from Task

Inputs:

• specific_character Object

Parameters:

• filter_options TASK_CHARACTER_CLASS_FILTER

Methods:

FlashCallback

Inherits from ScriptInterface

Targets:

• callback

Parameters:

• callback_name String

FlashInvoke

Inherits from ScriptInterface

Inputs:

• layer_name String
• mrtt_texture String

Parameters:

• method String
• invoke_type FLASH_INVOKE_TYPE
• int_argument_0 int
• int_argument_1 int
• int_argument_2 int
• int_argument_3 int
• float_argument_0 float
• float_argument_1 float
• float_argument_2 float
• float_argument_3 float

Methods:

FlashScript

Inherits from ScriptInterface

States:

• show_on_reset bool

Parameters:

• filename String
• layer_name String
• target_texture_name String
• type FLASH_SCRIPT_RENDER_TYPE

Methods:

FloatAbsolute

Inherits from FloatOperation

FloatAdd

Inherits from FloatMath

FloatAdd_All

Inherits from FloatMath_All

FloatClamp

Inherits from ScriptInterface

Inputs:

• Min float
• Max float
• Value float

Outputs:

• Result float

Methods:

FloatClampMultiply

Inherits from FloatMath

Inputs:

• Min float
• Max float

FloatCompare

Inherits from EvaluatorInterface

Targets:

• on_true
• on_false

Inputs:

• LHS float
• RHS float
• Threshold float

Outputs:

• Result bool

Methods:

FloatDivide

Inherits from FloatMath

FloatEquals

Inherits from FloatCompare

FloatGetLinearProportion

Inherits from ScriptInterface

Inputs:

• Min float
• Input float
• Max float

Outputs:

• Proportion float

Methods:

FloatGreaterThan

Inherits from FloatCompare

FloatGreaterThanOrEqual

Inherits from FloatCompare

FloatLessThan

Inherits from FloatCompare

FloatLessThanOrEqual

Inherits from FloatCompare

FloatLinearInterpolateSpeed

Inherits from TransformerInterface

Targets:

• on_finished
• on_think

Outputs:

• Result float

Parameters:

• Initial_Value float
• Target_Value float
• Speed float
• PingPong bool
• Loop bool

Methods:

FloatLinearInterpolateSpeedAdvanced

Inherits from SensorInterface

Targets:

• on_finished
• on_think
• trigger_on_min
• trigger_on_max
• trigger_on_loop

Outputs:

• Result float

Parameters:

• Initial_Value float
• Min_Value float
• Max_Value float
• Speed float
• PingPong bool
• Loop bool

Methods:

FloatLinearInterpolateTimed

Inherits from TransformerInterface

Targets:

• on_finished
• on_think

Outputs:

• Result float

Parameters:

• Initial_Value float
• Target_Value float
• Time float
• PingPong bool
• Loop bool

Methods:

FloatLinearProportion

Inherits from ScriptInterface

Inputs:

• Initial_Value float
• Target_Value float
• Proportion float

Outputs:

• Result float

Methods:

FloatMath

Inherits from EvaluatorInterface

Inputs:

• LHS float
• RHS float

Outputs:

• Result float

Methods:

FloatMath_All

Inherits from EvaluatorInterface

Inputs:

• Numbers float

Outputs:

• Result float

Methods:

FloatMax

Inherits from FloatMath

FloatMax_All

Inherits from FloatMath_All

FloatMin

Inherits from FloatMath

FloatMin_All

Inherits from FloatMath_All

FloatModulate

Inherits from TransformerInterface

Targets:

• on_think

Outputs:

• Result float

Parameters:

• wave_shape WAVE_SHAPE
• frequency float
• phase float
• amplitude float
• bias float

Methods:

FloatModulateRandom

Inherits from TransformerInterface

Targets:

• on_full_switched_on
• on_full_switched_off
• on_think

Outputs:

• Result float

Parameters:

• switch_on_anim LIGHT_TRANSITION
• switch_on_delay float
• switch_on_custom_frequency float
• switch_on_duration float
• switch_off_anim LIGHT_TRANSITION
• switch_off_custom_frequency float
• switch_off_duration float
• behaviour_anim LIGHT_ANIM
• behaviour_frequency float
• behaviour_frequency_variance float
• behaviour_offset float
• pulse_modulation float
• oscillate_range_min float
• sparking_speed float
• blink_rate float
• blink_range_min float
• flicker_rate float
• flicker_off_rate float
• flicker_range_min float
• flicker_off_range_min float
• disable_behaviour bool

Methods:

FloatMultiply

Inherits from FloatMath

FloatMultiply_All

Inherits from FloatMath_All

Parameters:

• Invert bool

FloatMultiplyClamp

Inherits from FloatMath

Inputs:

• Min float
• Max float

FloatNotEqual

Inherits from FloatCompare

FloatOperation

Inherits from EvaluatorInterface

Inputs:

• Input float

Outputs:

• Result float

Methods:

FloatReciprocal

Inherits from FloatOperation

FloatRemainder

Inherits from FloatMath

FloatSmoothStep

Inherits from ScriptInterface

Inputs:

• Low_Edge float
• High_Edge float
• Value float

Outputs:

• Result float

Methods:

FloatSqrt

Inherits from FloatOperation

FloatSubtract

Inherits from FloatMath

FlushZoneCache

Inherits from ScriptInterface

Parameters:

• CurrentGen bool
• NextGen bool

Methods:

FogBox

Inherits from Box

States:

• deleted bool
• show_on_reset bool

Parameters:

• GEOMETRY_TYPE FOG_BOX_TYPE
• COLOUR_TINT Direction
• DISTANCE_FADE float
• ANGLE_FADE float
• BILLBOARD bool
• EARLY_ALPHA bool
• LOW_RES bool
• CONVEX_GEOM bool
• THICKNESS float
• START_DISTANT_CLIP bool
• START_DISTANCE_FADE float
• SOFTNESS bool
• SOFTNESS_EDGE float
• LINEAR_HEIGHT_DENSITY bool
• SMOOTH_HEIGHT_DENSITY bool
• HEIGHT_MAX_DENSITY float
• FRESNEL_FALLOFF bool
• FRESNEL_POWER float
• DEPTH_INTERSECT_COLOUR bool
• DEPTH_INTERSECT_INITIAL_COLOUR Direction
• DEPTH_INTERSECT_INITIAL_ALPHA float
• DEPTH_INTERSECT_MIDPOINT_COLOUR Direction
• DEPTH_INTERSECT_MIDPOINT_ALPHA float
• DEPTH_INTERSECT_MIDPOINT_DEPTH float
• DEPTH_INTERSECT_END_COLOUR Direction
• DEPTH_INTERSECT_END_ALPHA float
• DEPTH_INTERSECT_END_DEPTH float

Internals:

• resource RENDERABLE_INSTANCE

Methods:

FogPlane

Inherits from TransformerInterface

Inputs:

• fog_plane_resource Object

Parameters:

• start_distance_fade_scalar float
• distance_fade_scalar float
• angle_fade_scalar float
• linear_height_density_fresnel_power_scalar float
• linear_heigth_density_max_scalar float
• tint Direction
• thickness_scalar float
• edge_softness_scalar float
• diffuse_0_uv_scalar float
• diffuse_0_speed_scalar float
• diffuse_1_uv_scalar float
• diffuse_1_speed_scalar float

Methods:

FogSetting

Inherits from ModifierInterface

Inputs:

• linear_distance float
• max_distance float
• linear_density float
• exponential_density float
• near_colour Direction
• far_colour Direction

Methods:

FogSphere

Inherits from Sphere

States:

• deleted bool
• show_on_reset bool

Parameters:

• COLOUR_TINT Direction
• INTENSITY float
• OPACITY float
• EARLY_ALPHA bool
• LOW_RES_ALPHA bool
• CONVEX_GEOM bool
• DISABLE_SIZE_CULLING bool
• NO_CLIP bool
• ALPHA_LIGHTING bool
• DYNAMIC_ALPHA_LIGHTING bool
• DENSITY float
• EXPONENTIAL_DENSITY bool
• SCENE_DEPENDANT_DENSITY bool
• FRESNEL_TERM bool
• FRESNEL_POWER float
• SOFTNESS bool
• SOFTNESS_EDGE float
• BLEND_ALPHA_OVER_DISTANCE bool
• FAR_BLEND_DISTANCE float
• NEAR_BLEND_DISTANCE float
• SECONDARY_BLEND_ALPHA_OVER_DISTANCE bool
• SECONDARY_FAR_BLEND_DISTANCE float
• SECONDARY_NEAR_BLEND_DISTANCE float
• DEPTH_INTERSECT_COLOUR bool
• DEPTH_INTERSECT_COLOUR_VALUE Direction
• DEPTH_INTERSECT_ALPHA_VALUE float
• DEPTH_INTERSECT_RANGE float

Internals:

• resource RENDERABLE_INSTANCE

Methods:

FollowCameraModifier

Inherits from EntityInterface

States:

• enable_on_reset bool

Inputs:

• position_curve Object
• target_curve Object

Parameters:

• modifier_type FOLLOW_CAMERA_MODIFIERS
• position_offset Direction
• target_offset Direction
• field_of_view float
• force_state bool
• force_state_initial_value float
• can_mirror bool
• is_first_person bool
• bone_blending_ratio float
• movement_speed float
• movement_speed_vertical float
• movement_damping float
• horizontal_limit_min float
• horizontal_limit_max float
• vertical_limit_min float
• vertical_limit_max float
• mouse_speed_hori float
• mouse_speed_vert float
• acceleration_duration float
• acceleration_ease_in float
• acceleration_ease_out float
• transition_duration float
• transition_ease_in float
• transition_ease_out float

Methods:

FollowTask

Inherits from IdleTask

Parameters:

• can_initially_end_early bool
• stop_radius float

Methods:

Force_UI_Visibility

Inherits from ScriptInterface

States:

• also_disable_interactions bool

Methods:

FullScreenBlurSettings

Inherits from PostprocessingSettings

Inputs:

• contribution float

Methods:

FullScreenOverlay

Inherits from PostprocessingSettings

Parameters:

• overlay_texture String
• threshold_value float
• threshold_start float
• threshold_stop float
• threshold_range float
• alpha_scalar float

Methods:

GameDVR

Inherits from ScriptInterface

Parameters:

• start_time int
• duration int
• moment_ID GAME_CLIP

Methods:

GameOver

Inherits from ScriptInterface

Parameters:

• tip_string_id String
• default_tips_enabled bool
• level_tips_enabled bool

Methods:

GameOverCredits

Inherits from ScriptInterface

Methods:

GameplayTip

Inherits from ScriptInterface

Parameters:

• string_id GAMEPLAY_TIP_STRING_ID

GameStateChanged

Inherits from ModifierInterface

Parameters:

• mission_number float

Methods:

GCIP_WorldPickup

Inherits from AttachmentInterface

Targets:

• spawn_completed
• pickup_collected

Parameters:

• Pipe bool
• Gasoline bool
• Explosive bool
• Battery bool
• Blade bool
• Gel bool
• Adhesive bool
• BoltGun Ammo bool
• Revolver Ammo bool
• Shotgun Ammo bool
• BoltGun bool
• Revolver bool
• Shotgun bool
• Flare bool
• Flamer Fuel bool
• Flamer bool
• Scrap bool
• Torch Battery bool
• Torch bool
• Cattleprod Ammo bool
• Cattleprod bool
• StartOnReset bool
• MissionNumber float

Methods:

GenericHighlightEntity

Inherits from ScriptInterface

Inputs:

• highlight_geometry RENDERABLE_INSTANCE

Methods:

GetBlueprintAvailable

Inherits from ScriptInterface

Outputs:

• available bool

Parameters:

• type BLUEPRINT_TYPE

Methods:

GetBlueprintLevel

Inherits from ScriptInterface

Outputs:

• level int

Parameters:

• type BLUEPRINT_TYPE

Methods:

GetCentrePoint

Inherits from ScriptInterface

Inputs:

• Positions Object

Outputs:

• position_of_centre Position

Methods:

GetCharacterRotationSpeed

Inherits from ScriptInterface

Inputs:

• character CHARACTER

Outputs:

• speed float

Methods:

GetClosestPercentOnSpline

Inherits from ScriptInterface

Inputs:

• spline Object
• pos_to_be_near Direction

Outputs:

• position_on_spline Position
• Result float

Parameters:

• bidirectional bool

Methods:

GetClosestPoint

Inherits from ScriptInterface

Targets:

• bound_to_closest

Inputs:

• Positions Object
• pos_to_be_near Position

Outputs:

• position_of_closest Position

Methods:

GetClosestPointFromSet

Inherits from ScriptInterface

Targets:

• closest_is_1
• closest_is_2
• closest_is_3
• closest_is_4
• closest_is_5
• closest_is_6
• closest_is_7
• closest_is_8
• closest_is_9
• closest_is_10

Inputs:

• Position_1 Object
• Position_2 Object
• Position_3 Object
• Position_4 Object
• Position_5 Object
• Position_6 Object
• Position_7 Object
• Position_8 Object
• Position_9 Object
• Position_10 Object
• pos_to_be_near Position

Outputs:

• position_of_closest Position
• index_of_closest int

Methods:

GetClosestPointOnSpline

Inherits from ScriptInterface

Inputs:

• spline Object
• pos_to_be_near Position

Outputs:

• position_on_spline Position

Parameters:

• look_ahead_distance float
• unidirectional bool
• directional_damping_threshold float

Methods:

GetCurrentCameraFov

Inherits from ScriptInterface

GetCurrentCameraPos

Inherits from ScriptInterface

GetCurrentCameraTarget

Inherits from ScriptInterface

Outputs:

• target Position
• distance float

Methods:

GetCurrentPlaylistLevelIndex

Inherits from ScriptInterface

Outputs:

• index int

Methods:

GetFlashFloatValue

Inherits from ScriptInterface

Targets:

• callback

States:

• enable_on_reset bool

Outputs:

• float_value float

Parameters:

• callback_name String

Methods:

GetFlashIntValue

Inherits from ScriptInterface

Targets:

• callback

States:

• enable_on_reset bool

Outputs:

• int_value int

Parameters:

• callback_name String

Methods:

GetGatingToolLevel

Inherits from ScriptInterface

Outputs:

• level int

Parameters:

• tool_type GATING_TOOL_TYPE

Methods:

GetInventoryItemName

Inherits from ScriptInterface

Inputs:

• item INVENTORY_ITEM_QUANTITY
• equippable_item EQUIPPABLE_ITEM_INSTANCE

GetNextPlaylistLevelName

Inherits from ScriptInterface

Outputs:

• level_name String

Methods:

GetPlayerHasGatingTool

Inherits from ScriptInterface

Targets:

• has_tool
• doesnt_have_tool

Parameters:

• tool_type GATING_TOOL_TYPE

Methods:

GetPlayerHasKeycard

Inherits from ScriptInterface

Targets:

• has_card
• doesnt_have_card

Parameters:

• card_uid int

Methods:

GetPointOnSpline

Inherits from ScriptInterface

Inputs:

• spline Object
• percentage_of_spline float

Outputs:

• Result Position

Methods:

GetRotation

Inherits from InspectorInterface

Inputs:

• Input Position

Outputs:

• Result Direction

Methods:

GetSelectedCharacterId

Inherits from ScriptInterface

Outputs:

• character_id int

Methods:

GetSplineLength

Inherits from ScriptInterface

Inputs:

• spline Object

Outputs:

• Result float

Methods:

GetTranslation

Inherits from InspectorInterface

Inputs:

• Input Position

Outputs:

• Result Direction

Methods:

GetX

Inherits from GetComponentInterface

GetY

Inherits from GetComponentInterface

GetZ

Inherits from GetComponentInterface

GlobalEvent

Inherits from ScriptInterface

Inputs:

• EventValue int

Parameters:

• EventName String

Methods:

GlobalEventMonitor

Inherits from ScriptInterface

Targets:

• Event_1
• Event_2
• Event_3
• Event_4
• Event_5
• Event_6
• Event_7
• Event_8
• Event_9
• Event_10
• Event_11
• Event_12
• Event_13
• Event_14
• Event_15
• Event_16
• Event_17
• Event_18
• Event_19
• Event_20

Parameters:

• EventName String

Methods:

GlobalPosition

Inherits from ScriptVariable

Parameters:

• PositionName String

GoToFrontend

Inherits from ScriptInterface

Parameters:

• frontend_state FRONTEND_STATE

Methods:

GPU_PFXEmitterReference

Inherits from SensorAttachmentInterface

States:

• start_on_reset bool
• deleted bool

Inputs:

• mastered_by_visibility Object

Parameters:

• EFFECT_NAME String
• SPAWN_NUMBER int
• SPAWN_RATE float
• SPREAD_MIN float
• SPREAD_MAX float
• EMITTER_SIZE float
• SPEED float
• SPEED_VAR float
• LIFETIME float
• LIFETIME_VAR float

Methods:

HableToneMappingSettings

Inherits from TransformerInterface

Inputs:

• shoulder_strength float
• linear_strength float
• linear_angle float
• toe_strength float
• toe_numerator float
• toe_denominator float
• linear_white_point float

Methods:

HackingGame

Inherits from ScriptInterface

Targets:

• win
• fail
• alarm_triggered
• closed
• loaded_idle
• loaded_success
• ui_breakout_triggered
• resources_finished_unloading
• resources_finished_loading

States:

• lock_on_reset bool
• light_on_reset bool

Outputs:

• completion_percentage float

Parameters:

• hacking_difficulty int
• auto_exit bool

Methods:

HandCamera

Inherits from CameraBehaviorInterface

Parameters:

• noise_type NOISE_TYPE
• frequency Direction
• damping Direction
• rotation_intensity Direction
• min_fov_range float
• max_fov_range float
• min_noise float
• max_noise float

HasAccessAtDifficulty

Inherits from ScriptInterface

Parameters:

• difficulty int

HeldItem_AINotifier

Inherits from ScriptInterface

Inputs:

• Item Object
• Duration float

Methods:

HighSpecMotionBlurSettings

Inherits from PostprocessingSettings

Inputs:

• contribution float
• camera_velocity_scalar float
• camera_velocity_min float
• camera_velocity_max float
• object_velocity_scalar float
• object_velocity_min float
• object_velocity_max float
• blur_range float

Methods:

HostOnlyTrigger

Inherits from ScriptInterface

Targets:

• on_triggered

Methods:

IdleTask

Inherits from Task

Targets:

• start_pre_move
• start_interrupt
• interrupted_while_moving

Inputs:

• specific_character Object

Parameters:

• should_auto_move_to_position bool
• ignored_for_auto_selection bool
• has_pre_move_script bool
• has_interrupt_script bool
• filter_options TASK_CHARACTER_CLASS_FILTER

Methods:

ImpactSphere

Inherits from AttachmentInterface

Targets:

• event

Parameters:

• radius float
• include_physics bool

Methods:

InhibitActionsUntilRelease

Inherits from ScriptInterface

Methods:

IntegerAbsolute

Inherits from IntegerOperation

IntegerAdd

Inherits from IntegerMath

IntegerAdd_All

Inherits from IntegerMath_All

IntegerAnalyse

Inherits from EvaluatorInterface

Inputs:

• Input int

Outputs:

• Result int

Parameters:

• Val0 int
• Val1 int
• Val2 int
• Val3 int
• Val4 int
• Val5 int
• Val6 int
• Val7 int
• Val8 int
• Val9 int

Methods:

IntegerAnd

Inherits from IntegerMath

IntegerCompare

Inherits from EvaluatorInterface

Targets:

• on_true
• on_false

Inputs:

• LHS int
• RHS int

Outputs:

• Result bool

Methods:

IntegerCompliment

Inherits from IntegerOperation

IntegerDivide

Inherits from IntegerMath

IntegerEquals

Inherits from IntegerCompare

IntegerGreaterThan

Inherits from IntegerCompare

IntegerGreaterThanOrEqual

Inherits from IntegerCompare

IntegerLessThan

Inherits from IntegerCompare

IntegerLessThanOrEqual

Inherits from IntegerCompare

IntegerMath

Inherits from EvaluatorInterface

Inputs:

• LHS int
• RHS int

Outputs:

• Result int

Methods:

IntegerMath_All

Inherits from EvaluatorInterface

Inputs:

• Numbers int

Outputs:

• Result int

Methods:

IntegerMax

Inherits from IntegerMath

IntegerMax_All

Inherits from IntegerMath_All

IntegerMin

Inherits from IntegerMath

IntegerMin_All

Inherits from IntegerMath_All

IntegerMultiply

Inherits from IntegerMath

IntegerMultiply_All

Inherits from IntegerMath_All

IntegerNotEqual

Inherits from IntegerCompare

IntegerOperation

Inherits from EvaluatorInterface

Inputs:

• Input int

Outputs:

• Result int

Methods:

IntegerOr

Inherits from IntegerMath

IntegerRemainder

Inherits from IntegerMath

IntegerSubtract

Inherits from IntegerMath

Interaction

Inherits from ScriptInterface

Targets:

• on_damaged
• on_interrupt
• on_killed

Parameters:

• interruptible_on_start bool

Methods:

InteractiveMovementControl

Inherits from TransformerInterface

Targets:

• completed

Inputs:

• duration float
• start_time float
• progress_path SPLINE

Outputs:

• result float
• speed float

Parameters:

• can_go_both_ways bool
• use_left_input_stick bool
• base_progress_speed float
• movement_threshold float
• momentum_damping float
• track_bone_position bool
• character_node CHARACTER_NODE
• track_position Position

Methods:

Internal_JOB_SearchTarget

Inherits from Job

InventoryItem

Inherits from ScriptInterface

Targets:

• collect

Inputs:

• itemName String

Outputs:

• out_itemName String
• out_quantity int

Parameters:

• item String
• quantity int
• clear_on_collect bool
• gcip_instances_count int

Methods:

IrawanToneMappingSettings

Inherits from TransformerInterface

Inputs:

• target_device_luminance float
• target_device_adaptation float
• saccadic_time float
• superbright_adaptation float

Methods:

IsActive

Inherits from StateQuery

IsAttached

Inherits from StateQuery

IsCurrentLevelAChallengeMap

Inherits from ScriptInterface

Outputs:

• challenge_map bool

Methods:

IsCurrentLevelAPreorderMap

Inherits from ScriptInterface

Outputs:

• preorder_map bool

Methods:

IsEnabled

Inherits from StateQuery

IsInstallComplete

Inherits from ScriptInterface

IsLoaded

Inherits from StateQuery

IsLoading

Inherits from StateQuery

IsLocked

Inherits from StateQuery

IsMultiplayerMode

Inherits from Filter

IsOpen

Inherits from StateQuery

IsOpening

Inherits from StateQuery

IsPaused

Inherits from StateQuery

IsPlaylistTypeAll

Inherits from ScriptInterface

Outputs:

• all bool

Methods:

IsPlaylistTypeMarathon

Inherits from ScriptInterface

Outputs:

• marathon bool

Methods:

IsPlaylistTypeSingle

Inherits from ScriptInterface

Outputs:

• single bool

Methods:

IsSpawned

Inherits from StateQuery

IsStarted

Inherits from StateQuery

IsSuspended

Inherits from StateQuery

IsVisible

Inherits from StateQuery

Job

Inherits from ScriptInterface

States:

• start_on_reset bool

JOB_AreaSweep

Inherits from Job

JOB_AreaSweepFlare

Inherits from Job

JOB_Assault

Inherits from Job

JOB_Follow

Inherits from Job

JOB_Follow_Centre

Inherits from Job

JOB_Idle

Inherits from Job

Parameters:

• task_operation_mode TASK_OPERATION_MODE
• should_perform_all_tasks bool

JOB_Panic

Inherits from Job

JOB_SpottingPosition

Inherits from JobWithPosition

Inputs:

• SpottingPosition Position

JOB_SystematicSearch

Inherits from Job

JOB_SystematicSearchFlare

Inherits from Job

JobWithPosition

Inherits from Job

LeaderboardWriter

Inherits from ScriptInterface

Parameters:

• time_elapsed float
• score int
• level_number int
• grade int
• player_character int
• combat int
• stealth int
• improv int
• star1 bool
• star2 bool
• star3 bool

Methods:

LeaveGame

Inherits from ScriptInterface

Inputs:

• disconnect_from_session bool

Methods:

LensDustSettings

Inherits from PostprocessingSettings

Parameters:

• DUST_MAX_REFLECTED_BLOOM_INTENSITY float
• DUST_REFLECTED_BLOOM_INTENSITY_SCALAR float
• DUST_MAX_BLOOM_INTENSITY float
• DUST_BLOOM_INTENSITY_SCALAR float
• DUST_THRESHOLD float

Methods:

LevelCompletionTargets

Inherits from ScriptInterface

Parameters:

• TargetTime float
• NumDeaths int
• TeamRespawnBonus int
• NoLocalRespawnBonus int
• NoRespawnBonus int
• GrappleBreakBonus int

Methods:

LevelInfo

Inherits from ScriptInterface

Parameters:

• save_level_name_id String

LevelLoaded

Inherits from SensorInterface

Methods:

LightAdaptationSettings

Inherits from TransformerInterface

Inputs:

• fast_neural_t0 float
• slow_neural_t0 float
• pigment_bleaching_t0 float
• fb_luminance_to_candelas_per_m2 float
• max_adaptation_lum float
• min_adaptation_lum float
• adaptation_percentile float
• low_bracket float
• high_bracket float

Parameters:

• adaptation_mechanism LIGHT_ADAPTATION_MECHANISM

Methods:

LightingMaster

Inherits from ScriptInterface

States:

• light_on_reset bool

Inputs:

• objects Object

Methods:

LightReference

Inherits from AttachmentInterface

States:

• deleted bool
• show_on_reset bool
• light_on_reset bool

Inputs:

• occlusion_geometry RENDERABLE_INSTANCE
• mastered_by_visibility Object
• exclude_shadow_entities Object

Parameters:

• type LIGHT_TYPE
• defocus_attenuation float
• start_attenuation float
• end_attenuation float
• physical_attenuation bool
• near_dist float
• near_dist_shadow_offset float
• inner_cone_angle float
• outer_cone_angle float
• intensity_multiplier float
• radiosity_multiplier float
• area_light_radius float
• diffuse_softness float
• diffuse_bias float
• glossiness_scale float
• flare_occluder_radius float
• flare_spot_offset float
• flare_intensity_scale float
• cast_shadow bool
• fade_type LIGHT_FADE_TYPE
• is_specular bool
• has_lens_flare bool
• has_noclip bool
• is_square_light bool
• is_flash_light bool
• no_alphalight bool
• include_in_planar_reflections bool
• shadow_priority int
• aspect_ratio float
• gobo_texture String
• horizontal_gobo_flip bool
• colour Direction
• strip_length float
• distance_mip_selection_gobo bool
• volume bool
• volume_end_attenuation float
• volume_colour_factor Direction
• volume_density float
• depth_bias float
• slope_scale_depth_bias int

Internals:

• resource RENDERABLE_INSTANCE

Methods:

LimitItemUse

Inherits from ScriptInterface

States:

• enable_on_reset bool

Inputs:

• items Object

Methods:

LODControls

Inherits from ModifierInterface

Inputs:

• lod_range_scalar float
• disable_lods bool

Methods:

Logic_MultiGate

Inherits from ModifierInterface

Targets:

• Underflow
• Pin_1
• Pin_2
• Pin_3
• Pin_4
• Pin_5
• Pin_6
• Pin_7
• Pin_8
• Pin_9
• Pin_10
• Pin_11
• Pin_12
• Pin_13
• Pin_14
• Pin_15
• Pin_16
• Pin_17
• Pin_18
• Pin_19
• Pin_20
• Overflow

Parameters:

• trigger_pin int

Methods:

Logic_Vent_Entrance

Inherits from ScriptInterface

Inputs:

• Hide_Pos Position
• Emit_Pos Position

Parameters:

• force_stand_on_exit bool

Methods:

Logic_Vent_System

Inherits from ScriptInterface

Inputs:

• Vent_Entrances VENT_ENTRANCE

LogicAll

Inherits from ScriptInterface

Targets:

• Pin1_Synced
• Pin2_Synced
• Pin3_Synced
• Pin4_Synced
• Pin5_Synced
• Pin6_Synced
• Pin7_Synced
• Pin8_Synced
• Pin9_Synced
• Pin10_Synced

Parameters:

• num int
• reset_on_trigger bool

Methods:

LogicCounter

Inherits from ScriptInterface

Targets:

• on_under_limit
• on_limit
• on_over_limit
• restored_on_under_limit
• restored_on_limit
• restored_on_over_limit

Outputs:

• Count int

Parameters:

• is_limitless bool
• trigger_limit int
• non_persistent bool

Methods:

LogicDelay

Inherits from EvaluatorInterface

Targets:

• on_delay_finished

Inputs:

• delay float
• can_suspend bool

Methods:

LogicGate

Inherits from EvaluatorInterface

Targets:

• on_allowed
• on_disallowed

Inputs:

• allow bool

Methods:

LogicGateAnd

Inherits from BooleanLogicInterface

LogicGateEquals

Inherits from BooleanLogicInterface

LogicGateNotEqual

Inherits from BooleanLogicInterface

LogicGateOr

Inherits from BooleanLogicInterface

LogicNot

Inherits from BooleanLogicOperation

LogicOnce

Inherits from ModifierInterface

Targets:

• on_success
• on_failure

Methods:

LogicPressurePad

Inherits from ScriptInterface

Targets:

• Pad_Activated
• Pad_Deactivated
• bound_characters

Inputs:

• Limit int

Outputs:

• Count int

Methods:

LogicSwitch

Inherits from EvaluatorInterface

Targets:

• true_now_false
• false_now_true
• on_true
• on_false
• on_restored_true
• on_restored_false

Parameters:

• initial_value bool
• is_persistent bool

Methods:

LowResFrameCapture

Inherits from ModifierInterface

Methods:

Map_Floor_Change

Inherits from ScriptInterface

Parameters:

• floor_name String

Methods:

MapAnchor

Inherits from ScriptInterface

Inputs:

• map_north Direction
• map_pos Direction
• map_scale float

Parameters:

• keyframe String
• keyframe1 String
• keyframe2 String
• keyframe3 String
• keyframe4 String
• keyframe5 String
• world_pos Position
• is_default_for_items bool

Methods:

MapItem

Inherits from ScriptInterface

States:

• show_ui_on_reset bool

Parameters:

• item_type MAP_ICON_TYPE
• map_keyframe MAP_KEYFRAME_ID

Methods:

Master

Inherits from ScriptInterface

States:

• suspend_on_reset bool

Inputs:

• objects Object

Parameters:

• disable_display bool
• disable_collision bool
• disable_simulation bool

Methods:

MELEE_WEAPON

Inherits from EQUIPPABLE_ITEM

Inputs:

• item_animated_model_and_collision Object

Parameters:

• normal_attack_damage float
• power_attack_damage float
• position_input Position

Methods:

Minigames

Inherits from SensorInterface

Targets:

• on_success
• on_failure

Parameters:

• game_inertial_damping_active bool
• game_green_text_active bool
• game_yellow_chart_active bool
• game_overloc_fail_active bool
• game_docking_active bool
• game_environ_ctr_active bool
• config_pass_number int
• config_fail_limit int
• config_difficulty int

Methods:

MissionNumber

Inherits from ScriptInterface

Targets:

• on_changed

ModelReference

Inherits from AttachmentInterface

Targets:

• on_damaged

States:

• show_on_reset bool
• enable_on_reset bool
• simulate_on_reset bool
• light_on_reset bool
• convert_to_physics bool

Parameters:

• material String
• occludes_atmosphere bool
• include_in_planar_reflections bool
• lod_ranges String
• intensity_multiplier float
• radiosity_multiplier float
• emissive_tint Direction
• replace_intensity bool
• replace_tint bool
• decal_scale Direction
• lightdecal_tint Direction
• lightdecal_intensity float
• diffuse_colour_scale Direction
• diffuse_opacity_scale float
• vertex_colour_scale Direction
• vertex_opacity_scale float
• uv_scroll_speed_x float
• uv_scroll_speed_y float
• alpha_blend_noise_power_scale float
• alpha_blend_noise_uv_scale float
• alpha_blend_noise_uv_offset_X float
• alpha_blend_noise_uv_offset_Y float
• dirt_multiply_blend_spec_power_scale float
• dirt_map_uv_scale float
• remove_on_damaged bool
• damage_threshold int
• is_debris bool
• is_prop bool
• is_thrown bool
• report_sliding bool
• force_keyframed bool
• force_transparent bool
• soft_collision bool
• allow_reposition_of_physics bool
• disable_size_culling bool
• cast_shadows bool
• cast_shadows_in_torch bool

Internals:

• resource RENDERABLE_INSTANCE
• alpha_light_offset_x float
• alpha_light_offset_y float
• alpha_light_scale_x float
• alpha_light_scale_y float
• alpha_light_average_normal Direction

Methods:

MonitorActionMap

Inherits from SensorInterface

Targets:

• on_pressed_use
• on_released_use
• on_pressed_crouch
• on_released_crouch
• on_pressed_run
• on_released_run
• on_pressed_aim
• on_released_aim
• on_pressed_shoot
• on_released_shoot
• on_pressed_reload
• on_released_reload
• on_pressed_melee
• on_released_melee
• on_pressed_activate_item
• on_released_activate_item
• on_pressed_switch_weapon
• on_released_switch_weapon
• on_pressed_change_dof_focus
• on_released_change_dof_focus
• on_pressed_select_motion_tracker
• on_released_select_motion_tracker
• on_pressed_select_torch
• on_released_select_torch
• on_pressed_torch_beam
• on_released_torch_beam
• on_pressed_peek
• on_released_peek
• on_pressed_back_close
• on_released_back_close

Outputs:

• movement_stick_x float
• movement_stick_y float
• camera_stick_x float
• camera_stick_y float
• mouse_x float
• mouse_y float
• analog_aim float
• analog_shoot float

Methods:

MonitorBase

Inherits from ScriptInterface

Methods:

MonitorPadInput

Inherits from SensorInterface

Targets:

• on_pressed_A
• on_released_A
• on_pressed_B
• on_released_B
• on_pressed_X
• on_released_X
• on_pressed_Y
• on_released_Y
• on_pressed_L1
• on_released_L1
• on_pressed_R1
• on_released_R1
• on_pressed_L2
• on_released_L2
• on_pressed_R2
• on_released_R2
• on_pressed_L3
• on_released_L3
• on_pressed_R3
• on_released_R3
• on_dpad_left
• on_released_dpad_left
• on_dpad_right
• on_released_dpad_right
• on_dpad_up
• on_released_dpad_up
• on_dpad_down
• on_released_dpad_down

Outputs:

• left_stick_x float
• left_stick_y float
• right_stick_x float
• right_stick_y float

Methods:

MotionTrackerMonitor

Inherits from ScriptInterface

Targets:

• on_motion_sound
• on_enter_range_sound

Methods:

MotionTrackerPing

Inherits from ScriptInterface

Inputs:

• FakePosition Position

Methods:

MoveAlongSpline

Inherits from TransformerInterface

Targets:

• on_think
• on_finished

Inputs:

• spline Object
• speed float

Outputs:

• Result Position

Methods:

MoveInTime

Inherits from TransformerInterface

Targets:

• on_finished

Inputs:

• start_position Position
• end_position Position

Outputs:

• result Position

Parameters:

• duration float

Methods:

MoviePlayer

Inherits from ScriptInterface

Targets:

• start
• end
• skipped

Parameters:

• trigger_end_on_skipped bool
• filename String
• skippable bool
• enable_debug_skip bool

Methods:

MultipleCharacterAttachmentNode

Inherits from ScriptInterface

States:

• attach_on_reset bool