Cycler: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(created in raw form)
 
(move to trivia)
 
(58 intermediate revisions by 24 users not shown)
Line 1: Line 1:
An entity used to display a model for testing purposes. Shooting it with cycle through the model's animations.
{{LanguageBar}}
{{TabsBar|main=gs|base=Cycler}}
{{This is a|model entity|name=cycler|game=Half-Life: Source|game1=Half-Life 2 series|game2=Portal series|game3=Counter-Strike series}}


==KEYS==
{{CD|CGenericCycler|file1=h_cycler.cpp}}
It is used to display a model for testing purposes. Shooting it will cycle through the model's animations.


Name targetname <target_source> The name that other entities refer to this entity by.
{{Important|This is a debug entity. For mapping purposes use {{ent|prop_dynamic}} or {{ent|prop_dynamic_override}} instead.}}
{{altnames|name1=model_studio}}


Parent parentname <target_destination> The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
== Keyvalues ==
{{KV Targetname}}
{{KV Model}}


Pitch Yaw Roll (Y Z X) angles <angle> This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
== Flags ==
{{fl|1|Not Solid}}


Render FX renderfx <choices>
== Inputs ==
{{I|SetSequence|Sets the cycler's sequence.|param=string}}


Render Mode rendermode <choices> Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.
== Trivia ==
Despite being intended for testing, the entity was used in {{hl2|1}} for Noriko on the [[Creating a working Crane in Half-Life 2|crane]], then often used in {{hl2ep1|1}} (and once for {{hl2|name}} (on Dark Energy) and {{hl2ep2|1}}) for a [[Advisor|Combine Advisor]] that appears on a screen (using {{ent|point_camera}} entity).{{Cite|1}}


FX Amount (0 - 255) renderamt <integer> The FX amount is used by the selected Render Mode.
== See also ==
* {{ent|cycler_actor}} - Special cycler entity for NPCs.
* {{ent|cycler_blender}}
* {{ent|cycler_flex}}
* {{ent|cycler_weapon}}
* {{ent|cycler_wreckage}}


FX Color (R G B) rendercolor <color255> The FX color is used by the selected Render Mode.
{{references|1=
 
{{ref2|cite id=1|url=https://youtu.be/WaOyDHiYqqM?t=253|website=YouTube|author=Pinsplash|title=Explaining Half-Life 2 Facts (Part 2) - 4:13}}
Disable Receiving Shadows disablereceiveshadows <choices>
{{ref2|cite id=1a<!-- workaround-->|1={{Quote|If you hit Noriko with an explosive, she'll start playing various animations. Every time she is hit, a new one starts. Noriko is a entity called a cycler, an entity which are used in Half-Life (Alpha) demo map. Despite prop entities like {{code|prop_dynamic}} are now present in Source engine, cyclers are continued to be used in {{Hl2|1}} twice (Noriko in Highway 17 and Combine Advisor in Dark Energy) and later in {{hl2ep1|1}} for several times and once in {{hl2ep2|1}} for a Combine Advisor that appears on the screen.}}}}
 
}}
spawnflags spawnflags <flags>
 
Model model <studio>
 
Skin skin <integer> Some models have multiple versions of their textures, called skins. Set this to a number other than 0 to use that skin instead of the default.
 
Sequence sequence <integer> Default animation sequence for the model to be playing after spawning.
 
 
==INPUTS==
 
Kill Removes this entity from the world.
 
KillHierarchy Removes this entity and all its children from the world.
 
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.
 
FireUser1 Causes this entity's OnUser1 output to be fired.
 
FireUser2 Causes this entity's OnUser2 output to be fired.
 
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.
 
SetSequence <string> Sets the cycler's sequence.
 
Alpha <integer> Sets the cycler's alpha value.
 
 
==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.

Latest revision as of 11:44, 29 November 2025

English (en)Hrvatski (hr)Русский (ru)中文 (zh)Translate (Translate)

cycler is a model entity available in Half-Life: Source Half-Life: Source, Half-Life 2 series Half-Life 2 series, Portal seriesPortal series Portal series, and Counter-Strike seriesCounter-Strike series Counter-Strike series.

C++ Class hierarchy
CGenericCycler
CCycler
CAI_BaseNPC
CBaseCombatCharacter
CBaseFlex
CBaseAnimatingOverlay
CBaseAnimating
CBaseEntity
C++ h_cycler.cpp

It is used to display a model for testing purposes. Shooting it will cycle through the model's animations.

Icon-Important.pngImportant:This is a debug entity. For mapping purposes use prop_dynamic or prop_dynamic_override instead.
AltNames.pngAltNames: This entity is also tied to model_studio.

Keyvalues

Name (targetname) <string>
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also: Generic Keyvalues, Inputs and Outputs available to all entities
World Model (model) <model path>
In-game 3D representation of the entity to display. This is the path to a MDL relative to the game's root directory. (128 character limit)

Flags

Not Solid : [1]

Inputs

SetSequence <stringRedirectInput/string>
Sets the cycler's sequence.

Trivia

Despite being intended for testing, the entity was used in Half-Life 2 for Noriko on the crane, then often used in Half-Life 2: Episode One (and once for Half-Life 2 (on Dark Energy) and Half-Life 2: Episode Two) for a Combine Advisor that appears on a screen (using point_camera entity).[1]

See also

References

References
1a.
If you hit Noriko with an explosive, she'll start playing various animations. Every time she is hit, a new one starts. Noriko is a entity called a cycler, an entity which are used in Half-Life (Alpha) demo map. Despite prop entities like prop_dynamic are now present in Source engine, cyclers are continued to be used in Half-Life 2 twice (Noriko in Highway 17 and Combine Advisor in Dark Energy) and later in Half-Life 2: Episode One for several times and once in Half-Life 2: Episode Two for a Combine Advisor that appears on the screen.
.