Weapon |
A definition of the weapon type.
Inheritance HierarchyNamespace: NeoAxis
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.1.1.0 (2026.1.1.0)
SyntaxC#
public class WeaponType : Component, Item3DTypeInterface
The WeaponType type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WeaponType | Initializes a new instance of the WeaponType class |
Properties| Name | Description | |
|---|---|---|
 | AnyData |
The user data of the component.
(Inherited from Component) |
| BaseType |
Gets the base type of the object.
(Inherited from Component) |
| CloneSupport |
Whether the object supports cloning.
(Inherited from Component) |
| Components |
Gets the collection of the child components.
(Inherited from Component) |
| CreatedByBaseType |
Whether the object is created using a base type.
(Inherited from Component) |
| DisplayInEditor |
Whether to show the object in the editor.
(Inherited from Component) |
| Disposed |
Whether the object is disposed.
(Inherited from Component) |
| EditorDocumentConfiguration |
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component) |
| EditorReadOnly |
Whether the object is read only in the editor.
(Inherited from Component) |
| EditorReadOnlyInHierarchy |
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component) |
| Enabled |
Whether the component is enabled. Any functionality of component is not works when it disabled.
(Inherited from Component) |
| EnabledInHierarchy |
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) |
| EnabledInHierarchyAndIsInstance |
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) |
| HandguardFar | |
| HandguardNear | |
| HierarchyController |
Gets the object hierarchy control controller.
(Inherited from Component) |
| IdleAnimation | An animation of the weapon at rest. |
| InventoryImage | The image of the weapon type to preview in the inventory. |
| IsResource | (Inherited from Component) |
| Mesh | The mesh of the weapon. |
| Mode1BulletCount | The number of bullets when fired. |
| Mode1BulletDispersionAngle | The maximal dispersion angle of the bullet when fired. |
| Mode1BulletSpeed | The initial speed of the bullet. |
| Mode1BulletTransform | The initial position, rotation and scale of the bullet. |
| Mode1BulletType | The type of the bullet. |
| Mode1Enabled | Whether to enabled a mode 1. |
| Mode1FireAnimation | An animation of the weapon at fire. |
| Mode1FireAnimationSpeed | The multiplier for playing the fire animation. |
| Mode1FireMuzzleFlashParticle | |
| Mode1FireSound | The sound that is played when a shot occurs. |
| Mode1FiringBeginSound | The sound that is played when the firing begins. |
| Mode1FiringDistance | |
| Mode1FiringFireTime | The time of the bullet creation during firing cycle. |
| Mode1FiringTotalTime | Total time of one firing cycle. |
| Mode1MaxRecoilOffset | |
| Mode1MaxRecoilOffsetTime | |
| Mode1MeleeCollisionDetectionMethod | |
| Mode1MeleeCollisionSound | |
| Mode1MeleeCollisionVolume | |
| Mode1MeleeDamage | |
| Mode1MeleeImpulse | |
| Mode1RecoilForce | |
| Mode1StopMovementWhenFiring | |
| Mode2BulletCount | The number of bullets when fired. |
| Mode2BulletDispersionAngle | The maximal dispersion angle of the bullet when fired. |
| Mode2BulletSpeed | The initial speed of the bullet. |
| Mode2BulletTransform | The initial position, rotation and scale of the bullet. |
| Mode2BulletType | The type of the bullet. |
| Mode2Enabled | Whether to enabled a mode 2. |
| Mode2FireAnimation | An animation of the weapon at fire. |
| Mode2FireAnimationSpeed | The multiplier for playing the fire animation. |
| Mode2FireMuzzleFlashParticle | |
| Mode2FireSound | The sound that is played when a shot occurs. |
| Mode2FiringBeginSound | The sound that is played when the firing begins. |
| Mode2FiringDistance | |
| Mode2FiringFireTime | The time of the bullet creation during firing cycle. |
| Mode2FiringTotalTime | Total time of one firing cycle. |
| Mode2MaxRecoilOffset | |
| Mode2MaxRecoilOffsetTime | |
| Mode2MeleeCollisionDetectionMethod | |
| Mode2MeleeCollisionSound | |
| Mode2MeleeCollisionVolume | |
| Mode2MeleeDamage | |
| Mode2MeleeImpulse | |
| Mode2RecoilForce | |
| Mode2StopMovementWhenFiring | |
| Name |
The name of the component.
(Inherited from Component) |
| NetworkID | (Inherited from Component) |
| NetworkIsClient | (Inherited from Component) |
| NetworkIsServer |
Whether to work in network server mode. It is false until the scene is not loaded.
(Inherited from Component) |
| NetworkIsSingle | (Inherited from Component) |
| NetworkIsSingleOrClient | (Inherited from Component) |
| NetworkMode |
Whether to enable synchronization of the component between server and clients.
(Inherited from Component) |
| NetworkModeUsers | (Inherited from Component) |
| Parent |
Gets the parent object.
(Inherited from Component) |
| ParentRoot |
Gets the parent root object.
(Inherited from Component) |
| PistolGripBottom | |
| PistolGripTop | |
| RemoveFromParentQueued |
Whether the object is placed in the detach queue from the parent.
(Inherited from Component) |
| SaveSupport |
Whether the object supports saving to a file.
(Inherited from Component) |
| ScreenLabel |
The displaying mode of an on-screen label of the component in the scene editor.
(Inherited from Component) |
| TypeSettingsPrivateObjects |
Object settings when used as a type.
(Inherited from Component) |
| Version | |
| WayToUse | How to use the weapon. |
Methods| Name | Description | |
|---|---|---|
| AddComponent |
Adds a component as a child.
(Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessageToEveryone | (Inherited from Component) |
| BeginNetworkMessageToServer | (Inherited from Component) |
| Clone |
Creates a copy of the object.
(Inherited from Component) |
| CreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| DataWasChanged | |
| Dispose |
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindParent(Type) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParent(MetadataTypeInfo) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParentT |
Finds the parent of the specified type.
(Inherited from Component) |
| FindThisOrParent(Type) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParent(MetadataTypeInfo) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParentT |
Finds the parent or self of the specified type.
(Inherited from Component) |
| GetAllParents |
Gets all parents of the component.
(Inherited from Component) |
| GetArmsCenter | |
| GetComponent(String, Boolean) |
Finds a child component by name.
(Inherited from Component) |
| GetComponent(Type, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponent(MetadataTypeInfo, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentT(Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentByNameWithIndex |
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component) |
| GetComponentByPath |
Finds a child component by path.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean) |
Finds child components.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent) |
Finds child components.
(Inherited from Component) |
| GetComponents(Type, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT) |
Finds child components of the specified type.
(Inherited from Component) |
| GetHandguardCenter | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPathFromParent |
Returns the path to the object from the parent.
(Inherited from Component) |
| GetPathFromRoot |
Returns the object's access path from the root object.
(Inherited from Component) |
| GetPistolGripCenter | |
| GetProvidedType |
Returns a type when the object is used as a type.
(Inherited from Component) |
| GetScreenLabelInfo | (Inherited from Component) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsMethodInvoking |
Checks if a method is running over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MetadataGetMemberBySignature |
Returns the object metadata member by name.
(Inherited from Component) |
| MetadataGetMembers |
Returns the object metadata members.
(Inherited from Component) |
| MethodInvoke |
Calls a method by name.
(Inherited from Component) |
| MethodInvokeCancel |
Cancels the execution of selected method that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| MethodInvokeCancelAll |
Cancels the execution of all methods that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| NetworkDisablePropertySynchronization | (Inherited from Component) |
| NetworkIsDisabledPropertySynchronization | (Inherited from Component) |
| NetworkModeAddUser | (Inherited from Component) |
| NetworkModeIsEnabledForUser | (Inherited from Component) |
| NetworkModeRemoveUser | (Inherited from Component) |
| NetworkRestoreDisabledPropertySynchronization | (Inherited from Component) |
| NewObjectSetDefaultConfiguration | (Overrides ComponentNewObjectSetDefaultConfiguration(Boolean)) |
| NewObjectSetDefaultConfigurationUpdate |
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component) |
| OnAddedToParent |
Called when a component is added to the parent.
(Inherited from Component) |
| OnClientConnectedAfterRootComponentEnabled | (Inherited from Component) |
| OnClientConnectedBeforeRootComponentEnabled | (Inherited from Component) |
| OnClientDisconnected | (Inherited from Component) |
| OnClone |
Called when the object is cloned.
(Inherited from Component) |
| OnComponentAdded |
Called when a child component is added.
(Inherited from Component) |
| OnComponentRemoved |
Called when a child component is removed.
(Inherited from Component) |
| OnDisabled |
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnDisabledInSimulation |
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) |
| OnDispose |
Called when the object is disposed.
(Inherited from Component) |
| OnEditorGetTextInfoCenterBottomCorner | (Inherited from Component) |
| OnEnabled |
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnEnabledChanged |
Called when value of Enabled property is changed.
(Inherited from Component) |
| OnEnabledInHierarchyChanged |
Called when value of EnabledInHierarchy property is changed.
(Inherited from Component) |
| OnEnabledInSimulation |
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) |
| OnLoad |
Called during object loading.
(Inherited from Component) |
| OnMetadataGetMemberBySignature |
Called when the object metadata member is received by name.
(Inherited from Component) |
| OnMetadataGetMembers |
Called upon receipt of the object's metadata members.
(Inherited from Component) |
| OnMetadataGetMembersFilter | (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean)) |
| OnPreloadResources |
Called when preloading the resources used by the object.
(Inherited from Component) |
| OnReceiveNetworkMessageFromClient | (Inherited from Component) |
| OnReceiveNetworkMessageFromServer | (Inherited from Component) |
| OnRemovedFromParent |
Called when a component is removed from the parent.
(Inherited from Component) |
| OnSave |
Called during object saving.
(Inherited from Component) |
| OnSimulationStep |
Called during the simulation step.
(Inherited from Component) |
| OnSimulationStepClient |
Called during the simulation step.
(Inherited from Component) |
| OnUpdate |
Called during the update process of all objects.
(Inherited from Component) |
| PreloadResources |
Preload resources used by the object.
(Inherited from Component) |
| PropertyGet(String, Object, Boolean) |
Gets the value of a property by name.
(Inherited from Component) |
| PropertySet |
Sets the value of a property by name.
(Inherited from Component) |
| RemoveAllComponents |
Removes all child components.
(Inherited from Component) |
| RemoveComponent |
Removes a child component.
(Inherited from Component) |
| RemoveFromParent |
Detaches the object from its parent.
(Inherited from Component) |
| ToString |
Returns the name and type of the object as a string.
(Inherited from Component) |
| TypeSettingsIsPublic |
Checks whether the object provided as a type is public.
(Inherited from Component) |
| TypeSettingsIsPublicMember |
Checks whether the member is set up as public.
(Inherited from Component) |
Events| Name | Description | |
|---|---|---|
 | AddedToParent |
Occurs when a component is added to the parent.
(Inherited from Component) |
| CloneEvent |
Occurs when object is cloned.
(Inherited from Component) |
| CloneSupportChanged |
Occurs after changing value of CloneSupport property.
(Inherited from Component) |
| ComponentAdded |
Occurs when a child component is added.
(Inherited from Component) |
| ComponentRemoved |
Occurs when a child component is removed.
(Inherited from Component) |
| ComponentsChanged |
Occurs when the set of children is changed.
(Inherited from Component) |
| DisabledEvent |
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component) |
| DisabledInSimulation |
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) |
| DisplayInEditorChanged |
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component) |
| DisposeEvent |
Occurs when the object is disposed.
(Inherited from Component) |
| EnabledChanged |
Occurs when the Enabled property value changes.
(Inherited from Component) |
| EnabledEvent |
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component) |
| EnabledInHierarchyChanged |
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component) |
| EnabledInSimulation |
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) |
| HandguardFarChanged | Occurs when the HandguardFar property value changes. |
| HandguardNearChanged | Occurs when the HandguardNear property value changes. |
| IdleAnimationChanged | Occurs when the IdleAnimation property value changes. |
| InventoryImageChanged | Occurs when the InventoryImage property value changes. |
| LoadEvent |
Occurs during object loading.
(Inherited from Component) |
| MeshChanged | Occurs when the Mesh property value changes. |
| MetadataGetMemberBySignatureEvent |
Occurs when the object metadata member is received by name.
(Inherited from Component) |
| MetadataGetMembersEvent |
Occurs upon receipt of the object's metadata members.
(Inherited from Component) |
| MetadataGetMembersFilterEvent |
Occurs when filtering receive members of the object metadata.
(Inherited from Component) |
| Mode1BulletCountChanged | Occurs when the Mode1BulletCount property value changes. |
| Mode1BulletDispersionAngleChanged | Occurs when the Mode1BulletDispersionAngle property value changes. |
| Mode1BulletSpeedChanged | Occurs when the Mode1BulletSpeed property value changes. |
| Mode1BulletTransformChanged | Occurs when the Mode1BulletTransform property value changes. |
| Mode1BulletTypeChanged | Occurs when the Mode1BulletType property value changes. |
| Mode1EnabledChanged | Occurs when the Mode1Enabled property value changes. |
| Mode1FireAnimationChanged | Occurs when the Mode1FireAnimation property value changes. |
| Mode1FireAnimationSpeedChanged | Occurs when the Mode1FireAnimationSpeed property value changes. |
| Mode1FireMuzzleFlashParticleChanged | Occurs when the Mode1FireMuzzleFlashParticle property value changes. |
| Mode1FireSoundChanged | Occurs when the Mode1FireSound property value changes. |
| Mode1FiringBeginSoundChanged | Occurs when the Mode1FiringBeginSound property value changes. |
| Mode1FiringDistanceChanged | Occurs when the Mode1FiringDistance property value changes. |
| Mode1FiringFireTimeChanged | Occurs when the Mode1FiringFireTime property value changes. |
| Mode1FiringTotalTimeChanged | Occurs when the Mode1FiringTotalTime property value changes. |
| Mode1MaxRecoilOffsetChanged | Occurs when the Mode1MaxRecoilOffset property value changes. |
| Mode1MaxRecoilOffsetTimeChanged | Occurs when the Mode1MaxRecoilOffsetTime property value changes. |
| Mode1MeleeCollisionDetectionMethodChanged | Occurs when the Mode1MeleeCollisionDetectionMethod property value changes. |
| Mode1MeleeCollisionSoundChanged | Occurs when the Mode1MeleeCollisionSound property value changes. |
| Mode1MeleeCollisionVolumeChanged | Occurs when the Mode1MeleeCollisionVolume property value changes. |
| Mode1MeleeDamageChanged | Occurs when the Mode1MeleeDamage property value changes. |
| Mode1MeleeImpulseChanged | Occurs when the Mode1MeleeImpulse property value changes. |
| Mode1RecoilForceChanged | Occurs when the Mode1RecoilForce property value changes. |
| Mode1StopMovementWhenFiringChanged | Occurs when the Mode1StopMovementWhenFiring property value changes. |
| Mode2BulletCountChanged | Occurs when the Mode2BulletCount property value changes. |
| Mode2BulletDispersionAngleChanged | Occurs when the Mode2BulletDispersionAngle property value changes. |
| Mode2BulletSpeedChanged | Occurs when the Mode2BulletSpeed property value changes. |
| Mode2BulletTransformChanged | Occurs when the Mode2BulletTransform property value changes. |
| Mode2BulletTypeChanged | Occurs when the Mode2BulletType property value changes. |
| Mode2EnabledChanged | Occurs when the Mode2Enabled property value changes. |
| Mode2FireAnimationChanged | Occurs when the Mode2FireAnimation property value changes. |
| Mode2FireAnimationSpeedChanged | Occurs when the Mode2FireAnimationSpeed property value changes. |
| Mode2FireMuzzleFlashParticleChanged | Occurs when the Mode2FireMuzzleFlashParticle property value changes. |
| Mode2FireSoundChanged | Occurs when the Mode2FireSound property value changes. |
| Mode2FiringBeginSoundChanged | Occurs when the Mode2FiringBeginSound property value changes. |
| Mode2FiringDistanceChanged | Occurs when the Mode2FiringDistance property value changes. |
| Mode2FiringFireTimeChanged | Occurs when the Mode2FiringFireTime property value changes. |
| Mode2FiringTotalTimeChanged | Occurs when the Mode2FiringTotalTime property value changes. |
| Mode2MaxRecoilOffsetChanged | Occurs when the Mode2MaxRecoilOffset property value changes. |
| Mode2MaxRecoilOffsetTimeChanged | Occurs when the Mode2MaxRecoilOffsetTime property value changes. |
| Mode2MeleeCollisionDetectionMethodChanged | Occurs when the Mode2MeleeCollisionDetectionMethod property value changes. |
| Mode2MeleeCollisionSoundChanged | Occurs when the Mode2MeleeCollisionSound property value changes. |
| Mode2MeleeCollisionVolumeChanged | Occurs when the Mode2MeleeCollisionVolume property value changes. |
| Mode2MeleeDamageChanged | Occurs when the Mode2MeleeDamage property value changes. |
| Mode2MeleeImpulseChanged | Occurs when the Mode2MeleeImpulse property value changes. |
| Mode2RecoilForceChanged | Occurs when the Mode2RecoilForce property value changes. |
| Mode2StopMovementWhenFiringChanged | Occurs when the Mode2StopMovementWhenFiring property value changes. |
| NameChanged |
Occurs when component name is changed.
(Inherited from Component) |
| NetworkModeChanged | Occurs when the NetworkMode property value changes. (Inherited from Component) |
| PistolGripBottomChanged | Occurs when the PistolGripBottom property value changes. |
| PistolGripTopChanged | Occurs when the PistolGripTop property value changes. |
| PreloadResourcesEvent |
Occurs when preloading the resources used by the object.
(Inherited from Component) |
| ReceiveNetworkMessageFromClient | (Inherited from Component) |
| ReceiveNetworkMessageFromServer | (Inherited from Component) |
| RemovedFromParent |
Occurs when a component is removed from the parent.
(Inherited from Component) |
| SaveEvent |
Occurs during object saving.
(Inherited from Component) |
| SaveSupportChanged |
Occurs after changing value of SaveSupport property.
(Inherited from Component) |
| ScreenLabelChanged | Occurs when the ScreenLabel property value changes. (Inherited from Component) |
| SimulationStep |
Occurs during the simulation step.
(Inherited from Component) |
| SimulationStepClient |
Occurs during the simulation step.
(Inherited from Component) |
| UpdateEvent |
Occurs during the update process of all objects.
(Inherited from Component) |
| WayToUseChanged | Occurs when the WayToUse property value changes. |
Fields| Name | Description | |
|---|---|---|
 | EditorCameraTransform |
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx) |
| PropertyGet |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertyGetT |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx) |
See Also