PhysicalObject

Description

Base class for any entity that is physical

• C++ related class: OvCore::ECS::Components::CPhysicalObject
• Inherits from lua usertype: Component
• Inherited by lua usertypes:
  • PhysicalBox
  • PhysicalSphere
  • PhysicalCapsule

Variables

This usertype has no variables

Constructors

Name	Input	Output	Description
new		PhysicalObject

Functions

Name	Input	Output	Description
GetMass	PhysicalObject: instance		Returns the mass of the physical object
SetMass	PhysicalObject: instance number: mass		Defines a new mass for the physical object
GetFriction	PhysicalObject: instance	number	Returns the friction of the physical object
SetFriction	PhysicalObject: instance number: friction		Defines a new friction for the physical object
GetBounciness	PhysicalObject: instance	number	Returns the bounciness of the physical object
SetBounciness	PhysicalObject: instance number: bounciness		Defines a new bounciness for the physical object
SetLinearVelocity	PhysicalObject: instance Vector3: linearVelocity		Defines a new linear velocity for the physical object
SetAngularVelocity	PhysicalObject: instance Vector3: angularVelocity		Defines a new angular velocity for the physical object
GetLinearVelocity	PhysicalObject: instance	Vector3	Returns the linear velocity of the physical object
GetAngularVelocity	PhysicalObject: instance	Vector3	Returns the angular of the physical object
SetLinearFactor	PhysicalObject: instance Vector3: linearFactor		Defines a new linear factor for the physical object
SetAngularFactor	PhysicalObject: instance Vector3: angularFactor		Defines a new angular factor for the physical object
GetLinearFactor	PhysicalObject: instance	Vector3	Returns the linear factor of the physical object
GetAngularFactor	PhysicalObject: instance	Vector3	Returns the angular of the physical object
IsTrigger	PhysicalObject: instance	boolean	Returns true if the physical object is a trigger
SetTrigger	PhysicalObject: instance boolean: trigger		Defines if the physical object should be a trigger or not
AddForce	PhysicalObject: instance Vector3: force		Add a force to the physical object
AddImpulse	PhysicalObject: instance Vector3: impulse		Add an impulse to the physical object
ClearForces	PhysicalObject: instance		Clear forces
SetCollisionDetectionMode	PhysicalObject: instance CollisionDetectionMode: mode		Defines a new collision detection mode for the physical object
GetCollisionMode	PhysicalObject: instance	CollisionDetectionMode	Returns the collision detection mode of the physical object
IsKinematic	PhysicalObject: instance	boolean	Returns true if the physical object is kinematic
SetKinematic	PhysicalObject: instance boolean: kinematic		Defines if the physical object should be kinematic or not

Operators

This usertype has no operators