Click or drag to resize

CharacterAI Class

Task-based artificial intelligence for character.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.CoreExtension (in NeoAxis.CoreExtension.dll) Version: 2024.1.1.0 (2024.1.1.0)
Syntax
C#
public class CharacterAI : AI

The CharacterAI type exposes the following members.

Constructors
  NameDescription
Public methodCharacterAI
Initializes a new instance of the CharacterAI class
Top
Properties
  NameDescription
Public propertyAllowInteract
Whether to enable the ability to interact with the character.
Public propertyAllowRun
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyCharacter
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyCombatMode
Whether to enabled a combat mode. In the combat mode the AI manages weapons and can drive the vehicle.
Public propertyCombatModeCanMove
Whether to allow control the vehicle in the combat mode.
Public propertyCombatModeFindEnemyDistance
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 propertyCurrentTask (Inherited from AI.)
Public propertyDebugVisualization
Whether to show a calculated path.
Public propertyDialogueFlow
The entry point of the dialogue based on the flow graph.
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 propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyLookAtControlledCharacterByPlayerDistance
The distance at which need to look at the character controlled by the player.
Public propertyLookingForFoodInGroundModeMoveMaxTime
Public propertyLookingForFoodMode
Public propertyLookingForFoodModeArea
Public propertyLookingForFoodModeIdleTime
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 propertyPathfinding
Whether to use pathfinding functionality.
Public propertyPathfindingSpecific
Use only the specified pathfinding object. This is used for scenes in which there are several pathfinding objects.
Public propertyPermanentMessage
The text of the permanent message that is displayed above the controlled object.
(Inherited from AI.)
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 propertyTrafficWalkingMode
Whether to enabled a walking mode. In the walking mode the AI manages walking of character by using the traffic system.
Public propertyTrafficWalkingModeCurrentRoad
Public propertyTrafficWalkingModeCurrentRoadLane
Public propertyTurningSpeedOverride
The speed of turning. Set zero to use default value specified in the character type.
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
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 methodClearTaskQueue (Inherited from AI.)
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 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 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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPathfinding
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 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 methodMoveTo(ObjectInSpace, Boolean, Boolean)
Public methodMoveTo(Vector3, Boolean, Boolean)
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
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodObjectInteractionEnter (Overrides AIObjectInteractionEnter(ObjectInteractionContext).)
Public methodObjectInteractionExit (Overrides AIObjectInteractionExit(ObjectInteractionContext).)
Public methodObjectInteractionGetInfo (Overrides AIObjectInteractionGetInfo(GameMode, InteractiveObjectObjectInfo).)
Public methodObjectInteractionInputMessage (Overrides AIObjectInteractionInputMessage(GameMode, InputMessage).)
Public methodObjectInteractionUpdate (Overrides AIObjectInteractionUpdate(ObjectInteractionContext).)
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 (Overrides ComponentOnEnabledInHierarchyChanged.)
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 (Overrides ComponentOnReceiveNetworkMessageFromClient(ServerNetworkService_ComponentsClientItem, String, ArrayDataReader).)
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 (Overrides AIOnSimulationStep.)
Protected methodOnSimulationStepClient
Called during the simulation step.
(Inherited from Component.)
Protected methodOnUpdate
Called during the update process of all objects.
(Inherited from Component.)
Public methodPathfindingClearData
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 methodStop
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 eventAllowInteractChanged
Occurs when the AllowInteract property value changes.
Public eventAllowRunChanged
Occurs when the AllowRun property value changes.
Public eventCloneEvent
Occurs when object is cloned.
(Inherited from Component.)
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
(Inherited from Component.)
Public eventCombatModeCanMoveChanged
Occurs when the CombatModeCanMove property value changes.
Public eventCombatModeChanged
Occurs when the CombatMode property value changes.
Public eventCombatModeFindEnemyDistanceChanged
Occurs when the CombatModeFindEnemyDistance property value changes.
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 eventDebugVisualizationChanged
Occurs when the DebugVisualization property value changes.
Public eventDialogueFlowChanged
Occurs when the DialogueFlow property value changes.
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 eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventLookAtControlledCharacterByPlayerDistanceChanged
Occurs when the LookAtControlledCharacterByPlayerDistance property value changes.
Public eventLookingForFoodInGroundModeMoveMaxTimeChanged
Occurs when the LookingForFoodInGroundModeMoveMaxTime property value changes.
Public eventLookingForFoodModeAreaChanged
Occurs when the LookingForFoodModeArea property value changes.
Public eventLookingForFoodModeChanged
Occurs when the LookingForFoodMode property value changes.
Public eventLookingForFoodModeIdleTimeChanged
Occurs when the LookingForFoodModeIdleTime 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 eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventNetworkModeChanged
Occurs when the NetworkMode property value changes.
(Inherited from Component.)
Public eventObjectInteractionEnterEvent (Inherited from AI.)
Public eventObjectInteractionExitEvent (Inherited from AI.)
Public eventObjectInteractionGetInfoEvent (Inherited from AI.)
Public eventObjectInteractionInputMessageEvent (Inherited from AI.)
Public eventObjectInteractionUpdateEvent (Inherited from AI.)
Public eventPathfindingChanged
Occurs when the Pathfinding property value changes.
Public eventPathfindingSpecificChanged
Occurs when the PathfindingSpecific property value changes.
Public eventPermanentMessageChanged
Occurs when the PermanentMessage property value changes.
(Inherited from AI.)
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 eventTrafficWalkingModeChanged
Occurs when the TrafficWalkingMode property value changes.
Public eventTrafficWalkingModeCurrentRoadChanged
Occurs when the TrafficWalkingModeCurrentRoad property value changes.
Public eventTrafficWalkingModeCurrentRoadLaneChanged
Occurs when the TrafficWalkingModeCurrentRoadLane property value changes.
Public eventTurningSpeedOverrideChanged
Occurs when the TurningSpeedOverride property value changes.
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Top
Extension Methods
See Also