Skip to content

document the animation speed setting #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OSSDiablo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

document the animation speed setting #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions rayfield-gen2/windows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,27 @@ The window handle exposes everything you need at runtime.
`true` once `Unload` has run. The handle is spent after that.
</ResponseField>

### Motion

The interface animates at one pace, set library wide rather than per window. Players can change it under **Animation speed** in the settings tab, and it persists with the rest of their settings.

<ResponseField name="SetAnimationSpeed(speed)">
How quickly everything animates. `1` is the pace the interface was designed at, higher is quicker. Clamped between `0.25` and `3`.
</ResponseField>

<ResponseField name="GetAnimationSpeed()" type="number">
The pace in use.
</ResponseField>

```lua
window:SetAnimationSpeed(1.5) -- half again as quick
window:GetAnimationSpeed() -- 1.5
```

<Note>
This is a preference about motion rather than a property of one window, closer to a system setting, so two windows open at once always animate at the same pace.
</Note>

### Theme and language

<ResponseField name="ChangeTheme(theme)">
Expand Down