@HouseDesignCommitItem - Revision history

Gorgo: /* Description */

2022-08-27T23:13:00Z

‎Description

Gorgo at 19:14, 27 August 2022

2022-08-27T19:14:49Z

Gorgo at 22:29, 26 August 2022

2022-08-26T22:29:52Z

Gorgo: Blanked the page

2022-04-30T11:00:55Z

Blanked the page

Gorgo: Created page with "==Description== X branch only. This triggers fires with each commited item when using AOS House Designer tool. Fires on: * Items ==References== There is no references..."

2022-04-29T19:36:00Z

Created page with "==Description== X branch only. This triggers fires with each commited item when using AOS House Designer tool. Fires on: * Items ==References== There is no references..."

New page

==Description==
X branch only. This triggers fires with each commited item when using AOS House Designer tool.

Fires on:
* [[Items]]

==References==
There is no references in this trigger.

==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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| local.ID || I || ID of the item.
|-
| local.p.x || I || x location
|-
| local.p.y || I || y location
|-
| local.p.z || I || z location
|-
| local.MAXZ || I || Returns the value of the top placed item.
|-
| local.visible || I || 0 or 1 (non-visible items are things like doors and signs)
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || Will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

@@ Line 32: / Line 32: @@
 | local.p.z || I || The z location of the item
 |-
-| local.id || I || 0 or 1 (non-visible items are things like doors and signs) return false will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.
+| local.visible || I || 0 or 1 (non-visible items are things like doors and signs) return false will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.
 |}

← Older revision		Revision as of 11:00, 30 April 2022
Line 1:		Line 1:
−	~~==Description==~~
−	~~X branch only. This triggers fires with each commited item when using AOS House Designer tool.~~

−
−	~~Fires on:~~
−	* [[Items]]
−
−
−	~~==References==~~
−	~~There is no references in this trigger.~~
−
−
−	~~==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:
−
−	~~{\| border="1" cellspacing="4" cellpadding="4"~~
−	~~\| '''Argument''' \|\| '''In/Out''' \|\| '''Description'''~~
−	\|-
−	~~\| local.ID \|\| I \|\| ID of the item.~~
−	\|-
−	~~\| local.p.x \|\| I \|\| x location~~
−	\|-
−	~~\| local.p.y \|\| I \|\| y location~~
−	\|-
−	~~\| local.p.z \|\| I \|\| z location~~
−	\|-
−	~~\| local.MAXZ \|\| I \|\| Returns the value of the top placed item.~~
−	\|-
−	~~\| local.visible \|\| I \|\| 0 or 1 (non-visible items are things like doors and signs)~~
−	\|}
−
−
−	~~==Return Values==~~
−	~~The following return values are explicitly defined for this trigger:~~
−
−	~~{\| border="1" cellspacing="4" cellpadding="4"~~
−	~~\| '''Return Value''' \|\| '''Description'''~~
−	\|-
−	~~\| 0 \|\| Will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.~~
−	\|}
−
−
−	~~[[Category: Reference Compendium]]~~
−	~~[[Category: Triggers]]~~

@@ Line 1: / Line 1: @@
 ==Description==
-This trigger fires when an item is about to commit when using house designer.
+X branch only. This trigger fires when an item is about to commit when using house designer.
 Fires on:
 * [[Items]]
 ==References==

← Older revision	Revision as of 22:29, 26 August 2022
Line 1:	Line 1:
	+	==Description==
	+	This trigger fires when an item is about to commit when using house designer.

	+
	+	Fires on:
	+	* [[Items]]
	+
	+
	+	==References==
	+	The following object references are explicitly available for this trigger:
	+
	+	{\| border="1" cellspacing="4" cellpadding="4"
	+	\| '''Name''' \|\| '''Description'''
	+	\|-
	+	\| [[I]] \|\| The [[Items\|item]] being commited.
	+	\|}
	+
	+
	+	==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:
	+
	+
	+	{\| border="1" cellspacing="4" cellpadding="4"
	+	\| '''Argument''' \|\| '''In/Out''' \|\| '''Description'''
	+	\|-
	+	\| local.id \|\| I \|\| ID of the item
	+	\|-
	+	\| local.p.x \|\| I \|\| The x location of the item
	+	\|-
	+	\| local.p.y \|\| I \|\| The y location of the item
	+	\|-
	+	\| local.p.z \|\| I \|\| The z location of the item
	+	\|-
	+	\| local.id \|\| I \|\| 0 or 1 (non-visible items are things like doors and signs) return false will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.
	+
	+	\|}
	+
	+
	+	==Return Values==
	+	The following return values are explicitly defined for this trigger:
	+
	+	{\| border="1" cellspacing="4" cellpadding="4"
	+	\| '''Return Value''' \|\| '''Description'''
	+	\|-
	+	\| 1 \|\| Prevents the item from being commited.
	+	\|}