Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Dynamic modules to display useful information on your store.
Modules allow you to add dynamic modules on your store, which you can configure from within your creator panel on the sidebar section.
Each modules HTML is configurable in their associated module.*.html page (documented onwards).
You can display the modules on your store by printing the modules variable, as seen below:
Please ensure to use the raw filter, as the modules variable contains HTML that will be escaped automatically by TWIG if this filter is not used.
The payments module allows you to display a selection of recent payments received from customers on your store.
| Variables | Type | Description |
|---|---|---|
| Variable | Type | Description |
|---|---|---|
If you'd like access to a variable that is not currently available, please let us know.
The gift card balance module lets your customers enter a gift card and determine the amount of value that remains on the specified gift card.
| Variables | Type | Description |
|---|---|---|
If you'd like access to a variable that is not currently available, please let us know.
The goal module allows you to show a goal of how much money you'd like to earn over a specific period.
| Variables | Type | Description |
|---|---|---|
If you'd like access to a variable that is not currently available, please let us know.
The textbox module allows a store owner to define a module with arbitrary text.
| Variables | Type | Description |
|---|
Please ensure to use the raw on the module.text variable as it contains HTML and will be automatically escaped by TWIG if not used.
If you'd like access to a variable that is not currently available,
module.header
string
The header of the module.
module.payments
array[Payment]
An array of payments.
module.displayPackage
boolean
If to display the package names against each payment.
module.displayPrice
boolean
If to display the price of each payment.
ign
string
The username of the customer.
name
string
The name of the package the customer has purchased.
time
string
The time the purchase was received on the store.
price
string
The amount of the purchase.
currency
string
The currency of the purchase.
module.header
string
The header of the module.
search
boolean
If the customer has attempted to search for a giftcard.
giftcard
object
If a giftcard was found from their search, it will be populated in this object.
giftcard.card_number
string
The gift card number the customer has searched for.
giftcard.void
boolean
If the giftcard that has been searched for has been voided by the store owner.
giftcard.remaining_balance
string
The remaining balance of the giftcard which has been searched for.
module.header
string
The header of the module.
module.bar.style
string
The style of the module.
module.bar.animated
string
If the goal bar should be animated.
module.displayAmount
boolean
If to display the amount instead of just a percentage.
module.total
string
The total amount earned so far towards the goal.
module.target
string
The target of the goal.
module.percentage
string
The percentage towards completion of the goal.
| string | The header of the module. |
| string | The content of the textbox module. |
| string | The header of the module. |
| string | The URL of the image of the community goal hosted on our public CDN. |
| boolean | If the community goal is repeatable. |
| string | The number of times the community goal has been reached. |
| string | The description of the community goal. |
| string | The style of the goal, either striped or animated. |
| boolean | If the amount of the community goal should be displayed on your store. |
| string | The total the community goal has currently earned. |
| string | The target amount of the community goal. |
| string | The percentage equivalent of the current total against the target. |
| string | The header of the module. |
| boolean | If the game server is online. |
| string | The IP address of the game server. |
| string | The port of the game server. |
| string | The total players on the game server. |
| string | The maximum players that can be online at one point on the game server. |
| string | The header of the module. |
| boolean | If there is actually a top customer to show yet. |
| string | The URL of the customers profile image to display. |
| string | The username of the customer. |
| boolean | If to display the amount the customer has spent on your store. |
| string | The total amount the customer has spent on your store. |
| string | The period which calculates the above total. Can be either hourly, daily, weekly, monthly or yearly. |
| string | The header of the module. |
| The package to feature. |