Func nobuild: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Fix typo "Teleportres")
m (added the new "destroy buildings" keyvalue.)
Line 1: Line 1:
{{lang|Func nobuild}}
{{tf2 brush|func_nobuild}}
{{tf2 brush|func_nobuild}}


==Entity description==
==Entity Description==
A func_nobuild entity will restrict an engineer from building in the specific area it contains.
A <code>func_nobuild</code> entity will restrict an Engineer from building in the specific area it contains.


'''Normal Use'''
===Normal Use===
 
A <code>func_nobuild</code> area should come in contact with the top side of the brush you don't want the engineer to build upon. The <code>func_nobuild</code> should also be at least 96 units high to keep an Engineer from bypassing it by jumping above it. Keep in mind that a {{Ent|func_respawnroom}} entity also blocks an Engineer's ability to build, and thus a <code>func_nobuild</code> does not have to be placed in the same location as a <tt>func_respawnroom</tt>.{{Note|Keep in mind that a <code>func_nobuild</code> only prevents the center of the Engineer's buildings from being placed on top of a surface, not the whole structure; parts of the building can actually overlap the <code>func_nobuild</code> area.{{todo|add picture example here}}}}
A func_nobuild area should come in contact with the top side of the brush you don't want the engineer to build upon. The func_nobuild should also be at least 96 units high to keep an engineer from bypassing it by jumping above it. Keep in mind that a [[func_respawnroom]] entity also blocks an engineer's ability to build and thus a func_nobuild does not have to be placed in the same location as a func_respawnroom.
{{Note|Keep in mind that a func_nobuild only prevents the center of engineer's buildable structures from being placed on top of a surface, not the whole structure; parts of the buildable can actually overlap the func_nobuild area.}} <!-- todo: add picture example here... -->


[[Image:Nobuild_ledge.gif|thumb|300px|right|The required 96 units for each accessible side.]]
[[Image:Nobuild_ledge.gif|thumb|300px|right|The required 96 units for each accessible side.]]
'''Ledges'''
===Ledges===
 
High ledges present an element a bit different from a standard floor surface. If there is a ledge you do not want an engineer to build upon, the <code>func_nobuild</code> brush should not only be 96 units above the surface, but 96 units below the surface as well, with the <code>func_nobuild</code> brush overlapping the ledge. It should also stick out 96 units from all accessible sides of the ledge. If the ledge is less then 96 units above a larger flat surface, the <code>func_nobuild</code> only needs to touch the top of the surface the ledge is above.{{clr}}
High ledges present an element a bit different from a standard floor surface. If there is a ledge you do not want an engineer to build upon, the func_nobuild brush should not only be 96 units above the surface, but 96 units below the surface as well, with the func_nobuild brush overlapping the ledge. It should also stick out 96 units from all accessible sides of the ledge. If the ledge is less then 96 units above a larger flat surface, the func_nobuild only needs to touch the top of the surface the ledge is above.{{clr}}


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
{{KV BaseEntity|base=1|brush=1}}
{{KV Parentname}}
{{KV TeamNum|tf2=1}}
{{KV TFTeam}}
{{KV|Allow Sentries|bool| Allow or Disallow building sentries.}}
{{KV|Allow Dispensers|bool| Allow or Disallow building dispensers.}}
{{KV|Allow Teleporters|bool| Allow or Disallow building teleporters.}}
{{KV EnableDisable}}
{{KV EnableDisable}}
{{KV|Allow Sentries|bool|Allow or disallow building sentries.}}
{{KV|Allow Dispensers|bool|Allow or disallow building dispensers.}}
{{KV|Allow Teleporters|bool|Allow or disallow building teleporters.}}
{{KV|Destroy Buildings|bool|Whether or not to destroy buildings already within the volume once it activates.}}


==Inputs==
==Inputs==
{{I Targetname}}
{{I BaseEntity|base=1}}
{{I Parentname}}
{{I EnableDisable}}
{{IO|SetTeam|Sets which team to be aligned with.|param=int}}
{{IO|SetActive|Activates the nobuild zone.}}
{{IO|SetActive|Activates the nobuild zone.}}
{{IO|SetInactive|Deactivates the nobuild zone.}}
{{IO|SetInactive|Deactivates the nobuild zone.|nofgd=1}}
{{IO|ToggleActive|Toggle the state of the nobuild zone.}}
{{IO|ToggleActive|Toggle the state of the nobuild zone.|nofgd=1}}
 
{{todo|what is the difference between whether it's active and whether it's enabled?}}
{{I EnableDisable}}


==Outputs==
==Outputs==
{{O Targetname}}
{{O BaseEntity}}

Revision as of 14:56, 27 September 2022

English (en)Español (es)Translate (Translate)

Template:Tf2 brush

Entity Description

A func_nobuild entity will restrict an Engineer from building in the specific area it contains.

Normal Use

A func_nobuild area should come in contact with the top side of the brush you don't want the engineer to build upon. The func_nobuild should also be at least 96 units high to keep an Engineer from bypassing it by jumping above it. Keep in mind that a func_respawnroom entity also blocks an Engineer's ability to build, and thus a func_nobuild does not have to be placed in the same location as a func_respawnroom.

Note.pngNote:Keep in mind that a func_nobuild only prevents the center of the Engineer's buildings from being placed on top of a surface, not the whole structure; parts of the building can actually overlap the func_nobuild area.
Todo: add picture example here
The required 96 units for each accessible side.

Ledges

High ledges present an element a bit different from a standard floor surface. If there is a ledge you do not want an engineer to build upon, the func_nobuild brush should not only be 96 units above the surface, but 96 units below the surface as well, with the func_nobuild brush overlapping the ledge. It should also stick out 96 units from all accessible sides of the ledge. If the ledge is less then 96 units above a larger flat surface, the func_nobuild only needs to touch the top of the surface the ledge is above.

Keyvalues

TeamNum:
Initial Team (TeamNum) <choices>
Which Team the entity belongs / is assigned to on spawn
  • 0: None
  • 1: Spectator/Halloween Souls Team Fortress 2
  • 2: RED Team Fortress 2
  • 3: BLU/Robots Team Fortress 2
  • 5: Halloween Bosses (only in Team Fortress 2) !FGD
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).
Allow Sentries ([todo internal name (i)]) <boolean>
Allow or disallow building sentries.
Allow Dispensers ([todo internal name (i)]) <boolean>
Allow or disallow building dispensers.
Allow Teleporters ([todo internal name (i)]) <boolean>
Allow or disallow building teleporters.
Destroy Buildings ([todo internal name (i)]) <boolean>
Whether or not to destroy buildings already within the volume once it activates.

Inputs

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
SetTeam <integerRedirectInput/integer>
Sets which team to be aligned with.
SetActive
Activates the nobuild zone.
SetInactive  !FGD
Deactivates the nobuild zone.
ToggleActive  !FGD
Toggle the state of the nobuild zone.
Todo: what is the difference between whether it's active and whether it's enabled?

Outputs

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