sidescroller-framework

SF Physics Manager API

The SFramework Physics Manager handles storing references all physics objects in a scene as well as handling collision detection and resolution for Physics objects. While most developers will not likely ever need this API, as it is mainly used under the hood in the Physics component, it is still available to use if there is ever a case that someone may need it.

Contents

• SF Physics Manager
  • Accessors
  • AddPhysicsObject
  • RemovePhysicsObject
  • GetCollisionData
  • ResolveCollision

SF Physics Manager

Accessors

SFPhysicsManager.physicsObjects

SFPhysicsManager:AddPhysicsObject

Adds the given GameObject with Physics component to the manager’s table of Physics objects

Arguments

• obj - GameObject (required) the object to add

  Example

  SF.physics.manager:AddPhysicsObject(self.gameObject)
  

SFPhysicsManager:RemovePhysicsObject

Removes the given GameObject from the manager’s table of Physics objects

Arguments

• obj - GameObject (required) the object to remove

  Example

  SF.physics.manager:RemovePhysicsObject(self.gameObject)
  

SFPhysicsManager:GetCollisionData

Returns a table with collision depth and normal for the two given objects or nil if no collision

Arguments

• obj1 - GameObject (required) the first GameObject to check
• obj2 - GameObject (required) the second GameObject to check

  Example

  local myCollisionData = SF.physics.manager:GetCollisionData(self.gameObject, CS.FindGameObject("other object"))
  if myCollisionData ~= nil then
    print("Collision depth: "..myCollisionData.depth)
    print("Collision normal: "..myCollisionData.normal)
  end
  

SFPhysicsManager:ResolveCollision

Resolves the collision between the two given objects with the given collision data

Arguments

• obj1 - GameObject (required) the first GameObject
• obj2 - GameObject (required) the second GameObject
• data - CollisionData (required) the collision data

  Example

  local myOtherObject = CS.FindGameObject("other object")
  local myCollisionData = SF.physics.manager:GetCollisionData(self.gameObject, myOtherObject)
  if myCollisionData ~= nil then
    SF.physics.manager:ResolveCollision(self.gameObject, myOtherObject, myCollisionData)
  end
  

This site is open source. Improve this page.