TopDown Engine  v4.1
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
MoreMountains.Tools.MMRigidbodyInterface Class Reference

This class acts as an interface to allow the demo levels to work whether the environment (colliders, rigidbodies) are set as 2D or 3D. If you already know for sure that you're going for a 2D or 3D game, I suggest you replace the use of this class with the appropriate classes. More...

Inheritance diagram for MoreMountains.Tools.MMRigidbodyInterface:

Public Member Functions

virtual void AddForce (Vector3 force)
 Adds the specified force to the rigidbody associated to the interface.. More...
 
virtual void AddRelativeForce (Vector3 force)
 Adds the specified relative force to the rigidbody associated to the interface.. More...
 
virtual void MovePosition (Vector3 newPosition)
 Move the rigidbody to the position vector specified More...
 
virtual void ResetAngularVelocity ()
 Resets the angular velocity. More...
 
virtual void ResetRotation ()
 Resets the rotation. More...
 
virtual void IsKinematic (bool status)
 Determines whether the rigidbody associated to the interface is kinematic More...
 
virtual void EnableBoxCollider (bool status)
 Enables the box collider associated to the interface. More...
 

Protected Member Functions

virtual void Awake ()
 Initialization More...
 

Protected Attributes

string _mode
 
Rigidbody2D _rigidbody2D
 
Rigidbody _rigidbody
 
Collider2D _collider2D
 
Collider _collider
 
Bounds _colliderBounds
 

Properties

Vector3 position [get, set]
 Returns the rigidbody's position More...
 
Rigidbody2D InternalRigidBody2D [get]
 Only use if you absolutely need to target the rigidbody2D specifically More...
 
Rigidbody InternalRigidBody [get]
 Only use if you absolutely need to target the rigidbody2D specifically More...
 
Vector3 Velocity [get, set]
 Gets or sets the velocity of the rigidbody associated to the interface. More...
 
Bounds ColliderBounds [get]
 Gets the collider bounds. More...
 
bool isKinematic [get]
 Gets a value indicating whether this MoreMountains.Tools.RigidbodyInterface is kinematic. More...
 
bool Is3D [get]
 Use this to check if you're dealing with a 3D object More...
 
bool Is2D [get]
 Use this to check if you're dealing with a 2D object More...
 

Detailed Description

This class acts as an interface to allow the demo levels to work whether the environment (colliders, rigidbodies) are set as 2D or 3D. If you already know for sure that you're going for a 2D or 3D game, I suggest you replace the use of this class with the appropriate classes.

Member Function Documentation

◆ AddForce()

virtual void MoreMountains.Tools.MMRigidbodyInterface.AddForce ( Vector3  force)
virtual

Adds the specified force to the rigidbody associated to the interface..

Parameters
forceForce.

◆ AddRelativeForce()

virtual void MoreMountains.Tools.MMRigidbodyInterface.AddRelativeForce ( Vector3  force)
virtual

Adds the specified relative force to the rigidbody associated to the interface..

Parameters
forceForce.

◆ Awake()

virtual void MoreMountains.Tools.MMRigidbodyInterface.Awake ( )
protectedvirtual

Initialization

◆ EnableBoxCollider()

virtual void MoreMountains.Tools.MMRigidbodyInterface.EnableBoxCollider ( bool  status)
virtual

Enables the box collider associated to the interface.

Parameters
statusIf set to true status.

◆ IsKinematic()

virtual void MoreMountains.Tools.MMRigidbodyInterface.IsKinematic ( bool  status)
virtual

Determines whether the rigidbody associated to the interface is kinematic

Returns
true if this instance is kinematic the specified status; otherwise, false.
Parameters
statusIf set to true status.

◆ MovePosition()

virtual void MoreMountains.Tools.MMRigidbodyInterface.MovePosition ( Vector3  newPosition)
virtual

Move the rigidbody to the position vector specified

Parameters
newPosition

◆ ResetAngularVelocity()

virtual void MoreMountains.Tools.MMRigidbodyInterface.ResetAngularVelocity ( )
virtual

Resets the angular velocity.

◆ ResetRotation()

virtual void MoreMountains.Tools.MMRigidbodyInterface.ResetRotation ( )
virtual

Resets the rotation.

Member Data Documentation

◆ _collider

Collider MoreMountains.Tools.MMRigidbodyInterface._collider
protected

◆ _collider2D

Collider2D MoreMountains.Tools.MMRigidbodyInterface._collider2D
protected

◆ _colliderBounds

Bounds MoreMountains.Tools.MMRigidbodyInterface._colliderBounds
protected

◆ _mode

string MoreMountains.Tools.MMRigidbodyInterface._mode
protected

◆ _rigidbody

Rigidbody MoreMountains.Tools.MMRigidbodyInterface._rigidbody
protected

◆ _rigidbody2D

Rigidbody2D MoreMountains.Tools.MMRigidbodyInterface._rigidbody2D
protected

Property Documentation

◆ ColliderBounds

Bounds MoreMountains.Tools.MMRigidbodyInterface.ColliderBounds
get

Gets the collider bounds.

The collider bounds.

◆ InternalRigidBody

Rigidbody MoreMountains.Tools.MMRigidbodyInterface.InternalRigidBody
get

Only use if you absolutely need to target the rigidbody2D specifically

The internal rigid body.

◆ InternalRigidBody2D

Rigidbody2D MoreMountains.Tools.MMRigidbodyInterface.InternalRigidBody2D
get

Only use if you absolutely need to target the rigidbody2D specifically

The internal rigid body2 d.

◆ Is2D

bool MoreMountains.Tools.MMRigidbodyInterface.Is2D
get

Use this to check if you're dealing with a 2D object

The position.

◆ Is3D

bool MoreMountains.Tools.MMRigidbodyInterface.Is3D
get

Use this to check if you're dealing with a 3D object

true if this instance is3 d; otherwise, false.

◆ isKinematic

bool MoreMountains.Tools.MMRigidbodyInterface.isKinematic
get

Gets a value indicating whether this MoreMountains.Tools.RigidbodyInterface is kinematic.

true if is kinematic; otherwise, false.

◆ position

Vector3 MoreMountains.Tools.MMRigidbodyInterface.position
getset

Returns the rigidbody's position

The position.

◆ Velocity

Vector3 MoreMountains.Tools.MMRigidbodyInterface.Velocity
getset

Gets or sets the velocity of the rigidbody associated to the interface.

The velocity.

The documentation for this class was generated from the following file: