Verse API reference page for the ConsumeEntitlement function | Fortnite Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

Consumes a consumable entitlement. Fails if:

The entitlement is not consumable.
The Player does not own requested Count of entitlement.


Verse `using` statement	`using { /Fortnite.com/Marketplace }`

ConsumeEntitlement<public><native>(Player:player, entitlement_type:concrete_subtype(entitlement), Count:int)<transacts><suspends><no_rollback>:logic

Parameters

ConsumeEntitlement takes the following parameters:

Name	Type	Description
`Player`	`player`
`entitlement_type`	`concrete_subtype(entitlement)`
`Count`	`int`

Attributes, Specifiers, and Effects

Specifiers

The following specifiers determine how you can interact with ConsumeEntitlement in your programs. For the complete list of specifiers, see the Specifiers Page.

Specifier	Meaning
`public`	The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data.
`native`	Indicates that the definition details of the element are implemented in C++. Verse definitions with the `native` specifier auto-generate C++ definitions that a developer can then fill out its implementation. You can use this specifier on classes, interfaces, enums, methods, and data.

Effects

The following effects determine how ConsumeEntitlement behaves in your programs. For the complete list of effects, see the Effect Specifers section of the Specifiers Page.

Effect	Meaning
`transacts`	This effect indicates that any actions performed by the function can be rolled back. The transacts effect is required any time a mutable variable (`var`) is written. You’ll be notified when you compile your code if the `transacts` effect was added to a function that can’t be rolled back. Note that this check is not done for functions with the `native` specifier.
`suspends`	Indicates that the function is async. Creates an async context for the body of the function.
`no_rollback`	This is the default effect when no exclusive effect is specified. The `no_rollback` effect indicates that any actions performed by the function cannot be undone and so the function cannot be used in a failure context. This effect cannot be manually specified.