Module timeline 

The timeline operations.

Modules

def

The timeline.def operations.

settings

The timeline.settings operations.

Structs

TimelineCreateOptions

The optional inputs of create; leave any out with ..Default::default().

TimelineListOptions

The optional inputs of list; leave any out with ..Default::default().

TimelinePlaceOptions

The optional inputs of place; leave any out with ..Default::default().

TimelineSetOptions

The optional inputs of set; leave any out with ..Default::default().

TimelineUpdateOptions

The optional inputs of update; leave any out with ..Default::default().

Functions

create

Add a plain event to a project’s timeline, main unless timeline names another, at the end unless an index is given. A dated timeline needs a start and takes no index. Entries and scenes are added with timeline.place.

delete

Delete a timeline event for good. Deleting a placement leaves its entry or scene alone.

list

A timeline’s events in display order: their manual order, or by start date on a dated timeline. The main timeline unless timeline names another; orphaned lists, by order, the events left on timelines deleted since, such as one made offline before a sync.

move

Move a timeline event to a position on its own timeline; index is its position after the move. A dated timeline is ordered by its dates, so nothing can be moved on it. timeline.set moves an event to another timeline.

place

Place an encyclopedia entry of type event, or a scene, on a project’s timeline, main unless timeline names another. Each can be placed once on each timeline, and its name and words come from it. A dated timeline needs a start.

read

One timeline event.

set

Set single fields of any timeline event, or clear them by name, leaving the rest alone. A placement takes only label, lane, milestone, start, and end. This is how a placement is edited. A timeline other than the event’s own moves it there, with start and end, when given, as its dates on that timeline’s calendar; a dated timeline refuses the move unless the event’s start fits or one is given.

update

Replace a plain event’s text, and any other field given; an empty value clears it. The text is always required, so every call replaces it. Edit a placement with timeline.set.