INTRODUCTION:

This archive contains SiN entity definition files for SinEd. They are simply
configuration files used by the editor to build its entity selection menu and
the entity dialog that enables you to set the relevant keys and spawnflags
for those entities. I revised from its original for 3 main reasons:

1. The information they contained was innacurate and incomplete.

2. The comments format was inconsistent and poorly organised.

3. Some entity definitions were missing while others were obsolete.

In order to bring the community better tools and information for editing
Sin maps, I felt this was direly needed. But to make sure the information
was accurate, I had to test ALL the entities thoroughly so I can assure you
that the information contained here is the result of experimentation and
not idle guessing.

I also updated a lot of .def files from the original versions. The .def files
mainly contain information about SiN models but most of them also contain
/*SINED .../* declarations which have the same function as the ones in the
.cpp file. Which is for the editor to build its entity menu with. While
most of them are used for entities which only support a minimum amount of
keys and spawnflags, a few of those entities have a larger amount of
settable keys which require more in-depth explanation. Others needed
essential corrections to their spawnflags list or bounding box sizes or model
name reference, etc.

I hope these files help you figure how to set up the entities in your maps.
I'm open to suggestions and please, please, if you find errors, by all means,
don't hesitate to email me and let me know.

Eutectic (eutectic@ritualistic.com)


INSTALLATION:

1. Extract the file named sinedf14.cpp from this archive to your
   \tools\sin\base\code\game folder.

2. Extract all the .def files to your \tools\sin\base\models folder and
   overwrite the older versions.

3. Edit your SinEd project file sample.sed in your \tools\sin\base\scripts
   folder and edit the "entitypath" statement so it points to the new file:

"entitypath"            "..\base\code\game\sinedf14.cpp"

4. Restart SinEd.


ADDITIONAL INFO:

I could have updated all the relevant .def files to add key information
but it didn't make much sense since there's over 400 of them. Instead, I
will update the info for those directly in the Node entity docs.


CHANGE HISTORY

---- V1.0 ----
Many corrections and additions from the original SINED declarations comments
enbedded in Ritual's gameX86.dll V1.03 source code. The following versions
will be corrections to this present version and won't use these comments as
reference since those won't be updated by Ritual.

Major overhaul to the entity descriptions, missing keys, keys that didn't work
which were taken out, incomplete and/or innacurate key descriptions, same thing
for the spawnflags and their descriptions. A few broken entities were removed
or commented out (info_navbeacon, func_electrocute, func_shield). The missing
'skeetlauncher' entity was added.

Plus way too many other changes to list here. Everything that was changed was
thoroughly tested so just trust me, ok? :)

The format and layout of the comments were also modified to make them more
readable in SinEd's entity dialog window.

---- V1.1 ----

- "angles" key and description added to func_camera.
- "angle" key and description removed from func_securitycamera.

---- V1.2 ----

- info_player_hardcorps and info_player_sintek for CTF added.

---- V1.3 ----

- "angle" key added to func_scriptobject.
- updated spline.def : definition of "loop" key for info_splinepath corrected.
- updated rockturtop.def : typo correction in Notes plus additional info.
- updated camgun2.def : typo correction in Notes.
- definition of "height" key for func_camera and func_securitycamera corrected.
- default value of "radius" key for lensflare corrected. Notes added.
- definition of the "lightstyle" key for lensflare corrected.
- "target" key and Notes added to waypoint.
- func_beam beamstyles updated.
- fixed problem with rockturtop.def displaying wrong model for trap_rocketturret.
- added "sighttarget" and "sightthread" keys to trap_rocketturret (rockturtop.def).
- added "sighttarget", "sightthread", "patience" and "lagtime" keys to
  trap_securityturret (turtop.def).
- added "noise" key for all trigger entities which also support message key.
- improved definition of "message" key for triggers to be relevant to "noise" key.

---- V1.4 ----

- added "noise" key to func_door, func_exploder, func_explodingwall,
  func_multi_exploder, func_rotatingdoor, func_scriptdoor, inventory_genericpulsepart
  and misc_oxygen since those also support the "message" key.
- added a corrected version of batlow.def to the entity definition set: the entity is
  already NOT_SOLID and NOT_DAMAGEABLE by default. The spawnflags were removed since
  the default makes them useless.
- added "scale" key and removed NOT_SOLID and NOT_DAMAGEABLE spawnflags (which make no
  sense for pickup-able items) from inventory_genericpulsepart.
- added corrected versions of all 25 inventory_* .def files in which all the relevant
  keys were added and the NOT_SOLID and NOT_DAMAGEABLE spawnflags (which make no sense
  for pickup-able items) were removed.
- added corrected version of u4.def (Powerup_U4) with an accurate description (only a
  static object) and the inclusion of the NOT_SOLID and NOT_DAMAGEABLE spawnflags & the
  "targetname" key
- added corrected versions of sledgeham.def (weapon_sledgehammer), stun.def (weapon_stun)
  and wrench.def (weapon_wrench) with accurate descriptions (only static objects) and
  the inclusion of the NOT_SOLID and NOT_DAMAGEABLE spawnflags for each & the "targetname"
  key.
- added corrected versions of cpu_keyboard_use.def (deskitems_cpu_keyboarduseable) and
  cpu_monitor_use.def (deskitems_cpu_monitoruseable). Since these entities are already
  not destructible by default, the NOT_DAMAGEABLE spawnflag was removed.
- added corrected versions of sink.def (world_sink), toilet.def (world_toilet) and
  urinal.def (world_urinal). Since these entities are sentients and not objects, the
  NOT_SOLID and NOT_DAMAGEABLE spawnflags don't apply and were removed.
- added corrected versions of all 17 gib_* .def files in which all the relevant keys
  were added as well as the NOT_SOLID and NOT_DAMAGEABLE spawnflags.
- added corrected versions of all 10 Projectile_* .def files in which all the relevant 
  keys were added as well as the NOT_SOLID and NOT_DAMAGEABLE spawnflags.
- added corrected versions of all 11 trap_* .def files in which many relevant keys
  were added and incorrect ones were removed. The NOT_SOLID and NOT_DAMAGEABLE spawnflags
  were added to claymore.def (trap_claymore), dynamite.def (trap_dynamite),
  launcher_base.def (trap_missilelauncher_base), launcher.def (trap_oldlauncher),
  rockturbase.def (trap_rocketturret_base) and turbase.def (trap_securityturret_base).
- added corrected versions of all 19 vehicles_* .def files in which many relevant keys
  were added and incorrect ones were removed. The NOT_SOLID and NOT_DAMAGEABLE spawnflags
  were removed from atvtire_back.def (vehicles_atv_backtire), atvtire_front.def
  (vehicles_atv_fronttire), humv_back_tire.def (vehicles_humv_backtire) and
  humv_front_tire.def (vehicles_humv_fronttire). The NOT_DAMAGEABLE spawnflag was removed
  from atv.def (vehicles_atv), bulldozer.def (vehicles_bulldozer), forklift.def
  (vehicles_forklift), hcboat.def (vehicles_HCBoat), lamprey.def (vehicles_lamprey) and
  lamprey_sintek.def (vehicles_lamprey_sintek).
- added "surfacefile" key to worldspawn entity.
- added corrected versions of all 16 fx_* .def files in which many relevant keys
  were added and incorrect ones were removed. The NOT_SOLID and NOT_DAMAGEABLE spawnflags
  were added to laser.def (fx_laser). The NOT_SOLID spawnflag was added to all the model
  based fx_* entities : sphere.def, sphere2.def, sphere3.def (fx_explosion),
  muzflash1.def (fx_muzzleflash), muzflash2.def (fx_muzzleflash2), beam.def
  (fx_pulsebeam), beam2.def (fx_pulsebeam2), ln.def (fx_pulseline) and psphere.def
  (fx_pulsesphere).
- added "scale" and "targetname" keys to fx_fire.
- removed "color" key and added "angle", "model" and "targetname" keys to fx_sprite
  (fxsprite.def).
- the START_OPEN spawnflag was removed from func_door, func_rotatingdoor and
  func_scriptdoor since it doesn't work. The OPEN_DIRECTION spawnflag was removed from
  func_rotatingdoor since it doesn't work.
- the HURT_SHATTER spawnflag was removed from func_glass and func_shatter since it
  doesn't work.
- added the NOT_SOLID and NOT_DAMAGEABLE spawnflags to func_throwobject.
- the NOT_PLAYERS spawnflag was removed from trigger_camerause since it doesn't work.
