getPlayerFlag

Retrieves a player flag value by key.

Player flags are persistent key-value pairs used for storing simple data that needs to survive server restarts. This method provides safe access to flag values without throwing exceptions.

Usage Examples:

val questComplete = playerData.getPlayerFlag("quest_tutorial_complete")
val playerClass = playerData.getPlayerFlag("player_class") ?: "warrior"

Return Behavior:

  • Returns the flag value if the key exists

  • Returns null if the key doesn't exist

  • Never throws exceptions for missing keys

Return

The flag value as a String, or null if not set

Parameters

key

The flag name/key to retrieve

See also