Shadowing & Displacement - Revision history

Colen: /* Basics */

2011-03-01T23:11:48Z

Basics

← Older revision		Revision as of 23:11, 1 March 2011
Line 1:		Line 1:
	== Basics ==		== Basics ==
	Shadowing and ~~Displacement~~ are intended for use on picks that can be present on gizmos. If a pick is shadowed or displaced, it effectively exists in '''two containers at once''': the gizmo container, and another container (usually the hero container).		Shadowing and displacement are intended for use on picks that can be present on gizmos. If a pick is shadowed or displaced, it effectively exists in '''two containers at once''': the gizmo container, and another container (usually the hero container).

	This means that the pick can be found by iterators (for example, a foreach loop, a call to firstchild, or a table shown in the UI) in both containers. This is often used to add a pick on a gizmo, then have that pick also appear on the hero in some way (for example, in a list of weapons or special abilities).		This means that the pick can be found by iterators (for example, a foreach loop, a call to firstchild, or a table shown in the UI) in both containers. This is often used to add a pick on a gizmo, then have that pick also appear on the hero in some way (for example, in a list of weapons or special abilities).

Colen: /* Limitations */

2011-03-01T23:11:37Z

Limitations

← Older revision		Revision as of 23:11, 1 March 2011
Line 46:		Line 46:
	The following limitations apply to shadowed and displaced picks:		The following limitations apply to shadowed and displaced picks:

	* '''Choose One Only:''' It is not legal to have a pick that is shadowed under some circumstances, and displaced under others. Only one of the components in a component set may specify a "shadow" or "displace" element. Trying to do otherwise will cause a compilation error.		* '''Choose One Only:''' It is not legal to have a pick that is shadowed under some circumstances, and displaced under others. Only one of the components in a component set may specify a "shadow" or "displace" element. Trying to do otherwise will cause a compilation error. (If necessary, you can carve out the "shadow" element into a separate component, and include that component in the appropriate component sets instead of defining it in multiple components.)

	* '''Uniqueness:''' Even if a shadowed or displaced pick is unique, it will not be merged with other picks in the shadow container~~; merging two unique~~ picks ~~with different containers is not possible~~. (Uniqueness is observed normally in the "owner" container.)		* '''Uniqueness:''' Even if a shadowed or displaced pick is unique, it will not be merged with other picks in the shadow container, even other shadowed or displaced picks. Uniqueness is observed normally in the "owner" container.

	* '''User-ordering:''' When a pick is shadowed or displaced, it maintains a SEPARATE user-sorted order within each container to avoid conflicts. The "echo" behavior of the user-sorted order into a field value is only performed for the order within the "owner" container.		* '''User-ordering:''' When a pick is shadowed or displaced, it maintains a SEPARATE user-sorted order within each container to avoid conflicts. The "echo" behavior of the user-sorted order into a field value is only performed for the order within the "owner" container.

	* '''Duplication & Moving:''' Displaced picks can't be duplicated or stacked, or moved between gizmos and the hero (since movement and stacking effectively duplicates the original pick to move or split it). '''Note:''' This only applies to displaced picks. Shadowed picks can be duplicated, moved and stacked as normal.		* '''Duplication & Moving:''' Displaced picks can't be duplicated, split, stacked, or moved between gizmos and the hero (since movement and stacking effectively duplicates the original pick to move or split it). '''Note:''' This only applies to displaced picks. Shadowed picks can be duplicated, moved and stacked as normal.

	* '''Maxlimit:''' Displaced picks can't use "maxlimit". This is because limits within a foreign container cannot be properly detected and policed by Hero Lab's engine. '''Note:''' This only applies to displaced picks. Shadowed picks can be duplicated, moved and stacked as normal.		* '''Maxlimit:''' Displaced picks can't use "maxlimit". This is because limits within a foreign container cannot be properly detected and policed by Hero Lab's engine. '''Note:''' This only applies to displaced picks. Shadowed picks can be duplicated, moved and stacked as normal.

Colen: /* Script Access */

2011-03-01T23:09:28Z

Script Access

← Older revision		Revision as of 23:09, 1 March 2011
Line 35:		Line 35:
	\|-		\|-
	\|shadowed		\|shadowed
	\|Returns 0 if the pick is ~~not~~ shadowed, ~~non-zero~~ otherwise.		\|Returns non-zero if the pick is shadowed, 0 otherwise.
	\|-		\|-
	\|displaced		\|displaced
	\|Returns 0 if the pick is ~~not~~ displaced, ~~non-zero~~ otherwise.		\|Returns non-zero if the pick is displaced, 0 otherwise.
	\|-		\|-
	\|}		\|}

Colen: /* What's the Difference? */

2011-03-01T23:08:44Z

What's the Difference?

← Older revision		Revision as of 23:08, 1 March 2011
Line 12:		Line 12:
	== What's the Difference? ==		== What's the Difference? ==

	Normal (non-shadowed or -displaced) picks have only one container - the container that they were added through, which is known as their '''"owner" container'''. Shadowed and displaced picks have another, named the '''"shadow" container'''.		Normal (non-shadowed or -displaced) picks have only one container - the container that they were added through, which is known as their '''"owner" container'''. Shadowed and displaced picks have another, named the '''"shadow" container''' (how sinister!).

	* If a pick is '''shadowed''', its owner container remains the same. The shadow container is the ~~'''secondary~~ container~~'''~~ (the hero or parent of the gizmo).		* If a pick is '''shadowed''', its owner container remains the same. The shadow container is the other container (the hero or parent of the gizmo).

	* If a pick is '''displaced''', its owner container is '''the container the pick is displaced into''' (the hero or parent of the gizmo). The shadow container is the original container.		* If a pick is '''displaced''', its owner container becomes '''the container the pick is displaced into''' (the hero or parent of the gizmo). The shadow container is the original container.

	This has important implications. The "container" transition always goes to the '''owner container'''. ~~For example,~~ this script:		This has important implications. The "container" transition always goes to the '''owner container'''. Consider this script:

	<pre>perform container.assign[Group.Tag]</pre>		<pre>perform container.assign[Group.Tag]</pre>

	On a normal or shadowed pick, the tag "Group.Tag" is assigned to the container the pick was added to. However, on a displaced pick, the tag is assigned to the container the pick was displaced into.		On a normal or shadowed pick, the tag "Group.Tag" is assigned to the container the pick was added to. However, on a displaced pick, the tag is assigned to the container the pick was displaced into, because that's its owner container.

	Also, bootstrapped picks are always added to the '''owner container'''. This means that if a displaced pick bootstraps other picks, those picks will be added to the container the pick was displaced into.		Also, bootstrapped picks are always added to the '''owner container'''. This means that if a displaced pick bootstraps other picks, those picks will be added to the container the pick was displaced into.

Colen: /* Basics */

2011-03-01T23:06:33Z

Basics

← Older revision		Revision as of 23:06, 1 March 2011
Line 1:		Line 1:
	== Basics ==		== Basics ==
	Shadowing and Displacement are intended for use on picks present on gizmos. If a pick is shadowed or displaced, it effectively exists in '''two containers at once''' (the gizmo container, and usually the hero container).		Shadowing and Displacement are intended for use on picks that can be present on gizmos. If a pick is shadowed or displaced, it effectively exists in '''two containers at once''': the gizmo container, and another container (usually the hero container).

	This means that the pick can be found by iterators (for example, a foreach loop, a call to firstchild, or a table shown in the UI) in both containers. This is often used to add a pick on a gizmo, then have that pick also appear on the hero in some way (for example, in a list of weapons or special abilities).		This means that the pick can be found by iterators (for example, a foreach loop, a call to firstchild, or a table shown in the UI) in both containers. This is often used to add a pick on a gizmo, then have that pick also appear on the hero in some way (for example, in a list of weapons or special abilities).
Line 7:		Line 7:

	Note that both displaced and shadowed picks may only be deleted through the original container they were added through. They may not be deleted by the user from a table in any other container.		Note that both displaced and shadowed picks may only be deleted through the original container they were added through. They may not be deleted by the user from a table in any other container.

			If a pick on the hero is shadowed or displaced, there is no effect.

	== What's the Difference? ==		== What's the Difference? ==

Colen: /* Script Access */

2011-03-01T23:04:33Z

Script Access

← Older revision		Revision as of 23:04, 1 March 2011
Line 26:		Line 26:
	== Script Access ==		== Script Access ==

	~~- Script transition "shadow~~.~~" moves from a pick to its shadow container~~		Several related script transitions and target references are available for shadowed and displaced picks.
	~~- The~~ "~~container.~~" ~~transition goes to the container that~~ "~~owns" the picks, while the~~ "shadow~~." transition goes~~ to the ~~alternate (~~shadow) container
	- ~~Script target reference "~~shadowed~~" returns whether a~~ pick is shadowed		:{\| class="infotable"
	- ~~Script target reference "~~displaced~~" returns whether a~~ pick is displaced		\|class="leftnormal"\|shadow
			\|Transitions to the shadow container for a pick.
			\|-
			\|shadowed
			\|Returns 0 if the pick is not shadowed, non-zero otherwise.
			\|-
			\|displaced
			\|Returns 0 if the pick is not displaced, non-zero otherwise.
			\|-
			\|}

	== Limitations ==		== Limitations ==

Colen: /* What's the Difference? */

2011-03-01T23:00:40Z

What's the Difference?

← Older revision		Revision as of 23:00, 1 March 2011
Line 10:		Line 10:
	== What's the Difference? ==		== What's the Difference? ==

	(~~explain~~ the ~~shadow~~ container / owner container ~~here)~~		Normal (non-shadowed or -displaced) picks have only one container - the container that they were added through, which is known as their '''"owner" container'''. Shadowed and displaced picks have another, named the '''"shadow" container'''.

	owner container:		* If a pick is '''shadowed''', its owner container remains the same. The shadow container is the '''secondary container''' (the hero or parent of the gizmo).

	container.~~blah goes to~~ the ~~owner~~ container		* If a pick is '''displaced''', its owner container is '''the container the pick is displaced into''' (the hero or parent of the gizmo). The shadow container is the original container.

	bootstrapped picks ~~appear in~~ the owner container		This has important implications. The "container" transition always goes to the '''owner container'''. For example, this script:

			<pre>perform container.assign[Group.Tag]</pre>

			On a normal or shadowed pick, the tag "Group.Tag" is assigned to the container the pick was added to. However, on a displaced pick, the tag is assigned to the container the pick was displaced into.

			Also, bootstrapped picks are always added to the '''owner container'''. This means that if a displaced pick bootstraps other picks, those picks will be added to the container the pick was displaced into.

	== Script Access ==		== Script Access ==

Colen: /* Limitations */

2011-03-01T22:53:22Z

Limitations

← Older revision		Revision as of 22:53, 1 March 2011
Line 29:		Line 29:
	The following limitations apply to shadowed and displaced picks:		The following limitations apply to shadowed and displaced picks:

	* '''~~Combinations~~:''' It is not legal to have a pick that is shadowed under some circumstances, and displaced under others. Only one of the components in a component set may specify a "shadow" or "displace" element. Trying to do otherwise will cause a compilation error.		* '''Choose One Only:''' It is not legal to have a pick that is shadowed under some circumstances, and displaced under others. Only one of the components in a component set may specify a "shadow" or "displace" element. Trying to do otherwise will cause a compilation error.

	* '''Uniqueness:''' Even if a shadowed or displaced pick is unique, it will not be merged with other picks in the shadow container; merging two unique picks with different containers is not possible. (Uniqueness is observed normally in the "owner" container.)		* '''Uniqueness:''' Even if a shadowed or displaced pick is unique, it will not be merged with other picks in the shadow container; merging two unique picks with different containers is not possible. (Uniqueness is observed normally in the "owner" container.)
Line 35:		Line 35:
	* '''User-ordering:''' When a pick is shadowed or displaced, it maintains a SEPARATE user-sorted order within each container to avoid conflicts. The "echo" behavior of the user-sorted order into a field value is only performed for the order within the "owner" container.		* '''User-ordering:''' When a pick is shadowed or displaced, it maintains a SEPARATE user-sorted order within each container to avoid conflicts. The "echo" behavior of the user-sorted order into a field value is only performed for the order within the "owner" container.

	* '''Duplication & Moving:''' Displaced picks can't be duplicated or stacked, or moved between gizmos and the hero (since movement and stacking effectively duplicates the original pick to move or split it).		* '''Duplication & Moving:''' Displaced picks can't be duplicated or stacked, or moved between gizmos and the hero (since movement and stacking effectively duplicates the original pick to move or split it). '''Note:''' This only applies to displaced picks. Shadowed picks can be duplicated, moved and stacked as normal.

	~~- Use of~~ "maxlimit" ~~on a thing~~ is ~~NOT compatible with displacement~~		* '''Maxlimit:''' Displaced picks can't use "maxlimit". This is because limits within a foreign container cannot be properly detected and policed by Hero Lab's engine. '''Note:''' This only applies to displaced picks. Shadowed picks can be duplicated, moved and stacked as normal.
	~~- Limits~~ within a foreign container cannot be properly detected and policed

Colen: /* Basics */

2011-03-01T22:51:35Z

Basics

← Older revision		Revision as of 22:51, 1 March 2011
Line 2:		Line 2:
	Shadowing and Displacement are intended for use on picks present on gizmos. If a pick is shadowed or displaced, it effectively exists in '''two containers at once''' (the gizmo container, and usually the hero container).		Shadowing and Displacement are intended for use on picks present on gizmos. If a pick is shadowed or displaced, it effectively exists in '''two containers at once''' (the gizmo container, and usually the hero container).

	This means that the pick can be found by iterators (for example, in a foreach loop, a call to firstchild, or in a table shown in the UI) in both containers. This is often used to add a pick on a gizmo, then have that pick also appear on the hero in some way (for example, in a list of weapons or special abilities).		This means that the pick can be found by iterators (for example, a foreach loop, a call to firstchild, or a table shown in the UI) in both containers. This is often used to add a pick on a gizmo, then have that pick also appear on the hero in some way (for example, in a list of weapons or special abilities).

	Shadowing and Displacement are set up using the [[Component_Element_(Data)#The_.22shadow.22_Element\|shadow]] and [[Component_Element_(Data)#The_.22displace.22_Element\|displace]] elements on a component.		Shadowing and Displacement are set up using the [[Component_Element_(Data)#The_.22shadow.22_Element\|shadow]] and [[Component_Element_(Data)#The_.22displace.22_Element\|displace]] elements on a component.

	~~- Both~~ displaced and shadowed picks may only be deleted through the original container they were added through		Note that both displaced and shadowed picks may only be deleted through the original container they were added through. They may not be deleted by the user from a table in any other container.

	== What's the Difference? ==		== What's the Difference? ==

Colen at 22:50, 1 March 2011

2011-03-01T22:50:00Z

@@ Line 5: / Line 5: @@
 Shadowing and Displacement are set up using the [[Component_Element_(Data)#The_.22shadow.22_Element|shadow]] and [[Component_Element_(Data)#The_.22displace.22_Element|displace]] elements on a component.
 == What's the Difference? ==
 (explain the shadow container / owner container here)
 == Limitations ==
@@ Line 19: / Line 34: @@
 * '''User-ordering:''' When a pick is shadowed or displaced, it maintains a SEPARATE user-sorted order within each container to avoid conflicts. The "echo" behavior of the user-sorted order into a field value is only performed for the order within the "owner" container.