Difference between revisions of "Shadowing & Displacement"

From HLKitWiki
Jump to: navigation, search
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.
 
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
  
 
== What's the Difference? ==
 
== What's the Difference? ==
  
 
(explain the shadow container / owner container here)
 
(explain the shadow container / owner container here)
 +
 +
owner container:
 +
 +
container.blah goes to the owner container
 +
 +
bootstrapped picks appear in the owner container
 +
 +
== Script Access ==
 +
 +
- Script transition "shadow." moves from a pick to its shadow container
 +
- 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
 +
- Script target reference "displaced" returns whether a pick is displaced
  
 
== Limitations ==
 
== 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.
 
* '''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).
 +
 +
- Use of "maxlimit" on a thing is NOT compatible with displacement
 +
- Limits within a foreign container cannot be properly detected and policed

Revision as of 15:50, 1 March 2011

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).

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).

Shadowing and Displacement are set up using the shadow and displace elements on a component.

- Both displaced and shadowed picks may only be deleted through the original container they were added through

What's the Difference?

(explain the shadow container / owner container here)

owner container:

container.blah goes to the owner container

bootstrapped picks appear in the owner container

Script Access

- Script transition "shadow." moves from a pick to its shadow container - 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 - Script target reference "displaced" returns whether a pick is displaced

Limitations

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.
  • 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.)
  • 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).

- Use of "maxlimit" on a thing is NOT compatible with displacement - Limits within a foreign container cannot be properly detected and policed