Version: 0.4.2
Create Entries
Creating adapters for the TypeWriter Spigot plugin involves working with various entry types, each serving a specific purpose in crafting immersive player experiences. This documentation explains the roles and functionalities of these entry types, providing clear guidance for developers on how to effectively use them.
Base Entry Interfaces
There are three base interfaces that all entries extend one of. These are:
- StaticEntry: Represents static pages. These are used for content that does not change dynamically or trigger any actions. Examples include static text or images.
- TriggerEntry: Designed for entries that initiate other actions or events. These entries can trigger one or more additional entries, making them crucial for interactive sequences.
- CinematicEntry: Used for cinematic experiences. These entries are ideal for creating immersive story-driven sequences that engage players in a more visually dynamic way.
1. StaticEntry
- AssetEntry: Handles external assets, like images or files.
- ArtifactEntry: Manages plugin-generated assets, such as JSON files.
- EntityEntry: Serves as a base for static entities in the game.
- SpeakerEntry: Extends EntityEntry for entities capable of speaking, with defined display names and sounds.
- FactEntry: Represents static facts or data points.
- SoundIdEntry: Holds identifiers for specific sounds.
- SoundSourceEntry: Deals with the sources of sound emissions.
2. TriggerEntry
- EventEntry: A base for entries that are event-driven.
- CustomCommandEntry: Extends EventEntry to allow for the creation of custom in-game commands.