User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
matsys:cmat_manual:keywordreference [2006-11-28 21:59]
Carsten Added the new section "Other keywords", with "clip" and "surfaceType"
matsys:cmat_manual:keywordreference [2007-05-28 12:59]
Carsten Minor revision of the punktuation
Line 108: Line 108:
 There are also keywords that define other aspects of the material that are not directly related to their rendering. There are also keywords that define other aspects of the material that are not directly related to their rendering.
  
-  * **''​clip $c1, $c2, ...''​** Defines for whom or for which purposes the material is considered solid in clipping (collision detection) computations. This is mostly interesting in game related settings (e.g. with player or monster clip brushes), but also programs like CaLight ​and others ​perform ray trace tests that in turn are affected by this keyword. \\ ''​$c1,​ $c2, ...''​ must be a comma-separated list of at least one of these flags: ''​nothing'',​ ''​players'',​ ''​monsters'',​ ''​moveables'',​ ''​ik'',​ ''​radiance'',​ ''​sight'',​ or ''​all''​. The default ​value (i.e. if you do not use this keyword at all), is ''​clip all''​. When you use it, the value is first cleared and then additively rebuilt from the parameter list. \\ :!: Note that each Ca3DE map file must entirely be sealed by materials with the ''​clip all''​ property, or else the map has a leak. \\ Here is an explanation of the individual flags: ​ ( FIXME Several of them not yet implemented...)+  * **''​clip $c1, $c2, ...''​** Defines for whom or for which purposes the material is considered solid in clipping (collision detection) computations. This is mostly interesting in game related settings (e.g. with player or monster clip brushes), but also programs like CaBSP and CaLight ​perform ​clip and ray trace tests that in turn are affected by this keyword. \\ ''​$c1,​ $c2, ...''​ must be a comma-separated list of at least one of these flags: ''​nothing'',​ ''​players'',​ ''​monsters'',​ ''​moveables'',​ ''​ik'',​ ''​projectiles'',​ ''​sight'',​ ''​bspPortals'',​ ''​radiance'',​ or ''​all''​. The default ​setting ​(i.e. if you do not use the ''​clip'' ​keyword at all), is ''​clip all''​. When you use ''​clip''​, the value is first cleared ​(reset to ''​nothing''​) ​and then additively rebuilt from the parameter list. \\ Here is an explanation of the individual flags:
     * ''​nothing''​ means that a surface with this material clips against nothing, it is non-solid.     * ''​nothing''​ means that a surface with this material clips against nothing, it is non-solid.
-    * ''​players''​ means that the surface is solid to players, +    * ''​players''​ means that the surface is solid to players. 
-    * ''​monsters''​ means that the surface is solid to monsters (AI entities), +    * ''​monsters''​ means that the surface is solid to monsters (AI entities). 
-    * ''​moveables''​ means that the surface is solid to moveable entities, +    * ''​moveables''​ means that the surface is solid to moveable entities. 
-    * ''​ik''​ means that the surface is solid to IK, +    * ''​ik''​ means that the surface is solid to IK. 
-    * ''​radiance''​ means that the surface ​blocks ​the transfer of light energy in the Radiosity computations ​of CaLight ​(most walls do, but for example glass and decals usually don't), +    * ''​projectiles''​ means that the surface ​is solid to the projectiles ​of weapons ​(e.g. water surfaces, but not sky). 
-    * ''​sight''​ means that the surface blocks line-of-sight tests (used e.g. for AI),+    * ''​sight''​ means that the surface blocks line-of-sight tests (used e.g. for AI)
 +    * ''​bspPortals''​ means that the surface clips portalsthat is, it is solid to the flood-fill operation of CaBSP. \\ :!: Note that each Ca3DE map must //entirely be sealed// by materials with the ''​bspPortals''​ property, or else CaBSP will not be able to flood-fill it properly and report that the map has a leak. \\ Developers, note that this means that maps can be made where objects can fall out of the map (e.g. through the floor). Considering the clip-world only, this can be desirable e.g. for rockets that are fired into the sky, even though Ca3DE has to treat them specially for drawing (render objects in non-PVS "​outer"​ leaves). CaBSP issues a warning if it ever finds a material that has ''​bspPortals'',​ but not both ''​players''​ and ''​monsters''​ set, in order to make you aware that in such places, players or monsters could fall out of the map. 
 +    * ''​radiance''​ means that the surface blocks the transfer of light energy in the Radiosity computations of CaLight (most walls do, but for example glass and decals usually don'​t).
     * ''​all''​ means that the surface is solid to all of the above.     * ''​all''​ means that the surface is solid to all of the above.
  
matsys/cmat_manual/keywordreference.txt · Last modified: 2013-01-07 12:07 (external edit)