Bootstrap Element (Data) - Revision history

Rob: /* The "assignval" Element{{anchor|assignval}} */

2009-02-20T02:02:18Z

The "assignval" Element{{anchor|assignval}}

← Older revision		Revision as of 02:02, 20 February 2009
Line 74:		Line 74:
	*No array-based or matrix-based fields may be assigned via bootstraps.		*No array-based or matrix-based fields may be assigned via bootstraps.
	*User fields may be assigned, but there are additional restrictions (see below).		*User fields may be assigned, but there are additional restrictions (see below).
	*Value assignment only occurs for bootstraps that satisfy all their ~~condition tests (e.g.~~ ContainerReq tests).		*Value assignment only occurs for bootstraps that satisfy all their ContainerReq tests.
	*If multiple bootstraps attempt to assign the same field value to a unique pick, the values are assigned in the order they are processed by the engine, which is dictated by evaluation timing.		*If multiple bootstraps attempt to assign the same field value to a unique pick, the values are assigned in the order they are processed by the engine, which is dictated by evaluation timing.
	*If two or more value assignments are applied at the exact same timing, then there is no* guarantee which will take precedence over the other.		*If two or more value assignments are applied at the exact same timing, then there is no* guarantee which will take precedence over the other.
	**If a bootstrap has ~~condition tests (e.g.~~ ContainerReq tests), the value assignment is applied when the final condition test is resolved for the pick.		**If a bootstrap has ContainerReq tests, the value assignment is applied when the final condition test is resolved for the pick.

	Fields of type "user" may be assigned via bootstraps. However, user field incur a number of additional restrictions, as outlined below:		Fields of type "user" may be assigned via bootstraps. However, user field incur a number of additional restrictions, as outlined below:

Rob: /* The "bootstrap" Element */

2009-02-20T02:01:29Z

The "bootstrap" Element

← Older revision		Revision as of 02:01, 20 February 2009
Line 28:		Line 28:
	\|[[AutoTag Element (Data)\|autotag]]		\|[[AutoTag Element (Data)\|autotag]]
	\|Zero or more "autotag" elements may appear as defined by the given link. This element specifies tags that are automatically assigned to the added thing.		\|Zero or more "autotag" elements may appear as defined by the given link. This element specifies tags that are automatically assigned to the added thing.
			{{important}}When the bootstrap include a ContainerReq test, the tags are only assigned to the pick when ContainerReq tag expression is satisfied.
	\|-		\|-
	\|[[#assignval\|assignval]]		\|[[#assignval\|assignval]]

Rob: /* The "assignval" Element{{anchor|assignval}} */

2009-02-20T01:59:33Z

The "assignval" Element{{anchor|assignval}}

← Older revision		Revision as of 01:59, 20 February 2009
Line 68:		Line 68:
	\|}		\|}

	{{~~note~~}}There are a variety of important limitations that apply to the assignment of field values via bootstraps. These include the following:		{{important}}There are a variety of important limitations that apply to the assignment of field values via bootstraps. These include the following:
	*Non-persistent, derived fields may have their values specified freely.		*Non-persistent, derived fields may have their values specified freely.
	*All other derived fields and all non-user fields may not be assigned via bootstraps.		*All other derived fields and all non-user fields may not be assigned via bootstraps.

Rob: /* Example */

2009-02-20T01:58:08Z

Example

← Older revision		Revision as of 01:58, 20 February 2009
Line 94:		Line 94:
	</container>		</container>
	<autotag group="TheGroup" tag="TheTag"/>		<autotag group="TheGroup" tag="TheTag"/>
			<assignval field="MyField" value="42"/>
	</bootstrap>		</bootstrap>
	</pre>		</pre>

Rob: /* The "assignval" Element */

2009-02-20T01:56:40Z

The "assignval" Element

← Older revision		Revision as of 01:56, 20 February 2009
Line 44:		Line 44:
	\|}		\|}

	==The "assignval" Element==		==The "assignval" Element{{anchor\|assignval}}==

	In a ~~variety of situations~~, you ~~will be able to specify one or more tags that will be automatically assigned~~ to ~~an object~~ when ~~it is added. This will always be controlled by the mechanism that is adding the object, such as~~ bootstrapping a thing ~~or adding~~ a ~~thing via~~ a ~~particular table~~.		All of the initial field values for a pick are dictated by the thing. However, there are situation where you'll want to dictate custom field values when bootstrapping a thing. For example, if you have a "Fly" ability, there may be different flying speeds. The "Fly" ability will have its initial speed, but each situation where you bootstrap the ability may call for a different speed.

	~~Each tag that is to be automatically assigned is identified through the use of~~ the "~~autotag~~" element. The complete list of attributes for this element is below.		To handle this situation, the "assignval" element allows you to designate the initial value to be used for a field within a bootstrapped pick. The complete list of attributes for this element is below.

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|~~group~~		\|class="leftnormal"\|field
	\|Id – Specifies the unique id of the ~~tag group within~~ which the assigned ~~tag is defined~~.		\|Id – Specifies the unique id of the field for which the value is being assigned.
	\|-		\|-
	\|~~tag~~		\|value
	\|Id – Specifies the unique id of the ~~assigned tag within~~ the ~~above tag group~~.		\|Text – Specifies the new starting value to be assigned to the field. If the field is text-based, the value is simply assigned, although it may be truncated if it exceeds the defined maximum length for the field. If the field is value-based, the text is converted to a floating point value and assigned.
			\|-
			\|behavior
			\|(Optional) Set – Designates the assignment behavior to be used if the thing is unique and has already been added to the container. An ability like "Fly" is likely to be unique, so it's possible that the ability is bootstrapped by multiple sources or even user-selected. When this occurs, you can stipulate the rules for how the new value is assigned to the field. Must be one of these values:
			<ul class="sets">
			<li>assign – The new value overrides any existing value.</li>
			<li>minimum – Use the lowest of the new value and any existing value.</li>
			<li>maximum – Use the highest of the new value and any existing value.</li>
			<li>Default: "assign".</li>
			</ul>
	\|-		\|-
	\|}		\|}

			{{note}}There are a variety of important limitations that apply to the assignment of field values via bootstraps. These include the following:
			*Non-persistent, derived fields may have their values specified freely.
			*All other derived fields and all non-user fields may not be assigned via bootstraps.
			*No array-based or matrix-based fields may be assigned via bootstraps.
			*User fields may be assigned, but there are additional restrictions (see below).
			*Value assignment only occurs for bootstraps that satisfy all their condition tests (e.g. ContainerReq tests).
			*If multiple bootstraps attempt to assign the same field value to a unique pick, the values are assigned in the order they are processed by the engine, which is dictated by evaluation timing.
			*If two or more value assignments are applied at the exact same timing, then there is no* guarantee which will take precedence over the other.
			**If a bootstrap has condition tests (e.g. ContainerReq tests), the value assignment is applied when the final condition test is resolved for the pick.

			Fields of type "user" may be assigned via bootstraps. However, user field incur a number of additional restrictions, as outlined below:
			*Cannot be used with conditional bootstraps (only derived fields may)
			*Cannot be used with unique things, since the assigned value could overwrite an existing user-modified value
			*Specified value is initialized as the default user value when the pick is first added and is thereafter allowed to be modified by the user
			*The "maximum" and "minimum" behaviors are pointless with user values, since the value will always be the initial value assigned

	==Example==		==Example==

Rob: /* Example */

2009-02-20T00:44:53Z

Example

@@ Line 41: / Line 41: @@
 |class="leftnormal"|PCDATA
 |TagExpr – Specifies the code comprising the Match tag expression.
 |-
 |}

Rob: /* The "bootstrap" Element */

2009-02-20T00:43:52Z

The "bootstrap" Element

← Older revision		Revision as of 00:43, 20 February 2009
Line 28:		Line 28:
	\|[[AutoTag Element (Data)\|autotag]]		\|[[AutoTag Element (Data)\|autotag]]
	\|Zero or more "autotag" elements may appear as defined by the given link. This element specifies tags that are automatically assigned to the added thing.		\|Zero or more "autotag" elements may appear as defined by the given link. This element specifies tags that are automatically assigned to the added thing.
			\|-
			\|[[#assignval\|assignval]]
			\|Zero or more "assignval" elements may appear as defined by the given link. This element specifies modified field values that are automatically assigned to the added thing.
	\|-		\|-
	\|}		\|}

Rob: /* The "bootstrap" Element */

2008-12-09T11:29:49Z

The "bootstrap" Element

← Older revision		Revision as of 11:29, 9 December 2008
Line 11:		Line 11:
	\|index		\|index
	\|(Optional) Integer – Specifies a unique index value for this bootstrap entry. Only global bootstraps that add things to all actors require this attribute and it can be omitted in all other situations. Default: "0".		\|(Optional) Integer – Specifies a unique index value for this bootstrap entry. Only global bootstraps that add things to all actors require this attribute and it can be omitted in all other situations. Default: "0".
	{{warning}}The index is used to uniquely identify this specific bootstrap within saved portfolios. Consequently, it must '''never''' be changed or re-used within ~~differnt~~ versions of the data files. If you eliminate a bootstrap entry, simply leave that index value unused, replacing the old "bootstrap" element with a comment explaining why the hole in numbering is left.		{{warning}}The index is used to uniquely identify this specific bootstrap within saved portfolios. Consequently, it must '''never''' be changed or re-used within different versions of the data files. If you eliminate a bootstrap entry, simply leave that index value unused, replacing the old "bootstrap" element with a comment explaining why the hole in numbering is left.
	\|-		\|-
	\|}		\|}
Line 20:		Line 20:
	\|class="leftnormal"\|[[#match\|match]]		\|class="leftnormal"\|[[#match\|match]]
	\|An optional "match" element may appear as defined by the given link. This element defines the [[Match Tag Expression]]. If omitted, all things are assumed to match and the bootstrap is assigned to all.		\|An optional "match" element may appear as defined by the given link. This element defines the [[Match Tag Expression]]. If omitted, all things are assumed to match and the bootstrap is assigned to all.
	{{important}}This element is only applicable when the bootstrap is defined within a component. In all other cases, this element may not be specified.		{{important}}This element is only applicable when the bootstrap is defined directly within a component. In all other cases, this element may not be specified.
	\|-		\|-
	\|{{flalt\|ContainerReq Element (Data)\|containerreq}}		\|{{flalt\|ContainerReq Element (Data)\|containerreq}}

Rob: /* The "bootstrap" Element */

2008-12-01T06:38:38Z

The "bootstrap" Element

← Older revision		Revision as of 06:38, 1 December 2008
Line 22:		Line 22:
	{{important}}This element is only applicable when the bootstrap is defined within a component. In all other cases, this element may not be specified.		{{important}}This element is only applicable when the bootstrap is defined within a component. In all other cases, this element may not be specified.
	\|-		\|-
	\|[[ContainerReq Element (Data)\|containerreq]]		\|{{flalt\|ContainerReq Element (Data)\|containerreq}}
	\|An optional "containerreq" element may appear as defined by the given link. This element defines the conditional requirements that determine whether the bootstrap is made available within the container. The tag expression is applied against the container of the prospective bootstrapped pick. If the container does not satisfy the tag expression, the bootstrapped pick is treated as non-live.		\|An optional "containerreq" element may appear as defined by the given link. This element defines the conditional requirements that determine whether the bootstrap is made available within the container. The tag expression is applied against the container of the prospective bootstrapped pick. If the container does not satisfy the tag expression, the bootstrapped pick is treated as non-live.
	{{important}}This element is not applicable when the bootstrap is defined within an entity.		{{important}}This element is not applicable when the bootstrap is defined within an entity.

Rob: /* The "bootstrap" Element */

2008-11-28T12:07:45Z

The "bootstrap" Element

← Older revision		Revision as of 12:07, 28 November 2008
Line 19:		Line 19:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|[[#match\|match]]		\|class="leftnormal"\|[[#match\|match]]
	\|An optional "match" element may appear as defined by the given link. This element defines the [[Match Tag Expression]]. If omitted, all things are assumed to match.		\|An optional "match" element may appear as defined by the given link. This element defines the [[Match Tag Expression]]. If omitted, all things are assumed to match and the bootstrap is assigned to all.
	{{important}}This element is only applicable when the bootstrap is defined within a component. In all other cases, this element may not be specified.		{{important}}This element is only applicable when the bootstrap is defined within a component. In all other cases, this element may not be specified.
	\|-		\|-