[INC] Beam Entities
 

Description:

Quote:

Originally Posted by HLSDK These functions are here to show the way beams are encoded as entities. Encoding beams as entities simplifies their management in the client/server architecture.

Credits:

• HLSDK - effects.cpp & effects.h

INC:

PHP Code:

---

/* AMX Mod X
*    Beam entities include by KORD_12.7.
*
* Version 1.3 (last update: 4, may (05), 2013)
*
* http://aghl.ru/forum/ - Russian Half-Life and Adrenaline Gamer Community
*
* This file is provided as is (no warranties)
*/

#if defined _beams_included
    #endinput
#endif
#define _beams_included

#include <engine>
#include <fakemeta>
#include <xs>


// These functions are here to show the way beams are encoded as entities.
// Encoding beams as entities simplifies their management in the client/server architecture.


// Beam types
enum _:Beam_Types
{
    BEAM_POINTS,
    BEAM_ENTPOINT,
    BEAM_ENTS,
    BEAM_HOSE
};

// Beam flags
#define BEAM_FSINE    0x10
#define BEAM_FSOLID    0x20
#define BEAM_FSHADEIN    0x40
#define BEAM_FSHADEOUT    0x80


#define Beam_SetType(%0,%1) set_pev(%0, pev_rendermode, (pev(%0, pev_rendermode) & 0xF0) | %1 & 0x0F)
/* stock Beam_SetType(const iBeamEntity, const iType)
    return set_pev(iBeamEntity, pev_rendermode, (pev(iBeamEntity, pev_rendermode) & 0xF0) | iType & 0x0F); */
    
#define Beam_SetFlags(%0,%1) set_pev(%0, pev_rendermode, (pev(%0, pev_rendermode) & 0x0F) | %1 & 0xF0)
/* stock Beam_SetFlags(const iBeamEntity, const iType)
    return set_pev(iBeamEntity, pev_rendermode, (pev(iBeamEntity, pev_rendermode) & 0x0F) | iType & 0xF0); */    

#define Beam_SetStartPos(%0,%1) set_pev(%0, pev_origin, %1)
/* stock Beam_SetStartPos(const iBeamEntity, const Float: flVecStart[3])
    return set_pev(iBeamEntity, pev_origin, flVecStart); */

#define Beam_SetEndPos(%0,%1) set_pev(%0, pev_angles, %1)
/* stock Beam_SetEndPos(const iBeamEntity, const Float: flVecEnd[3]) 
    return set_pev(iBeamEntity, pev_angles, flVecEnd); */

#define Beam_SetStartEntity(%0,%1) \
    set_pev(%0, pev_sequence, (%1 & 0x0FFF) | ((pev(%0, pev_sequence) & 0xF000) << 12)); \
    set_pev(%0, pev_owner, %1) \
/* stock Beam_SetStartEntity(const iBeamEntity, const iEntityIndex) */

#define Beam_SetEndEntity(%0,%1) \
    set_pev(%0, pev_skin, (%1 & 0x0FFF) | ((pev(%0, pev_skin) & 0xF000) << 12)); \
    set_pev(%0, pev_aiment, %1) \
/* stock Beam_SetEndEntity(const iBeamEntity, const iEntityIndex) */

#define Beam_SetStartAttachment(%0,%1) set_pev(%0, pev_sequence, (pev(%0, pev_sequence) & 0x0FFF) | ((%1 & 0xF) << 12))
/* stock Beam_SetStartAttachment(const iBeamEntity, const iAttachment)
    return set_pev(iBeamEntity, pev_sequence, (pev(iBeamEntity, pev_sequence) & 0x0FFF) | ((iAttachment & 0xF) << 12)); */

#define Beam_SetEndAttachment(%0,%1) set_pev(%0, pev_skin, (pev(%0, pev_skin) & 0x0FFF) | ((%1 & 0xF) << 12))
/* stock Beam_SetEndAttachment(const iBeamEntity, const iAttachment)
    return set_pev(iBeamEntity, pev_skin, (pev(iBeamEntity, pev_skin) & 0x0FFF) | ((iAttachment & 0xF) << 12)); */

#define Beam_SetTexture(%0,%1) set_pev(%0, pev_modelindex, %1)
/* stock Beam_SetTexture(const iBeamEntity, const iSpriteIndex)
    return set_pev(iBeamEntity, pev_modelindex, iSpriteIndex); */

#define Beam_SetWidth(%0,%1) set_pev(%0, pev_scale, %1)
/* stock Beam_SetWidth(const iBeamEntity, const Float: flWidth)
    return set_pev(iBeamEntity, pev_scale, flWidth); */

#define Beam_SetNoise(%0,%1) set_pev(%0, pev_body, %1)
/* stock Beam_SetNoise(const iBeamEntity, const iNoise)
    return set_pev(iBeamEntity, pev_body, iNoise); */    
    
#define Beam_SetColor(%0,%1) set_pev(%0, pev_rendercolor, %1)
/* stock Beam_SetColor(const iBeamEntity, const Float: flColor[3])
    return set_pev(iBeamEntity, pev_rendercolor, flColor); */    
        
#define Beam_SetBrightness(%0,%1) set_pev(%0, pev_renderamt, %1)
/* stock Beam_SetBrightness(const iBeamEntity, const Float: flBrightness)
    return set_pev(iBeamEntity, pev_renderamt, flBrightness); */

#define Beam_SetFrame(%0,%1) set_pev(%0, pev_frame, %1)
/* stock Beam_SetFrame(const iBeamEntity, const Float: flFrame)
    return set_pev(iBeamEntity, pev_frame, flFrame); */

#define Beam_SetScrollRate(%0,%1) set_pev(%0, pev_animtime, %1)
/* stock Beam_SetScrollRate(const iBeamEntity, const Float: flSpeed)
    return set_pev(iBeamEntity, pev_animtime, flSpeed); */

#define Beam_GetType(%0) (pev(%0, pev_rendermode) & 0x0F)
/* stock Beam_GetType(const iBeamEntity)
    return pev(iBeamEntity, pev_rendermode) & 0x0F; */
    
#define Beam_GetFlags(%0) (pev(%0, pev_rendermode) & 0xF0)
/* stock Beam_GetFlags(const iBeamEntity)
    return pev(iBeamEntity, pev_rendermode) & 0xF0; */    

#define Beam_GetStartEntity(%0) (pev(%0, pev_sequence) & 0xFFF)
/* stock Beam_GetStartEntity(const iBeamEntity)
    return pev(iBeamEntity, pev_sequence) & 0xFFF; */

#define Beam_GetEndEntity(%0) (pev(%0, pev_skin) & 0xFFF)
/* stock Beam_GetEndEntity(const iBeamEntity)
    return pev(iBeamEntity, pev_skin) & 0xFFF; */

stock Beam_GetStartPos(const iBeamEntity, Float: vecStartPos[3])
{
    static iEntity; iEntity = Beam_GetStartEntity(iBeamEntity);
    
    if (Beam_GetType(iBeamEntity) == BEAM_ENTS && pev_valid(iEntity))
    {
        pev(iEntity, pev_origin, vecStartPos);
        return;
    }
    
    pev(iBeamEntity, pev_origin, vecStartPos);
}

stock Beam_GetEndPos(const iBeamEntity, Float: vecEndPos[3])
{
    static iType; 
    static iEntity;
    
    iType = Beam_GetType(iBeamEntity);
    
    if (iType == BEAM_POINTS || iType == BEAM_HOSE)
    {
        pev(iBeamEntity, pev_angles, vecEndPos);
        return;
    }
    
    iEntity = Beam_GetEndEntity(iBeamEntity);
    
    if (pev_valid(iEntity))
    {
        pev(iEntity, pev_origin, vecEndPos);
        return;
    }
    
    pev(iBeamEntity, pev_angles, vecEndPos);
}

#define Beam_GetTexture(%0) pev(%0, pev_modelindex)
/* stock Beam_GetTexture(const iBeamEntity)
    return pev(iBeamEntity, pev_modelindex); */
    
#define Beam_GetWidth(%0) entity_get_float(%0, EV_FL_scale)
/* stock Float: Beam_GetWidth(const iBeamEntity)
    return entity_get_float(iBeamEntity, EV_FL_scale); */

#define Beam_GetNoise(%0) pev(%0, pev_body)
/* stock Beam_GetNoise(const iBeamEntity)
    return pev(iBeamEntity, pev_body); */
    
#define Beam_GetColor(%0,%1) pev(%0, pev_rendercolor,%1)
/* stock Beam_GetColor(const iBeamEntity, Float: flRGB[3])
    return pev(iBeamEntity, pev_rendercolor, flRGB); */

#define Beam_GetBrightness(%0) entity_get_float(%0, EV_FL_renderamt)
/* stock Float: Beam_GetBrightness(const iBeamEntity)
    return entity_get_float(iBeamEntity, EV_FL_renderamt); */
    
#define Beam_GetFrame(%0) entity_get_float(%0, EV_FL_frame)
/* stock Float: Beam_GetFrame(const iBeamEntity)
    return entity_get_float(iBeamEntity, EV_FL_frame); */

#define Beam_GetScrollRate(%0) entity_get_float(%0, EV_FL_animtime)
/* stock Float: Beam_GetScrollRate(const iBeamEntity)
    return entity_get_float(iBeamEntity, EV_FL_animtime); */

stock Beam_Create(const szSpriteName[], const Float: flWidth)
{
    static iBeamEntity, iszAllocStringCached;
    if (iszAllocStringCached || (iszAllocStringCached = engfunc(EngFunc_AllocString, "beam")))
    {
        iBeamEntity = engfunc(EngFunc_CreateNamedEntity, iszAllocStringCached);
    }
    
    if (!pev_valid(iBeamEntity))
    {
        return FM_NULLENT;
    }
    
    Beam_Init(iBeamEntity, szSpriteName, flWidth);
    return iBeamEntity;
}

stock Beam_Init(const iBeamEntity, const szSpriteName[], const Float: flWidth)
{
    set_pev(iBeamEntity, pev_flags, pev(iBeamEntity, pev_flags) | FL_CUSTOMENTITY);
    
    Beam_SetColor(iBeamEntity, Float: {255.0, 255.0, 255.0});
    Beam_SetBrightness(iBeamEntity, 255.0);
    Beam_SetNoise(iBeamEntity, 0);
    Beam_SetFrame(iBeamEntity, 0.0);
    Beam_SetScrollRate(iBeamEntity, 0.0);
    Beam_SetWidth(iBeamEntity, flWidth);
    
    engfunc(EngFunc_SetModel, iBeamEntity, szSpriteName);
    
    set_pev(iBeamEntity, pev_skin, 0);
    set_pev(iBeamEntity, pev_sequence, 0);
    set_pev(iBeamEntity, pev_rendermode, 0);
}

stock Beam_PointsInit(const iBeamEntity, const Float: flVecStart[3], const Float: flVecEnd[3])
{
    Beam_SetType(iBeamEntity, BEAM_POINTS);
    Beam_SetStartPos(iBeamEntity, flVecStart);
    Beam_SetEndPos(iBeamEntity, flVecEnd);
    Beam_SetStartAttachment(iBeamEntity, 0);
    Beam_SetEndAttachment(iBeamEntity, 0);
    Beam_RelinkBeam(iBeamEntity);
}

stock Beam_HoseInit(const iBeamEntity, const Float: flVecStart[3], const Float: flVecDirection[3])
{
    Beam_SetType(iBeamEntity, BEAM_HOSE);
    Beam_SetStartPos(iBeamEntity, flVecStart);
    Beam_SetEndPos(iBeamEntity, flVecDirection);
    Beam_SetStartAttachment(iBeamEntity, 0);
    Beam_SetEndAttachment(iBeamEntity, 0);
    Beam_RelinkBeam(iBeamEntity);
}

stock Beam_PointEntInit(const iBeamEntity, const Float: flVecStart[3], const iEndIndex)
{
    Beam_SetType(iBeamEntity, BEAM_ENTPOINT);
    Beam_SetStartPos(iBeamEntity, flVecStart);
    Beam_SetEndEntity(iBeamEntity, iEndIndex);
    Beam_SetStartAttachment(iBeamEntity, 0);
    Beam_SetEndAttachment(iBeamEntity, 0);
    Beam_RelinkBeam(iBeamEntity);
}

stock Beam_EntsInit(const iBeamEntity, const iStartIndex, const iEndIndex)
{
    Beam_SetType(iBeamEntity, BEAM_ENTS);
    Beam_SetStartEntity(iBeamEntity, iStartIndex);
    Beam_SetEndEntity(iBeamEntity, iEndIndex);
    Beam_SetStartAttachment(iBeamEntity, 0);
    Beam_SetEndAttachment(iBeamEntity, 0);
    Beam_RelinkBeam(iBeamEntity);
}

stock Beam_RelinkBeam(const iBeamEntity)
{
    static Float: vecMins[3];
    static Float: vecMaxs[3];
    
    static Float: vecOrigin[3];
    static Float: vecEndPos[3];
    static Float: vecStartPos[3];
    
    pev(iBeamEntity, pev_origin, vecOrigin);
    
    Beam_GetStartPos(iBeamEntity, vecStartPos);
    Beam_GetEndPos(iBeamEntity, vecEndPos);
    
    vecMins[0] = floatmin(vecStartPos[0], vecEndPos[0]);
    vecMins[1] = floatmin(vecStartPos[1], vecEndPos[1]);
    vecMins[2] = floatmin(vecStartPos[2], vecEndPos[2]);
    
    vecMaxs[0] = floatmax(vecStartPos[0], vecEndPos[0]);
    vecMaxs[1] = floatmax(vecStartPos[1], vecEndPos[1]);
    vecMaxs[2] = floatmax(vecStartPos[2], vecEndPos[2]);
    
    xs_vec_sub(vecMins, vecOrigin, vecMins);
    xs_vec_sub(vecMaxs, vecOrigin, vecMaxs);
    
    set_pev(iBeamEntity, pev_mins, vecMins);
    set_pev(iBeamEntity, pev_maxs, vecMaxs);
    
    engfunc(EngFunc_SetSize, iBeamEntity, vecMins, vecMaxs);
    engfunc(EngFunc_SetOrigin, iBeamEntity, vecOrigin);
} 


---

TO DO:

Add some code examples with creating beam ents :D

Re: [INC] Beam Entities
 

Very cool, good job. I didn't know you could create beams as entities.

Can you explain what a BEAM_HOSE is?

Are you able to use this method to create other types of beam messages? (ie. TE_BEAMSPRITE, TE_BEAMTORUS, TE_BEAMDISK, TE_BEAMCYLINDER, TE_BEAMFOLLOW, and TE_BEAMRING)

I assume using this is equivalent to doing MSG_BROADCAST, is there a way to show only to a single player?

One thing I think you should change is letting iSpriteIndex be optional in Beam_Create and Beam_Init; you should be able to find the index for the sprite if you have the name (or vice versa).

You should also try to put a little more documentation for each macro/function to make it easier to understand for beginners.

Overall good job though; I'm sure I will end up using this some day.

Re: [INC] Beam Entities
 

Never heard of env_laser/env_beam/beam entities ?

BEAM_HOSE is the same as BEAM_POINTS, except your provide a direction instead of an end point.

No. It's specific. Though you can try to reproduce the same effect.

Like any others entities, if you want to filter, I guess you have to use AddToFullPack.

Re: [INC] Beam Entities
 

about the entity, I suggest you to see the "halflife-cs.fgd"

Re: [INC] Beam Entities
 

Updated.

Re: [INC] Beam Entities
 

You should say what are the changes.

Re: [INC] Beam Entities
 

Removed iSpriteIndex argument in Beam_Create and Beam_Init stocks.

Re: [INC] Beam Entities
 

Are you able to create a sample plugin with INC, please?

Thanks

Re: [INC] Beam Entities
 

Hello;

Using this shizzle for a new mod of me.
Pretty hard to use without examples anyway;

I think you forgot to include <xs>, bcs I had errors when I compiled.

[Edit]
- Used first time, and worked.
- This is awesome, thanks!

[Edit #2]
- Is it possible to detect touch?

Re: [INC] Beam Entities
 

Touch works here now,

but after testing, and I move sometimes..
at a time the line doesnt come anymore, it says an entity number.. but nothing shows

arround entitynumber 90

How to solve this?