CBeam: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:


== Fields <!-- is this correct name ? Would members be better ? --> ==
== Fields <!-- is this correct name ? Would members be better ? --> ==
{{note|These are changable via [[#See Also|NetProps vscript instance ↓]] or available [[#KIO_access_to_fields|KIO ↓]]}}


{{DEFINE_FIELD|m_nHaloIndex|FIELD_MODELINDEX}}
{{DEFINE_FIELD|m_nHaloIndex|FIELD_MODELINDEX}}
Line 11: Line 10:
{{DEFINE_FIELD|m_nNumBeamEnts|FIELD_INTEGER}}
{{DEFINE_FIELD|m_nNumBeamEnts|FIELD_INTEGER}}
{{DEFINE_FIELD|m_nMinDXLevel|FIELD_INTEGER}}
{{DEFINE_FIELD|m_nMinDXLevel|FIELD_INTEGER}}
{{DEFINE_FIELD|m_flHDRColorScale|FIELD_FLOAT}}
{{DEFINE_FIELD|m_flDamage|FIELD_FLOAT}}
{{DEFINE_FIELD|m_nDissolveType|FIELD_INTEGER}}


{{DEFINE_FIELD|m_fWidth|FIELD_FLOAT|Width of the beam at the start}}
{{DEFINE_FIELD|m_fWidth|FIELD_FLOAT|Width of the beam at the start}}
Line 32: Line 27:
{{DEFINE_FIELD|m_hEndEntity|FIELD_EHANDLE}}
{{DEFINE_FIELD|m_hEndEntity|FIELD_EHANDLE}}


=== KeyFields ===
{{DEFINE_KEYFIELD|m_flHDRColorScale|FIELD_FLOAT|HDRColorScale}}
{{DEFINE_KEYFIELD|m_flDamage|FIELD_FLOAT|damage}}
{{DEFINE_KEYFIELD|m_nDissolveType|FIELD_INTEGER|dissolvetype}}


#ifdef PORTAL
{{DEFINE_FIELD|m_bDrawInMainRender|FIELD_BOOLEAN}}
{{DEFINE_FIELD|m_bDrawInPortalRender|FIELD_BOOLEAN}}
#endif
=== Array fields ===
=== Array fields ===
{{DEFINE_ARRAY|m_hAttachEntity|FIELD_EHANDLE|10}}
{{DEFINE_ARRAY|m_hAttachEntity|FIELD_EHANDLE|10}}
{{DEFINE_ARRAY|m_nAttachIndex|FIELD_INTEGER|10}}
{{DEFINE_ARRAY|m_nAttachIndex|FIELD_INTEGER|10}}


== KIO access to fields <!-- not sure if this is correct way to call this stuff --> ==
=== Only in {{portal|4}} ===
=== KeyFields ===
{{DEFINE_FIELD|m_bDrawInMainRender|FIELD_BOOLEAN}}
{{DEFINE_KEYFIELD|[[#Fields|m_flHDRColorScale ↑]]|FIELD_FLOAT|HDRColorScale}}
{{DEFINE_FIELD|m_bDrawInPortalRender|FIELD_BOOLEAN}}
{{DEFINE_KEYFIELD|[[#Fields|m_flDamage ↑]]|FIELD_FLOAT|damage}}
{{DEFINE_KEYFIELD|[[#Fields|m_nDissolveType ↑]]|FIELD_INTEGER|dissolvetype}}


=== Inputs ===
=== Inputs ===
Line 65: Line 56:
*MAX_BEAM_NOISEAMPLITUDE = 64
*MAX_BEAM_NOISEAMPLITUDE = 64


== Flags ==
== See Also ==
{{fl|1|SF_BEAM_STARTON}}
{{See also netprops}}
{{fl|2|SF_BEAM_TOGGLE}}
{{fl|4|SF_BEAM_RANDOM}}
{{fl|8|SF_BEAM_RING}}
{{fl|16|SF_BEAM_SPARKSTART}}
{{fl|32|SF_BEAM_SPARKEND}}
{{fl|64|SF_BEAM_DECALS}}
{{fl|128|SF_BEAM_SHADEIN}}
{{fl|256|SF_BEAM_SHADEOUT}}
{{fl|512|SF_BEAM_TAPEROUT}}
{{fl|32768|SF_BEAM_TEMPORARY}}

Revision as of 03:42, 24 September 2024

C++ Class hierarchy
CBeam
CBaseEntity
C++ beam_shared.cpp

Entities linked to this class

Fields

m_nHaloIndex <FIELD_MODELINDEX>

m_nBeamType <FIELD_INTEGER>

m_nBeamFlags <FIELD_INTEGER>

m_nNumBeamEnts <FIELD_INTEGER>

m_nMinDXLevel <FIELD_INTEGER>


m_fWidth <FIELD_FLOAT>

Width of the beam at the start

m_fEndWidth <FIELD_FLOAT>

Width of the beam at the end

m_fFadeLength <FIELD_FLOAT>

m_fHaloScale <FIELD_FLOAT>

m_fAmplitude <FIELD_FLOAT>

m_fStartFrame <FIELD_FLOAT>

m_fSpeed <FIELD_FLOAT>


m_flFrameRate <FIELD_FLOAT>

m_flFrame <FIELD_FLOAT>


m_flFireTime <FIELD_TIME>


m_vecEndPos <FIELD_POSITION_VECTOR>

m_hEndEntity <FIELD_EHANDLE>


KeyFields

m_flHDRColorScale <FIELD_FLOAT> (HDRColorScale)

m_flDamage <FIELD_FLOAT> (damage)

m_nDissolveType <FIELD_INTEGER> (dissolvetype)


Array fields

m_hAttachEntity[10] <FIELD_EHANDLE>

m_nAttachIndex[10] <FIELD_INTEGER>


Only in Portal Portal

m_bDrawInMainRender <FIELD_BOOLEAN>

m_bDrawInPortalRender <FIELD_BOOLEAN>


Inputs

Note.pngNote:These inputs are usable either as Keyvalue or Input, they are also not autocompleted for ent_fire ConCommand

m_fSpeed ↑ <FIELD_FLOAT> (ScrollSpeed)


Input Functions

Width <FIELD_FLOAT> linked function: InputWidth

Asserts that specified width is lower than MAX_BEAM_WIDTH and then sets m_fWidth ↑ and m_fEndWidth ↑

Noise <FIELD_FLOAT> linked function: InputNoise

Sets m_fAmplitude ↑

ColorRedValue <FIELD_FLOAT> linked function: InputColorRedValue

Sets r portion of m_clrRender to value clamped between 0, 255

ColorGreenValue <FIELD_FLOAT> linked function: InputColorGreenValue

Sets g portion of m_clrRender to value clamped between 0, 255

ColorBlueValue <FIELD_FLOAT> linked function: InputColorBlueValue

Sets b portion of m_clrRender to value clamped between 0, 255

Constants

  • MAX_BEAM_WIDTH = 102.3f
  • MAX_BEAM_SCROLLSPEED = 100.0f
  • MAX_BEAM_NOISEAMPLITUDE = 64

See Also