Module scene 

The scene operations.

Modules

meta

The scene.meta operations.

read

The scene.read operations.

references

The scene.references operations.

Structs

SceneCreateOptions

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

SceneMoveOptions

The optional inputs of [r#move]; leave any out with ..Default::default().

SceneWriteOptions

The optional inputs of [write]; leave any out with ..Default::default().

Functions

append

Add markdown to the end of a scene’s text, as a new paragraph.

archive

Archive a scene: take it out of the story, keeping its text, drafts, and notes.

archived

A project’s archived scenes.

create

Create an empty scene or group, at the end of its parent unless an index is given.

delete

Delete a scene, archived or not, or an empty group, for good.

move

Move a scene or group to a position within a group, or the top level when parentId is left out. index is its position there after the move.

read

A scene’s markdown, including unsaved edits, with its outline, notes, and tags.

rename

Rename a scene or group.

tree

A project’s scenes and groups in story order, with word counts.

unarchive

Return an archived scene to the story, at the end of the top level.

write

Replace a scene’s text with markdown. Mode draft saves it as a new draft of the scene and leaves the scene alone. Mode live replaces the scene’s text, saving the old text as a draft first.