sidescroller-framework

Physics Component API

Physics component handles object physics.

Contents

• Physics
  • Accessors
  • GetMass
  • SetMass
  • GetWidth
  • SetWidth
  • GetHeight
  • SetHeight
  • GetBounciness
  • SetBounciness
  • GetVelocity
  • SetVelocity
  • IsStatic
  • SetStatic
  • GetColliderType
  • SetColliderType
  • GetFriction
  • SetFriction
  • ApplyImpulse

Physics

Accessors

Physics.mass
Physics.width
Physics.height
Physics.bounciness
Physics.velocity
Physics.static
Physics.colliderType
Physics.friction

Physics:GetMass

Returns the mass of the Physics object

Example

local myMass = self.gameObject.physics:GetMass()

Physics:SetMass

Sets the mass of the Physics object to the given value

Arguments

• mass - number (required) the mass to set to

  Example

  self.gameObject.physics:SetMass(5)
  

Physics:GetWidth

Returns the width of the Physics object

Example

local myWidth = self.gameObject.physics:GetWidth()

Physics:SetWidth

Sets the width of the Physics object

Arguments

• width - number (required) the width to set to

  Example

  self.gameObject.physics:SetWidth(10)
  

Physics:GetHeight

Returns the height of the Physics object

Example

local myHeight = self.gameObject.physics:GetHeight()

Physics:SetHeight

Sets the height of the Physics object

Arguments

• height - number (required) the height to set to

  Example

  self.gameObject.physics:SetHeight(10)
  

Physics:GetBounciness

Returns the bounciness value of the Physics object

Example

local myBounciness = self.gameObject.physics:GetBounciness()

Physics:SetBounciness

Sets the bounciness of the Physics object to the given value

Arguments

• bounciness - number (required) the bounciness to set to

  Example

  self.gameObject.physics:SetBounciness(.5)
  

Physics:GetVelocity

Returns the velocity vector of the object

Example

local myVelocity = self.gameObject.physics:GetVelocity()

Physics:SetVelocity

Sets the velocity of the Physics object to the given vector

Arguments

• velocity - Vector3 (required) the velocity to set to

  Example

  self.gameObject.physics:SetVelocity(Vector3:New(2, 1, 0))
  

Physics:IsStatic

Returns whether or not the Physics object is static

Example

local isStatic = self.gameObject.physics:IsStatic()

Physics:SetStatic

Sets whether or not the Physics object is static

Arguments

• static - bool (required) true to set to static, false for non-static

  Example

  self.gameObject.physics:SetStatic(false)
  

Physics:GetColliderType

Returns the collider type of the object

Example

local myCollider = self.gameObject.physics:GetColliderType()

Physics:SetColliderType

Sets the collider type of the Physics object to the value

Arguments

• type - string (required) the collider type to set to

  Example

  self.gameObject.physics:SetColliderType('CIRCLE')
  

Physics:GetFriction

Returns the friction coefficient of the object

Example

local myFrictionCoefficient = self.gameObject.physics:GetFriction()

Physics:SetFriction

Sets the friction coefficient of the Physics object to the given value. This should be a value between 0 and 1

Arguments

• type - number (required) the friction coefficient to set to

  Example

  self.gameObject.physics:SetFriction(.5)
  

Physics:ApplyImpulse

Applies an impulse to the Physics object according to the given vector

Arguments

• impulse - Vector3 (required) the impulse vector to apply

  Example

  self.gameObject.physics:ApplyImpulse(Vector3:New(0, 1, 0))
  

This site is open source. Improve this page.