M8 CMS SDK - API Quick Reference

Instant Access

C#Copy code
using M8CMS;

M8CMSManager cmsManager = M8CMSManager.Instance;

Initialization

Getting Data

Loading Content (Async)

Levels

Collections

Content Status

Content Consumption

Note: Triggers automatic downloading of upcoming content based on settings.

Cache Management

Version Management

Events

Static Events (Global)

C#Copy code
M8CMSManager.OnInitializationComplete += (bool success) => {};
M8CMSManager.OnGameDataLoaded += (GameData data) => {};
M8CMSManager.OnError += (string error) => {};

Instance Events

C#Copy code
cmsManager.OnLevelContentReady += (int index, bool ready) => {};
cmsManager.OnCollectionContentReady += (int index, bool ready) => {};
cmsManager.OnContentLoadError += (int index, string error) => {};
cmsManager.OnNetworkStateChanged += (bool available) => {};

Helper Methods

C#Copy code
using M8CMS.Helpers;

// Check content availability without triggering downloads
bool available = M8CMSContentHelper.IsContentAvailableForLevel(index, cmsManager);
bool available = M8CMSContentHelper.IsContentAvailableForCollection(index, cmsManager);

Data Models

Level

C#Copy code
public class Level
{
    public int index;
    public string levelType;        // "normal", "boss", "tutorial"
    public string difficulty;        // "normal", "hard"
    public string gridSize;
    public int rewardCoin;
    public string imageUrl;
    public string videoUrl;
    // ...
}

CollectionItem

C#Copy code
public class CollectionItem
{
    public int index;
    public string name;
    public string imageUrl;
    public string videoUrl;
    public int startLevel;
    public int endLevel;
    // ...
}

Common Patterns

Pattern 1: Load Level Image

C#Copy code
async void LoadLevelImage(int levelIndex)
{
    var sprite = await cmsManager.GetLevelSpriteAsync(levelIndex);
    if (sprite != null) {
        myImage.sprite = sprite;
    }
}

Pattern 2: Track Player Progress

C#Copy code
void StartLevel(int levelIndex)
{
    cmsManager.ConsumeLevelContent(levelIndex);
    // SDK auto-downloads upcoming levels
}

Pattern 3: Check Content Status

C#Copy code
void UpdateLevelButtons()
{
    foreach (var level in levels) {
        bool ready = cmsManager.IsLevelContentReady(level.index);
        button.interactable = ready;
    }
}

Pattern 4: Handle Events

C#Copy code
void OnEnable()
{
    M8CMSManager.OnGameDataLoaded += OnDataLoaded;
    cmsManager.OnLevelContentReady += OnLevelReady;
}

void OnDisable()
{
    M8CMSManager.OnGameDataLoaded -= OnDataLoaded;
    cmsManager.OnLevelContentReady -= OnLevelReady;
}

void OnDataLoaded(GameData data) {
    // Process data
}

void OnLevelReady(int index, bool ready) {
    // Update UI
}

Settings (Inspector)

Error Handling

C#Copy code
void Start()
{
    M8CMSManager.OnError += (string error) => {
        Debug.LogError($"SDK Error: {error}");
        // Show user-friendly message
    };
    
    cmsManager.OnContentLoadError += (int index, string error) => {
        Debug.LogError($"Failed to load content for {index}: {error}");
        // Retry or show fallback
    };
}

Quick Tips

1. ✅ Always use await or coroutines with async methods
2. ✅ Call ConsumeLevelContent() when player reaches a level
3. ✅ Subscribe to events in OnEnable(), unsubscribe in OnDisable()
4. ✅ Check IsInitialized() before using SDK
5. ✅ Use IsLevelContentReady() before displaying content
6. ✅ Let SDK handle caching - don't duplicate logic
7. ✅ Set appropriate cache size limits
8. ✅ Enable debug logs during development

See SDK_DOCUMENTATION.md for complete documentation.