Click or drag to resize

WeaponType Class

A definition of the weapon type.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.CoreExtension (in NeoAxis.CoreExtension.dll) Version: 2024.1.1.0 (2024.1.1.0)
Syntax
C#
public class WeaponType : Component, ItemTypeInterface

The WeaponType type exposes the following members.

Constructors
  NameDescription
Public methodWeaponType
Initializes a new instance of the WeaponType class
Top
Properties
  NameDescription
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyComponents
Gets the collection of the child components.
(Inherited from Component.)
Public propertyCreatedByBaseType
Whether the object is created using a base type.
(Inherited from Component.)
Public propertyDisplayInEditor
Whether to show the object in the editor.
(Inherited from Component.)
Public propertyDisposed
Whether the object is disposed.
(Inherited from Component.)
Public propertyEditorDocumentConfiguration
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component.)
Public propertyEditorReadOnly
Whether the object is read only in the editor.
(Inherited from Component.)
Public propertyEditorReadOnlyInHierarchy
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component.)
Public propertyEnabled
Whether the component is enabled. Any functionality of component is not works when it disabled.
(Inherited from Component.)
Public propertyEnabledInHierarchy
Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyEnabledInHierarchyAndIsInstance
Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyHandguardFar
Public propertyHandguardNear
Public propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyIdleAnimation
An animation of the weapon at rest.
Public propertyInventoryImage
The image of the weapon type to preview in the inventory.
Public propertyMesh
The mesh of the weapon.
Public propertyMode1BulletCount
The number of bullets when fired.
Public propertyMode1BulletDispersionAngle
The maximal dispersion angle of the bullet when fired.
Public propertyMode1BulletSpeed
The initial speed of the bullet.
Public propertyMode1BulletTransform
The initial position, rotation and scale of the bullet.
Public propertyMode1BulletType
The type of the bullet.
Public propertyMode1Enabled
Whether to enabled a mode 1.
Public propertyMode1FireAnimation
An animation of the weapon at fire.
Public propertyMode1FireAnimationSpeed
The multiplier for playing the fire animation.
Public propertyMode1FireMuzzleFlashParticle
Public propertyMode1FireSound
The sound that is played when a shot occurs.
Public propertyMode1FiringBeginSound
The sound that is played when the firing begins.
Public propertyMode1FiringDistance
Public propertyMode1FiringFireTime
The time of the bullet creation during firing cycle.
Public propertyMode1FiringTotalTime
Total time of one firing cycle.
Public propertyMode1MaxRecoilOffset
Public propertyMode1MaxRecoilOffsetTime
Public propertyMode1MeleeCollisionDetectionMethod
Public propertyMode1MeleeCollisionSound
Public propertyMode1MeleeCollisionVolume
Public propertyMode1MeleeDamage
Public propertyMode1MeleeImpulse
Public propertyMode1StopMovementWhenFiring
Public propertyMode2BulletCount
The number of bullets when fired.
Public propertyMode2BulletDispersionAngle
The maximal dispersion angle of the bullet when fired.
Public propertyMode2BulletSpeed
The initial speed of the bullet.
Public propertyMode2BulletTransform
The initial position, rotation and scale of the bullet.
Public propertyMode2BulletType
The type of the bullet.
Public propertyMode2Enabled
Whether to enabled a mode 2.
Public propertyMode2FireAnimation
An animation of the weapon at fire.
Public propertyMode2FireAnimationSpeed
The multiplier for playing the fire animation.
Public propertyMode2FireMuzzleFlashParticle
Public propertyMode2FireSound
The sound that is played when a shot occurs.
Public propertyMode2FiringBeginSound
The sound that is played when the firing begins.
Public propertyMode2FiringDistance
Public propertyMode2FiringFireTime
The time of the bullet creation during firing cycle.
Public propertyMode2FiringTotalTime
Total time of one firing cycle.
Public propertyMode2MaxRecoilOffset
Public propertyMode2MaxRecoilOffsetTime
Public propertyMode2MeleeCollisionDetectionMethod
Public propertyMode2MeleeCollisionSound
Public propertyMode2MeleeCollisionVolume
Public propertyMode2MeleeDamage
Public propertyMode2MeleeImpulse
Public propertyMode2StopMovementWhenFiring
Public propertyName
The name of the component.
(Inherited from Component.)
Public propertyNetworkID (Inherited from Component.)
Public propertyNetworkIsClient (Inherited from Component.)
Public propertyNetworkIsServer
Whether to work in network server mode. It is false until the scene is not loaded.
(Inherited from Component.)
Public propertyNetworkIsSingle (Inherited from Component.)
Public propertyNetworkIsSingleOrClient (Inherited from Component.)
Public propertyNetworkMode
Whether to enable synchronization of the component between server and clients.
(Inherited from Component.)
Public propertyNetworkModeUsers (Inherited from Component.)
Public propertyParent
Gets the parent object.
(Inherited from Component.)
Public propertyParentRoot
Gets the parent root object.
(Inherited from Component.)
Public propertyPistolGripBottom
Public propertyPistolGripTop
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
(Inherited from Component.)
Public propertySaveSupport
Whether the object supports saving to a file.
(Inherited from Component.)
Public propertyScreenLabel
The displaying mode of an on-screen label of the component in the scene editor.
(Inherited from Component.)
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
Public propertyVersion
Public propertyWayToUse
How to use the weapon.
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
(Inherited from Component.)
Public methodBeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String) (Inherited from Component.)
Public methodBeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String) (Inherited from Component.)
Public methodBeginNetworkMessage(ServerNetworkService_UsersUserInfo, String) (Inherited from Component.)
Public methodBeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String) (Inherited from Component.)
Public methodBeginNetworkMessageToEveryone (Inherited from Component.)
Public methodBeginNetworkMessageToServer (Inherited from Component.)
Public methodClone
Creates a copy of the object.
(Inherited from Component.)
Public methodCreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum)
Creates a child component.
(Inherited from Component.)
Public methodDataWasChanged
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component.)
Public methodEndNetworkMessage (Inherited from Component.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindParent(Type)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParent(MetadataTypeInfo)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParentT
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(Type)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(MetadataTypeInfo)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParentT
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodGetAllParents
Gets all parents of the component.
(Inherited from Component.)
Public methodGetArmsCenter
Public methodGetComponent(String, Boolean)
Finds a child component by name.
(Inherited from Component.)
Public methodGetComponent(Type, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentT(Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentByNameWithIndex
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component.)
Public methodGetComponentByPath
Finds a child component by path.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetHandguardCenter
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPathFromParent
Returns the path to the object from the parent.
(Inherited from Component.)
Public methodGetPathFromRoot
Returns the object's access path from the root object.
(Inherited from Component.)
Public methodGetPistolGripCenter
Public methodGetProvidedType
Returns a type when the object is used as a type.
(Inherited from Component.)
Public methodGetScreenLabelInfo (Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking (Inherited from Component.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetadataGetMemberBySignature
Returns the object metadata member by name.
(Inherited from Component.)
Public methodMetadataGetMembers
Returns the object metadata members.
(Inherited from Component.)
Public methodMethodInvoke
Calls a method by name.
(Inherited from Component.)
Public methodMethodInvokeCancel (Inherited from Component.)
Public methodMethodInvokeCancelAll (Inherited from Component.)
Public methodNetworkDisablePropertySynchronization (Inherited from Component.)
Public methodNetworkIsDisabledPropertySynchronization (Inherited from Component.)
Public methodNetworkModeAddUser (Inherited from Component.)
Public methodNetworkModeIsEnabledForUser (Inherited from Component.)
Public methodNetworkModeRemoveUser (Inherited from Component.)
Public methodNetworkRestoreDisabledPropertySynchronization (Inherited from Component.)
Public methodNewObjectSetDefaultConfiguration (Overrides ComponentNewObjectSetDefaultConfiguration(Boolean).)
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component.)
Protected methodOnAddedToParent
Called when a component is added to the parent.
(Inherited from Component.)
Protected methodOnClientConnectedAfterRootComponentEnabled (Inherited from Component.)
Protected methodOnClientConnectedBeforeRootComponentEnabled (Inherited from Component.)
Protected methodOnClientDisconnected (Inherited from Component.)
Protected methodOnClone
Called when the object is cloned.
(Inherited from Component.)
Protected methodOnComponentAdded
Called when a child component is added.
(Inherited from Component.)
Protected methodOnComponentRemoved
Called when a child component is removed.
(Inherited from Component.)
Protected methodOnDisabled
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDisabledInSimulation
Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDispose
Called when the object is disposed.
(Inherited from Component.)
Protected methodOnEditorGetTextInfoCenterBottomCorner (Inherited from Component.)
Protected methodOnEnabled
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledChanged
Called when value of Enabled property is changed.
(Inherited from Component.)
Protected methodOnEnabledInHierarchyChanged
Called when value of EnabledInHierarchy property is changed.
(Inherited from Component.)
Protected methodOnEnabledInSimulation
Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnLoad
Called during object loading.
(Inherited from Component.)
Protected methodOnMetadataGetMemberBySignature
Called when the object metadata member is received by name.
(Inherited from Component.)
Protected methodOnMetadataGetMembers
Called upon receipt of the object's metadata members.
(Inherited from Component.)
Protected methodOnMetadataGetMembersFilter (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean).)
Protected methodOnPreloadResources
Called when preloading the resources used by the object.
(Inherited from Component.)
Protected methodOnReceiveNetworkMessageFromClient (Inherited from Component.)
Protected methodOnReceiveNetworkMessageFromServer (Inherited from Component.)
Protected methodOnRemovedFromParent
Called when a component is removed from the parent.
(Inherited from Component.)
Protected methodOnSave
Called during object saving.
(Inherited from Component.)
Protected methodOnSimulationStep
Called during the simulation step.
(Inherited from Component.)
Protected methodOnSimulationStepClient
Called during the simulation step.
(Inherited from Component.)
Protected methodOnUpdate
Called during the update process of all objects.
(Inherited from Component.)
Public methodPreloadResources
Preload resources used by the object.
(Inherited from Component.)
Public methodPropertyGet(String, Object, Boolean)
Gets the value of a property by name.
(Inherited from Component.)
Public methodPropertySet
Sets the value of a property by name.
(Inherited from Component.)
Public methodRemoveAllComponents
Removes all child components.
(Inherited from Component.)
Public methodRemoveComponent
Removes a child component.
(Inherited from Component.)
Public methodRemoveFromParent
Detaches the object from its parent.
(Inherited from Component.)
Public methodToString
Returns the name and type of the object as a string.
(Inherited from Component.)
Public methodTypeSettingsIsPublic
Checks whether the object provided as a type is public.
(Inherited from Component.)
Public methodTypeSettingsIsPublicMember
Checks whether the member is set up as public.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventCloneEvent
Occurs when object is cloned.
(Inherited from Component.)
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
(Inherited from Component.)
Public eventComponentAdded
Occurs when a child component is added.
(Inherited from Component.)
Public eventComponentRemoved
Occurs when a child component is removed.
(Inherited from Component.)
Public eventComponentsChanged
Occurs when the set of children is changed.
(Inherited from Component.)
Public eventDisabledEvent
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisabledInSimulation
Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component.)
Public eventDisposeEvent
Occurs when the object is disposed.
(Inherited from Component.)
Public eventEnabledChanged
Occurs when the Enabled property value changes.
(Inherited from Component.)
Public eventEnabledEvent
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventEnabledInHierarchyChanged
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component.)
Public eventEnabledInSimulation
Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventHandguardFarChanged
Occurs when the HandguardFar property value changes.
Public eventHandguardNearChanged
Occurs when the HandguardNear property value changes.
Public eventIdleAnimationChanged
Occurs when the IdleAnimation property value changes.
Public eventInventoryImageChanged
Occurs when the InventoryImage property value changes.
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventMeshChanged
Occurs when the Mesh property value changes.
Public eventMetadataGetMemberBySignatureEvent
Occurs when the object metadata member is received by name.
(Inherited from Component.)
Public eventMetadataGetMembersEvent
Occurs upon receipt of the object's metadata members.
(Inherited from Component.)
Public eventMetadataGetMembersFilterEvent
Occurs when filtering receive members of the object metadata.
(Inherited from Component.)
Public eventMode1BulletCountChanged
Occurs when the Mode1BulletCount property value changes.
Public eventMode1BulletDispersionAngleChanged
Occurs when the Mode1BulletDispersionAngle property value changes.
Public eventMode1BulletSpeedChanged
Occurs when the Mode1BulletSpeed property value changes.
Public eventMode1BulletTransformChanged
Occurs when the Mode1BulletTransform property value changes.
Public eventMode1BulletTypeChanged
Occurs when the Mode1BulletType property value changes.
Public eventMode1EnabledChanged
Occurs when the Mode1Enabled property value changes.
Public eventMode1FireAnimationChanged
Occurs when the Mode1FireAnimation property value changes.
Public eventMode1FireAnimationSpeedChanged
Occurs when the Mode1FireAnimationSpeed property value changes.
Public eventMode1FireMuzzleFlashParticleChanged
Occurs when the Mode1FireMuzzleFlashParticle property value changes.
Public eventMode1FireSoundChanged
Occurs when the Mode1FireSound property value changes.
Public eventMode1FiringBeginSoundChanged
Occurs when the Mode1FiringBeginSound property value changes.
Public eventMode1FiringDistanceChanged
Occurs when the Mode1FiringDistance property value changes.
Public eventMode1FiringFireTimeChanged
Occurs when the Mode1FiringFireTime property value changes.
Public eventMode1FiringTotalTimeChanged
Occurs when the Mode1FiringTotalTime property value changes.
Public eventMode1MaxRecoilOffsetChanged
Occurs when the Mode1MaxRecoilOffset property value changes.
Public eventMode1MaxRecoilOffsetTimeChanged
Occurs when the Mode1MaxRecoilOffsetTime property value changes.
Public eventMode1MeleeCollisionDetectionMethodChanged
Occurs when the Mode1MeleeCollisionDetectionMethod property value changes.
Public eventMode1MeleeCollisionSoundChanged
Occurs when the Mode1MeleeCollisionSound property value changes.
Public eventMode1MeleeCollisionVolumeChanged
Occurs when the Mode1MeleeCollisionVolume property value changes.
Public eventMode1MeleeDamageChanged
Occurs when the Mode1MeleeDamage property value changes.
Public eventMode1MeleeImpulseChanged
Occurs when the Mode1MeleeImpulse property value changes.
Public eventMode1StopMovementWhenFiringChanged
Occurs when the Mode1StopMovementWhenFiring property value changes.
Public eventMode2BulletCountChanged
Occurs when the Mode2BulletCount property value changes.
Public eventMode2BulletDispersionAngleChanged
Occurs when the Mode2BulletDispersionAngle property value changes.
Public eventMode2BulletSpeedChanged
Occurs when the Mode2BulletSpeed property value changes.
Public eventMode2BulletTransformChanged
Occurs when the Mode2BulletTransform property value changes.
Public eventMode2BulletTypeChanged
Occurs when the Mode2BulletType property value changes.
Public eventMode2EnabledChanged
Occurs when the Mode2Enabled property value changes.
Public eventMode2FireAnimationChanged
Occurs when the Mode2FireAnimation property value changes.
Public eventMode2FireAnimationSpeedChanged
Occurs when the Mode2FireAnimationSpeed property value changes.
Public eventMode2FireMuzzleFlashParticleChanged
Occurs when the Mode2FireMuzzleFlashParticle property value changes.
Public eventMode2FireSoundChanged
Occurs when the Mode2FireSound property value changes.
Public eventMode2FiringBeginSoundChanged
Occurs when the Mode2FiringBeginSound property value changes.
Public eventMode2FiringDistanceChanged
Occurs when the Mode2FiringDistance property value changes.
Public eventMode2FiringFireTimeChanged
Occurs when the Mode2FiringFireTime property value changes.
Public eventMode2FiringTotalTimeChanged
Occurs when the Mode2FiringTotalTime property value changes.
Public eventMode2MaxRecoilOffsetChanged
Occurs when the Mode2MaxRecoilOffset property value changes.
Public eventMode2MaxRecoilOffsetTimeChanged
Occurs when the Mode2MaxRecoilOffsetTime property value changes.
Public eventMode2MeleeCollisionDetectionMethodChanged
Occurs when the Mode2MeleeCollisionDetectionMethod property value changes.
Public eventMode2MeleeCollisionSoundChanged
Occurs when the Mode2MeleeCollisionSound property value changes.
Public eventMode2MeleeCollisionVolumeChanged
Occurs when the Mode2MeleeCollisionVolume property value changes.
Public eventMode2MeleeDamageChanged
Occurs when the Mode2MeleeDamage property value changes.
Public eventMode2MeleeImpulseChanged
Occurs when the Mode2MeleeImpulse property value changes.
Public eventMode2StopMovementWhenFiringChanged
Occurs when the Mode2StopMovementWhenFiring property value changes.
Public eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventNetworkModeChanged
Occurs when the NetworkMode property value changes.
(Inherited from Component.)
Public eventPistolGripBottomChanged
Occurs when the PistolGripBottom property value changes.
Public eventPistolGripTopChanged
Occurs when the PistolGripTop property value changes.
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventReceiveNetworkMessageFromClient (Inherited from Component.)
Public eventReceiveNetworkMessageFromServer (Inherited from Component.)
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
(Inherited from Component.)
Public eventSaveEvent
Occurs during object saving.
(Inherited from Component.)
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
(Inherited from Component.)
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventSimulationStepClient
Occurs during the simulation step.
(Inherited from Component.)
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventWayToUseChanged
Occurs when the WayToUse property value changes.
Top
Fields
  NameDescription
Public fieldEditorCameraTransform
Top
Extension Methods
See Also