Класс CatchingContextTrapsBase

Граф наследования:CatchingContextTrapsBase:

Защищенные члены
void	DeserializeData (Param par)
void	CreateResultDataStructure ()
void	ClearCatchingItemData ()
void	InitItemValues (EntityAI item)
float	AdjustBaitItemChance (EntityAI item)
	Allows for adjustment of all catch probabilities from item qualities (damage, qty...)
void	InitCatchEnviroMask ()
void	Init (Param par)
void	SetupInitialTypes ()
void	UpdateDataAndMasks ()
int	UpdateTrapEnviroMask ()
void	SetTrapEnviroMask (int value)
void	UpdateUsedBait (ECatchingBaitCategories type)
	if non-empty bait type is used, some 'Bait' attachment is picked as an active bait (currently no direct link between item and sensitivity-weighted target probability)
override void	UpdateBaseProbability (YieldItemBase yItem)
override bool	ModifySignalProbability (inout float probability)
void	RemoveBait ()
void	ReduceBaitQty (float qtyNorm)

Защищенные данные
float	m_CumulativeTrappingSuccess
	after N attempts, the chance to catch should be this. Only highest one applies. @NOTE: Take care, only way to achieve guaranteed 1.0 chance at the end is to have EVERY chance at 1.0.
int	m_AttemptsCount
ItemBase	m_Bait

Подробное описание

Методы

AdjustBaitItemChance()

float AdjustBaitItemChance ( EntityAI item )

inlineprotected

Allows for adjustment of all catch probabilities from item qualities (damage, qty...)

    {
        float ret = 1.0;
        ItemBase ib;
        if (Class.CastTo(ib,item))
        {
            //ret *= ib.GetBaitEffectivity(); //disconnected for the Time Being
        }
        
        return ret;
    }

Перекрестные ссылки Class::CastTo().

Используется в InitItemValues().

ClearCatchingItemData()

void ClearCatchingItemData ( )

inlineprotected

    {
        super.ClearCatchingItemData();
        
        m_CumulativeTrappingSuccess = 0.0;
        m_QualityBaseMod = 0.0;
        m_QualityDispersionMinMod = 0.0;
        m_QualityDispersionMaxMod = 0.0; 
    }

Перекрестные ссылки m_CumulativeTrappingSuccess, m_QualityBaseMod, m_QualityDispersionMaxMod и m_QualityDispersionMinMod.

CreateResultDataStructure()

void CreateResultDataStructure ( )

inlineprotected

    {
        m_Result = new CatchingResultTrapBase(m_MainItem);
        
        super.CreateResultDataStructure();
    }

Перекрестные ссылки m_MainItem и m_Result.

DeserializeData()

void DeserializeData ( Param par )

inlineprotected

    {
        Param2<EntityAI,int> p;
        if (Class.CastTo(p,par))
        {
            m_MainItem = p.param1;
            m_AttemptsCount = p.param2;
        }
    }

Перекрестные ссылки Class::CastTo(), m_AttemptsCount и m_MainItem.

Init()

void Init ( Param par )

inlineprotected

    {
        super.Init(par);
        
        GenerateResult();
    }

Перекрестные ссылки GenerateResult().

InitCatchEnviroMask()

void InitCatchEnviroMask ( )

inlineprotected

    {
        vector pos = m_MainItem.GetPosition();
        if (GetGame().SurfaceIsSea(pos[0], pos[2]))
            m_EnviroMask = AnimalCatchingConstants.MASK_ENVIRO_SEA;
        else if (GetGame().SurfaceIsPond( pos[0], pos[2]))
            m_EnviroMask = AnimalCatchingConstants.MASK_ENVIRO_POND;
        else
            m_EnviroMask = AnimalCatchingConstants.MASK_ENVIRO_LAND_ALL;
    }

Перекрестные ссылки GetGame(), m_EnviroMask, m_MainItem, AnimalCatchingConstants::MASK_ENVIRO_LAND_ALL, AnimalCatchingConstants::MASK_ENVIRO_POND и AnimalCatchingConstants::MASK_ENVIRO_SEA.

Используется в UpdateTrapEnviroMask().

InitItemValues()

void InitItemValues ( EntityAI item )

inlineprotected

    {
        //skip ruined or deleted items entirely
        if (item.IsRuined() || item.IsSetForDeletion())
            return;
        
        string path = "" + CFG_VEHICLESPATH + " " + item.GetType() + " Trapping";
        if (GetGame().ConfigIsExisting(path))
        {
            if (GetGame().ConfigIsExisting(path + " baitTypes") && GetGame().ConfigIsExisting(path + " baitTypeChances"))
            {
                CachedObjectsArrays.ARRAY_INT.Clear();
                CachedObjectsArrays.ARRAY_FLOAT.Clear();
                GetGame().ConfigGetIntArray(path + " baitTypes",CachedObjectsArrays.ARRAY_INT);
                GetGame().ConfigGetFloatArray(path + " baitTypeChances",CachedObjectsArrays.ARRAY_FLOAT);
                int count = CachedObjectsArrays.ARRAY_INT.Count();
                if (count == CachedObjectsArrays.ARRAY_FLOAT.Count())
                {
                    int key;
                    float value;
                    for (int i = 0; i < count; i++)
                    {
                        key = CachedObjectsArrays.ARRAY_INT[i];
                        value = AdjustBaitItemChance(item) * CachedObjectsArrays.ARRAY_FLOAT[i];
                        if (!m_BaitCompatibilityMap.Contains(key) || (m_BaitCompatibilityMap.Get(key).m_BaseProbability < value))
                        {
                            m_BaitCompatibilityMap.Set(key,new BaitData(value,item));
                        }
                    }
                }
                else
                {
                    ErrorEx("'baitTypes' and 'baitTypeChances' arrray counts of " + item.GetType() + " do not match!",ErrorExSeverity.INFO);
                }
            }
            if (GetGame().ConfigIsExisting(path + " resultQuantityBaseMod"))
                m_QualityBaseMod += GetGame().ConfigGetFloat(path + " resultQuantityBaseMod");
            if (GetGame().ConfigIsExisting(path + " resultQuantityDispersionMin"))
                m_QualityDispersionMinMod += GetGame().ConfigGetFloat(path + " resultQuantityDispersionMin");
            if (GetGame().ConfigIsExisting(path + " resultQuantityDispersionMax"))
                m_QualityDispersionMaxMod += GetGame().ConfigGetFloat(path + " resultQuantityDispersionMax");
        }
    }

Перекрестные ссылки AdjustBaitItemChance(), CachedObjectsArrays::ARRAY_FLOAT, CachedObjectsArrays::ARRAY_INT, CFG_VEHICLESPATH, ErrorEx, GetGame(), m_BaitCompatibilityMap, m_QualityBaseMod, m_QualityDispersionMaxMod, m_QualityDispersionMinMod и path.

ModifySignalProbability()

override bool ModifySignalProbability ( inout float probability )

inlineprotected

    {
        probability = 1 - Math.Pow((1 - m_CumulativeTrappingSuccess),(1/m_AttemptsCount));
        
        return true;
    }

Перекрестные ссылки m_AttemptsCount, m_CumulativeTrappingSuccess и Math::Pow().

Используется в UpdateBaseProbability().

ReduceBaitQty()

void ReduceBaitQty ( float qtyNorm )

inlineprotected

    {
        if (m_Bait)
        {
            if (m_Bait.HasQuantity() && !m_Bait.CanBeSplit())
                m_Bait.SetQuantityNormalized((m_Bait.GetQuantityNormalized() - qtyNorm));
            else
                m_Bait.DeleteSafe();
        }
    }

Перекрестные ссылки ItemBase::CanBeSplit() и m_Bait.

RemoveBait()

void RemoveBait ( )

inlineprotected

    {
        if (m_Bait)
            m_Bait.DeleteSafe();
    }

Перекрестные ссылки m_Bait.

SetTrapEnviroMask()

void SetTrapEnviroMask ( int value )

inlineprotected

    {
        m_EnviroMask = value;
    }

Перекрестные ссылки m_EnviroMask.

SetupInitialTypes()

void SetupInitialTypes ( )

inlineprotected

    {
        #ifdef DEVELOPER
        if (IsCLIParam("catchingLogs"))
        {
            Print("********************"); //just for debug purposes to track the start
            Print("dbgTrapz | START");
            Print("********************");
        }
        #endif
        
        super.SetupInitialTypes();
        
        #ifdef DEVELOPER
        if (IsCLIParam("catchingLogs"))
        {
            Print("***"); //just for debug purposes to track the start
        }
        #endif
    }

Перекрестные ссылки IsCLIParam() и Print().

Используется в UpdateDataAndMasks().

UpdateBaseProbability()

override void UpdateBaseProbability ( YieldItemBase yItem )

inlineprotected

    {
        int baitType = ECatchingBaitCategories.BAIT_TYPE_EMPTY;
        int usedType = -1;
        float probability = -1;
        float highestProbability = 0.0;
        int count = m_BaitCompatibilityMap.Count();
        for (int i = 0; i < count; i++)
        {
            baitType = m_BaitCompatibilityMap.GetKey(i);
            probability = m_BaitCompatibilityMap.Get(baitType).m_BaseProbability * yItem.GetBaitTypeSensitivity(baitType);
            if (probability > highestProbability)
            {
                highestProbability = probability;
                usedType = baitType;
            }
        }
        
        m_CumulativeTrappingSuccess = Math.Clamp(highestProbability,0,1);
        #ifdef DEVELOPER
        if (IsCLIParam("catchingLogs"))
        {
            //Print("********************");
            Print("dbgTrapz | using bait type: " + baitType + " to catch: " + yItem);
        }
        #endif
        UpdateUsedBait(usedType);
        
        #ifdef DEVELOPER
        if (IsCLIParam("catchingLogs"))
        {
            float dbgProb;
            ModifySignalProbability(dbgProb);
            Print("dbgTrapz | starting catching of " + yItem + " | at probability: " + dbgProb + " | with target success: " + m_CumulativeTrappingSuccess);
        }
        #endif
    }

Перекрестные ссылки Math::Clamp(), IsCLIParam(), m_BaitCompatibilityMap, m_CumulativeTrappingSuccess, ModifySignalProbability(), Print() и UpdateUsedBait().

UpdateDataAndMasks()

void UpdateDataAndMasks ( )

inlineprotected

    {
        InitCatchingItemData();
        InitCatchMethodMask(); //bait check
        //InitCatchEnviroMask(); //skipping, raycasts are unreliable outside network bubbles
        SetupInitialTypes();
        SetupProbabilityArray();
    }

Перекрестные ссылки InitCatchingItemData(), InitCatchMethodMask(), SetupInitialTypes() и SetupProbabilityArray().

UpdateTrapEnviroMask()

int UpdateTrapEnviroMask ( )

inlineprotected

    {
        InitCatchEnviroMask();
        return GetCatchEnviroMask();
    }

Перекрестные ссылки GetCatchEnviroMask() и InitCatchEnviroMask().

UpdateUsedBait()

void UpdateUsedBait ( ECatchingBaitCategories type )

inlineprotected

if non-empty bait type is used, some 'Bait' attachment is picked as an active bait (currently no direct link between item and sensitivity-weighted target probability)

    {
        m_Bait = null;
        if (type != ECatchingBaitCategories.BAIT_TYPE_EMPTY)
        {
            BaitData dta = m_BaitCompatibilityMap.Get(type);
            if (dta)
            {
                ItemBase potentialBait = ItemBase.Cast(dta.m_Owner);
                if (potentialBait != m_MainItem)
                    m_Bait = potentialBait;
            }
            else
                ErrorEx("failed to acquire BaitData from type: " + type);
        }
        
        #ifdef DEVELOPER
        if (IsCLIParam("catchingLogs"))
        {
            if (m_Bait)
                Print("dbgTrapz | UpdateUsedBait to: " + m_Bait + " | with base bait probability used: " + m_BaitCompatibilityMap.Get(type).m_BaseProbability);
            else
                Print("dbgTrapz | UpdateUsedBait to 'null'!");
        }
        #endif
    }

Перекрестные ссылки ErrorEx, IsCLIParam(), m_Bait, m_BaitCompatibilityMap, m_MainItem и Print().

Используется в UpdateBaseProbability().

Поля

m_AttemptsCount

int m_AttemptsCount

protected

Используется в DeserializeData() и ModifySignalProbability().

m_Bait

ItemBase m_Bait

protected

Используется в ReduceBaitQty(), RemoveBait() и UpdateUsedBait().

m_CumulativeTrappingSuccess

m_CumulativeTrappingSuccess

protected

after N attempts, the chance to catch should be this. Only highest one applies. @NOTE: Take care, only way to achieve guaranteed 1.0 chance at the end is to have EVERY chance at 1.0.

Используется в ClearCatchingItemData(), ModifySignalProbability() и UpdateBaseProbability().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/4_World/Systems/AnimalCatchingSystem/CatchingContexts/CatchingContextTraps.c