Item attributes:
ItemClass: defines built-in behaviour such as catapult / target pairing,
fizzler auto-extend etc.
Type: name of this item as referenced in p2c files
_______________________________________________________________________________
Editor: subsection for how it behaves in the editor
sub-items:
MovementHandle: how the item can be positioned inside a voxel
possible values (example items in parentheses):
HANDLE_NONE: position is fixed (floor button)
HANDLE_4_DIRECTIONS: rotate 4 ways (switch, glass)
HANDLE_36_DIRECTIONS: rotate in 10dg increments (turret)
HANDLE_8_POSITIONS: 4 horizontal, 4 vertical (lights)
HANDLE_6_POSITIONS: similar to 8, but item is placed in the center
instead of at 1/4 and 3/4 (light bridge, fizzler)
HANDLE_5_POSITIONS: center and 4 edges (all laser props)
(Not suitable for custom items: there need to be two paired item
types, one for the center and one for the edges. These pairings
are hard-coded in the editor.)
HANDLE_CATAPULT: catapult trajectory
(Also obviously not suitable for custom items.)
SubType: variations on one part (buttons, gels, ...)
at least one SubType block is required per item type, even if it does
not have multiple types.
sub-items:
Name: name of item as displayed to the user (can be any text)
Model: appearance in the editor
can be present more than once for certain ItemClass types
sub-items:
ModelName: name of model to show in the editor. 3ds extension is
ignored, as this must be an mdl file inside
models/props_map_editor.
There is a selection_name.3ds, which is used for
detecting when the user clicks on the object.
(It's like a vphysics mesh in the normal game.)
TextureName: name of texture; obsolete as the mdl file already
refers to a texture.
Palette: position on the parts list
(non-placeable items don't have this)
sub-items:
Position: "<x> <y> 0" (last number must be 0 or it won't show up)
(speculation: different tabs besides the one "items"?)
If multiple items specify the same position,
the last one takes precedence.
(i.e. just add you custom stuff to the end of the file
and it will replace built-in items)
Tooltip: text shown at the bottom of the parts list when this item
is selected (Like Name, you can put any description you
want here.)
Image: image in the parts list, from
materials/models/props_map_editor
Sounds: various sounds that play when handling this item
Animations: TODO: investigate
(not needed for a part to play its "explode" animation when
selected. Defining the animations in the mdl is enough.)
SubTypeProperty: property that enables selection of sub-type via rclick.
Value is position of SubType in list, starting from 0
Only works with an ItemClass that is designed to do this,
and the number of choices and their names are not
customisable AFAIK.
InvalidSurface: indicates invalid orientations: CEILING; WALL; FLOOR
(multiple flags can be combined)
CanAnchorOnBarriers: set to 1 to allow placement on glass or grating
(cubes, turret)
CanAnchorOnGoo: set to 1 to allow placement above goo
(only the cubes, currently)
OccupiesVoxel: set to 0 to indicate that this item does not prevent
placement of other stuff in the same voxel
(glass, catapult target)
Copyable: set to 0 to prevent clone-dragging of this item (exits etc.)
Deletable: set to 0 to prevent deletion of this item (exits, but also
resizing widgets, which seem to be separate items)
DesiredFacing: item prefers certain orientations (bridge, fizzlers)
PseudoHandle: not sure; all resizing widgets seem to have this
RenderColor: Unknown, as of now. (Only the catapult target has it.)
_______________________________________________________________________________
Properties: item-specific properties.
Standard properties that will work on any item regardless of class:
TimerDelay and TimerSound: places a time selection widget on the rclick
menu for setting time.
(TimerSound is set to 0 if selection is "infinite"?)
ConnectionCount: will report the number of incoming connections to
the map instance for this item. Used by instances to set MaxLegalValue
on a counter inside the instance vmf, so they only work when all incoming
signals are activated.
StartEnabled: places a "Start Enabled" menu item on the rclick menu.
TODO: there are similar properties named StartDeployed and StartOpen.
I haven't checked whether these are class-specific or not.
_______________________________________________________________________________
Exporting: various settings for exporting an item to vmf
sub-items:
InstanceNames: one or more vmf files; function of each file seems
predefined by item class
generic behaviour is to put the first instance in the map
at the indicated position and orientation
TargetName: base targetname for instances; gets number appended to make
unique targetnames
probably a good idea to keep this unique across items
Inputs, Outputs: specifies which inputs and outputs the instance for this
item uses. Specifying either of these for a standard
item will enable the rclick menu option for connecting
to other items. Items are allowed to specify both an
input and an output in order to act as a relay.
Sub-items name the type of connection. The only
connection type supported on standard items is
CONNECTION_STANDARD. (You can't make up your own
connection types, unfortunately.)
Any item defining inputs or outputs must have a
ConnectionPoints section to specify where the antlines
attach. (Failing to provide this will result in
a disabled "connect" menu item.)
Offset: offset of the inserted instances from the lower-front-left corner
of the voxel. Everything except the entry and exit doors has this
set to "64 64 64" i.e. the center of the voxel.
OccupiedVoxels: defines the space taken up by the item in the map.
sub-items: one or more "voxel" entries.
voxel attributes:
Pos: relative position where "0 0 0" is the anchor location
of the item
Surface: addresses one side of a voxel. (See below.)
CollideType, CollideAgainst: Distinguishes between different types
of objects, so that certain objects only collide with certain
other objects. I haven't looked at this much but it seems pretty
straightforward.
surface attributes:
Normal: designates one whole side of a voxel.
The value is the vector of the surface normal
pointing inwards (e.g. bottom = "0 0 1", top = "0 0 -1")
Pos: designates a 32x32x32 cube inside the voxel at the given
coordinates (range 0 ~ 3)
These two properties can be combined to designate a 32x32 square
on one side of a voxel. (See the pedestal button for an example.)
I have no idea how this is different from just addressing the
sub-cubes directly, without the normal.
EmbeddedVoxels: Defines the space taken up behind the surface the
item is mounted on. When exporting to vmf, the editor will
build a hollow shell around the indicated area, consisting
of 128x128x4 trapezoid shapes. These serve as chamber
walls, floors or ceilings for any areas that border on open
parts of the map, instead of the regular solid blocks
generated elsewhere. Any surfaces that border on voxels
designated as occupied by the item, will be left open.
(But see "EmbedFace" below.)
sub-items:
Voxel: coordinates of an occupied voxel, like for "OccupiedVoxels",
except that "0 0 0" is the voxel behind the item's anchor
location, inside the wall.
Volume: designates the entire block between Pos1 and Pos2 as occupied.
(See entrance and exit doors, for example.)
EmbedFace: Used to close any openings left because the instance is smaller
than 128x128. (Example: lasers.)
sub-items: one or more "Solid" entries, each of which creates one
rectengular tile around the base of the instance.
Attributes:
Center: location of the center relative to the bottom-left corner
of the face, in map units.
TODO: meaning of Z coordinate?
Dimensions: width and length of the solid; Z seems to be ignored
and is always 4.
Grid: which tile texture to use on the chamber-facing side;
options are 2x2 and 4x4. (The colour will match the portal /
nonportal setting of the surface.)
ConnectionPoints: defines locations where the antlines attach to the item.
sub-items: one or more Point entries, with these attributes:
Dir: incoming line direction: left to right is "1 0 0", top to bottom
is "0 -1 0" etc.
Pos: point on an 8x8 grid inside the voxel, where the line terminates.
(Z coordinate is always 0.) (Each grid cell is 16x16 map units.)
"0 0 0" is the lower-left corner. Coordinates outside the voxel
continue on whatever surface makes sense in that direction.
SignageOffset: a second point in the same grid. This point, together
with "Pos", must mark a 2x2 block (32x32 map units) area
where a checkmark or timer display will be placed.
Priority: connections with priority 0 are used first, then 1, etc.
GroupID: unknown at this time.
