Script Contexts - Revision history

Colen: /* Contexts Within Structural Hierarchy */

2011-03-01T23:21:40Z

Contexts Within Structural Hierarchy

← Older revision		Revision as of 23:21, 1 March 2011
Line 54:		Line 54:
	\|-		\|-
	\|shadow		\|shadow
	\|The "shadow" context represents the shadowed version of a pick, which resides within a different location in the structural hierarchy due the shadowing. If the pick is not shadowed, there is no shadow context.		\|The [[Shadowing & Displacement\|"shadow" context]] represents the shadowed version of a pick, which resides within a different location in the structural hierarchy due the shadowing. If the pick is not shadowed, there is no shadow context.
	\|-		\|-
	\|origin		\|origin

Rob at 00:05, 8 December 2008

2008-12-08T00:05:52Z

← Older revision		Revision as of 00:05, 8 December 2008
Line 81:		Line 81:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|scene		\|class="leftnormal"\|{{flalt\|Scene Context\|scene}}
	\|The "scene" context identifies the top-level visual element within the current hierarchy, which will be either a panel, a form, or a sheet.~~<br>~~		\|The "scene" context identifies the top-level visual element within the current hierarchy, which will be either a panel, a form, or a sheet.
	~~See Also: [[Scene Context Transitions]], [[Scene Target References]]~~
	\|-		\|-
	\|layout		\|{{flalt\|Layout Context\|layout}}
	\|The "layout" context identifies a layout within the top-level scene of the current hierarchy.~~<br>~~		\|The "layout" context identifies a layout within the top-level scene of the current hierarchy.
	~~See Also: [[Layout Context Transitions]], [[Layout Target References]]~~
	\|-		\|-
	\|template		\|{{flalt\|Template Context\|template}}
	\|The "template" context identifies a template within the current hierarchy. Templates can either be used within layouts or within tables, so the parent context of the template within the hierarchy can vary.~~<br>~~		\|The "template" context identifies a template within the current hierarchy. Templates can either be used within layouts or within tables, so the parent context of the template within the hierarchy can vary.
	~~See Also: [[Template Context Transitions]], [[Template Target References]]~~
	\|-		\|-
	\|portal		\|{{flalt\|Portal Context\|portal}}
	\|The "portal" context identifies a portal within the current hierarchy. Portals can either be used within templates or within layouts, so the parent context of the portal within the hierarchy can vary.~~<br>~~		\|The "portal" context identifies a portal within the current hierarchy. Portals can either be used within templates or within layouts, so the parent context of the portal within the hierarchy can vary.
	~~See Also: [[Portal Context Transitions]], [[Portal Target References]]~~
	\|-		\|-
	\|table		\|{{flalt\|Table Context\|table}}
	\|The "table" context identifies the containing table of a template or portal within the current hierarchy.~~<br>~~		\|The "table" context identifies the containing table of a template or portal within the current hierarchy.
	~~See Also: [[Table Context Transitions]], [[Table Target References]]~~
	\|-		\|-
	\|value		\|{{flalt\|Value Context\|value}}
	\|The "value" context represents any field within the pick or thing associated with a template. The value context is used for display only, so all aspects of the field are always read-only.~~<br>~~		\|The "value" context represents any field within the pick or thing associated with a template. The value context is used for display only, so all aspects of the field are always read-only.
	~~See Also: [[Value Context Transitions]], [[Value Target References]]~~
	\|-		\|-
	\|}		\|}
Line 138:		Line 132:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|state		\|class="leftnormal"\|{{flalt\|State Context\|state}}
	\|The "state" context provides access to overall state information that pertains to the portfolio as a whole or general information about the evaluation cycle.~~<br>~~		\|The "state" context provides access to overall state information that pertains to the portfolio as a whole or general information about the evaluation cycle.
	~~See Also: [[State Context Transitions]], [[State Target References]]~~
	\|-		\|-
	\|transaction		\|transaction

Rob at 00:04, 8 December 2008

2008-12-08T00:04:12Z

← Older revision		Revision as of 00:04, 8 December 2008
Line 18:		Line 18:
	\|The "hero" context represents an individual actor within the portfolio. This actor could be a lead or a minion.		\|The "hero" context represents an individual actor within the portfolio. This actor could be a lead or a minion.
	\|-		\|-
	\|container		\|{{flalt\|Container Context\|container}}
	\|The "container" context represents any container within the portfolio. The container could be an actor or a gizmo.~~<br>~~		\|The "container" context represents any container within the portfolio. The container could be an actor or a gizmo.
	~~See Also: [[Container Context Transitions]], [[Container Target References]]~~
	\|-		\|-
	\|pick		\|{{flalt\|Pick Context\|pick}}
	\|The "pick" context represents any pick throughout the portfolio, located within any container.~~<br>~~		\|The "pick" context represents any pick throughout the portfolio, located within any container.
	~~See Also: [[Pick Context Transitions]], [[Pick Target References]]~~
	\|-		\|-
	\|thing		\|{{flalt\|Thing Context\|thing}}
	\|The "thing" context represents a thing that has not been added to the portfolio. The thing context is very similar to the pick context in behavior, with the only real difference being that the dynamic facets of picks don't exist for things, resulting in many valid actions for picks being inaccessible from things.~~<br>~~		\|The "thing" context represents a thing that has not been added to the portfolio. The thing context is very similar to the pick context in behavior, with the only real difference being that the dynamic facets of picks don't exist for things, resulting in many valid actions for picks being inaccessible from things.
	~~See Also: [[Thing Context Transitions]], [[Thing Target References]]~~
	\|-		\|-
	\|field		\|{{flalt\|Field Context\|field}}
	\|The "field" context represents any field within any pick or thing. If within a thing, all aspects of the field are read-only.~~<br>~~		\|The "field" context represents any field within any pick or thing. If within a thing, all aspects of the field are read-only.
	~~See Also: [[Field Context Transitions]], [[Field Target References]]~~
	\|-		\|-
	\|pool		\|{{flalt\|Pool Context\|pool}}
	\|The "pool" context represents any usage pool associated with either the actor or a specific pick.~~<br>~~		\|The "pool" context represents any usage pool associated with either the actor or a specific pick.
	~~See Also: [[Pool Context Transitions]], [[Pool Target References]]~~
	\|-		\|-
	\|}		\|}

Rob at 00:02, 8 December 2008

2008-12-08T00:02:45Z

← Older revision		Revision as of 00:02, 8 December 2008
Line 15:		Line 15:
	\|The "portfolio" context represents the topmost level within the structural hierarchy, encapsulating all of the different leads that have been created. This context is generally '''not''' accessible via scripts, as each lead is considered to be an atomic object.		\|The "portfolio" context represents the topmost level within the structural hierarchy, encapsulating all of the different leads that have been created. This context is generally '''not''' accessible via scripts, as each lead is considered to be an atomic object.
	\|-		\|-
	\|hero		\|{{flalt\|Hero Context\|hero}}
	\|The "hero" context represents an individual actor within the portfolio. This actor could be a lead or a minion.~~<br>~~		\|The "hero" context represents an individual actor within the portfolio. This actor could be a lead or a minion.
	~~See Also: [[Hero Context Transitions]], [[Hero Target References]]~~
	\|-		\|-
	\|container		\|container

Rob at 23:40, 7 December 2008

2008-12-07T23:40:49Z

← Older revision		Revision as of 23:40, 7 December 2008
Line 106:		Line 106:
	\|The "table" context identifies the containing table of a template or portal within the current hierarchy.<br>		\|The "table" context identifies the containing table of a template or portal within the current hierarchy.<br>
	See Also: [[Table Context Transitions]], [[Table Target References]]		See Also: [[Table Context Transitions]], [[Table Target References]]
			\|-
			\|value
			\|The "value" context represents any field within the pick or thing associated with a template. The value context is used for display only, so all aspects of the field are always read-only.<br>
			See Also: [[Value Context Transitions]], [[Value Target References]]
	\|-		\|-
	\|}		\|}

Rob at 13:22, 7 December 2008

2008-12-07T13:22:59Z

← Older revision		Revision as of 13:22, 7 December 2008
Line 16:		Line 16:
	\|-		\|-
	\|hero		\|hero
	\|The "hero" context represents an individual actor within the portfolio. This actor could be a lead or a minion.		\|The "hero" context represents an individual actor within the portfolio. This actor could be a lead or a minion.<br>
			See Also: [[Hero Context Transitions]], [[Hero Target References]]
	\|-		\|-
	\|container		\|container
	\|The "container" context represents any container within the portfolio. The container could be an actor or a gizmo.		\|The "container" context represents any container within the portfolio. The container could be an actor or a gizmo.<br>
			See Also: [[Container Context Transitions]], [[Container Target References]]
	\|-		\|-
	\|pick		\|pick
	\|The "pick" context represents any pick throughout the portfolio, located within any container.		\|The "pick" context represents any pick throughout the portfolio, located within any container.<br>
			See Also: [[Pick Context Transitions]], [[Pick Target References]]
	\|-		\|-
	\|thing		\|thing
	\|The "thing" context represents a thing that has not been added to the portfolio. The thing context is very similar to the pick context in behavior, with the only real difference being that the dynamic facets of picks don't exist for things, resulting in many valid actions for picks being inaccessible from things.		\|The "thing" context represents a thing that has not been added to the portfolio. The thing context is very similar to the pick context in behavior, with the only real difference being that the dynamic facets of picks don't exist for things, resulting in many valid actions for picks being inaccessible from things.<br>
			See Also: [[Thing Context Transitions]], [[Thing Target References]]
	\|-		\|-
	\|field		\|field
	\|The "field" context represents any field within any pick or thing. If within a thing, all aspects of the field are read-only.		\|The "field" context represents any field within any pick or thing. If within a thing, all aspects of the field are read-only.<br>
			See Also: [[Field Context Transitions]], [[Field Target References]]
	\|-		\|-
	\|pool		\|pool
	\|The "pool" context represents any usage pool associated with either the actor or a specific pick.		\|The "pool" context represents any usage pool associated with either the actor or a specific pick.<br>
			See Also: [[Pool Context Transitions]], [[Pool Target References]]
	\|-		\|-
	\|}		\|}
Line 82:		Line 88:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|scene		\|class="leftnormal"\|scene
	\|The "scene" context identifies the top-level visual element within the current hierarchy, which will be either a panel, a form, or a sheet.		\|The "scene" context identifies the top-level visual element within the current hierarchy, which will be either a panel, a form, or a sheet.<br>
			See Also: [[Scene Context Transitions]], [[Scene Target References]]
	\|-		\|-
	\|layout		\|layout
	\|The "layout" context identifies a layout within the top-level scene of the current hierarchy.		\|The "layout" context identifies a layout within the top-level scene of the current hierarchy.<br>
			See Also: [[Layout Context Transitions]], [[Layout Target References]]
	\|-		\|-
	\|template		\|template
	\|The "template" context identifies a template within the current hierarchy. Templates can either be used within layouts or within tables, so the parent context of the template within the hierarchy can vary.		\|The "template" context identifies a template within the current hierarchy. Templates can either be used within layouts or within tables, so the parent context of the template within the hierarchy can vary.<br>
			See Also: [[Template Context Transitions]], [[Template Target References]]
	\|-		\|-
	\|portal		\|portal
	\|The "portal" context identifies a portal within the current hierarchy. Portals can either be used within templates or within layouts, so the parent context of the portal within the hierarchy can vary.		\|The "portal" context identifies a portal within the current hierarchy. Portals can either be used within templates or within layouts, so the parent context of the portal within the hierarchy can vary.<br>
			See Also: [[Portal Context Transitions]], [[Portal Target References]]
	\|-		\|-
	\|table		\|table
	\|The "table" context identifies the containing table of a template or portal within the current hierarchy.		\|The "table" context identifies the containing table of a template or portal within the current hierarchy.<br>
			See Also: [[Table Context Transitions]], [[Table Target References]]
	\|-		\|-
	\|}		\|}
Line 130:		Line 141:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|state		\|class="leftnormal"\|state
	\|The "state" context provides access to overall state information that pertains to the portfolio as a whole or general information about the evaluation cycle.		\|The "state" context provides access to overall state information that pertains to the portfolio as a whole or general information about the evaluation cycle.<br>
			See Also: [[State Context Transitions]], [[State Target References]]
	\|-		\|-
	\|transaction		\|transaction

Rob: /* General Contexts */

2008-12-05T10:58:06Z

General Contexts

← Older revision		Revision as of 10:58, 5 December 2008
Line 136:		Line 136:
	\|-		\|-
	\|focus		\|focus
	\|The "focus" context reflects the pick that has been established as the current "focus" via explicit actions within scripts. If no focus has been setup, then there is no focus context.		\|The "focus" context reflects the pick that has been established as the current "pick focus" via explicit actions within scripts. If no pick focus has been setup, then there is no focus context.
			\|-
			\|actor
			\|The "actor" context reflects the hero that has been established as the current "actor focus" via explicit actions within scripts. If no actor focus has been setup, then there is no actor context.
	\|-		\|-
	\|eachpick		\|eachpick

Rob: /* Overview */

2008-12-04T23:08:13Z

Overview

← Older revision		Revision as of 23:08, 4 December 2008
Line 4:		Line 4:

	This first step in accessing data via scripts is in identifying where that data resides within the overall data hierarchy. A separate hierarchy is maintained for both structural information (e.g. actors, picks, gizmos, minions, etc.) and visual information (e.g. panels, layouts, templates, etc.). Each different layer within the hierarchy is considered a distinct "context".		This first step in accessing data via scripts is in identifying where that data resides within the overall data hierarchy. A separate hierarchy is maintained for both structural information (e.g. actors, picks, gizmos, minions, etc.) and visual information (e.g. panels, layouts, templates, etc.). Each different layer within the hierarchy is considered a distinct "context".

			{{important}}Within certain script contexts, '''all''' target references are treated as read-only, regardless of whether they are normally writable. Any attempts to modify the contents of a target reference that has been forced to be read-only will fail to either compile or work at run-time. For example, if a Position script for a visual element attempts to modify the contents of a pick, it will be forbidden. Scripts and/or contexts within which this behavior occurs should specify it within their documentation.

	==Contexts Within Structural Hierarchy==		==Contexts Within Structural Hierarchy==

Rob: /* General Contexts */

2008-12-04T08:36:24Z

General Contexts

← Older revision		Revision as of 08:36, 4 December 2008
Line 128:		Line 128:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|state		\|class="leftnormal"\|state
	\|x		\|The "state" context provides access to overall state information that pertains to the portfolio as a whole or general information about the evaluation cycle.
	\|-		\|-
	\|transaction		\|transaction
	\|x		\|The "transaction" context represents the special pick that is utilized for buy and sell transactions. Since such transactions can be canceled by the user, all the details must be managed in a temporary fashion until the user completes the transaction.
	\|-		\|-
	\|focus		\|focus
	\|x		\|The "focus" context reflects the pick that has been established as the current "focus" via explicit actions within scripts. If no focus has been setup, then there is no focus context.
	\|-		\|-
	\|eachpick		\|eachpick
	\|x		\|The "eachpick" context reflects the current pick that is being processed within a "foreach" loop performed by a script.
	\|-		\|-
	\|altpick		\|altpick
	\|x		\|The "altpick" context identifies a secondary pick that is involved in an operation, such as when merging two stackable picks into one.
	\|-		\|-
	\|altthing		\|altthing
	\|x		\|The "altthing" context identifies a secondary thing that is involved in an operation, such as is necessary when performing pre-requisite tests.
	\|-		\|-
	\|}		\|}

Rob at 08:27, 4 December 2008

2008-12-04T08:27:16Z

← Older revision		Revision as of 08:27, 4 December 2008
Line 76:		Line 76:
	==Contexts Within Visual Hierarchy==		==Contexts Within Visual Hierarchy==

	The visual hierarchy has a separate set of contexts that are managed by the Kit. The following table describes each of these contexts.		The visual hierarchy has a separate set of contexts that are managed by the Kit and that are accessed exclusively via Position scripts on visual elements. The following table describes each of these contexts.

	:{\| class="infotable"		:{\| class="infotable"
Line 112:		Line 112:
	\|-		\|-
	\|hero		\|hero
	\|The "hero" context within a visual script		\|The "hero" context within a visual script identifies the actor that the visual element is operating upon. This context is always treated as read-only from within a visual script.
	\|-		\|-
	\|container		\|container
	\|x		\|The "container" context within a visual script identifies the container that the visual element is operating upon. This context is always treated as read-only from within a visual script.
	\|-		\|-
	\|value		\|value
	\|x		\|The "value" context within a visual script represents the contents of a field. The field is accessed via a pick, which is identified by the template from which the value context is being utilized.
	\|-		\|-
	\|}		\|}
Line 143:		Line 143:
	\|-		\|-
	\|altthing		\|altthing
	\|x
	\|-
	\|x
	\|x
	\|-
	\|x
	\|x
	\|-
	\|x
	\|x		\|x
	\|-		\|-
	\|}		\|}