Func monitor: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Technical limitations)
(cleanup and such)
Line 1: Line 1:
{{wrongtitle|title=func_monitor}}
{{wrongtitle|title=func_monitor}}


== Entity Desciption==
==Entity Desciption==


A monitor that renders the view from a given [[point_camera]] entity.  
A monitor that renders the view from a given [[point_camera]] entity.  
When a func_monitor is created, the surface in which the view from the [[point_camera]] will be displayed from must be assigned to a material that uses the special value "_rt_Camera" in its "$basetexture" property (such as the dev/dev_combinemonitor* and dev/dev_tvmonitor* textures). It is also a good idea to Justify to Fit in the Face Edit Sheet texture dialog for the combinemonitor surface so the camera view isn't cut off.
When a func_monitor is created, the surface in which the view from the [[point_camera]] will be displayed from must be assigned to a material that uses the special value "_rt_Camera" in its "$basetexture" property (such as the dev/dev_combinemonitor* and dev/dev_tvmonitor* textures). It is also a good idea to Justify to Fit in the Face Edit Sheet texture dialog for the combinemonitor surface so the camera view isn't cut off.


== Keys ==
==Keys==




'''Name targetname'''
*{{kv targetname}}
''<target_source>'' The name that other entities refer to this entity by.


'''Parent parentname'''
*{{kv parentname}}
''<target_destination>'' The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
*{{kv enabledisable}}


'''Origin (X Y Z)'''  
*'''Origin (X Y Z)'''  
''origin <origin>'' The position of this entity's center in the world. Rotating entities typically rotate around their origin.
:<origin> The position of this entity's center in the world. Rotating entities typically rotate around their origin.


'''Render FX'''
*{{KV RenderFields}}
''renderfx <choices>''


'''Render Mode'''  
*'''Disable Receiving Shadows (disablereceiveshadows)'''
''rendermode <choices>'' Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.
:<choices>  


'''FX Amount (0 - 255)'''
*'''Disable shadows (disableshadows)'''
'' renderamt <integer>'' The FX amount is used by the selected Render Mode.
:<choices>


'''FX Color (R G B)'''
*'''Global Entity Name (globalname)'''
'' rendercolor <color255>'' The FX color is used by the selected Render Mode.
:<string> Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.


'''Disable Receiving Shadows'''
*'''Input Filter (InputFilter)'''
'' disablereceiveshadows <choices>''
:<choices> Used to specify which inputs this entity will accept.


'''Global Entity Name'''
*'''Minimum Light Level (_minlight)'''
''globalname <string>'' Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
:<string> The minimum level of ambient light that hits this brush.


'''Input Filter'''
*'''Solidity (Solidity)'''
''InputFilter <choices>'' Used to specify which inputs this entity will accept.
:<choices> Used to control the solidity/collision of these brushes.


'''Start Disabled'''
*'''NPC class excluded from collisions (excludednpc)'''
''StartDisabled <choices>''
:<string> If an NPC classname (i.e. [[npc_zombie]]) is specified here, NPCs of that type won't collide with these brushes.


'''Disable shadows'''
*'''Solid BSP (solidbsp)'''
''disableshadows <choices>''
:<choices> Set this if this brush is in heirarchy with a moving object of some kind, and the player can stand on this brush.


'''spawnflags'''  
*'''Camera name (target)'''  
''spawnflags <flags>''
:<target_destination> The '''Name''' of the [[point_camera]] in which the viewpoint is rendered from.
'''
Minimum Light Level'''
''_minlight <string>'' The minimum level of ambient light that hits this brush.


'''Solidity Solidity'''
''<choices>'' Used to control the solidity/collision of these brushes.


'''NPC class excluded from collisions'''
''excludednpc <string>'' If an NPC classname (i.e. npc_zombie) is specified here, NPCs of that type won't collide with these brushes.


'''Solid BSP'''
==Inputs==
''solidbsp <choices>'' Set this if this brush is in heirarchy with a moving object of some kind, and the player can stand on this brush.


'''Camera name'''
* {{i targetname}}
''target <target_destination>'' The '''Name''' of the [[point_camera]] in which the viewpoint is rendered from.


* {{i parentname}}


* {{i enabledisable}}


== Inputs ==
*'''DisableShadow'''
:Turn shadow off.


'''Kill''' Removes this entity from the world.
*'''EnableShadow'''
:Turn shadow on.


'''KillHierarchy''' Removes this entity and all its children from the world.
*'''Toggle Toggle'''
:If on, turn off, if off, turn on.


'''AddOutput <string>''' Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
*'''SetCamera <string>'''  
:Sets the camera to use for this monitor. Takes the name of a [[point_camera]] entity in the map.


'''FireUser1''' Causes this entity's OnUser1 output to be fired.
==Outputs==


'''FireUser2''' Causes this entity's OnUser2 output to be fired.
* {{o targetname}}
 
'''FireUser3''' Causes this entity's OnUser3 output to be fired.
 
'''FireUser4''' Causes this entity's OnUser4 output to be fired.
 
'''SetParent <string>''' Changes the entity's parent in the movement hierarchy.
 
'''SetParentAttachment <string>''' Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
 
'''ClearParent''' Removes this entity from the the movement hierarchy, leaving it free to move independently.
 
'''Enable''' Enable this entity.
 
'''Disable''' Disable this entity.
 
'''DisableShadow''' Turn shadow off.
 
'''EnableShadow''' Turn shadow on.
 
'''Toggle Toggle''' - If on, turn off, if off, turn on.
 
'''Enable''' Enable.
 
'''Disable''' Disable.
 
'''SetCamera <string>''' Sets the camera to use for this monitor. Takes the name of a point_camera entity in the map.
 
 
 
== Outputs ==
 
 
'''OnUser1''' Fired in response to FireUser1 input.
 
'''OnUser2''' Fired in response to FireUser2 input.
 
'''OnUser3''' Fired in response to FireUser3 input.
 
'''OnUser4''' Fired in response to FireUser4 input.


----
----
Line 120: Line 76:


* [[info_camera_link]]
* [[info_camera_link]]
* [[List of entities]]
* [[point_camera]]
 
[[Category:Entities]]

Revision as of 19:34, 10 July 2005

Template:Wrongtitle

Entity Desciption

A monitor that renders the view from a given point_camera entity. When a func_monitor is created, the surface in which the view from the point_camera will be displayed from must be assigned to a material that uses the special value "_rt_Camera" in its "$basetexture" property (such as the dev/dev_combinemonitor* and dev/dev_tvmonitor* textures). It is also a good idea to Justify to Fit in the Face Edit Sheet texture dialog for the combinemonitor surface so the camera view isn't cut off.

Keys

  • Origin (X Y Z)
<origin> The position of this entity's center in the world. Rotating entities typically rotate around their origin.
  • RenderFields:


Render Mode (rendermode) <byte choices>
Set a non-standard rendering mode on this entity.
Render Modes
  • 0: Normal
  • 1: Color
  • 2: Texture
  • 3: Glow
  • 4: Solid/Alphatest Obsolete
  • 5: Additive
  • 6: Removed, does nothing Obsolete
  • 7: Additive Fractional Frame
  • 8: Alpha Add
  • 9: World Space Glow
  • 10: Don't Render
Render FX (renderfx) <byte choices>
Various somewhat legacy alpha effects. See render effects.
Render Amount / Transparency (renderamt) <byte>
Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
Render Color (R G B) (rendercolor) <color255>
Color tint.
  • Disable Receiving Shadows (disablereceiveshadows)
<choices>
  • Disable shadows (disableshadows)
<choices>
  • Global Entity Name (globalname)
<string> Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
  • Input Filter (InputFilter)
<choices> Used to specify which inputs this entity will accept.
  • Minimum Light Level (_minlight)
<string> The minimum level of ambient light that hits this brush.
  • Solidity (Solidity)
<choices> Used to control the solidity/collision of these brushes.
  • NPC class excluded from collisions (excludednpc)
<string> If an NPC classname (i.e. npc_zombie) is specified here, NPCs of that type won't collide with these brushes.
  • Solid BSP (solidbsp)
<choices> Set this if this brush is in heirarchy with a moving object of some kind, and the player can stand on this brush.
  • Camera name (target)
<target_destination> The Name of the point_camera in which the viewpoint is rendered from.


Inputs

  • DisableShadow
Turn shadow off.
  • EnableShadow
Turn shadow on.
  • Toggle Toggle
If on, turn off, if off, turn on.
  • SetCamera <string>
Sets the camera to use for this monitor. Takes the name of a point_camera entity in the map.

Outputs

See Also

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