sidescroller-framework

SFramework API Documentation

SFramework has some functionality that is useful. Learn about these functions here.

Contents

• SFramework
  • Accessors
  • Physics
    • Physics Accessors
    • getGravity
    • setGravity
    • getPhysicsManager

SFramework

SFramework’s namespace is SF. All SFramework functions will be called with this namespace.

Accessors

  SF.physics

Physics

Physics Accessors

SF.physics.gravity
SF.physics.manager

SF.physics.getGravity

Gets the current gravity value in SFramework in units per second

Example

local myGravity = SF.physics.GetGravity()

SF.physics.setGravity

Sets the current gravity value in SFramework in units per second. The default value is 1

Arguments

• g - number (required) the gravity value to set

  Example

  SF.physics.setGravity(2)
  

SF.physics.getPhysicsManager

Gets the instance of SF Physics Manager currently being used

Example

local myPhysicsManager = SF.physics.getPhysicsManager()

This site is open source. Improve this page.