SCR_PrefabSpawnPoint.c

Go to the documentation of this file.

[EntityEditorProps(style: "cylinder", category: "GameScripted/GameMode/PrefabsSpawn", description: "Prefab Spawn Point Entity", sizeMin: "-0.25 0 -0.25", color: "64 0 64 255")]
class SCR_PrefabSpawnPointClass : GenericEntityClass
{
}

class SCR_PrefabSpawnPoint : GenericEntity
{
    [Attribute("0", UIWidgets.EditComboBox, "Defines which spawner uses this Spawn Point", "", ParamEnumArray.FromEnum(EPrefabSpawnType) )]
    protected EPrefabSpawnType m_eType;
    
    [Attribute("0", UIWidgets.CheckBox, "Should be SP snaped in script to ground? -- GetWorld().GetSurfaceY()", "", ParamEnumArray.FromEnum(EPrefabSpawnType) )]
    protected bool m_bSnapToGroud; // grouNd
    
    //------------------------------------------------------------------------------------------------
    EPrefabSpawnType GetType()
    {
        return m_eType;
    }
    
    //------------------------------------------------------------------------------------------------
    [Obsolete("Please use ShouldSnapToGround()")]
    bool ShouldSnapToGroud()
    {
        return ShouldSnapToGround();
    }
    
    //------------------------------------------------------------------------------------------------
    bool ShouldSnapToGround()
    {
        return m_bSnapToGroud;
    }
    
    //------------------------------------------------------------------------------------------------
    // constructor
    void SCR_PrefabSpawnPoint(IEntitySource src, IEntity parent)
    {
        #ifdef WORKBENCH
            SetFlags(EntityFlags.TRACEABLE, false);
        #else
            SetFlags(EntityFlags.NO_LINK, false);
        #endif
        SCR_PrefabsSpawnerManager.RegisterPrefabSpawnPoint(this);
    }
 
    //------------------------------------------------------------------------------------------------
    // destructor
    void ~SCR_PrefabSpawnPoint()
    {
        SCR_PrefabsSpawnerManager.UnregisterPrefabSpawnPoint(this);
    }
}