Timeline Lua API

Timeline

Description

Allows controlling Timelines on MissionObjects

Functions

Play

Timeline.Play(missionObjectName)

Expected parameter types

Name	Type
missionObjectName	string

Description: Starts the timeline

Returns: Nothing

Pause

Timeline.Pause(missionObjectName)

Expected parameter types

Name	Type
missionObjectName	string

Description: Pauses the timeline

Returns: Nothing

Stop

Timeline.Stop(missionObjectName)

Expected parameter types

Name	Type
missionObjectName	string

Description: Stops the timeline

Returns: Nothing

SetDynamicCameraTarget

Timeline.SetDynamicCameraTarget(missionObjectName, targetName)

Expected parameter types

Name	Type
missionObjectName	string
targetName	string

Description: Sets the look at & follow target for all dynamically targeted cameras in the timeline

Returns: Nothing

PauseAI

Timeline.PauseAI(characterName)

Expected parameter types

Name	Type
characterName	string

Description: Pauses an AI agent.

Returns: Nothing

Notes: Bit of a hack for Timeline use, this might get removed later on!

UnpauseAI

Timeline.UnpauseAI(characterName)

Expected parameter types

Name	Type
characterName	string

Description: Unpauses an AI agent, resuming standard behaviour.

Returns: Nothing

Notes: Bit of a hack for Timeline use, this might get removed later on!

This file is auto generated, please don't edit manually!

Docs last hacked together on: 29/08/2023 16:24