Difference between revisions of "@HouseDesignCommit"
From SphereWiki
MrSugarCube (talk | contribs) (Created page with '==Description== This trigger fires when a player attempts to commit a new house design. Fires on: * Players ==References== The following object referen...') |
|||
| Line 36: | Line 36: | ||
|- | |- | ||
| LOCAL.FIXTURES.OLD || I || The total number of fixtures in the current house design. | | LOCAL.FIXTURES.OLD || I || The total number of fixtures in the current house design. | ||
| + | |- | ||
| + | | LOCAL.MAXZ || I || The value of the top placed item | ||
|} | |} | ||
Latest revision as of 23:22, 26 August 2022
Description
This trigger fires when a player attempts to commit a new house design.
Fires on:
References
The following object references are explicitly available for this trigger:
| Name | Description |
| ARGO | The custom multi being designed. |
| I | The player committing the design. |
| SRC | The player committing the design. |
Arguments
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:
| Argument | In/Out | Description |
| ARGN1 | I | The total number of components in the current house design. |
| ARGN2 | I | The total number of components in the house design being committed. |
| ARGN3 | I | The revision number of the house design being committed. |
| LOCAL.FIXTURES.NEW | I | The total number of fixtures in the house design being committed. |
| LOCAL.FIXTURES.OLD | I | The total number of fixtures in the current house design. |
| LOCAL.MAXZ | I | The value of the top placed item |
Return Values
The following return values are explicitly defined for this trigger:
| Return Value | Description |
| 1 | Prevents the house design from being committed. |
