# Player API

**Assembly:** `Spark.Player`

The Player plugin does not expose a public interface. It provides save data persistence for the player entity and a component for persistent player identification.

## Save Data

### PlayerSaveData

Stores player state between sessions. Extends `SaveDataEntry`.

| Field                  | Type                   | Description                                   |
| ---------------------- | ---------------------- | --------------------------------------------- |
| `playerEntityId`       | string                 | Persistent player identifier                  |
| `playerPosition`       | Vector3Serializable    | Last saved world position                     |
| `playerRotation`       | QuaternionSerializable | Last saved rotation                           |
| `sessionStartTime`     | long                   | Unix timestamp when the current session began |
| `sessionCount`         | int                    | Total number of play sessions                 |
| `totalPlaytimeSeconds` | long                   | Accumulated playtime across all sessions      |

**Methods:**

```csharp
void SetPlayerEntityId(string id)
string GetPlayerEntityId()

void SetPlayerPosition(Vector3 position)
Vector3 GetPlayerPosition()

void SetPlayerRotation(Quaternion rotation)
Quaternion GetPlayerRotation()

void UpdatePlayerTransform()   // Syncs position/rotation from SparkEntity before save
void UpdateTotalPlaytime()     // Calculates and updates session duration
```

## Components

### PersistentPlayerEntityId

MonoBehaviour that assigns a persistent ID to the player entity. Requires `SparkEntity`.

On initialization, it checks for an existing ID in `PlayerSaveData`. If none exists, it generates one in the format `player.{12-char-guid}.{unix-timestamp}` and stores it.

This component supports both Local and Networked entity ID sources.

## Usage

```csharp
// Access player save data through the Save plugin
var savePlugin = Spark.GetPlugin<ISaveDataPlugin>();
if (savePlugin != null)
{
    var playerData = savePlugin.GetSaveData<PlayerSaveData>();
    Debug.Log($"Player ID: {playerData.GetPlayerEntityId()}");
    Debug.Log($"Sessions: {playerData.sessionCount}");
    Debug.Log($"Total playtime: {playerData.totalPlaytimeSeconds}s");
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sparkframework.dev/documentation/developer-guide/core-systems/characters/player-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.