Class PayoutView
Component that manages displaying all the payout items in a Transaction.
Inherited Members
Namespace: UnityEngine.GameFoundation.Components
Syntax
[AddComponentMenu("Game Foundation/Payout View", 2)]
[ExecuteInEditMode]
public class PayoutView : MonoBehaviourProperties
currencyPayoutCountPrefix
The string to prefix the payout Currency counts when displaying the transaction's payouts.
Declaration
public string currencyPayoutCountPrefix { get; }Property Value
| Type | Description |
|---|---|
| String |
itemPayoutCountPrefix
The string to prefix the payout InventoryItem counts when displaying the transaction's payouts.
Declaration
public string itemPayoutCountPrefix { get; }Property Value
| Type | Description |
|---|---|
| String |
payoutItemIconPropertyKey
The Static Property key for the icon of the Inventory or Currency payout items, as specified in their Static Properties.
Declaration
public string payoutItemIconPropertyKey { get; }Property Value
| Type | Description |
|---|---|
| String |
payoutItemPrefab
The Payout Item prefab to use when displaying the transaction's payouts.
Declaration
public ImageInfoView payoutItemPrefab { get; }Property Value
| Type | Description |
|---|---|
| ImageInfoView |
separatorPrefab
The GameObject to use as a separator between Payout Items when auto generating promotion image.
Declaration
public GameObject separatorPrefab { get; }Property Value
| Type | Description |
|---|---|
| GameObject |
transaction
The BaseTransaction to display in the view at runtime.
Declaration
public BaseTransaction transaction { get; }Property Value
| Type | Description |
|---|---|
| BaseTransaction |
transactionKey
The key of the Transaction Item being displayed.
Declaration
public string transactionKey { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
SetCurrencyPayoutCountPrefix(String)
Sets the string with which to prefix the Currency payout counts.
Declaration
public void SetCurrencyPayoutCountPrefix(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| String | prefix | The string to prefix. |
SetInventoryItemPayoutCountPrefix(String)
Sets the string with which to prefix the Inventory Item payout counts.
Declaration
public void SetInventoryItemPayoutCountPrefix(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| String | prefix | The string to prefix. |
SetPayoutItemIconPropertyKey(String)
Sets the Static Property key that will be used when displaying the transaction's payout item images.
Declaration
public void SetPayoutItemIconPropertyKey(string propertyKey)Parameters
| Type | Name | Description |
|---|---|---|
| String | propertyKey | The key that is defined in the static properties of the transaction's payouts. |
SetPayoutItemPrefab(ImageInfoView)
The prefab to use for each payout item when auto generating the promotion image.
Declaration
public void SetPayoutItemPrefab(ImageInfoView prefab)Parameters
| Type | Name | Description |
|---|---|---|
| ImageInfoView | prefab | The prefab to use when displaying the Payout Items. |
SetSeparatorPrefab(GameObject)
Sets the prefab to use for as a separator when when auto generating the promotion image.
Declaration
public void SetSeparatorPrefab(GameObject prefab)Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | prefab | The prefab to use when displaying the separator between Payout Items. |
SetTransaction(BaseTransaction)
Sets the Transaction Item that should be displayed by this view.
Declaration
public void SetTransaction(BaseTransaction transaction)Parameters
| Type | Name | Description |
|---|---|---|
| BaseTransaction | transaction | A reference to BaseTransaction that should be displayed. |