Файл WeaponStableState.c

См. исходные тексты.

Перечисления
enum	MuzzleState { U = -1 , E = 0 , F = 1 , L = 2 }

Функции
void	WeaponStableState (Weapon_Base w=NULL, WeaponStateBase parent=NULL, int anim_state=-1)
void	SyncAnimState ()
override void	OnEntry (WeaponEventBase e)
override void	OnUpdate (float dt)
override void	OnExit (WeaponEventBase e)
override bool	IsIdle ()
int	GetCurrentStateID ()
Weapon state properties
Properties defining the state in several properties for other systems Override these to set them up Several systems depends on this: WeaponFSM.RandomizeFSMState, which picks out a suitable FSM state when attaching magazine through CE WeaponFSM.ValidateAndRepair, which will attempt to identify a desync and repair the FSM state if so @WARNING So it is important to set these up correctly to prevent any desync of weapon FSM and actual wepon state
bool	IsRepairEnabled ()
	Whether WeaponFSM.ValidateAndRepair should be applied on this state @NOTE: This property was implemented at the same time as ValARep To have it disabled by default In case there are modders who created their own state But potentially did not set up their properties correctly As having ValARep run on an improper setup would result in horrible VME spam and desync @WARNING: When enabling repair, it is imperative that all properties are set up correctly.
bool	HasBullet ()
	Whether there is a bullet in the chamber @NOTE: This should only be false when it is empty So this is true when there is a bullet in the chamber Regardless of the bullet being loaded, firedout or jammed.
bool	HasMagazine ()
	Whether there is a magazine attached.
bool	IsJammed ()
	Whether the gun is jammed.
bool	IsDischarged ()
	Whether the gun is discharged.
bool	IsWeaponOpen ()
	Whether the gun is open.
void	InitMuzzleArray ()
	Override with the filling of m_muzzleHasBullet.
bool	IsSingleState ()
	Special one for when the weapon only has one singular state (like Magnum)
Weapon state properties helpers
Several helpers for better access of certain properties
MuzzleState	GetMuzzleState (int idx)
	Get chamber state of the muzzle at index.
int	GetMuzzleStateCount ()
bool	IsChamberValid (int idx)
bool	IsChamberFiredOut (int idx)
bool	IsChamberFull (int idx)
void	ValidateMuzzleArray ()
	Safety check and error message in case not set up correctly.

Переменные
enum MuzzleState	m_animState
ref array< MuzzleState >	m_muzzleHasBullet = new array<MuzzleState>()

Перечисления

MuzzleState

enum MuzzleState

Элементы перечислений
U	UNKNOWN.
E	EMPTY.
F	FIRED.
L	LOADED.

{
    U   = -1,
    E   =  0,
    F   =  1,
    L   =  2
}

Функции

GetCurrentStateID()

int GetCurrentStateID

(

)

{ return 0; }

GetMuzzleState()

MuzzleState GetMuzzleState

(

int

idx

)

Get chamber state of the muzzle at index.

{ return m_muzzleHasBullet[idx]; }  

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

GetMuzzleStateCount()

int GetMuzzleStateCount

(

)

{ return m_muzzleHasBullet.Count(); }   

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

HasBullet()

bool HasBullet

(

)

Whether there is a bullet in the chamber @NOTE: This should only be false when it is empty So this is true when there is a bullet in the chamber Regardless of the bullet being loaded, firedout or jammed.

{ return false; }

HasMagazine()

bool HasMagazine

(

)

Whether there is a magazine attached.

{ return false; }

InitMuzzleArray()

void InitMuzzleArray

(

)

Override with the filling of m_muzzleHasBullet.

{ m_muzzleHasBullet = { MuzzleState.U }; }

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

IsChamberFiredOut()

bool IsChamberFiredOut

(

int

idx

)

{ return m_muzzleHasBullet[idx] == MuzzleState.F; }

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

Используется в DoubleBarrel_Base::CanChamberBullet(), Weapon_Base::CanChamberBullet(), Weapon::CanChamberBullet(), Weapon::CanFire(), Weapon::GetMuzzleStates() и Weapon_Base::ShowBullet().

IsChamberFull()

bool IsChamberFull

(

int

idx

)

{ return m_muzzleHasBullet[idx] != MuzzleState.E; }

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

Используется в Weapon::CanChamberBullet(), Weapon_Base::CanEjectBullet(), Weapon::ForceSyncSelectionState(), Weapon::GetMuzzleStates() и InventoryItemSuper::IsChamberFullEx().

IsChamberValid()

bool IsChamberValid

(

int

idx

)

{ return m_muzzleHasBullet[idx] != MuzzleState.U; }

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

IsDischarged()

bool IsDischarged

(

)

Whether the gun is discharged.

{ return false; }

IsIdle()

override bool IsIdle

(

)

{ return true; }

Используется в Weapon::CanRemoveFromHands() и ManBase::OnQuickBarSingleUse().

IsJammed()

bool IsJammed

(

)

Whether the gun is jammed.

{ return false; }

IsRepairEnabled()

bool IsRepairEnabled

(

)

Whether WeaponFSM.ValidateAndRepair should be applied on this state @NOTE: This property was implemented at the same time as ValARep To have it disabled by default In case there are modders who created their own state But potentially did not set up their properties correctly As having ValARep run on an improper setup would result in horrible VME spam and desync @WARNING: When enabling repair, it is imperative that all properties are set up correctly.

{ return false; }

IsSingleState()

bool IsSingleState

(

)

Special one for when the weapon only has one singular state (like Magnum)

{ return false; }

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

IsWeaponOpen()

bool IsWeaponOpen

(

)

Whether the gun is open.

{ return false; }

OnEntry()

override void OnEntry

(

WeaponEventBase

e

)

    {
        super.OnEntry(e);
        m_weapon.SetJammed(false);
        if (e)
            SyncAnimState();
        m_weapon.ResetWeaponAnimState();
    }

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

OnExit()

override void OnExit

(

WeaponEventBase

e

)

    {
        m_weapon.ResetWeaponAnimState();
        super.OnExit(e);
    }

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

OnUpdate()

override void OnUpdate

(

float

dt

)

    {
        super.OnUpdate(dt);
        SyncAnimState();
    }

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

SyncAnimState()

void SyncAnimState

(

)

    {
        int curr = m_weapon.GetWeaponAnimState();
        if (curr != m_animState)
        {
            //if (LogManager.IsWeaponLogEnable()) fsmDebugSpam("[wpnfsm] " + Object.GetDebugName(m_weapon) + " synchronizing anim state: " + curr + " --> " + m_animState);
            PlayerBase p;
            if (Class.CastTo(p, m_weapon.GetHierarchyParent()))
            {
                if (p.GetItemInHands() == m_weapon)
                {
                    HumanCommandWeapons hcw = p.GetCommandModifier_Weapons();
                    if (hcw)
                    {
                        hcw.SetInitState(m_animState);
                        if (LogManager.IsWeaponLogEnable()) fsmDebugSpam("[wpnfsm] " + Object.GetDebugName(m_weapon) + " state=" + m_weapon.GetCurrentState().Type() + " synchronized anim state: " + typename.EnumToString(PistolAnimState, curr) + " --> " + typename.EnumToString(PistolAnimState, m_animState));
                    }
                    else
                    {
                        Human wpnOwner = Human.Cast(m_weapon.GetHierarchyRootPlayer());
                        HumanCommandWeapons.StaticSetInitState(wpnOwner, m_animState);
                        if (LogManager.IsWeaponLogEnable()) fsmDebugSpam("[wpnfsm] " + Object.GetDebugName(m_weapon) + " state=" + m_weapon.GetCurrentState().Type() + " synchronized remote anim state: " + typename.EnumToString(PistolAnimState, curr) + " --> " + typename.EnumToString(PistolAnimState, m_animState));
                    }
                }
                m_weapon.SetWeaponAnimState(m_animState);
            }
            else
            {
                m_weapon.SetGroundAnimFrameIndex(m_animState);
            }       
        }
    }

Перекрестные ссылки Class::CastTo(), fsmDebugSpam(), LogManager::IsWeaponLogEnable(), m_animState, m_weapon и HumanCommandWeapons::StaticSetInitState().

Используется в HandStateBase::OnEntry(), OnEntry(), HandStateBase::OnUpdate() и OnUpdate().

ValidateMuzzleArray()

void ValidateMuzzleArray

(

)

Safety check and error message in case not set up correctly.

    {
        // There is only one
        if (IsSingleState())
            return;
        
        bool failed = false;
        
        if (!failed)
        {
            foreach (MuzzleState state : m_muzzleHasBullet)
            {
                if ( state == MuzzleState.U )
                {
                    failed = true;
                    break;
                }
            }
        }
        
        if (failed)
        {
            ErrorExSeverity severity = ErrorExSeverity.ERROR;
            
            #ifdef DEVELOPER
            if (DayZGame.m_IsPreviewSpawn)
            {
                // we do not want VMEs when spawning the item in order to visualize it for preview in script console
                severity = ErrorExSeverity.INFO;
            }
            #endif
            
            ErrorEx("Muzzle array validation has failed. Please set up the correct muzzle states by overriding InitMuzzleArray.", severity);
        }
    }

Перекрестные ссылки ErrorEx, IsSingleState() и m_muzzleHasBullet.

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

WeaponStableState()

void WeaponStableState	(	Weapon_Base	w = NULL,
		WeaponStateBase	parent = NULL,
		int	anim_state = -1 )

    {
        m_animState = anim_state;
        InitMuzzleArray();
        ValidateMuzzleArray();
    }

Перекрестные ссылки WeaponStableState::InitMuzzleArray(), m_animState и ValidateMuzzleArray().

Используется в Weapon_Base::InitStateMachine().

Переменные

m_animState

enum MuzzleState m_animState

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

m_muzzleHasBullet

ref array<MuzzleState> m_muzzleHasBullet = new array<MuzzleState>()

Используется в GetMuzzleState(), GetMuzzleStateCount(), InitMuzzleArray(), WeaponStableState::InitMuzzleArray(), WeaponStateJammed::InitMuzzleArray(), IsChamberFiredOut(), IsChamberFull(), IsChamberValid() и ValidateMuzzleArray().