Talk:Npc barnacle (hlvr): Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (small note)
mNo edit summary
Line 1: Line 1:
{{Note|If someone does make the page, remember that {{tl2|lang}} and {{tl2|entity}} are out of date templates, and you should use {{tl2|multipage}} and {{tl2|this is a}} instead.}}
{{Note|If someone does make the page, remember that {{T|Lang}} and {{T||Entity}} are out of date templates, and you should use {{T|MultiPage}} and {{T|This is a}} instead.}}
'''Working on it'''
'''Working on it'''
{| class=wikitable
{| class=wikitable
| {{tl2|Lang|<page name>}} || Adds the flags on the top right for language pages and adds this page to an appropriate language [[Help:Categories|Category]]. For example, this page uses {{tlc|lang|Entity Article Template}}.
| {{T|Lang|{{P}}<page name>}} || Adds the flags on the top right for language pages and adds this page to an appropriate language [[Help:Categories|Category]]. For example, this page uses {{T|Lang|{{P}}Entity Article Template}}.
|-
|-
| {{tl2|Distinguish|NPC_Barnacle}} || Adds a note with a link to a page that this page should not be confused with.
| {{T|Distinguish|{{P}}NPC_Barnacle}} || Adds a note with a link to a page that this page should not be confused with.
|-
|-
| {{Code|1=<nowiki>{{</nowiki>[[Template:Entity|entity]]{{!}}<entity class name>{{!}}type=<entity type>{{!}}game=<full game name><nowiki>}}</nowiki>}}
| {{Code|1=<nowiki>{{</nowiki>[[Template:Entity|entity]]{{!}}<entity class name>{{!}}type=<entity type>{{!}}game=<full game name><nowiki>}}</nowiki>}}
Line 12: Line 12:
|}
|}


==Entity Description==
== Entity Description ==
The Barnacle from [[Half-Life: Alyx]]. A stationary enemy which hangs its tongue down to capture enemies and objects that make contact with the tongue. The barnacle retracts the object/entity upwards towards its origin and ‘bites’ to apply damage. The primary damage is inflicted at the body of the barnacle. This will detonate any explosive containers, potentially damaging nearby barnacles/entities including other explosive containers. If ammo/resin is caught, the barnacle will retain that until death.  
The Barnacle from [[Half-Life: Alyx]]. A stationary enemy which hangs its tongue down to capture enemies and objects that make contact with the tongue. The barnacle retracts the object/entity upwards towards its origin and ‘bites’ to apply damage. The primary damage is inflicted at the body of the barnacle. This will detonate any explosive containers, potentially damaging nearby barnacles/entities including other explosive containers. If ammo/resin is caught, the barnacle will retain that until death.  


Line 19: Line 19:
Also include [[:Template:Code class]]:
Also include [[:Template:Code class]]:
{{syntax2
{{syntax2
|in={{tlc|code class|CEntityClass|entityfile}}
|in={{T|Code class|{{P}}CEntityClass{{P}}entityfile}}
|out={{code class|CEntityClass|entityfile}}
|out={{Code class|CEntityClass|entityfile}}
}}
}}
The entity's code class name can be found by searching <code>LINK_ENTITY_TO_CLASS</code> in the CPP file defining it.
The entity's code class name can be found by searching <code>LINK_ENTITY_TO_CLASS</code> in the CPP file defining it.


==Dedicated Console Variables and Commands (omit if none exist)==
== Dedicated Console Variables and Commands (omit if none exist) ==
Console variables and commands can be found by searching <code>ConVar</code> and <code>ConCommand</code> in the CPP file that defines the entity. Note a parameter if any exist.
Console variables and commands can be found by searching <code>ConVar</code> and <code>ConCommand</code> in the CPP file that defines the entity. Note a parameter if any exist.
;cvar_name <data type>
;cvar_name <data type>
Line 31: Line 31:
:Barney's spawn health.
:Barney's spawn health.


==Flags (omit if none exist)==
== Flags (omit if none exist) ==
{{Tip|See [[:Category:Flag Templates]] for a list of available templates.}}
{{Tip|See [[:Category:Flag Templates]] for a list of available templates.}}
For each flag, write one of the following.
For each flag, write one of the following.


{{tl2|fl|<integer>|<flag name>}}
{{T|Fl|{{P}}<integer>{{P}}<flag name>}}


{{tlc|fl|<integer>|<flag name>|<description>}}
{{T|Fl|{{P}}<integer>{{P}}<flag name>{{P}}<description>}}


Which could look like this:
Which could look like this:
Line 43: Line 43:
{{fl|16|Start Silent|The map will start without this sound playing. Enabled by default.}}
{{fl|16|Start Silent|The map will start without this sound playing. Enabled by default.}}


==Keyvalues==
== Keyvalues ==
Since every entity inherits {{ent|CBaseEntity}}, all entity pages should have [[:Template:KV BaseEntity]] if not more. The only exceptions are [[:Category:Internal entities|internal entities]], which are removed during the compiling of a map and cannot receive I/O and most base keyvalues. This all applies to inputs and outputs as well.
Since every entity inherits {{ent|CBaseEntity}}, all entity pages should have [[:Template:KV BaseEntity]] if not more. The only exceptions are [[:Category:Internal entities|internal entities]], which are removed during the compiling of a map and cannot receive I/O and most base keyvalues. This all applies to inputs and outputs as well.


Line 51: Line 51:
{{KV|Render Amount (renderamt)|integer|Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.}}
{{KV|Render Amount (renderamt)|integer|Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.}}


==Inputs==
== Inputs ==
Individual inputs (and outputs) are defined with [[:Template:IO]]
Individual inputs (and outputs) are defined with [[:Template:IO]]
{{Tip|See [[:Category:Input Templates]] for a list of available templates.}}
{{Tip|See [[:Category:Input Templates]] for a list of available templates.}}
Line 58: Line 58:
{{IO|SetSpeed|Set the speed of the train, as a ratio of max speed [0, 1]|param=float}}
{{IO|SetSpeed|Set the speed of the train, as a ratio of max speed [0, 1]|param=float}}


==Outputs==
== Outputs ==
{{Tip|See [[:Category:Output Templates]] for a list of available templates.}}
{{Tip|See [[:Category:Output Templates]] for a list of available templates.}}


Line 64: Line 64:
{{IO|OnPressed|Fired when the button is pressed.}}
{{IO|OnPressed|Fired when the button is pressed.}}


==See also==
== See also ==
{{Note|Add links to related articles, entities, or tutorials here.}}
{{Note|Add links to related articles, entities, or tutorials here.}}


Revision as of 18:57, 30 June 2024

Note.pngNote:If someone does make the page, remember that {{Lang}} and {{Entity}} are out of date templates, and you should use {{MultiPage}} and {{This is a}} instead.

Working on it

{{Lang|<page name>}} Adds the flags on the top right for language pages and adds this page to an appropriate language Category. For example, this page uses {{Lang|Entity Article Template}}.
{{Distinguish|NPC_Barnacle}} Adds a note with a link to a page that this page should not be confused with.
{{entity|<entity class name>|type=<entity type>|game=<full game name>}} Creates a first sentence with a link to the game.
 
 Example {{entity|type=e0|ammo_57mm|game=Counter-Strike: Source}} 
   Results ammo_57mm is a point entity available in Counter-Strike: Source Counter-Strike: Source.
Tip.pngTip:If the entity is available in all Source games, don't use {{{game}}}. If available in multiple games, use {{{game1}}} (See the documentation of the template for details).
Note.pngNote:See the documentation of the template for the details of entity types.

Entity Description

The Barnacle from Half-Life: Alyx. A stationary enemy which hangs its tongue down to capture enemies and objects that make contact with the tongue. The barnacle retracts the object/entity upwards towards its origin and ‘bites’ to apply damage. The primary damage is inflicted at the body of the barnacle. This will detonate any explosive containers, potentially damaging nearby barnacles/entities including other explosive containers. If ammo/resin is caught, the barnacle will retain that until death.

FGDs (and by extension the Hammer properties window) are good sources for information on an entity's keyvalues, inputs, outputs, and flags, however FGDs often will not list everything available for an entity. Because of this, the wiki uses a mix of templates that roughly follow the engine's class hierarchy and ones that follow FGDs.

Also include Template:Code class:

 
 Example {{Code class|CEntityClass|entityfile}} 
   Results
C++ In code, it is represented by theCEntityClassclass, defined in theentityfilefile.

The entity's code class name can be found by searching LINK_ENTITY_TO_CLASS in the CPP file defining it.

Dedicated Console Variables and Commands (omit if none exist)

Console variables and commands can be found by searching ConVar and ConCommand in the CPP file that defines the entity. Note a parameter if any exist.

cvar_name
Description.
sk_barney_health <integer>
Barney's spawn health.

Flags (omit if none exist)

Tip.pngTip:See Category:Flag Templates for a list of available templates.

For each flag, write one of the following.

{{Fl|<integer>|<flag name>}}

{{Fl|<integer>|<flag name>|<description>}}

Which could look like this:

Flag Name : [Integer value]
Description if necessary.
Start Silent : [16]
The map will start without this sound playing. Enabled by default.

Keyvalues

Since every entity inherits CBaseEntity, all entity pages should have Template:KV BaseEntity if not more. The only exceptions are internal entities, which are removed during the compiling of a map and cannot receive I/O and most base keyvalues. This all applies to inputs and outputs as well.

Individual keyvalues are defined with Template:KV.

Tip.pngTip:See Category:Keyvalue Templates for a list of available templates.
Keyvalue Name (non-SmartEdit name) ([todo internal name (i)]) <vartype>
A description of the keyvalue.
Render Amount (renderamt) ([todo internal name (i)]) <integer>
Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.

Inputs

Individual inputs (and outputs) are defined with Template:IO

Tip.pngTip:See Category:Input Templates for a list of available templates.


InputName <optional vartype>
A description of the input.
SetSpeed <float>
Set the speed of the train, as a ratio of max speed [0, 1]

Outputs

Tip.pngTip:See Category:Output Templates for a list of available templates.


OutputName
A description of the output.
OnPressed
Fired when the button is pressed.

See also

Note.pngNote:Add links to related articles, entities, or tutorials here.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Talk:Npc_barnacle_(hlvr)&oldid=412799"