Cluster Creator Kit Script Reference
    Preparing search index...

    Interface ProductGrantResultItem

    A readonly type that represents the result of a product grant operation performed using PlayerHandle.requestGrantProduct and ClusterScript.onRequestGrantProductResult.

    interface ProductGrantResult {
        errorReason: string;
        meta: string;
        player: PlayerHandle;
        productId: string;
        productName: string;
        status: ProductGrantStatus;
    }
    Index

    Properties

    errorReason meta player productId productName status

    Properties

    errorReason: string

    A string indicating the reason for failure when status is "Unknown" or "Failed".

    Returns null for other status values.

    meta: string

    The meta string specified in PlayerHandle.requestGrantProduct.

    player: PlayerHandle

    The PlayerHandle of the player who was granted the product.

    productId: string

    The ID of the granted product.

    productName: string

    The name of the granted product.

    status: ProductGrantStatus

    A string indicating the result of the product grant request.

    • "Unknown" .. Indicates that it cannot be determined whether the grant was performed due to reasons such as network errors.
    • "Granted" .. Indicates that the product was granted to the player.
    • "AlreadyOwned" .. Indicates that the player already owned the product.
    • "Failed" .. Indicates that an attempt was made to grant the product, but the grant failed.

    Settings

    Member Visibility

    On This Page

    Properties