renpy_flutter library

Classes

AudioplayersRenPyAudioPlayback
Production audio backend backed by the web-compatible audioplayers plugin.
RenPyAssetPlayer
Loads a bundled RenPy script asset and displays it with RenPyPlayer.
RenPyAudioAssetResolver
Resolves RenPy audio filenames into paths accepted by audioplayers.
RenPyAudioChange
Emitted when a RenPy audio command is encountered.
RenPyAudioChannelSnapshot
RenPyAudioLayer
Plays RenPy audio commands observed from a RenPyFlutterController.
RenPyAudioPlayback
Testable audio backend used by RenPyAudioLayer.
RenPyAudioSnapshot
RenPyBacklogEntry
A single dialogue line recorded in the player's backlog/history.
RenPyBacklogView
Scrollable overlay listing the dialogue lines shown so far, oldest at the top and newest at the bottom, mirroring a standard visual novel backlog.
RenPyBytesAudioPlayback
Audio backend for externally loaded project files held in memory.
RenPyColorValue
Platform-neutral RGBA color used by RenPy solid displayables.
RenPyComplete
The game finished running normally.
RenPyDiagnostic
Machine-readable compatibility signal produced while running a RenPy script.
RenPyDialogue
A line of dialogue, optionally attributed to a character.
RenPyDialogueResolvedImage
An image resolved for Ren'Py chrome, with optional source dimensions.
RenPyDialogueView
Displays RenPy dialogue and errors over the current scene.
RenPyError
The runner encountered an unrecoverable error.
RenPyFlutterController
Drives RenPyRunner and turns callbacks into ValueNotifier updates.
RenPyGameProject
A loaded RenPy project folder with script source and addressable assets.
RenPyGameStatus
Public, minimal information describing what the player should currently see.
RenPyGuiConfiguration
Ren'Py GUI configuration values that affect default presentation.
RenPyIdle
Idle: waiting for the app to load a script, nothing on screen yet.
RenPyImageChange
Emitted when a scene, show, or hide image command is encountered.
RenPyImageLayer
Renders RenPy scene and show image changes as Flutter asset images.
RenPyImageOperation
Platform-neutral display operation metadata.
RenPyImagePlacement
Platform-neutral placement metadata for a RenPy image command.
RenPyMemoryPreferenceStore
In-memory preference store useful for tests and embedded runners.
RenPyMemoryRunnerSnapshotSlotStore
RenPyMemoryRunnerSnapshotStore
RenPyMenu
A choice menu. UI must call onChoice with the index the user picked.
RenPyMenuSelector
Overlay that shows RenPy in-game menus.
RenPyMixerPreference
Per-mixer Ren'Py-style audio preference values.
RenPyNoOpAudioPlayback
Audio backend for tests and callers that intentionally disable audio.
RenPyPause
A RenPy pause that waits for player input or a future timed resume.
RenPyPauseView
Transparent tap target used while RenPy is waiting at a pause interaction.
RenPyPersistentStore
Stores Ren'Py persistent.* namespace values across runner instances.
RenPyPlayer
A reusable visual novel surface for an already-managed controller.
RenPyPlayerPreferences
Mutable Ren'Py-style preferences understood by the Flutter player.
RenPyPreferenceStore
Stores Ren'Py-style player preferences outside script state.
RenPyPresentationSnapshot
RenPyProjectFile
A file selected from a RenPy project folder.
RenPyProjectPlayer
Displays an externally loaded RenPy project folder.
RenPyResolvedDisplayable
A single resolved displayable (or layout container) in a resolved screen.
RenPyResolvedImage
A resolved RenPy image source and any display operations requested for it.
RenPyResolvedScreen
A platform-neutral, fully resolved screen-language tree.
RenPyRunnerBlockPathSegment
RenPyRunnerSlotEntry
A snapshot paired with the metadata describing its slot.
RenPyRunnerSlotMetadata
Human-readable metadata describing a saved slot, used to render a browser without deserializing the full snapshot.
RenPyRunnerSnapshot
RenPyRunnerSnapshotDialogue
RenPyRunnerSnapshotPendingDialogue
RenPyRunnerSnapshotSlotStore
A snapshot store addressed by named slots, each carrying its own metadata.
RenPyRunnerSnapshotStackFrame
RenPyRunnerSnapshotStore
RenPySaveBrowser
A minimal multi-slot save/load browser backed by the controller's slot store. Lists the quicksave and a fixed number of manual slots, lets the player save into a slot (with overwrite confirmation), load a populated slot, and delete a populated slot.
RenPyScreenAction
A platform-neutral descriptor for a RenPy screen action.
RenPyScreenLayer
Renders the engine's shown screens as a widget layer above the game stage.
RenPyScreenSize
The configured virtual screen size of a RenPy project.
RenPySharedPreferencesPersistentStore
Stores Ren'Py persistent values in Flutter's platform preferences.
RenPySharedPreferencesPreferenceStore
Stores Ren'Py-style player preferences in Flutter's platform preferences.
RenPySharedPreferencesSnapshotSlotStore
Stores named snapshot slots and their metadata in platform preferences.
RenPySharedPreferencesSnapshotStore
Stores serialized runner snapshots in Flutter's platform preferences.
RenPyShownScreen
A screen invocation currently on the screen layer.
RenPyText
Renders RenPy inline text tags using Flutter text spans.
RenPyTextInterpolation
Substitutes RenPy [expression] references in plain text against a RenPyTextResolver before the styled-text {tag} renderer runs.
RenPyTextReveal
Renders RenPy dialogue with an optional typewriter reveal driven by a characters-per-second rate. A rate of zero (or less) shows the full line at once. Tapping while revealing should call RenPyTextRevealController.complete to finish the line before advancing.
RenPyTextRevealController
Drives a RenPyTextReveal, letting an ancestor force the line complete.
RenPyTextSpanParser
Converts a RenPy dialogue string into Flutter TextSpans.
RenPyTransitionChange
Emitted when a RenPy with transition command is encountered.
RenPyTransitionIntent
Platform-neutral transition metadata parsed from RenPy transition values.
RenPyVisualElementSnapshot
RenPyVisualRestore
Emitted when a rollback or load replaces the full visual presentation.
RenPyVisualSnapshot

Enums

RenPyAudioAction
RenPyDiagnosticCode
RenPyImageOperationType
A display operation requested by a RenPy image expression.
RenPyRunnerBlockPathBranch
RenPySaveBrowserMode
How a save slot browser is being used.
RenPyScreenActionKind
The kind of a parsed screen RenPyScreenAction.
RenPyTransitionFidelity
Whether FiestaVN can render a transition exactly or only approximately.
RenPyTransitionType
A platform-neutral class of RenPy visual transition.

Typedefs

RenPyAtlResolver = RenPyAtlProgram? Function(String transformName)
Resolves the transform named in a show X at <name> clause to a compiled ATL animation program, or null when the name is not an animatable transform. The host wires this from the runner's transform registry (atlForTransform
RenPyDiagnosticCallback = void Function(RenPyDiagnostic diagnostic)
RenPyDialogueImageResolver = RenPyDialogueResolvedImage Function(String assetPath)
RenPyImageProviderFactory = ImageProvider<Object> Function(String assetPath)
RenPyLayerBuilder = Widget Function(BuildContext context, RenPyFlutterController controller)
RenPyLoadErrorBuilder = Widget Function(BuildContext context, Object error, StackTrace stackTrace)
RenPyLoadingBuilder = Widget Function(BuildContext context)
RenPyProjectFontRegistrar = Future<void> Function(String family, Uint8List bytes)
RenPyTextResolver = String? Function(String expression)
Resolves a RenPy [expression] reference to its displayed value.