Newxog volume: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
Line 259: Line 259:
{{O BaseTrigger}}
{{O BaseTrigger}}
{{O BaseEntity}}
{{O BaseEntity}}
==Issues==
====Xog incorrect work with [[$translucent]]====
Xog all time fully rendering through objects with [[material]] [[shader]] parameter [[$translucent]]. This happen because of game can't tell the depth of scene because of the transparency.
<br>
<gallery mode=packed heights=410px>
File:XBugHah.jpg| frame | No [[$translucent]]. Behind the wall placed xog volume and some models with small room.
File:XBugDamn.jpg| frame | With [[$translucent]]. Now player see everything, but only what in xog.
</gallery>
<br>
This problem also applies to brushes which not have [[$translucent]], but which parented to brushes that have this parameter. Similar will happen if brush with [[$translucent]] is part of your brush entity. Same will happen if you use [[overlays]]/[[decals]] on brushes with [[$translucent]].
<br>
<gallery mode=packed heights=410px>
File:XMS1.jpg| frame | Metal speaker is overlay that use [[$alphatest]], but xog fully visible anyway, because overlay pasted on the transparency window.
</gallery>
This issues doesn't happen if replace [[LightmappedGeneric]] to [[ShatteredGlass]] shader. [[ShatteredGlass]] give similar to [[LightmappedGeneric]] results, so, you can use it for glass or transparency surfaces when it's needed.
<br>
<gallery mode=packed heights=410px>
File:XHahF1.jpg| frame | [[LightmappedGeneric]].
File:XHahF2.jpg| frame | [[ShatteredGlass]].
</gallery>

Revision as of 08:10, 31 January 2024

English (en)Translate (Translate)

Keyvalues

Enabled (Enabled) <choices>
Enable/Disable this Entity.

Determines is this entity enabled or disabled on spawn.

  • 0: Enabled
  • 1: Disabled
Shape Type (xogtype) <choices>
Determines shape type that use xog volume, BBOX or Ellipsoid.
  • 0:0: LocalVolume BBOX
  • 1:1: LocalVolume Ellipsoid
Examples


  • BBOX
    BBOX
  • Ellipsoid
    Ellipsoid
colorMode (colormode) <choices>
Determines color mode.
  • 0:0:StaticColor
  • 1:1:1DGradTexture
  • 2:2: CubeGradTexture
Texture name Grad Texture (texname) <string>
Xog gradient texture name. The default is xen/effects/xen_sky_6_blurred_32.
colorTop (colortop) <color255>
Xog top color. This is the main color of xog that uses if Enable Height Blend KV is disabled.
Examples


  • colorTop - 255 0 0. colorBottom - 0 255 0.
    colorTop - 255 0 0. colorBottom - 0 255 0.
  • colorTop - 0 0 255. colorBottom - 0 255 0.
    colorTop - 0 0 255. colorBottom - 0 255 0.
  • colorTop - 255 0 255. colorBottom - 0 255 0.
    colorTop - 255 0 255. colorBottom - 0 255 0.
Note.pngNote:Top and bottom colors blending in xog center, for example with red and green colors the center of xog will be yellow.
colorBottom (colorbottom) <color255>
Xog bottom color. Requires enabled Enable Height Blend to be working.
Examples


  • colorTop - 255 0 0. colorBottom - 0 255 0.
    colorTop - 255 0 0. colorBottom - 0 255 0.
  • colorTop - 255 0 0. colorBottom - 255 255 255.
    colorTop - 255 0 0. colorBottom - 255 255 255.
  • colorTop - 255 0 0. colorBottom - 0 255 255.
    colorTop - 255 0 0. colorBottom - 0 255 255.
distStart (diststart) <float>
distStart

Xog start draw distance.

Examples


  • distStart - 10. distEnd - 100.
    distStart - 10. distEnd - 100.
  • distStart - 70. distEnd - 100.
    distStart - 70. distEnd - 100.
  • distStart - 200. distEnd - 100.
    distStart - 200. distEnd - 100.
Icon-Bug.pngBug:Numbers lower than 1 cause xog graphics issues.
Bug examples


  • Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
    Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
  • Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
    Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
  [todo tested in ?]
distEnd (distend) <float>
distEnd

Xog end draw distance.

Examples


  • distStart - 10. distEnd - 100.
    distStart - 10. distEnd - 100.
  • distStart - 10. distEnd - 700.
    distStart - 10. distEnd - 700.
  • distStart - 10. distEnd - 2000.
    distStart - 10. distEnd - 2000.
Icon-Bug.pngBug:Numbers lower than 1 cause xog graphics issues.
Bug examples


  • Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
    Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
  • Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
    Black Mesa - bm_c1a2c. As you can see, the fog is drawn through the geometry and models (with exception of viewmodel).
  [todo tested in ?]
Note.pngNote:The difference in values of distStart and distEnd should be not too big, otherwise the fog will be unsmooth.
distDensity (distdensity) <float>
distDensity

Density of xog entity, only values from 0 to 1 works.

Examples


  • 0
    0
  • 1
    1
opacityOffsetTop (opacityoffsettop) <float>
opacityOffsetTop

Offsets top color of xog.

Examples


  • opacityOffsetTop - 0.0.
    opacityOffsetTop - 0.0.
  • opacityOffsetTop - 0.5.
    opacityOffsetTop - 0.5.
  • opacityOffsetTop - 2.0.
    opacityOffsetTop - 2.0.
opacityOffsetBottom (opacityoffsetbottom) <float>
opacityOffsetBottom

Offsets bottom color of xog.

Examples


  • opacityOffsetBottom - 0.0.
    opacityOffsetBottom - 0.0.
  • opacityOffsetBottom - 0.2.
    opacityOffsetBottom - 0.2.
  • opacityOffsetBottom - 1.0.
    opacityOffsetBottom - 1.0.
htZStart (htzstart) <float>
htZStart

Height that xog starts rendering at.

Examples


  • htZStart - 80. htZEnd - 0.
    htZStart - 80. htZEnd - 0.
  • htZStart - 90. htZEnd - 0.
    htZStart - 90. htZEnd - 0.
  • htZStart - 90. htZEnd - 10.
    htZStart - 90. htZEnd - 10.
htZEnd (htzend) <float>
htZEnd

Height that xog stops rendering at.

Examples


  • htZStart - 0. htZEnd - 80.
    htZStart - 0. htZEnd - 80.
  • htZStart - 0. htZEnd - 120.
    htZStart - 0. htZEnd - 120.
  • htZStart - 0. htZEnd - 400.
    htZStart - 0. htZEnd - 400.
htZColStart (htzcolstart) <float>
htZColStart

Height that xog color starts rendering at. Results depend on htZColEnd value.

Examples


  • htZColStart - 0.
    htZColStart - 0.
  • htZColStart - 50.
    htZColStart - 50.
  • htZColStart - 150.
    htZColStart - 150.
htZColEnd (htzcolend) <float>
htZColEnd

Height that xog color stops rendering at. Results depend on htZColStart value.

Examples


  • htZColEnd - 400.
    htZColEnd - 400.
  • htZColEnd - 100.
    htZColEnd - 100.
  • htZColEnd - 190.
    htZColEnd - 190.
noise1ScrollSpeed (noise1scrollspeed) <vector>
Layer one, speed at which noise moves trough xog volume (X Y Z).
Examples


  • noise1ScrollSpeed - 1 0 0.
    noise1ScrollSpeed - 1 0 0.
  • noise1ScrollSpeed - 0 1 0.
    noise1ScrollSpeed - 0 1 0.
  • noise1ScrollSpeed - 0 0 1.
    noise1ScrollSpeed - 0 0 1.
noise1Tiling (noise1tiling) <vector>
Layer one, tiling speed at which noise moves trough xog volume (X Y Z).
Examples


  • noise1Tiling - 10 1 1.
    noise1Tiling - 10 1 1.
  • noise1Tiling - 1 10 1.
    noise1Tiling - 1 10 1.
  • noise1Tiling - 1 1 10.
    noise1Tiling - 1 1 10.
noise2ScrollSpeed (noise2scrollspeed) <vector>
Layer two, speed at which noise moves trough xog volume (X Y Z).
Examples


  • noise2ScrollSpeed - 1 0 0.
    noise2ScrollSpeed - 1 0 0.
  • noise2ScrollSpeed - 0 1 0.
    noise2ScrollSpeed - 0 1 0.
  • noise2ScrollSpeed - 0 0 1.
    noise2ScrollSpeed - 0 0 1.
noise2Tiling (noise2tiling) <vector>
Layer two, tiling speed at which noise moves trough xog volume (X Y Z).
Examples


  • noise2Tiling - 10 1 1.
    noise2Tiling - 10 1 1.
  • noise2Tiling - 1 10 1.
    noise2Tiling - 1 10 1.
  • noise2Tiling - 1 1 10.
    noise2Tiling - 1 1 10.
noiseContrast (noisecontrast) <float>
Contrast of xog.
Examples


  • 0.1
    0.1
  • 1.0
    1.0
  • 3.0
    3.0
noiseMultiplier (noisemultiplier) <float>
Multiplier of xog.
Examples


  • 0.1
    0.1
  • 1
    1
  • 10
    10
Enable Height Blend (enablevol_height) <choices>
Enable/Disable this heightbased xog.

Determines top color and blending is disabled or enabled.

  • 0: Disabled
  • 1: Enabled
Examples


  • Enable Height Blend - No. colorTop - 255 0 0 255, colorBottom - 0 255 0 255.
    Enable Height Blend - No. colorTop - 255 0 0 255, colorBottom - 0 255 0 255.
  • Enable Height Blend - Yes. colorTop - 255 0 0 255, colorBottom - 0 255 0 255.
    Enable Height Blend - Yes. colorTop - 255 0 0 255, colorBottom - 0 255 0 255.


Flags

BaseTrigger
Everything (not including physics debris) : [64]
Clients (Survivors, Special Infected, Tanks Left 4 Dead seriesLeft 4 Dead series) : [1]
Only clients in vehicles : [32]
Only clients *not* in vehicles : [512]
Disallow Bots (removed since Left 4 Dead) : [4096]
NPCs (Common Infected, Witches Left 4 Dead seriesLeft 4 Dead series) : [2]
Only player ally NPCs : [16]
Only NPCs in vehicles (respects player ally flag) : [2048]
Physics Objects (not including physics debris) : [8]
Physics debris (include also physics debris) : [1024]
Pushables (Passes entities with classname func_pushable) : [4] Obsolete
Deprecated.
Equivalent to using Everything + filter_activator_class that filters func_pushable.

Inputs

TurnOn <void>
Turn xog on.
TurnOff <void>
Turn xog off.
BaseTrigger
Toggle
Toggles this trigger between enabled and disabled states.
Enable
Enable trigger
Disable
Disable trigger
TouchTest  (in all games since Source 2007)
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
Icon-Bug.pngBug:Sleeping prop_physics will never fire "OnTouching". Also applies to entities using prop_physics as base.  (tested in: Half-Life 2)
StartTouch  (in all games since Source 2007) !FGD
Behave as if the !caller entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch  (in all games since Source 2007) !FGD
Behave as if !caller had just exited the trigger volume.
DisableAndEndTouch  (only in Source 2013 MultiplayerTeam Fortress 2 branch)
Disables this trigger and calls EndTouch on all currently-touching entities.


Outputs

BaseTrigger
OnStartTouch
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger.
OnStartTouchAll
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger, and no other entities are touching it. If there are any other entities touching the trigger when a new one begins to touch, only OnStartTouch will fire.
OnEndTouch
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity stops touching this trigger.
Note.pngNote:Will also fire for entities touching it when trigger is disabled via Disable input
Warning.pngWarning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.
Warning.pngWarning:OnEndTouch can fire before OnStartTouch under certain circumstances[How?] where both are fired on the same tick and each have the same delay.
Note.pngFix:Add a slight delay to OnEndTouch.
OnEndTouchAll
!activator = entity that caused this output
!caller = this entity
Fired when all valid entities stop touching this trigger.
OnTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if something is currently touching this trigger when TouchTest is fired.
OnNotTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if nothing is currently touching this trigger when TouchTest is fired.


Issues

Xog incorrect work with $translucent

Xog all time fully rendering through objects with material shader parameter $translucent. This happen because of game can't tell the depth of scene because of the transparency.

  • No $translucent. Behind the wall placed xog volume and some models with small room.
    No $translucent. Behind the wall placed xog volume and some models with small room.
  • With $translucent. Now player see everything, but only what in xog.
    With $translucent. Now player see everything, but only what in xog.


This problem also applies to brushes which not have $translucent, but which parented to brushes that have this parameter. Similar will happen if brush with $translucent is part of your brush entity. Same will happen if you use overlays/decals on brushes with $translucent.

  • Metal speaker is overlay that use $alphatest, but xog fully visible anyway, because overlay pasted on the transparency window.
    Metal speaker is overlay that use $alphatest, but xog fully visible anyway, because overlay pasted on the transparency window.

This issues doesn't happen if replace LightmappedGeneric to ShatteredGlass shader. ShatteredGlass give similar to LightmappedGeneric results, so, you can use it for glass or transparency surfaces when it's needed.

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Newxog_volume&oldid=383514"