Character |
A definition of the character 2D type.
Inheritance HierarchyNamespace: NeoAxis
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.1.1.0 (2026.1.1.0)
SyntaxC#
public class Character2DType : Component
The Character2DType type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Character2DType | Initializes a new instance of the Character2DType class |
Properties| Name | Description | |
|---|---|---|
 | AnyData |
The user data of the component.
(Inherited from Component) |
| ApplyGroundVelocity | Whether to consider the speed of the body on which the character is standing. |
| 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) |
| CrouchingForce | |
| CrouchingHeight | |
| CrouchingMaxSpeed | |
| CrouchingPositionToGroundHeight | |
| CrouchingSupport | |
| CrouchingWalkUpHeight | |
| 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) |
| EyePosition | The position of the eyes relative to the position of the character. |
| FlyAnimation | Character flying animation. |
| FlyControlForce | Physical force applied to the body for flying. |
| FlyControlMaxSpeed | Maximum speed of character control in flight. |
| FlyControlSupport | Can a character control himself in flight. |
| Height | The height of the character. |
| HierarchyController |
Gets the object hierarchy control controller.
(Inherited from Component) |
| IdleAnimation | Animation of character at rest. |
| InitialScale | The scale of the character at creation. |
| IsResource | (Inherited from Component) |
| JumpAnimation | Character jumping animation. |
| JumpSound | |
| JumpSpeed | The vertical speed of a jump. |
| JumpSupport | Can the character jump. |
| LinearDampingFly | The value of linear dumping when a character is flying. |
| LinearDampingOnGroundIdle | The value of linear dumping when a character is standing on the ground. |
| LinearDampingOnGroundMove | The value of linear dumping when a character is standing on the ground. |
| Mass | The mass of the character. |
| MaxSlopeAngle | The maximum angle of the surface on which the character can stand. |
| MinSpeedToSleepBody | |
| 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) |
| PositionToGroundHeight | The distance from the character position to the ground. |
| Radius | The radius of the collision capsule. |
| RemoveFromParentQueued |
Whether the object is placed in the detach queue from the parent.
(Inherited from Component) |
| RunAnimation | Character running animation. |
| RunAnimationSpeed | The multiplier for playing the running animation depending on the speed of the character. |
| RunForce | Physical force applied to the body for running. |
| RunForwardMaxSpeed | Maximum speed when running forward. |
| RunSupport | Can the character run. |
| 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 | |
| WalkAnimation | Character walking animation. |
| WalkAnimationSpeed | The multiplier for playing the walking animation depending on the speed of the character. |
| WalkForce | Physical force applied to the body for walking. |
| WalkForwardMaxSpeed | Maximum speed when walking forward. |
| WalkUpHeight | The height to which the character can rise. Set 0 to disable functionality of walking up. |
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) |
| GetBodyFormInfo | |
| 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) |
| 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) |
| 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 |
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component) |
| 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) |
| ApplyGroundVelocityChanged | Occurs when the ApplyGroundVelocity property value changes. |
| 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) |
| CrouchingForceChanged | Occurs when the CrouchingForce property value changes. |
| CrouchingHeightChanged | Occurs when the CrouchingHeight property value changes. |
| CrouchingMaxSpeedChanged | Occurs when the CrouchingMaxSpeed property value changes. |
| CrouchingPositionToGroundHeightChanged | Occurs when the CrouchingPositionToGroundHeight property value changes. |
| CrouchingSupportChanged | Occurs when the CrouchingSupport property value changes. |
| CrouchingWalkUpHeightChanged | Occurs when the CrouchingWalkUpHeight property value changes. |
| 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) |
| EyePositionChanged | Occurs when the EyePosition property value changes. |
| FlyAnimationChanged | Occurs when the FlyAnimation property value changes. |
| FlyControlForceChanged | Occurs when the FlyControlForce property value changes. |
| FlyControlMaxSpeedChanged | Occurs when the FlyControlMaxSpeed property value changes. |
| FlyControlSupportChanged | Occurs when the FlyControlSupport property value changes. |
| HeightChanged | Occurs when the Height property value changes. |
| IdleAnimationChanged | Occurs when the IdleAnimation property value changes. |
| InitialScaleChanged | Occurs when the InitialScale property value changes. |
| JumpAnimationChanged | Occurs when the JumpAnimation property value changes. |
| JumpSoundChanged | Occurs when the JumpSound property value changes. |
| JumpSpeedChanged | Occurs when the JumpSpeed property value changes. |
| JumpSupportChanged | Occurs when the JumpSupport property value changes. |
| LinearDampingFlyChanged | Occurs when the LinearDampingFly property value changes. |
| LinearDampingOnGroundChanged | Occurs when the LinearDampingOnGroundMove property value changes. |
| LinearDampingOnGroundIdleChanged | Occurs when the LinearDampingOnGroundIdle property value changes. |
| LoadEvent |
Occurs during object loading.
(Inherited from Component) |
| MassChanged | Occurs when the Mass property value changes. |
| MaxSlopeAngleChanged | Occurs when the MaxSlopeAngle 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) |
| MinSpeedToSleepBodyChanged | Occurs when the MinSpeedToSleepBody property value changes. |
| NameChanged |
Occurs when component name is changed.
(Inherited from Component) |
| NetworkModeChanged | Occurs when the NetworkMode property value changes. (Inherited from Component) |
| PositionToGroundHeightChanged | Occurs when the PositionToGroundHeight property value changes. |
| PreloadResourcesEvent |
Occurs when preloading the resources used by the object.
(Inherited from Component) |
| RadiusChanged | Occurs when the Radius property value changes. |
| ReceiveNetworkMessageFromClient | (Inherited from Component) |
| ReceiveNetworkMessageFromServer | (Inherited from Component) |
| RemovedFromParent |
Occurs when a component is removed from the parent.
(Inherited from Component) |
| RunAnimationChanged | Occurs when the RunAnimation property value changes. |
| RunAnimationSpeedChanged | Occurs when the RunAnimationSpeed property value changes. |
| RunForceChanged | Occurs when the RunForce property value changes. |
| RunForwardMaxSpeedChanged | Occurs when the RunForwardMaxSpeed property value changes. |
| RunSupportChanged | Occurs when the RunSupport property value changes. |
| 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) |
| WalkAnimationChanged | Occurs when the WalkAnimation property value changes. |
| WalkAnimationSpeedChanged | Occurs when the WalkAnimationSpeed property value changes. |
| WalkForceChanged | Occurs when the WalkForce property value changes. |
| WalkForwardMaxSpeedChanged | Occurs when the WalkForwardMaxSpeed property value changes. |
| WalkUpHeightChanged | Occurs when the WalkUpHeight property value changes. |
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