Class ModularFirearm

Inheritance
Object
MonoBehaviour
ModularFirearm
ModularAssaultRifle
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: NeoFPS.ModularFirearms
Assembly: NeoFPS.dll
Syntax
public class ModularFirearm : MonoBehaviour, IModularFirearm, IWieldable, IMonoBehaviour, IAimable, IDamageSource, ICrosshairDriver, IPoseHandler, IModularFirearmPayloadReceiver, INeoSerializableComponent

Properties

accuracy

Declaration
public float accuracy { get; }
Property Value
Type Description
System.Single

aimer

Declaration
public IAimer aimer { get; }
Property Value
Type Description
IAimer

aimRelativePosition

Declaration
public Vector3 aimRelativePosition { get; }
Property Value
Type Description
Vector3

aimRelativeRotation

Declaration
public Quaternion aimRelativeRotation { get; }
Property Value
Type Description
Quaternion

aimRelativeTransform

Declaration
public Transform aimRelativeTransform { get; }
Property Value
Type Description
Transform

aimToggleHold

Declaration
public ToggleOrHold aimToggleHold { get; }
Property Value
Type Description
ToggleOrHold

ammo

Declaration
public IAmmo ammo { get; }
Property Value
Type Description
IAmmo

animationHandler

Declaration
public IWieldableAnimationHandler animationHandler { get; }
Property Value
Type Description
IWieldableAnimationHandler

animator

Declaration
public Animator animator { get; }
Property Value
Type Description
Animator

controller

Declaration
public IController controller { get; }
Property Value
Type Description
IController

crosshair

Declaration
public FpsCrosshair crosshair { get; }
Property Value
Type Description
FpsCrosshair

damageSourceTransform

Declaration
public Transform damageSourceTransform { get; }
Property Value
Type Description
Transform

description

Declaration
public string description { get; }
Property Value
Type Description
System.String

ejector

Declaration
public IEjector ejector { get; }
Property Value
Type Description
IEjector

isBlocked

Declaration
public bool isBlocked { get; }
Property Value
Type Description
System.Boolean

lowerDelayType

Declaration
public FirearmDelayType lowerDelayType { get; }
Property Value
Type Description
FirearmDelayType

maxAccuracy

Declaration
public float maxAccuracy { get; set; }
Property Value
Type Description
System.Single

minAccuracy

Declaration
public float minAccuracy { get; set; }
Property Value
Type Description
System.Single

mode

Declaration
public virtual string mode { get; }
Property Value
Type Description
System.String

modeSwitcher

Declaration
public IModularFirearmModeSwitcher modeSwitcher { get; set; }
Property Value
Type Description
IModularFirearmModeSwitcher

muzzleEffect

Declaration
public IMuzzleEffect muzzleEffect { get; }
Property Value
Type Description
IMuzzleEffect

outDamageFilter

Declaration
public DamageFilter outDamageFilter { get; set; }
Property Value
Type Description
DamageFilter

raiseDelayType

Declaration
public FirearmDelayType raiseDelayType { get; }
Property Value
Type Description
FirearmDelayType

recoilHandler

Declaration
public IRecoilHandler recoilHandler { get; }
Property Value
Type Description
IRecoilHandler

reloader

Declaration
public IReloader reloader { get; }
Property Value
Type Description
IReloader

reloading

Declaration
public bool reloading { get; }
Property Value
Type Description
System.Boolean

shooter

Declaration
public IShooter shooter { get; }
Property Value
Type Description
IShooter

trigger

Declaration
public ITrigger trigger { get; }
Property Value
Type Description
ITrigger

wielder

Declaration
public ICharacter wielder { get; }
Property Value
Type Description
ICharacter

Methods

AddAimBlocker(Object)

Declaration
public void AddAimBlocker(Object o)
Parameters
Type Name Description
Object o

AddBlocker(Object)

Declaration
public void AddBlocker(Object o)
Parameters
Type Name Description
Object o

AddTriggerBlocker(Object)

Declaration
public void AddTriggerBlocker(Object o)
Parameters
Type Name Description
Object o

Awake()

Declaration
protected virtual void Awake()

Deselect()

Declaration
public Waitable Deselect()
Returns
Type Description
Waitable

DeselectInstant()

Declaration
public void DeselectInstant()

FixedUpdate()

Declaration
protected void FixedUpdate()

GetPose(MonoBehaviour)

Declaration
public PoseInformation GetPose(MonoBehaviour owner)
Parameters
Type Name Description
MonoBehaviour owner
Returns
Type Description
PoseInformation

HideCrosshair()

Declaration
public void HideCrosshair()

HideGeometry()

Declaration
public void HideGeometry()

ManualWeaponLowered()

Declaration
public void ManualWeaponLowered()

ManualWeaponRaised()

Declaration
public void ManualWeaponRaised()

OnDestroy()

Declaration
protected void OnDestroy()

OnDisable()

Declaration
protected void OnDisable()

OnEnable()

Declaration
protected void OnEnable()

OnIsBlockedChanged(Boolean)

Declaration
protected virtual void OnIsBlockedChanged(bool blocked)
Parameters
Type Name Description
System.Boolean blocked

OnModeChange()

Declaration
protected void OnModeChange()

OnStart()

Declaration
protected virtual void OnStart()

OnValidate()

Declaration
protected void OnValidate()

PlaySound(AudioClip, Single)

Declaration
public void PlaySound(AudioClip clip, float volume = 1F)
Parameters
Type Name Description
AudioClip clip
System.Single volume

PopPose(MonoBehaviour, Single)

Declaration
public void PopPose(MonoBehaviour owner, float blendTime)
Parameters
Type Name Description
MonoBehaviour owner
System.Single blendTime

PushPose(PoseInformation, MonoBehaviour, Single, Int32)

Declaration
public void PushPose(PoseInformation pose, MonoBehaviour owner, float blendTime, int priority = 0)
Parameters
Type Name Description
PoseInformation pose
MonoBehaviour owner
System.Single blendTime
System.Int32 priority

ReadProperties(INeoDeserializer, NeoSerializedGameObject)

Declaration
public virtual void ReadProperties(INeoDeserializer reader, NeoSerializedGameObject nsgo)
Parameters
Type Name Description
INeoDeserializer reader
NeoSerializedGameObject nsgo

Reload()

Declaration
public bool Reload()
Returns
Type Description
System.Boolean

RemoveAimBlocker(Object)

Declaration
public void RemoveAimBlocker(Object o)
Parameters
Type Name Description
Object o

RemoveBlocker(Object)

Declaration
public void RemoveBlocker(Object o)
Parameters
Type Name Description
Object o

RemoveTriggerBlocker(Object)

Declaration
public void RemoveTriggerBlocker(Object o)
Parameters
Type Name Description
Object o

Select()

Declaration
public void Select()

SetAimer(IAimer)

Declaration
public void SetAimer(IAimer to)
Parameters
Type Name Description
IAimer to

SetAmmo(IAmmo)

Declaration
public void SetAmmo(IAmmo to)
Parameters
Type Name Description
IAmmo to

SetEjector(IEjector)

Declaration
public void SetEjector(IEjector to)
Parameters
Type Name Description
IEjector to

SetHandling(IRecoilHandler)

Declaration
public void SetHandling(IRecoilHandler to)
Parameters
Type Name Description
IRecoilHandler to

SetMuzzleEffect(IMuzzleEffect)

Declaration
public void SetMuzzleEffect(IMuzzleEffect to)
Parameters
Type Name Description
IMuzzleEffect to

SetRecoilMultiplier(Single, Single)

Declaration
public void SetRecoilMultiplier(float move, float rotation)
Parameters
Type Name Description
System.Single move
System.Single rotation

SetReloader(IReloader)

Declaration
public void SetReloader(IReloader to)
Parameters
Type Name Description
IReloader to

SetShooter(IShooter)

Declaration
public void SetShooter(IShooter to)
Parameters
Type Name Description
IShooter to

SetStartupPayload(ModularFirearmPayload)

Declaration
public void SetStartupPayload(ModularFirearmPayload payload)
Parameters
Type Name Description
ModularFirearmPayload payload

SetTrigger(ITrigger)

Declaration
public void SetTrigger(ITrigger to)
Parameters
Type Name Description
ITrigger to

ShowCrosshair()

Declaration
public void ShowCrosshair()

ShowGeometry()

Declaration
public void ShowGeometry()

Start()

Declaration
protected IEnumerator Start()
Returns
Type Description
System.Collections.IEnumerator

SwitchMode()

Declaration
public virtual void SwitchMode()

Update()

Declaration
protected virtual void Update()

WriteProperties(INeoSerializer, NeoSerializedGameObject, SaveMode)

Declaration
public virtual void WriteProperties(INeoSerializer writer, NeoSerializedGameObject nsgo, SaveMode saveMode)
Parameters
Type Name Description
INeoSerializer writer
NeoSerializedGameObject nsgo
SaveMode saveMode

Events

onAccuracyChanged

Declaration
public event UnityAction<float> onAccuracyChanged
Event Type
Type Description
UnityAction<System.Single>

onAimerChange

Declaration
public event UnityAction<IModularFirearm, IAimer> onAimerChange
Event Type
Type Description
UnityAction<IModularFirearm, IAimer>

onAmmoChange

Declaration
public event UnityAction<IModularFirearm, IAmmo> onAmmoChange
Event Type
Type Description
UnityAction<IModularFirearm, IAmmo>

onBlockedChanged

Declaration
public event UnityAction<bool> onBlockedChanged
Event Type
Type Description
UnityAction<System.Boolean>

onCrosshairChanged

Declaration
public event UnityAction<FpsCrosshair> onCrosshairChanged
Event Type
Type Description
UnityAction<FpsCrosshair>

onModeChange

Declaration
public event UnityAction<IModularFirearm, string> onModeChange
Event Type
Type Description
UnityAction<IModularFirearm, System.String>

onReloaderChange

Declaration
public event UnityAction<IModularFirearm, IReloader> onReloaderChange
Event Type
Type Description
UnityAction<IModularFirearm, IReloader>

onShooterChange

Declaration
public event UnityAction<IModularFirearm, IShooter> onShooterChange
Event Type
Type Description
UnityAction<IModularFirearm, IShooter>

onTriggerChange

Declaration
public event UnityAction<IModularFirearm, ITrigger> onTriggerChange
Event Type
Type Description
UnityAction<IModularFirearm, ITrigger>

onWielderChanged

Declaration
public event UnityAction<ICharacter> onWielderChanged
Event Type
Type Description
UnityAction<ICharacter>

Implements

Extension Methods