# events

> Reference for the events tool of Author: events, with every action and the arguments you can pass.

Source: https://author.geenius.io/docs/reference/events/

Events on strands, with effects on a character's state.

Call it as `geenius_author(tool: "events", action: "<action>", args: {...})` through Geenius OS.

## Actions

| Action | What it does |
|---|---|
| `list` | Events in story order, filtered by time, strand, scene or profile. Rules: book_id, from?, to?, strand_ids?, scene_id?, profile_id?, limit?: in story order. |
| `add` | A new event on a strand, with its effects on characters. |
| `update` | Change an event. Rules: event_id + any of those (those of event_add). |
| `move` | Move an event in story time. Rules: event_id, start \| delta, ripple? (later events on its strand move too). |
| `remove` | Remove an event. Rules: event_id. |

## Arguments we have checked

### events · list

Events in story order, filtered by time, strand, scene or profile. Rules: book_id, from?, to?, strand_ids?, scene_id?, profile_id?, limit?: in story order.

- `book_id` (required)
- `from`
- `limit`
- `profile_id`
- `scene_id`
- `strand_ids`
- `to`

### events · add

A new event on a strand, with its effects on characters.

- `book_id` (required)
- `duration`
- `effects`
- `end`
- `importance`
- `kind`
- `note`
- `profile_id`
- `scene_id`
- `start`
- `strand_id`
- `title`
- `travel_mode`

### events · update

Change an event. Rules: event_id + any of those (those of event_add).

- `duration`
- `effects`
- `end`
- `event_id` (required)
- `importance`
- `kind`
- `note`
- `profile_id`
- `scene_id`
- `start`
- `strand_id`
- `title`
- `travel_mode`

### events · move

Move an event in story time. Rules: event_id, start | delta, ripple? (later events on its strand move too).

- `delta`
- `event_id` (required)
- `ripple`
- `start`

### events · remove

Remove an event. Rules: event_id.

- `event_id` (required)

> [!TIP]
> Ask for the exact arguments of any action with `action: "help", of: "list"`. The server answers from its own definitions, so that answer is always current.

> [!NOTE]
> Effects change a character's state through a path: location (a place profile id), injuries, knows and possessions (lists to add to or remove from), mood, status, alive (false means dead), appearance.<x>, relations.<other profile id> and facets.<facet>.<field>. Event kinds: beat, plot_point, development, reveal, travel, injury, death, birth, relationship_change, learns, weather, custom.