Search Results for

    Show / Hide Table of Contents

    Class CharacterController3D

    StaticBody 3D enables your entities to act under the control of physics as a static body.

    Inheritance
    object
    IdentifiableObject
    DependencyObject
    AttachableObject
    PrefabInstanceObject
    Component
    Behavior
    PhysicBody3D
    PhysicBody3D<IGhostBody3D, GhostBodyDef3D>
    CharacterController3D
    Implements
    IDependencyObject
    Inherited Members
    PhysicBody3D<IGhostBody3D, GhostBodyDef3D>.InternalBody
    PhysicBody3D.Transform3D
    PhysicBody3D.BeginCollision
    PhysicBody3D.EndCollision
    PhysicBody3D.UpdateCollision
    PhysicBody3D.ProcessCollision
    PhysicBody3D.InternalBody
    PhysicBody3D.ColliderList
    PhysicBody3D.IsSensor
    PhysicBody3D.Friction
    PhysicBody3D.Restitution
    PhysicBody3D.RollingFriction
    PhysicBody3D.CcdMotionThreshold
    PhysicBody3D.CcdSweptSphereRadius
    PhysicBody3D.CollisionCategories
    PhysicBody3D.MaskBits
    PhysicBody3D.WorldToLocalPosition(Vector3)
    PhysicBody3D.WorldToLocalPosition(ref Vector3, out Vector3)
    PhysicBody3D.ContactTest(ICollection<ContactPoint3D>)
    PhysicBody3D.ContactPairTest(PhysicBody3D, ICollection<ContactPoint3D>)
    PhysicBody3D.ContactPairTest(Collider3D, PhysicBody3D, Collider3D, ICollection<ContactPoint3D>)
    PhysicBody3D.ResetTransform(Vector3, Quaternion, Vector3)
    PhysicBody3D.PointTest(Vector3)
    Behavior.Family
    Behavior.UpdateOrder
    Component.Owner
    Component.Managers
    Component.Clone()
    Component.Attach(Entity)
    PrefabInstanceObject.PrefabSource
    PrefabInstanceObject.PrefabElementId
    PrefabInstanceObject.IsPrefabInstance
    PrefabInstanceObject.IsMissingPrefabSource
    AttachableObject.AttachableStateChanged
    AttachableObject.IsEnabled
    AttachableObject.State
    AttachableObject.IsLoaded
    AttachableObject.IsAttached
    AttachableObject.IsActivated
    AttachableObject.IsStarted
    AttachableObject.IsDestroyed
    AttachableObject.Destroy()
    DependencyObject.Dependencies
    DependencyObject.OnDependencyRemoved
    IdentifiableObject.Id
    Namespace: Evergine.Framework.Physics3D
    Assembly: Evergine.Framework.dll
    Syntax
    public sealed class CharacterController3D : PhysicBody3D<IGhostBody3D, GhostBodyDef3D>, IDependencyObject

    Constructors

    CharacterController3D()

    Initializes a new instance of the CharacterController3D class.

    Declaration
    public CharacterController3D()

    Properties

    FallSpeed

    Gets or sets the falling speed.

    Declaration
    public float FallSpeed { get; set; }
    Property Value
    Type Description
    float

    Gravity

    Gets or sets the character's gravity.

    Declaration
    public float Gravity { get; set; }
    Property Value
    Type Description
    float

    JumpSpeed

    Gets or sets the jump speed.

    Declaration
    public float JumpSpeed { get; set; }
    Property Value
    Type Description
    float

    MaxSlope

    Gets or sets the maximum slope.

    Declaration
    [RenderProperty(typeof(FloatRadianToDegreeConverter))]
    public float MaxSlope { get; set; }
    Property Value
    Type Description
    float

    OnGround

    Gets a value indicating whether this character is on the ground.

    Declaration
    public bool OnGround { get; }
    Property Value
    Type Description
    bool

    StepHeight

    Gets or sets the step height.

    Declaration
    public float StepHeight { get; set; }
    Property Value
    Type Description
    float

    Methods

    Jump()

    Makes this character jump.

    Declaration
    public void Jump()

    Jump(Vector3)

    Makes this character jump.

    Declaration
    public void Jump(Vector3 jumpDirection)
    Parameters
    Type Name Description
    Vector3 jumpDirection

    The direction of the jump.

    OnAttached()

    Invoked when the object is attached to the system.

    Declaration
    protected override bool OnAttached()
    Returns
    Type Description
    bool

    True if everything is OK.

    Overrides
    PhysicBody3D<IGhostBody3D, GhostBodyDef3D>.OnAttached()

    OnDetach()

    Invoked when the object is detached.

    Declaration
    protected override void OnDetach()
    Overrides
    PhysicBody3D<IGhostBody3D, GhostBodyDef3D>.OnDetach()

    Rotate(float)

    Turns the character on the Y axis with the specified angle.

    Declaration
    public void Rotate(float yAngle)
    Parameters
    Type Name Description
    float yAngle

    The rotation angle on the Y axis.

    SetVelocity(Vector3)

    Sets the character's velocity.

    Declaration
    public void SetVelocity(Vector3 velocity)
    Parameters
    Type Name Description
    Vector3 velocity

    The velocity vector.

    Teleport(Vector3)

    Teleports the specified character.

    Declaration
    public void Teleport(Vector3 newPosition)
    Parameters
    Type Name Description
    Vector3 newPosition

    The new position.

    Update(TimeSpan)

    Allows this instance to execute custom logic during its Update.

    Declaration
    protected override void Update(TimeSpan gameTime)
    Parameters
    Type Name Description
    TimeSpan gameTime

    The game time.

    Overrides
    PhysicBody3D.Update(TimeSpan)
    Remarks

    This method will not be executed if the Component, or the Entity owning it is not Active.

    Implements

    IDependencyObject

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX