Methods

  • 1. ShowUI_API

    Purpose: Displays the User Interface (UI) for a specific reward type.

    Parameters:

    • rewardType: The type of reward.

    • playerId: The unique ID of the player.

    • parent: The parent UI element.

    Usage:

    ShowUI_API("exampleRewardType", playerId, "exampleParent");

  • 2. Give_API

    Purpose: Grants a specified quantity of points to a player.

    Parameters:

    • rewardType: The type of reward.

    • playerId: The unique ID of the player.

    • quantity: The number of points to grant.

    Usage:

    Give_API("exampleRewardType", playerId, 10);

  • 3. Give_Owner_API

    Purpose: Grants a specified quantity of points to a player, specifying the owner.

    Parameters:

    • rewardType: The type of reward.

    • owner: The owner of the points.

    • playerId: The unique ID of the player.

    • quantity: The number of points to grant.

    Usage:

    Give_Owner_API("exampleRewardType", "exampleOwner", playerId, 10);

  • 4. Give_Owner_WithString_API

    Purpose: Grants a specified quantity of points to a player, specifying the owner, and includes a string value.

    Parameters:

    • rewardType: The type of reward.

    • owner: The owner of the points.

    • playerId: The unique ID of the player.

    • quantity: The number of points to grant.

    • stringValue: A string value associated with the points.

    Usage:

    Give_Owner_WithString_API("exampleRewardType", "exampleOwner", playerId, 10, "exampleStringValue");

  • 5. Get_API

    Purpose: Retrieves the number of points for a player.

    Parameters:

    • rewardType: The type of reward.

    • playerId: The unique ID of the player.

    Usage:

    points = Get_API("exampleRewardType", playerId);

  • 6. Get_All_API

    Purpose: Retrieves the total number of points for a player across all reward types.

    Parameters:

    • rewardType: The type of reward.

    • playerId: The unique ID of the player.

    Usage:

    totalPoints = Get_All_API("exampleRewardType", playerId);

  • 7. Get_Owner_API

    Purpose: Retrieves the number of points for a player, specifying the owner.

    Parameters:

    • rewardType: The type of reward.

    • owner: The owner of the points.

    • playerId: The unique ID of the player.

    Usage:

    ownerPoints = Get_Owner_API("exampleRewardType", "exampleOwner", playerId);

  • 8. Get_Owner_WithString_API

    Purpose: Retrieves the number of points and associated string value for a player, specifying the owner.

    Parameters:

    • rewardType: The type of reward.

    • owner: The owner of the points.

    • playerId: The unique ID of the player.

    Usage:

    string[] result = Get_Owner_WithString_API("exampleRewardType", "exampleOwner", playerId);
int ownerPoints = int.Parse(result[0]);
string stringValue = result[1];

This documentation provides a clear understanding of the API methods. For further questions or clarifications, please refer to the main documentation or contact support.

PreviousTutorial : How to create rewardsNextHooks

Last updated