Placeables.xls - Revision history

Sunjammer: Reformatting contents

2011-10-20T11:34:03Z

Reformatting contents

Sunjammer: Adding link

2011-10-16T16:20:30Z

Adding link

Sunjammer: Extracting 2da files into individual pages

2011-10-08T21:13:23Z

Extracting 2da files into individual pages

Show changes

Sunjammer: /* sound_plc_column_names worksheet */ Fixing parameters

2011-10-03T22:01:38Z

‎sound_plc_column_names worksheet: Fixing parameters

Sunjammer: /* StateCnt_* worksheets */ Applying CSS style

2011-10-03T22:00:38Z

‎StateCnt_* worksheets: Applying CSS style

Sunjammer: /* StateCnt_* worksheets */

2010-09-12T02:31:47Z

‎StateCnt_* worksheets

Sunjammer: /* StateCnt_* worksheets */ fixing link

2010-09-12T02:28:11Z

‎StateCnt_* worksheets: fixing link

Sunjammer: /* StateCnt_* worksheets */ Expanded basic information

2010-09-12T02:27:24Z

‎StateCnt_* worksheets: Expanded basic information

BryanDerksen: fix a link

2010-02-16T17:55:18Z

fix a link

Eshme: /* placeable_types worksheet */

2010-02-16T16:28:45Z

‎placeable_types worksheet

@@ Line 1: / Line 1: @@
 The '''placeables.xls''' file contains the [[2da]] data that define every placeables' appearance, properties and interactions. These 2da files are used by the Toolset, in the [[Placeable editor]], and by the game engine.
-The workbook contains worksheets for the following 2da files:
+The workbook contains the following worksheets:
-* [[placeable_basetypes 2da]]
+* [[placeable_basetypes 2da|placeable_basetypes]]
-* [[placeable_types 2da]]
+* [[placeable_interactions 2da|placeable_interactions]]
-* [[placeable_interactions 2da]]
+* [[placeable_types 2da|placeable_types]]
-* [[StateCnt_* 2da|StateCnt_Bridge 2da]]
+* [[StateCnt_* 2da|StateCnt_AOE]]
-* [[StateCnt_* 2da|StateCnt_AreaTransition 2da]]
+* [[StateCnt_* 2da|StateCnt_AreaTransition]]
-* [[StateCnt_* 2da|StateCnt_Furniture 2da]]
+* [[StateCnt_* 2da|StateCnt_BBase]]
-* [[StateCnt_* 2da|StateCnt_Informational 2da]]
+* [[StateCnt_* 2da|StateCnt_Bodybag]]
-* [[StateCnt_* 2da|StateCnt_AOE 2da]]
+* [[StateCnt_* 2da|StateCnt_Bridge]]
-* [[StateCnt_* 2da|StateCnt_FlipCover 2da]]
+* [[StateCnt_* 2da|StateCnt_Cage]]
-* [[StateCnt_* 2da|StateCnt_Trap_Trigger 2da]]
+* [[StateCnt_* 2da|StateCnt_Container]]
-* [[StateCnt_* 2da|StateCnt_NonSelectable_Trap 2da]]
+* [[StateCnt_* 2da|StateCnt_Container_Static]]
-* [[StateCnt_* 2da|StateCnt_Selectable_Trap 2da]]
+* [[StateCnt_* 2da|StateCnt_Door]]
-* [[StateCnt_* 2da|StateCnt_Puzzle 2da]]
+* [[StateCnt_* 2da|StateCnt_Door_Secret]]
-* [[StateCnt_* 2da|StateCnt_Static 2da]]
+* [[StateCnt_* 2da|StateCnt_FlipCover]]
-* [[StateCnt_* 2da|StateCnt_Cage 2da]]
+* [[StateCnt_* 2da|StateCnt_Furniture]]
-* [[StateCnt_* 2da|StateCnt_Bodybag 2da]]
+* [[StateCnt_* 2da|StateCnt_Informational]]
-* [[StateCnt_* 2da|StateCnt_Container_Static 2da]]
+* [[StateCnt_* 2da|StateCnt_NonSelectable_Trap]]
-* [[StateCnt_* 2da|StateCnt_Container 2da]]
+* [[StateCnt_* 2da|StateCnt_Puzzle]]
-* [[StateCnt_* 2da|StateCnt_BBase 2da]]
+* [[StateCnt_* 2da|StateCnt_Selectable_Trap]]
-* [[StateCnt_* 2da|StateCnt_TopBallista 2da]]
+* [[StateCnt_* 2da|StateCnt_Static]]
-* [[StateCnt_* 2da|StateCnt_Trigger 2da]]
+* [[StateCnt_* 2da|StateCnt_TopBallista]]
-* [[StateCnt_* 2da|StateCnt_Door 2da]]
+* [[StateCnt_* 2da|StateCnt_Trap_Trigger]]
-* [[StateCnt_* 2da|StateCnt_Door_Secret 2da]]
+* [[StateCnt_* 2da|StateCnt_Trigger]]
-* [[sound_plc_column_names  2da]]
+* [[sound_plc_column_names 2da|sound_plc_column_names]]
 [[Category:Placeables]]
 [[Category:XLS files]]

@@ Line 1: / Line 1: @@
-The '''placeables.xls''' file contains the 2da data that define every placeables' appearance, properties and interactions. These 2da files are used by the Toolset, in the [[Placeable editor]], and by the game engine.
+The '''placeables.xls''' file contains the [[2da]] data that define every placeables' appearance, properties and interactions. These 2da files are used by the Toolset, in the [[Placeable editor]], and by the game engine.
-Placeable.xls contains worksheets for the following 2da files:
+The workbook contains worksheets for the following 2da files:
 * [[placeable_basetypes 2da]]

@@ Line 144: / Line 144: @@
 == sound_plc_column_names worksheet ==
-{{2da start}}
+{{2da start|sound_plc_column_names}}
 {{2da column|Label|string|}}
 {{2da end}}

@@ Line 85: / Line 85: @@
 In addition, each state will have its own row and its own column. So for example a container would have both rows and columns for its possible states, like so:
-{| border="1"
+{| class="wikitable"
 |-
 | || Closed_Unlocked || Closed_Locked || Open || Dead
@@ Line 101: / Line 101: @@
 The following placeable types each have their own worksheet, each with the following state lists:
-{| border="1"
+{| class="wikitable"
 |-
 | Placeable type || States || Notes

@@ Line 97: / Line 97: @@
 | Dead || <nowiki>****</nowiki> || <nowiki>****</nowiki> || <nowiki>****</nowiki> || 1026
 |}
-The numbers in the grid correspond to the id of entries in [[ANIM_base.xls|AMIN_placeables.xls]] representing the animation required to change state, for example, of a doors swinging open.
+The numbers in the grid correspond to the id of entries in [[ANIM_base.xls|AMIN_placeables.xls]] representing the animation used to change from the old state to the new state. So, for example, a door going from '''Closed_Unlocked''' to '''Open''' would use the '''Door Opening''' animation.
 The following placeable types each have their own worksheet, each with the following state lists:

@@ Line 70: / Line 70: @@
 {{2da start  |StateCnt_<type>}}
-{{2da column | Label     | string | The entries on this page pertain to entries in the [[animations.xls]] file.}}
+{{2da column | Label     | string | The entries on this page pertain to entries in the [[ANIM_base.xls|AMIN_placeables.xls]] file.}}
 {{2da column | Action0   | int    | Id of an entry in placeable_interactions worksheet representing the primary action}}
 {{2da column | Success0  | int    | Id of an entry in the current '''StateCnt_<type>''' worksheet representing the new state}}

@@ Line 69: / Line 69: @@
 All of the StateCnt worksheets have the following columns in common:
-{{2da start|StateCnt_<type>}}
+{{2da start  |StateCnt_<type>}}
-{{2da column| Label |string| The entries on this page pertain to entries in the [[animations.xls]] file.}}
+{{2da column | Label     | string | The entries on this page pertain to entries in the [[animations.xls]] file.}}
-{{2da column| Action0| int | }}
+{{2da column | Action0   | int    | Id of an entry in placeable_interactions worksheet representing the primary action}}
-{{2da column| Success0| int| }}
+{{2da column | Success0  | int    | Id of an entry in the current '''StateCnt_<type>''' worksheet representing the new state}}
-{{2da column| Success0A| int| }}
+{{2da column | Success0A | int    | Id of an alternate entry in the current '''StateCnt_<type>''' worksheet representing the new state}}
-{{2da column| Action1|int|}}
+{{2da column | Action1   | int    | Id of an entry in '''placeable_interactions''' worksheet representing the secondary action}}
-{{2da column| Success1|int|}}
+{{2da column | Success1  | int    | Id of an entry in the current '''StateCnt_<type>''' worksheet representing the new state}}
-{{2da column| Success1A|int|}}
+{{2da column | Success1A | int    | Id of an alternate entry in the current '''StateCnt_<type>''' worksheet representing the new state}}
-{{2da column| BlockVis|int| Set this to non-zero if you want this state to block visibility.}}
+{{2da column | BlockVis  | int    | Set this to non-zero if you want this state to block visibility.}}
-{{2da column| STRREF|int|}}
+{{2da column | STRREF    | int    | Unknown (0 in all default '''StateCnt_<type>''' worksheets)}}
 {{2da end}}
 In addition, each state will have its own row and its own column. So for example a container would have both rows and columns for its possible states, like so:
@@ Line 95: / Line 97: @@
 | Dead || <nowiki>****</nowiki> || <nowiki>****</nowiki> || <nowiki>****</nowiki> || 1026
 |}
-!! Need to find out what the significance of the numbers populating this grid are!!
+The numbers in the grid correspond to the id of entries in [[ANIM_base.xls|AMIN_placeables.xls]] representing the animation required to change state, for example, of a doors swinging open.
 The following placeable types each have their own worksheet, each with the following state lists:

@@ Line 23: / Line 23: @@
 {{2da column| BaseType | int | ross: This is to replace the body bags flag, and so that we can determine what a placeable is, a door, a chest, bodybag, etc..  These correspond to values on the placeable_basetypes workbook. yaron: We don't use this value - not in scripting and not in engine - we can get rid of it}}
 {{2da column| TurnRate| float|}}
-{{2da column| EnableCollisionEvent|int| When non-zero, this placeable will generate an [[EVENT_TYPE_PLACEABLE_COLLISION]] [[event]].}}
+{{2da column| EnableCollisionEvent|int| When non-zero, this placeable will generate an [[EVENT_TYPE_PLACEABLE_COLLISION]] [[Event (dascript type)|event]].}}
 {{2da column| GeneratePathInfo|int|}}
 {{2da column| Height| float| Specify the height of the placeable. If no height is specified the height will be infered from the objects geometry. NOTE: If the object is rotated in space the height value provided here will not change, however if the height is computed it will be the height of the object after it has been rotated.}}

@@ Line 14: / Line 14: @@
 {{2da column| Label | string| }}
 {{2da column| StrRef | int|}}
-{{2da column| ModelName | string|}}
+{{2da column| ModelName | string| The full model filename (without extension) including and only the highest LOD variation if applicable}}
 {{2da column| BlendTree| string|}}
 {{2da column| DestroyVFX|int|}}
 {{2da column| CrustVFX|int|}}
 {{2da column| OcclusionFactor|float| Value between 0.0 (no occlusion) and 1.0 (full occlusion)}}
-{{2da column| StateController|string|}}
+{{2da column| StateController|string| {{undocumented}} <small>(Seems to influence how the placeable is handled, ie difference between opening a Chest and lifting a Lever)</small>}}
 {{2da column| RemoveWhenDead| int| }}
 {{2da column| BaseType | int | ross: This is to replace the body bags flag, and so that we can determine what a placeable is, a door, a chest, bodybag, etc..  These correspond to values on the placeable_basetypes workbook. yaron: We don't use this value - not in scripting and not in engine - we can get rid of it}}