dev.plexusmodloader.api.system.brand
Generated
This page is generated from the source's Javadoc by ./gradlew apiReference. Do not edit it; fix the source comment and generate it again.
| Type | Kind | Description |
|---|---|---|
GameBrandSystem | interface | System plexus:game_brand (legacy alias plexus:game_brand): the mod brand the game reports about itself — shown through the window title's "modded" marker, crash reports, and the server brand sent to clients. |
GameBrandSystem
interface · Stability PREVIEW · Since 0.1.0-alpha.4 or earlier
public interface GameBrandSystem extends PlexusSystem
System plexus:game_brand (legacy alias plexus:game_brand): the mod brand the game reports about itself — shown through the window title's "modded" marker, crash reports, and the server brand sent to clients.
- Default: returns
plexus. - Replaceable: yes, as a whole (
REPLACE); there is no extension point. - Threading: may be called from any thread, repeatedly; implementations must be stateless and fast.
- Result rules: 1–64 printable ASCII characters. Anything else stops the launch when Plexus Mod Loader validates the implementation (
PLEXUS-SYSTEM-003). - Owned data: none.
| Constant or field | Type | Description |
|---|---|---|
ID | SystemId | ID of this system (plexus:game_brand). |
LEGACY_ID | SystemId | Legacy ID of this system (plexus:game_brand). |
Supertypes: PlexusSystem
brand(GameSide)
String brand(GameSide side)
Since 0.1.0-alpha.4 or earlier
The brand reported by side.
| Parameter | Type | Description |
|---|---|---|
side | GameSide | — |
Returns String