메인 콘텐츠로 건너뛰기

Documentation Index

Fetch the complete documentation index at: https://docs.hyperx.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
개요

캐릭터 데이터는 게임 클라이언트가 유저의 인벤토리, 재화, 진행도처럼 자주 바뀌는 데이터를 저장하고 불러오는 기능입니다. 콘솔에서 먼저 테이블과 필드를 정의합니다. 클라이언트는 로그인 후 발급받은 유저 access token으로 해당 유저의 대표 캐릭터 데이터를 저장하거나 조회합니다.

​
데이터 저장

await HyperX.Core.CharacterData.SaveJson(
    "inventory",
    userAccessToken,
    "{\"gold\":1000,\"level\":12}"
);
  • 첫 번째 인자는 콘솔에서 정의한 테이블 키입니다.
  • 두 번째 인자는 유저 access token입니다.
  • 세 번째 인자는 콘솔 스키마와 일치하는 JSON object입니다.
  • 정의되지 않은 필드가 있거나 필드 타입이 맞지 않으면 서버에서 오류를 반환합니다.
JsonData를 직접 전달할 수도 있습니다. 
var data = HyperX.Json.JsonMapper.ToObject("{\"gold\":1000,\"level\":12}");
await HyperX.Core.CharacterData.Save("inventory", userAccessToken, data);

​
데이터 불러오기

var payload = await HyperX.Core.CharacterData.Get("inventory", userAccessToken);

if (payload.Exists)
{
    int gold = (int)payload.Data["gold"];
    int level = (int)payload.Data["level"];
}
반환 타입은 다음 값을 포함합니다. 
public readonly struct Payload
{
    public readonly bool Exists;
    public readonly int SchemaVersion;
    public readonly JsonData Data;
}

​
MVP 제한 사항

현재 버전은 저장과 불러오기에 집중합니다.
  • gold > 1000, level between 10 and 20 같은 조건 검색은 지원하지 않습니다.
  • 저장 데이터는 콘솔에서 정의한 필드 기준으로 검증됩니다.
  • public SDK는 현재 로그인 유저의 대표 캐릭터 데이터를 대상으로 합니다.