⮞ Go to NeoFPS.com

    Show / Hide Table of Contents

    Class WieldableTool

    Inheritance
    Object
    MonoBehaviour
    BaseWieldableItem
    WieldableTool
    Implements
    IWieldableTool
    IWieldable
    IMonoBehaviour
    ICrosshairDriver
    IPoseHandler
    Inherited Members
    BaseWieldableItem.onWielderChanged
    BaseWieldableItem.wielder
    BaseWieldableItem.animator
    BaseWieldableItem.animationHandler
    BaseWieldableItem.Awake()
    BaseWieldableItem.OnEnable()
    BaseWieldableItem.Select()
    BaseWieldableItem.DeselectInstant()
    BaseWieldableItem.Deselect()
    BaseWieldableItem.onBlockedChanged
    BaseWieldableItem.AddBlocker(Object)
    BaseWieldableItem.RemoveBlocker(Object)
    BaseWieldableItem.PushPose(PoseInformation, MonoBehaviour, Single, Int32)
    BaseWieldableItem.PopPose(MonoBehaviour, Single)
    BaseWieldableItem.GetPose(MonoBehaviour)
    BaseWieldableItem.Update()
    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.WieldableTools
    Assembly: NeoFPS.dll
    Syntax
    public class WieldableTool : BaseWieldableItem, IWieldableTool, IWieldable, IMonoBehaviour, ICrosshairDriver, IPoseHandler

    Properties

    accuracy

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

    crosshair

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

    isBlocked

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

    isBusy

    Declaration
    public override bool isBusy { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    BaseWieldableItem.isBusy

    Methods

    CheckAvailableActions()

    Declaration
    public void CheckAvailableActions()

    CheckCanUse()

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

    CheckIsBlocked()

    Declaration
    protected override bool CheckIsBlocked()
    Returns
    Type Description
    System.Boolean
    Overrides
    BaseWieldableItem.CheckIsBlocked()

    FixedUpdate()

    Declaration
    protected void FixedUpdate()

    HideCrosshair()

    Declaration
    public void HideCrosshair()

    Interrupt()

    Declaration
    public void Interrupt()

    OnDisable()

    Declaration
    protected override void OnDisable()
    Overrides
    BaseWieldableItem.OnDisable()

    OnIsBlockedChanged(Boolean)

    Declaration
    protected override void OnIsBlockedChanged(bool blocked)
    Parameters
    Type Name Description
    System.Boolean blocked
    Overrides
    BaseWieldableItem.OnIsBlockedChanged(Boolean)

    OnValidate()

    Declaration
    protected override void OnValidate()
    Overrides
    BaseWieldableItem.OnValidate()

    PrimaryPress()

    Declaration
    public void PrimaryPress()

    PrimaryRelease()

    Declaration
    public void PrimaryRelease()

    ReadProperties(INeoDeserializer, NeoSerializedGameObject)

    Declaration
    public override void ReadProperties(INeoDeserializer reader, NeoSerializedGameObject nsgo)
    Parameters
    Type Name Description
    INeoDeserializer reader
    NeoSerializedGameObject nsgo
    Overrides
    BaseWieldableItem.ReadProperties(INeoDeserializer, NeoSerializedGameObject)

    SecondaryPress()

    Declaration
    public void SecondaryPress()

    SecondaryRelease()

    Declaration
    public void SecondaryRelease()

    ShowCrosshair()

    Declaration
    public void ShowCrosshair()

    Start()

    Declaration
    protected void Start()

    WriteProperties(INeoSerializer, NeoSerializedGameObject, SaveMode)

    Declaration
    public override void WriteProperties(INeoSerializer writer, NeoSerializedGameObject nsgo, SaveMode saveMode)
    Parameters
    Type Name Description
    INeoSerializer writer
    NeoSerializedGameObject nsgo
    SaveMode saveMode
    Overrides
    BaseWieldableItem.WriteProperties(INeoSerializer, NeoSerializedGameObject, SaveMode)

    Events

    onAccuracyChanged

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

    onCrosshairChanged

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

    onPrimaryActionEnd

    Declaration
    public event UnityAction onPrimaryActionEnd
    Event Type
    Type Description
    UnityAction

    onPrimaryActionStart

    Declaration
    public event UnityAction onPrimaryActionStart
    Event Type
    Type Description
    UnityAction

    onSecondaryActionEnd

    Declaration
    public event UnityAction onSecondaryActionEnd
    Event Type
    Type Description
    UnityAction

    onSecondaryActionStart

    Declaration
    public event UnityAction onSecondaryActionStart
    Event Type
    Type Description
    UnityAction

    Implements

    IWieldableTool
    IWieldable
    IMonoBehaviour
    ICrosshairDriver
    IPoseHandler
    Back to top Copyright © 2019 Yondernauts Game Studios Ltd
    Generated with DocFX