diff --git a/bundles/plotly.js b/bundles/plotly.js index e00225eab..7e08af3a2 100644 --- a/bundles/plotly.js +++ b/bundles/plotly.js @@ -210828,10 +210828,10 @@ export default require => { mode: "lines" }, { xaxis: { - visible: false + visible: true }, yaxis: { - visible: false, + visible: true, scaleanchor: "x" } }, true); diff --git a/documentation/functions/ar.addARObject.html b/documentation/functions/ar.addARObject.html index 66890d24b..2a138ed37 100644 --- a/documentation/functions/ar.addARObject.html +++ b/documentation/functions/ar.addARObject.html @@ -1,2 +1,2 @@ addARObject | Source Academy Modules

Function addARObject

  • addARObject(arObject): void

  • Adds the specified object to the augmented world.

    -

    Parameters

    • arObject: ARObject

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/functions/ar.clearARObjects.html b/documentation/functions/ar.clearARObjects.html index 21364ab8c..3635e01ce 100644 --- a/documentation/functions/ar.clearARObjects.html +++ b/documentation/functions/ar.clearARObjects.html @@ -1,2 +1,2 @@ clearARObjects | Source Academy Modules

Function clearARObjects

  • clearARObjects(): void

  • Removes all objects in the augmented world.

    -

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/functions/ar.clearMovement.html b/documentation/functions/ar.clearMovement.html index b1769bd5a..ce0d70d53 100644 --- a/documentation/functions/ar.clearMovement.html +++ b/documentation/functions/ar.clearMovement.html @@ -1,3 +1,3 @@ clearMovement | Source Academy Modules

Function clearMovement

  • clearMovement(object): void

  • Removes the movement of the object.

    Parameters

    • object: ARObject

      Object to modifiy.

      -

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/documentation/functions/ar.createCubeObject.html b/documentation/functions/ar.createCubeObject.html index 24a564d1a..5700b417a 100644 --- a/documentation/functions/ar.createCubeObject.html +++ b/documentation/functions/ar.createCubeObject.html @@ -6,4 +6,4 @@
  • color: number

    Decimal representation of hex color.

  • Optional onSelect: (() => {})

    Function to call when object is tapped.

    • Returns CubeObject

    Created AR cube object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createGltfObject.html b/documentation/functions/ar.createGltfObject.html index 2c5b2c952..a46357f25 100644 --- a/documentation/functions/ar.createGltfObject.html +++ b/documentation/functions/ar.createGltfObject.html @@ -5,4 +5,4 @@
  • scale: number

    Scale of loaded object.

  • Optional onSelect: (() => {})

    Function to call when object is tapped.

    • Returns GltfObject

    Created AR interface object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createInterfaceBase64Image.html b/documentation/functions/ar.createInterfaceBase64Image.html index 57c6619b7..cca7f960c 100644 --- a/documentation/functions/ar.createInterfaceBase64Image.html +++ b/documentation/functions/ar.createInterfaceBase64Image.html @@ -8,4 +8,4 @@
  • paddingTop: number

    Size of padding on the top.

  • paddingBottom: number

    Size of padding on the bottom.

    • Returns UIBase64ImageComponent

    Created interface component.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createInterfaceColumn.html b/documentation/functions/ar.createInterfaceColumn.html index 10a01309f..88c630ac0 100644 --- a/documentation/functions/ar.createInterfaceColumn.html +++ b/documentation/functions/ar.createInterfaceColumn.html @@ -7,4 +7,4 @@
  • paddingBottom: number

    Size of padding on the bottom.

  • backgroundColor: number

    Background color of column.

    • Returns UIColumnItem

    Created column component.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createInterfaceImage.html b/documentation/functions/ar.createInterfaceImage.html index 6aab2dd2f..dd47974ae 100644 --- a/documentation/functions/ar.createInterfaceImage.html +++ b/documentation/functions/ar.createInterfaceImage.html @@ -8,4 +8,4 @@
  • paddingTop: number

    Size of padding on the top.

  • paddingBottom: number

    Size of padding on the bottom.

    • Returns UIImageItem

    Created interface component.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createInterfaceObject.html b/documentation/functions/ar.createInterfaceObject.html index bfcccc8f6..4f6ef8a9e 100644 --- a/documentation/functions/ar.createInterfaceObject.html +++ b/documentation/functions/ar.createInterfaceObject.html @@ -4,4 +4,4 @@
  • rootComponent: UIBasicItem

    Root UI component containing other components. Can be row, column, image or text.

  • Optional onSelect: (() => {})

    Function to call when object is tapped.

    • Returns UIObject

    Created AR interface object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createInterfaceRow.html b/documentation/functions/ar.createInterfaceRow.html index 2d9499ed3..63b71dd61 100644 --- a/documentation/functions/ar.createInterfaceRow.html +++ b/documentation/functions/ar.createInterfaceRow.html @@ -7,4 +7,4 @@
  • paddingBottom: number

    Size of padding on the bottom.

  • backgroundColor: number

    Background color of row.

    • Returns UIRowItem

    Created row component.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createInterfaceText.html b/documentation/functions/ar.createInterfaceText.html index 014d51c3d..e7dab30d8 100644 --- a/documentation/functions/ar.createInterfaceText.html +++ b/documentation/functions/ar.createInterfaceText.html @@ -9,4 +9,4 @@
  • paddingBottom: number

    Size of padding on the bottom.

  • color: number

    Color of text.

    • Returns UITextItem

    Created text component.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createLightObject.html b/documentation/functions/ar.createLightObject.html index 350c76710..092eef142 100644 --- a/documentation/functions/ar.createLightObject.html +++ b/documentation/functions/ar.createLightObject.html @@ -3,4 +3,4 @@

    Parameters

    Returns LightObject

    Created AR light source object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createPathItem.html b/documentation/functions/ar.createPathItem.html index 7c794c56e..0b3fbc480 100644 --- a/documentation/functions/ar.createPathItem.html +++ b/documentation/functions/ar.createPathItem.html @@ -3,4 +3,4 @@
  • end: Vector3

    End position

  • duration: number

    Duration of transition from start to end position.

    • Returns PathItem

    Created instance of path item.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createSphereObject.html b/documentation/functions/ar.createSphereObject.html index 6a768b567..36582e894 100644 --- a/documentation/functions/ar.createSphereObject.html +++ b/documentation/functions/ar.createSphereObject.html @@ -4,4 +4,4 @@
  • color: number

    Decimal representation of hex color.

  • Optional onSelect: (() => {})

    Function to call when object is tapped.

    • Returns SphereObject

    Created AR sphere object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.createVector3.html b/documentation/functions/ar.createVector3.html index 6719974e0..87037bf77 100644 --- a/documentation/functions/ar.createVector3.html +++ b/documentation/functions/ar.createVector3.html @@ -3,4 +3,4 @@
  • y: number

    Value of y-axis.

  • z: number

    Value of z-axis.

    • Returns Vector3

    Vector3 created from specified values.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.getARObjects.html b/documentation/functions/ar.getARObjects.html index 1c0cdefe9..e27d88ec3 100644 --- a/documentation/functions/ar.getARObjects.html +++ b/documentation/functions/ar.getARObjects.html @@ -1,2 +1,2 @@ getARObjects | Source Academy Modules

    Function getARObjects

    • getARObjects(): ARObject[]

    • Obtains the current ARObjects.

      -

      Returns ARObject[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ARObject[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.getFrontObject.html b/documentation/functions/ar.getFrontObject.html index 60019cd57..ba5442371 100644 --- a/documentation/functions/ar.getFrontObject.html +++ b/documentation/functions/ar.getFrontObject.html @@ -1,3 +1,3 @@ getFrontObject | Source Academy Modules

    Function getFrontObject

    • getFrontObject(): undefined | ARObject

    • Obtains the first object in the user's line of sight, if any.

      Returns undefined | ARObject

      ARObject in front of user if found, undefined if not.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.getJsonChild.html b/documentation/functions/ar.getJsonChild.html index 4316da438..660e4a2a4 100644 --- a/documentation/functions/ar.getJsonChild.html +++ b/documentation/functions/ar.getJsonChild.html @@ -1,2 +1,2 @@ getJsonChild | Source Academy Modules

    Function getJsonChild

    • getJsonChild(object, key): any

    • Obtains the value of a json object at the key.

      -

      Parameters

      • object: any
      • key: string

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.getXPosition.html b/documentation/functions/ar.getXPosition.html index 8c52fd528..8c9a1410a 100644 --- a/documentation/functions/ar.getXPosition.html +++ b/documentation/functions/ar.getXPosition.html @@ -1,4 +1,4 @@ getXPosition | Source Academy Modules

    Function getXPosition

    • getXPosition(arObject): number

    • Obtains the position of the specified object on the x-axis.

      Parameters

      • arObject: ARObject

        AR object to check.

      Returns number

      Value of position on the x-axis.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.getYPosition.html b/documentation/functions/ar.getYPosition.html index 4149c929f..6fb3e89a0 100644 --- a/documentation/functions/ar.getYPosition.html +++ b/documentation/functions/ar.getYPosition.html @@ -1,4 +1,4 @@ getYPosition | Source Academy Modules

    Function getYPosition

    • getYPosition(arObject): number

    • Obtains the position of the specified object on the y-axis.

      Parameters

      • arObject: ARObject

        AR object to check.

      Returns number

      Value of position on the y-axis.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.getZPosition.html b/documentation/functions/ar.getZPosition.html index f4563e58d..f4f1d5e61 100644 --- a/documentation/functions/ar.getZPosition.html +++ b/documentation/functions/ar.getZPosition.html @@ -1,4 +1,4 @@ getZPosition | Source Academy Modules

    Function getZPosition

    • getZPosition(arObject): number

    • Obtains the position of the specified object on the z-axis.

      Parameters

      • arObject: ARObject

        AR object to check.

      Returns number

      Value of position on the z-axis.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.initAR.html b/documentation/functions/ar.initAR.html index 21357e4f8..d923ed2a2 100644 --- a/documentation/functions/ar.initAR.html +++ b/documentation/functions/ar.initAR.html @@ -1,2 +1,2 @@ initAR | Source Academy Modules

    Function initAR

    • initAR(): void

    • Initialize AR.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.moveARObject.html b/documentation/functions/ar.moveARObject.html index 439d1ea6c..410591d3b 100644 --- a/documentation/functions/ar.moveARObject.html +++ b/documentation/functions/ar.moveARObject.html @@ -1,4 +1,4 @@ moveARObject | Source Academy Modules

    Function moveARObject

    • moveARObject(arObject, position): void

    • Moves the specified object to a new position.

      Parameters

      • arObject: ARObject

        AR object to move.

      • position: Vector3

        Position to move to.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.removeARObject.html b/documentation/functions/ar.removeARObject.html index 0821ef0a6..466ea46a1 100644 --- a/documentation/functions/ar.removeARObject.html +++ b/documentation/functions/ar.removeARObject.html @@ -1,3 +1,3 @@ removeARObject | Source Academy Modules

    Function removeARObject

    • removeARObject(arObject): void

    • Removes the specified object from the augmented world.

      Parameters

      • arObject: ARObject

        ARObject to remove.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.removeCenterToggle.html b/documentation/functions/ar.removeCenterToggle.html index 357ac0d62..13fb419b8 100644 --- a/documentation/functions/ar.removeCenterToggle.html +++ b/documentation/functions/ar.removeCenterToggle.html @@ -1,2 +1,2 @@ removeCenterToggle | Source Academy Modules

    Function removeCenterToggle

    • removeCenterToggle(): void

    • Resets and hides the center toggle.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.removeLeftToggle.html b/documentation/functions/ar.removeLeftToggle.html index 390c45c0e..722c072ec 100644 --- a/documentation/functions/ar.removeLeftToggle.html +++ b/documentation/functions/ar.removeLeftToggle.html @@ -1,2 +1,2 @@ removeLeftToggle | Source Academy Modules

    Function removeLeftToggle

    • removeLeftToggle(): void

    • Resets and hides the left toggle.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.removeRightToggle.html b/documentation/functions/ar.removeRightToggle.html index 8b8d9817c..8669d726e 100644 --- a/documentation/functions/ar.removeRightToggle.html +++ b/documentation/functions/ar.removeRightToggle.html @@ -1,2 +1,2 @@ removeRightToggle | Source Academy Modules

    Function removeRightToggle

    • removeRightToggle(): void

    • Resets and hides the right toggle.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.selectObject.html b/documentation/functions/ar.selectObject.html index e513941c8..3c52e5913 100644 --- a/documentation/functions/ar.selectObject.html +++ b/documentation/functions/ar.selectObject.html @@ -1,4 +1,4 @@ selectObject | Source Academy Modules

    Function selectObject

    • selectObject(arObject, isSelected): void

    • Sets the select state for the specified AR object.

      Parameters

      • arObject: ARObject

        AR object to select/unselect.

      • isSelected: boolean

        Whether the object is selected.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setAlwaysRender.html b/documentation/functions/ar.setAlwaysRender.html index b1cc311fd..216a7e8b8 100644 --- a/documentation/functions/ar.setAlwaysRender.html +++ b/documentation/functions/ar.setAlwaysRender.html @@ -1,3 +1,3 @@ setAlwaysRender | Source Academy Modules

    Function setAlwaysRender

    • setAlwaysRender(object): void

    • Always render the object.

      Parameters

      • object: ARObject

        Object to modifiy.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setAsARObjects.html b/documentation/functions/ar.setAsARObjects.html index 137adaa44..40db02302 100644 --- a/documentation/functions/ar.setAsARObjects.html +++ b/documentation/functions/ar.setAsARObjects.html @@ -1,2 +1,2 @@ setAsARObjects | Source Academy Modules

    Function setAsARObjects

    • setAsARObjects(json): void

    • Sets AR objects from json.

      -

      Parameters

      • json: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setCenterToggle.html b/documentation/functions/ar.setCenterToggle.html index 3d6d2fafe..49bbfc155 100644 --- a/documentation/functions/ar.setCenterToggle.html +++ b/documentation/functions/ar.setCenterToggle.html @@ -1,4 +1,4 @@ setCenterToggle | Source Academy Modules

    Function setCenterToggle

    • setCenterToggle(text, callback): void

    • Sets the center toggle.

      Parameters

      • text: string

        Label on toggle.

      • callback: (() => void)

        Function to call when toggle is clicked.

        -
          • (): void

          • Returns void

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setFixedRotation.html b/documentation/functions/ar.setFixedRotation.html index 41cf0be59..d6a0b7735 100644 --- a/documentation/functions/ar.setFixedRotation.html +++ b/documentation/functions/ar.setFixedRotation.html @@ -1,4 +1,4 @@ setFixedRotation | Source Academy Modules

    Function setFixedRotation

    • setFixedRotation(object, radians): void

    • Fix the rotation of the object at the specified angle around the vertical axis.

      Parameters

      • object: ARObject

        Object to modifiy.

      • radians: number

        Rotation angle in radians.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setHighlightFrontObject.html b/documentation/functions/ar.setHighlightFrontObject.html index e18246fda..dbbaa985c 100644 --- a/documentation/functions/ar.setHighlightFrontObject.html +++ b/documentation/functions/ar.setHighlightFrontObject.html @@ -1,3 +1,3 @@ setHighlightFrontObject | Source Academy Modules

    Function setHighlightFrontObject

    • setHighlightFrontObject(isEnabled): void

    • Turn on highlighting of object that the user is facing.

      Parameters

      • isEnabled: boolean

        Whether to highlight object in front.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setLeftToggle.html b/documentation/functions/ar.setLeftToggle.html index afd568e16..2245cd534 100644 --- a/documentation/functions/ar.setLeftToggle.html +++ b/documentation/functions/ar.setLeftToggle.html @@ -1,4 +1,4 @@ setLeftToggle | Source Academy Modules

    Function setLeftToggle

    • setLeftToggle(text, callback): void

    • Sets the left toggle.

      Parameters

      • text: string

        Label on toggle.

      • callback: (() => void)

        Function to call when toggle is clicked.

        -
          • (): void

          • Returns void

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setOrbitMovement.html b/documentation/functions/ar.setOrbitMovement.html index e6adb493b..408e5da77 100644 --- a/documentation/functions/ar.setOrbitMovement.html +++ b/documentation/functions/ar.setOrbitMovement.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setPathMovement.html b/documentation/functions/ar.setPathMovement.html index d2644489e..505e12a0c 100644 --- a/documentation/functions/ar.setPathMovement.html +++ b/documentation/functions/ar.setPathMovement.html @@ -1,4 +1,4 @@ setPathMovement | Source Academy Modules

    Function setPathMovement

    • setPathMovement(object, path): void

    • Moves object in the specified path, repeat when ended.

      Parameters

      • object: ARObject

        Object to modifiy.

      • path: PathItem[]

        Path to move. Use createPathItem to create a path segment.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setRenderDistance.html b/documentation/functions/ar.setRenderDistance.html index 553eda0f9..a3d2d3b5d 100644 --- a/documentation/functions/ar.setRenderDistance.html +++ b/documentation/functions/ar.setRenderDistance.html @@ -1,4 +1,4 @@ setRenderDistance | Source Academy Modules

    Function setRenderDistance

    • setRenderDistance(object, distance): void

    • Only render the object when in range.

      Parameters

      • object: ARObject

        Object to modifiy.

      • distance: number

        Range of object in metres.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setRightToggle.html b/documentation/functions/ar.setRightToggle.html index 55dd2a1ee..8d7c7cdb0 100644 --- a/documentation/functions/ar.setRightToggle.html +++ b/documentation/functions/ar.setRightToggle.html @@ -1,4 +1,4 @@ setRightToggle | Source Academy Modules

    Function setRightToggle

    • setRightToggle(text, callback): void

    • Sets the right toggle.

      Parameters

      • text: string

        Label on toggle.

      • callback: (() => void)

        Function to call when toggle is clicked.

        -
          • (): void

          • Returns void

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setRotateAroundY.html b/documentation/functions/ar.setRotateAroundY.html index fa719bdb9..c9c2bb245 100644 --- a/documentation/functions/ar.setRotateAroundY.html +++ b/documentation/functions/ar.setRotateAroundY.html @@ -1,3 +1,3 @@ setRotateAroundY | Source Academy Modules

    Function setRotateAroundY

    • setRotateAroundY(object): void

    • Rotates the object continuously around the vertical axis.

      Parameters

      • object: ARObject

        Object to modifiy.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setRotateToUser.html b/documentation/functions/ar.setRotateToUser.html index 895679c12..d63c32395 100644 --- a/documentation/functions/ar.setRotateToUser.html +++ b/documentation/functions/ar.setRotateToUser.html @@ -1,3 +1,3 @@ setRotateToUser | Source Academy Modules

    Function setRotateToUser

    • setRotateToUser(object): void

    • Always rotate the object to where the user is facing.

      Parameters

      • object: ARObject

        Object to modifiy.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/ar.setSpringMovement.html b/documentation/functions/ar.setSpringMovement.html index d651b822c..97740a00a 100644 --- a/documentation/functions/ar.setSpringMovement.html +++ b/documentation/functions/ar.setSpringMovement.html @@ -1,3 +1,3 @@ setSpringMovement | Source Academy Modules

    Function setSpringMovement

    • setSpringMovement(object): void

    • Animates movement when the position of the object changes.

      Parameters

      • object: ARObject

        Object to modifiy.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.build_game.html b/documentation/functions/arcade_2d.build_game.html index 84b0c0761..0eeed09cc 100644 --- a/documentation/functions/arcade_2d.build_game.html +++ b/documentation/functions/arcade_2d.build_game.html @@ -3,4 +3,4 @@ All created GameObjects and their properties are passed into the game.

    Returns BuildGame

    Example

    // This must be the last function called in the Source program.
    build_game();
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.create_audio.html b/documentation/functions/arcade_2d.create_audio.html index b7078073d..16ae724a6 100644 --- a/documentation/functions/arcade_2d.create_audio.html +++ b/documentation/functions/arcade_2d.create_audio.html @@ -10,4 +10,4 @@

    Returns AudioClip

    The AudioClip reference

    Example

    const audioClip = create_audio("bgm/GalacticHarmony.mp3", 0.5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.create_circle.html b/documentation/functions/arcade_2d.create_circle.html index 3ef85be9f..e62ae068e 100644 --- a/documentation/functions/arcade_2d.create_circle.html +++ b/documentation/functions/arcade_2d.create_circle.html @@ -1,2 +1,2 @@ create_circle | Source Academy Modules

    Function create_circle

    • create_circle(radius): ShapeGameObject

    • Creates a CircleGameObject that takes in circle shape properties.

      -

      Parameters

      • radius: number

      Returns ShapeGameObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns ShapeGameObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.create_rectangle.html b/documentation/functions/arcade_2d.create_rectangle.html index 9ca1cc885..1f2570b73 100644 --- a/documentation/functions/arcade_2d.create_rectangle.html +++ b/documentation/functions/arcade_2d.create_rectangle.html @@ -3,4 +3,4 @@
  • height: number

    The height of the rectangle

    • Returns ShapeGameObject

    Example

    const rectangle = create_rectangle(100, 100);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.create_sprite.html b/documentation/functions/arcade_2d.create_sprite.html index 2ef60dbb7..f48645175 100644 --- a/documentation/functions/arcade_2d.create_sprite.html +++ b/documentation/functions/arcade_2d.create_sprite.html @@ -8,4 +8,4 @@

    Parameters

    Returns SpriteGameObject

    Example

    const shortpath = create_sprite("objects/cmr/splendall.png");
    const fullpath = create_sprite("https://source-academy-assets.s3-ap-southeast-1.amazonaws.com/objects/cmr/splendall.png");
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.create_text.html b/documentation/functions/arcade_2d.create_text.html index e875acfb7..952702b4a 100644 --- a/documentation/functions/arcade_2d.create_text.html +++ b/documentation/functions/arcade_2d.create_text.html @@ -2,4 +2,4 @@

    Parameters

    Returns TextGameObject

    Example

    const helloworld = create_text("Hello\nworld!");
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.create_triangle.html b/documentation/functions/arcade_2d.create_triangle.html index 72c0dc337..12beee16f 100644 --- a/documentation/functions/arcade_2d.create_triangle.html +++ b/documentation/functions/arcade_2d.create_triangle.html @@ -3,4 +3,4 @@
  • height: number

    The height of the isosceles triangle

    const triangle = create_triangle(100, 100);
    -

    • Returns ShapeGameObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ShapeGameObject

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.debug_log.html b/documentation/functions/arcade_2d.debug_log.html index 3e52db807..f6d3be637 100644 --- a/documentation/functions/arcade_2d.debug_log.html +++ b/documentation/functions/arcade_2d.debug_log.html @@ -4,4 +4,4 @@

    Parameters

    Returns void

    Example

    enable_debug();
    update_loop(game_state => {
      debug_log(get_game_time());
    });
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.enable_debug.html b/documentation/functions/arcade_2d.enable_debug.html index cf5aefce9..6801aea2e 100644 --- a/documentation/functions/arcade_2d.enable_debug.html +++ b/documentation/functions/arcade_2d.enable_debug.html @@ -4,4 +4,4 @@ debug_log(...) information is shown on the top-left corner of the canvas.

    Returns void

    Example

    enable_debug();
    update_loop(game_state => {
      debug_log(get_game_time());
    });
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.gameobjects_overlap.html b/documentation/functions/arcade_2d.gameobjects_overlap.html index e8c569b9c..cf6525a54 100644 --- a/documentation/functions/arcade_2d.gameobjects_overlap.html +++ b/documentation/functions/arcade_2d.gameobjects_overlap.html @@ -6,4 +6,4 @@

    Returns boolean

    True, if both gameobjects overlap with each other.

    Example

    const rectangle1 = create_rectangle(100, 100);
    const rectangle2 = create_rectangle(100, 100);
    if (gameobjects_overlap(rectangle1, rectangle2)) {
      // Both rectangles overlap
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.get_game_time.html b/documentation/functions/arcade_2d.get_game_time.html index 5acc636ee..952be1c47 100644 --- a/documentation/functions/arcade_2d.get_game_time.html +++ b/documentation/functions/arcade_2d.get_game_time.html @@ -3,4 +3,4 @@

    Returns number

    a number specifying the time in milliseconds

    Example

    if (get_game_time() > 100) {
      // Do something after 100 milliseconds
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.get_loop_count.html b/documentation/functions/arcade_2d.get_loop_count.html index 4684d59bb..814d3585f 100644 --- a/documentation/functions/arcade_2d.get_loop_count.html +++ b/documentation/functions/arcade_2d.get_loop_count.html @@ -4,4 +4,4 @@

    Returns number

    a number specifying number of loops that have been run.

    Example

    if (get_loop_count() === 100) {
      // Do something on the 100th frame
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.input_key_down.html b/documentation/functions/arcade_2d.input_key_down.html index 7905e8e21..6e626b226 100644 --- a/documentation/functions/arcade_2d.input_key_down.html +++ b/documentation/functions/arcade_2d.input_key_down.html @@ -5,4 +5,4 @@

    Returns boolean

    True, in the frame the key is pressed down.

    Example

    if (input_key_down("a")) {
      // "a" key is pressed down
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.input_left_mouse_down.html b/documentation/functions/arcade_2d.input_left_mouse_down.html index e8cf98835..bfa70bff3 100644 --- a/documentation/functions/arcade_2d.input_left_mouse_down.html +++ b/documentation/functions/arcade_2d.input_left_mouse_down.html @@ -3,4 +3,4 @@

    Returns boolean

    True, if the left mouse button is pressed down.

    Example

    if(input_left_mouse_down()) {
      // Left mouse button down
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.input_right_mouse_down.html b/documentation/functions/arcade_2d.input_right_mouse_down.html index 46750958b..bbe9dda49 100644 --- a/documentation/functions/arcade_2d.input_right_mouse_down.html +++ b/documentation/functions/arcade_2d.input_right_mouse_down.html @@ -3,4 +3,4 @@

    Returns boolean

    True, if the right mouse button is pressed down.

    Example

    if (input_right_mouse_down()) {
      // Right mouse button down
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.loop_audio.html b/documentation/functions/arcade_2d.loop_audio.html index ac7158793..30a3487ac 100644 --- a/documentation/functions/arcade_2d.loop_audio.html +++ b/documentation/functions/arcade_2d.loop_audio.html @@ -4,4 +4,4 @@

    Returns AudioClip

    The AudioClip reference

    Example

    const audioClip = loop_audio(create_audio("bgm/GalacticHarmony.mp3", 0.5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.play_audio.html b/documentation/functions/arcade_2d.play_audio.html index 7f67ea2ba..8233a5938 100644 --- a/documentation/functions/arcade_2d.play_audio.html +++ b/documentation/functions/arcade_2d.play_audio.html @@ -3,4 +3,4 @@

    Returns AudioClip

    The AudioClip reference

    Example

    const audioClip = play_audio(create_audio("bgm/GalacticHarmony.mp3", 0.5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.pointer_over_gameobject.html b/documentation/functions/arcade_2d.pointer_over_gameobject.html index 4ce442fbf..c34e0dbc9 100644 --- a/documentation/functions/arcade_2d.pointer_over_gameobject.html +++ b/documentation/functions/arcade_2d.pointer_over_gameobject.html @@ -4,4 +4,4 @@

    Returns boolean

    True, if the pointer is over the gameobject.

    Example

    // Creating a button using a gameobject
    const button = createTextGameObject("click me");
    // Test if button is clicked
    if (pointer_over_gameobject(button) && input_left_mouse_down()) {
      // Button is clicked
    }
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_color.html b/documentation/functions/arcade_2d.query_color.html index e0cddf365..d09326d89 100644 --- a/documentation/functions/arcade_2d.query_color.html +++ b/documentation/functions/arcade_2d.query_color.html @@ -3,4 +3,4 @@

    Returns ColorRGBA

    [r, g, b, a] color as an array

    Example

    const gameobject = update_color(create_circle(100), [255, 127, 127, 255]);
    query_color(gameobject);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_flip.html b/documentation/functions/arcade_2d.query_flip.html index c2d45385c..66b8db005 100644 --- a/documentation/functions/arcade_2d.query_flip.html +++ b/documentation/functions/arcade_2d.query_flip.html @@ -3,4 +3,4 @@

    Returns FlipXY

    [x, y] flip state as an array

    Example

    const gameobject = update_flip(create_triangle(100), [false, true]);
    query_flip(gameobject);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_id.html b/documentation/functions/arcade_2d.query_id.html index 5ac3c4ad7..bfad88dd3 100644 --- a/documentation/functions/arcade_2d.query_id.html +++ b/documentation/functions/arcade_2d.query_id.html @@ -4,4 +4,4 @@

    Returns number

    the id of the GameObject reference

    Example

    const id0 = create_text("This has id 0");
    const id1 = create_text("This has id 1");
    const id2 = create_text("This has id 2");
    queryGameObjectId(id2);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_pointer_position.html b/documentation/functions/arcade_2d.query_pointer_position.html index 647d73745..0fc7afb30 100644 --- a/documentation/functions/arcade_2d.query_pointer_position.html +++ b/documentation/functions/arcade_2d.query_pointer_position.html @@ -2,4 +2,4 @@

    Returns PositionXY

    [x, y] coordinates of the pointer as an array

    Example

    const position = query_pointer_position();
    position[0]; // x
    position[1]; // y
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_position.html b/documentation/functions/arcade_2d.query_position.html index e665ef05f..0425f4784 100644 --- a/documentation/functions/arcade_2d.query_position.html +++ b/documentation/functions/arcade_2d.query_position.html @@ -3,4 +3,4 @@

    Returns PositionXY

    [x, y] position as an array

    Example

    const gameobject = update_position(create_circle(100), [100, 100]);
    query_position(gameobject);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_rotation.html b/documentation/functions/arcade_2d.query_rotation.html index b71df9e37..c39cbcfc2 100644 --- a/documentation/functions/arcade_2d.query_rotation.html +++ b/documentation/functions/arcade_2d.query_rotation.html @@ -3,4 +3,4 @@

    Returns number

    z-rotation as a number in radians

    Example

    const gameobject = update_rotation(create_rectangle(100, 200), math_PI / 4);
    query_rotation(gameobject);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_scale.html b/documentation/functions/arcade_2d.query_scale.html index 59de9974a..50044fa88 100644 --- a/documentation/functions/arcade_2d.query_scale.html +++ b/documentation/functions/arcade_2d.query_scale.html @@ -3,4 +3,4 @@

    Returns ScaleXY

    [x, y] scale as an array

    Example

    const gameobject = update_scale(create_circle(100), [2, 0.5]);
    query_scale(gameobject);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.query_text.html b/documentation/functions/arcade_2d.query_text.html index 0a1c66ca6..b32d84210 100644 --- a/documentation/functions/arcade_2d.query_text.html +++ b/documentation/functions/arcade_2d.query_text.html @@ -4,4 +4,4 @@

    Throws

    Error if not a TextGameObject is passed in

    Example

    const text = create_text("Hello World!");
    query_text(text);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.set_dimensions.html b/documentation/functions/arcade_2d.set_dimensions.html index 8639827ee..d3560ed7e 100644 --- a/documentation/functions/arcade_2d.set_dimensions.html +++ b/documentation/functions/arcade_2d.set_dimensions.html @@ -3,4 +3,4 @@

    Parameters

    Returns void

    Example

    // set the width as 500 and height as 400
    set_dimensions([500, 400]);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.set_fps.html b/documentation/functions/arcade_2d.set_fps.html index a0e6f738e..a8c3d7a1d 100644 --- a/documentation/functions/arcade_2d.set_fps.html +++ b/documentation/functions/arcade_2d.set_fps.html @@ -4,4 +4,4 @@

    Parameters

    Returns void

    Example

    // set fps to 60
    set_fps(60);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.set_scale.html b/documentation/functions/arcade_2d.set_scale.html index c58adb1d2..382f9f138 100644 --- a/documentation/functions/arcade_2d.set_scale.html +++ b/documentation/functions/arcade_2d.set_scale.html @@ -5,4 +5,4 @@

    Parameters

    Returns void

    Example

    // sets the scale of the canvas to 2.
    set_scale(2);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.stop_audio.html b/documentation/functions/arcade_2d.stop_audio.html index b71cbaaa8..d6e059bb3 100644 --- a/documentation/functions/arcade_2d.stop_audio.html +++ b/documentation/functions/arcade_2d.stop_audio.html @@ -3,4 +3,4 @@

    Returns AudioClip

    The AudioClip reference

    Example

    const audioClip = play_audio(create_audio("bgm/GalacticHarmony.mp3", 0.5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_color.html b/documentation/functions/arcade_2d.update_color.html index a96e3b836..57d3719fc 100644 --- a/documentation/functions/arcade_2d.update_color.html +++ b/documentation/functions/arcade_2d.update_color.html @@ -5,4 +5,4 @@

    Returns GameObject

    the GameObject reference passed in

    Example

    update_color(create_rectangle(100, 100), [255, 0, 0, 255]);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_flip.html b/documentation/functions/arcade_2d.update_flip.html index 21a812849..46b1b8184 100644 --- a/documentation/functions/arcade_2d.update_flip.html +++ b/documentation/functions/arcade_2d.update_flip.html @@ -4,4 +4,4 @@

    Returns GameObject

    the GameObject reference passed in

    Example

    update_flip(create_triangle(100, 100), [false, true]);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_loop.html b/documentation/functions/arcade_2d.update_loop.html index 82832cb86..fdb8542f5 100644 --- a/documentation/functions/arcade_2d.update_loop.html +++ b/documentation/functions/arcade_2d.update_loop.html @@ -7,4 +7,4 @@

    Parameters

    Returns void

    Example

    // Create gameobjects outside update_loop
    update_loop((game_state) => {
      // Update gameobjects inside update_loop

      // Using game_state as a counter
      if (game_state[0] === undefined) {
        game_state[0] = 0;
      }
      game_state[0] = game_state[0] + 1;
    })
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_position.html b/documentation/functions/arcade_2d.update_position.html index cc4033404..652524154 100644 --- a/documentation/functions/arcade_2d.update_position.html +++ b/documentation/functions/arcade_2d.update_position.html @@ -4,4 +4,4 @@

    Returns GameObject

    the GameObject reference passed in

    Example

    update_position(create_text("Hello world!"), [1, 2]);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_rotation.html b/documentation/functions/arcade_2d.update_rotation.html index 032523fb8..5d621527d 100644 --- a/documentation/functions/arcade_2d.update_rotation.html +++ b/documentation/functions/arcade_2d.update_rotation.html @@ -4,4 +4,4 @@

    Returns GameObject

    the GameObject reference passed in

    Example

    update_rotation(create_text("Hello world!"), math_PI);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_scale.html b/documentation/functions/arcade_2d.update_scale.html index 13b5acc79..ce291a68d 100644 --- a/documentation/functions/arcade_2d.update_scale.html +++ b/documentation/functions/arcade_2d.update_scale.html @@ -4,4 +4,4 @@

    Returns GameObject

    the GameObject reference passed in

    Example

    update_scale(create_text("Hello world!"), [2, 0.5]);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_text.html b/documentation/functions/arcade_2d.update_text.html index 824fa9da5..da494b5e2 100644 --- a/documentation/functions/arcade_2d.update_text.html +++ b/documentation/functions/arcade_2d.update_text.html @@ -5,4 +5,4 @@

    Throws

    Error if not a TextGameObject is passed in

    Example

    update_text(create_text("Hello world!"), "Goodbye world!");
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/arcade_2d.update_to_top.html b/documentation/functions/arcade_2d.update_to_top.html index 1dc720d3c..522fa9266 100644 --- a/documentation/functions/arcade_2d.update_to_top.html +++ b/documentation/functions/arcade_2d.update_to_top.html @@ -2,4 +2,4 @@

    Parameters

    Returns GameObject

    Example

    update_to_top(create_text("Hello world!"));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/binary_tree.entry.html b/documentation/functions/binary_tree.entry.html index 1be8738eb..e9dd5975b 100644 --- a/documentation/functions/binary_tree.entry.html +++ b/documentation/functions/binary_tree.entry.html @@ -3,4 +3,4 @@

    Returns boolean

    Value

    Example

    const tree = make_tree(1, make_empty_tree(), make_empty_tree());
    display(entry(tree)); // Shows "1" in the REPL
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/binary_tree.is_empty_tree.html b/documentation/functions/binary_tree.is_empty_tree.html index ee4ad96bf..c64abfc60 100644 --- a/documentation/functions/binary_tree.is_empty_tree.html +++ b/documentation/functions/binary_tree.is_empty_tree.html @@ -3,4 +3,4 @@

    Parameters

    Returns boolean

    bool

    Example

    const tree = make_tree(1, make_empty_tree(), make_empty_tree());
    display(is_empty_tree(tree)); // Shows "false" in the REPL
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/binary_tree.is_tree.html b/documentation/functions/binary_tree.is_tree.html index ff75a80dc..c433172e4 100644 --- a/documentation/functions/binary_tree.is_tree.html +++ b/documentation/functions/binary_tree.is_tree.html @@ -3,4 +3,4 @@

    Parameters

    Returns boolean

    bool

    Example

    const tree = make_tree(1, make_empty_tree(), make_empty_tree());
    display(is_tree(tree)); // Shows "true" in the REPL
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/binary_tree.left_branch.html b/documentation/functions/binary_tree.left_branch.html index 7c47e030c..42294c017 100644 --- a/documentation/functions/binary_tree.left_branch.html +++ b/documentation/functions/binary_tree.left_branch.html @@ -3,4 +3,4 @@

    Returns BinaryTree

    BinaryTree

    Example

    const tree = make_tree(1, make_tree(2, make_empty_tree(), make_empty_tree()), make_empty_tree());
    display(entry(left_branch(tree))); // Shows "2" in the REPL
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/binary_tree.make_empty_tree.html b/documentation/functions/binary_tree.make_empty_tree.html index d78e99565..0e1c69e74 100644 --- a/documentation/functions/binary_tree.make_empty_tree.html +++ b/documentation/functions/binary_tree.make_empty_tree.html @@ -2,4 +2,4 @@

    Returns BinaryTree

    An empty binary tree

    Example

    display(make_empty_tree()); // Shows "null" in the REPL
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/binary_tree.make_tree.html b/documentation/functions/binary_tree.make_tree.html index aa6929627..0002c66cb 100644 --- a/documentation/functions/binary_tree.make_tree.html +++ b/documentation/functions/binary_tree.make_tree.html @@ -5,4 +5,4 @@

    Returns BinaryTree

    A binary tree

    Example

    const tree = make_tree(1, make_empty_tree(), make_empty_tree());
    display(tree); // Shows "[1, [null, [null, null]]]" in the REPL
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/binary_tree.right_branch.html b/documentation/functions/binary_tree.right_branch.html index 9267c90d5..08a81e4f9 100644 --- a/documentation/functions/binary_tree.right_branch.html +++ b/documentation/functions/binary_tree.right_branch.html @@ -3,4 +3,4 @@

    Returns BinaryTree

    BinaryTree

    Example

    const tree = make_tree(1, make_empty_tree(), make_tree(2, make_empty_tree(), make_empty_tree()));
    display(entry(right_branch(tree))); // Shows "2" in the REPL
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.callFunction.html b/documentation/functions/communication.callFunction.html index f23a789fc..2a26acd38 100644 --- a/documentation/functions/communication.callFunction.html +++ b/documentation/functions/communication.callFunction.html @@ -3,4 +3,4 @@
  • name: string

    Identifier for function to call.

  • args: any[]

    Array of arguments to pass into the function.

  • callback: ((args) => void)

    Callback with return value.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.expose.html b/documentation/functions/communication.expose.html index b3db03f26..aa1655f05 100644 --- a/documentation/functions/communication.expose.html +++ b/documentation/functions/communication.expose.html @@ -2,4 +2,4 @@ Other users can use "callFunction" to call this function.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.getGlobalState.html b/documentation/functions/communication.getGlobalState.html index 7c6269732..4b801dc8f 100644 --- a/documentation/functions/communication.getGlobalState.html +++ b/documentation/functions/communication.getGlobalState.html @@ -1,3 +1,3 @@ getGlobalState | Source Academy Modules

    Function getGlobalState

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.getUserId.html b/documentation/functions/communication.getUserId.html index fe91e728e..51b1228eb 100644 --- a/documentation/functions/communication.getUserId.html +++ b/documentation/functions/communication.getUserId.html @@ -1,3 +1,3 @@ getUserId | Source Academy Modules

    Function getUserId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.initCommunications.html b/documentation/functions/communication.initCommunications.html index 8db1e4b6d..839de49a6 100644 --- a/documentation/functions/communication.initCommunications.html +++ b/documentation/functions/communication.initCommunications.html @@ -4,4 +4,4 @@
  • port: number

    WebSocket port number for broker.

  • user: string

    Username of account, use empty string if none.

  • password: string

    Password of account, use empty string if none.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.initGlobalState.html b/documentation/functions/communication.initGlobalState.html index 4b9f014e6..64da1d6d7 100644 --- a/documentation/functions/communication.initGlobalState.html +++ b/documentation/functions/communication.initGlobalState.html @@ -1,4 +1,4 @@ initGlobalState | Source Academy Modules

    Function initGlobalState

    • initGlobalState(topicHeader, callback): void

    • Initializes global state.

      Parameters

      • topicHeader: string

        MQTT topic to use for global state.

      • callback: ((state) => void)

        Callback to receive updates of global state.

        -
          • (state): void

          • Parameters

            • state: any

            Returns void

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.initRpc.html b/documentation/functions/communication.initRpc.html index 1f8d2767c..2343732c0 100644 --- a/documentation/functions/communication.initRpc.html +++ b/documentation/functions/communication.initRpc.html @@ -1,4 +1,4 @@ initRpc | Source Academy Modules

    Function initRpc

    • initRpc(topicHeader, userId?): void

    • Initializes RPC.

      Parameters

      • topicHeader: string

        MQTT topic to use for rpc.

      • Optional userId: string

        Identifier for this user, set undefined to generate a random ID.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.keepRunning.html b/documentation/functions/communication.keepRunning.html index 2306a27d5..a4abb456c 100644 --- a/documentation/functions/communication.keepRunning.html +++ b/documentation/functions/communication.keepRunning.html @@ -1,2 +1,2 @@ keepRunning | Source Academy Modules

    Function keepRunning

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.stopRunning.html b/documentation/functions/communication.stopRunning.html index 9c4b1ae5f..b63f9f7e6 100644 --- a/documentation/functions/communication.stopRunning.html +++ b/documentation/functions/communication.stopRunning.html @@ -1,2 +1,2 @@ stopRunning | Source Academy Modules

    Function stopRunning

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/communication.updateGlobalState.html b/documentation/functions/communication.updateGlobalState.html index a9ec1c943..742c3e2c8 100644 --- a/documentation/functions/communication.updateGlobalState.html +++ b/documentation/functions/communication.updateGlobalState.html @@ -2,4 +2,4 @@ Has ability to modify only part of the JSON state.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.allHeap.html b/documentation/functions/copy_gc.allHeap.html index 4ea1184cd..8347d32ac 100644 --- a/documentation/functions/copy_gc.allHeap.html +++ b/documentation/functions/copy_gc.allHeap.html @@ -1 +1 @@ -allHeap | Source Academy Modules

    Function allHeap

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +allHeap | Source Academy Modules

    Function allHeap

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.doneShowRoot.html b/documentation/functions/copy_gc.doneShowRoot.html index 13a8df72b..dea0c1d41 100644 --- a/documentation/functions/copy_gc.doneShowRoot.html +++ b/documentation/functions/copy_gc.doneShowRoot.html @@ -1 +1 @@ -doneShowRoot | Source Academy Modules

    Function doneShowRoot

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +doneShowRoot | Source Academy Modules

    Function doneShowRoot

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.endFlip.html b/documentation/functions/copy_gc.endFlip.html index 869f948af..044b1978c 100644 --- a/documentation/functions/copy_gc.endFlip.html +++ b/documentation/functions/copy_gc.endFlip.html @@ -1 +1 @@ -endFlip | Source Academy Modules

    Function endFlip

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +endFlip | Source Academy Modules

    Function endFlip

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.generateMemory.html b/documentation/functions/copy_gc.generateMemory.html index 56547fb0b..65c36e7e7 100644 --- a/documentation/functions/copy_gc.generateMemory.html +++ b/documentation/functions/copy_gc.generateMemory.html @@ -1 +1 @@ -generateMemory | Source Academy Modules

    Function generateMemory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +generateMemory | Source Academy Modules

    Function generateMemory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.init.html b/documentation/functions/copy_gc.init.html index fdd29cdf3..d78673fa4 100644 --- a/documentation/functions/copy_gc.init.html +++ b/documentation/functions/copy_gc.init.html @@ -1 +1 @@ -init | Source Academy Modules

    Function init

    • init(): {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_from_memory_matrix: (() => MemoryHeaps);
          get_from_space: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_to_memory_matrix: (() => MemoryHeaps);
          get_to_space: (() => number);
          get_types: (() => String[]);
          toReplString: (() => string);
      }

    • Returns {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_from_memory_matrix: (() => MemoryHeaps);
          get_from_space: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_to_memory_matrix: (() => MemoryHeaps);
          get_to_space: (() => number);
          get_types: (() => String[]);
          toReplString: (() => string);
      }

      • get_column_size: (() => number)
          • (): number

          • Returns number

      • get_command: (() => CommandHeapObject[])
          • (): CommandHeapObject[]

          • Returns CommandHeapObject[]

      • get_flips: (() => number[])
          • (): number[]

          • Returns number[]

      • get_from_memory_matrix: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_from_space: (() => number)
          • (): number

          • Returns number

      • get_memory_heap: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_memory_size: (() => number)
          • (): number

          • Returns number

      • get_roots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_row_size: (() => number)
          • (): number

          • Returns number

      • get_slots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_tags: (() => Tag[])
          • (): Tag[]

          • Returns Tag[]

      • get_to_memory_matrix: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_to_space: (() => number)
          • (): number

          • Returns number

      • get_types: (() => String[])
          • (): String[]

          • Returns String[]

      • toReplString: (() => string)
          • (): string

          • Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +init | Source Academy Modules

    Function init

    • init(): {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_from_memory_matrix: (() => MemoryHeaps);
          get_from_space: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_to_memory_matrix: (() => MemoryHeaps);
          get_to_space: (() => number);
          get_types: (() => String[]);
          toReplString: (() => string);
      }

    • Returns {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_from_memory_matrix: (() => MemoryHeaps);
          get_from_space: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_to_memory_matrix: (() => MemoryHeaps);
          get_to_space: (() => number);
          get_types: (() => String[]);
          toReplString: (() => string);
      }

      • get_column_size: (() => number)
          • (): number

          • Returns number

      • get_command: (() => CommandHeapObject[])
          • (): CommandHeapObject[]

          • Returns CommandHeapObject[]

      • get_flips: (() => number[])
          • (): number[]

          • Returns number[]

      • get_from_memory_matrix: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_from_space: (() => number)
          • (): number

          • Returns number

      • get_memory_heap: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_memory_size: (() => number)
          • (): number

          • Returns number

      • get_roots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_row_size: (() => number)
          • (): number

          • Returns number

      • get_slots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_tags: (() => Tag[])
          • (): Tag[]

          • Returns Tag[]

      • get_to_memory_matrix: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_to_space: (() => number)
          • (): number

          • Returns number

      • get_types: (() => String[])
          • (): String[]

          • Returns String[]

      • toReplString: (() => string)
          • (): string

          • Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.initialize_memory.html b/documentation/functions/copy_gc.initialize_memory.html index d57a79c90..b99e1e5cd 100644 --- a/documentation/functions/copy_gc.initialize_memory.html +++ b/documentation/functions/copy_gc.initialize_memory.html @@ -1 +1 @@ -initialize_memory | Source Academy Modules

    Function initialize_memory

    • initialize_memory(memorySize): void

    • Parameters

      • memorySize: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +initialize_memory | Source Academy Modules

    Function initialize_memory

    • initialize_memory(memorySize): void

    • Parameters

      • memorySize: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.initialize_tag.html b/documentation/functions/copy_gc.initialize_tag.html index b3d9feeba..9d60428bb 100644 --- a/documentation/functions/copy_gc.initialize_tag.html +++ b/documentation/functions/copy_gc.initialize_tag.html @@ -1 +1 @@ -initialize_tag | Source Academy Modules

    Function initialize_tag

    • initialize_tag(allTag, types): void

    • Parameters

      • allTag: number[]
      • types: string[]

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +initialize_tag | Source Academy Modules

    Function initialize_tag

    • initialize_tag(allTag, types): void

    • Parameters

      • allTag: number[]
      • types: string[]

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.newAssign.html b/documentation/functions/copy_gc.newAssign.html index 4cf21ac38..7dcd50bc4 100644 --- a/documentation/functions/copy_gc.newAssign.html +++ b/documentation/functions/copy_gc.newAssign.html @@ -1 +1 @@ -newAssign | Source Academy Modules

    Function newAssign

    • newAssign(res, left, heap): void

    • Parameters

      • res: any
      • left: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newAssign | Source Academy Modules

    Function newAssign

    • newAssign(res, left, heap): void

    • Parameters

      • res: any
      • left: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.newCommand.html b/documentation/functions/copy_gc.newCommand.html index 9766b38d9..4e1a9f09f 100644 --- a/documentation/functions/copy_gc.newCommand.html +++ b/documentation/functions/copy_gc.newCommand.html @@ -1 +1 @@ -newCommand | Source Academy Modules

    Function newCommand

    • newCommand(type, toSpace, fromSpace, left, right, sizeLeft, sizeRight, heap, description, firstDesc, lastDesc): void

    • Parameters

      • type: any
      • toSpace: any
      • fromSpace: any
      • left: any
      • right: any
      • sizeLeft: any
      • sizeRight: any
      • heap: any
      • description: any
      • firstDesc: any
      • lastDesc: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newCommand | Source Academy Modules

    Function newCommand

    • newCommand(type, toSpace, fromSpace, left, right, sizeLeft, sizeRight, heap, description, firstDesc, lastDesc): void

    • Parameters

      • type: any
      • toSpace: any
      • fromSpace: any
      • left: any
      • right: any
      • sizeLeft: any
      • sizeRight: any
      • heap: any
      • description: any
      • firstDesc: any
      • lastDesc: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.newCopy.html b/documentation/functions/copy_gc.newCopy.html index 5250961ff..96e80d423 100644 --- a/documentation/functions/copy_gc.newCopy.html +++ b/documentation/functions/copy_gc.newCopy.html @@ -1 +1 @@ -newCopy | Source Academy Modules

    Function newCopy

    • newCopy(left, right, heap): void

    • Parameters

      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newCopy | Source Academy Modules

    Function newCopy

    • newCopy(left, right, heap): void

    • Parameters

      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.newNew.html b/documentation/functions/copy_gc.newNew.html index 535541c57..bd902bb1e 100644 --- a/documentation/functions/copy_gc.newNew.html +++ b/documentation/functions/copy_gc.newNew.html @@ -1 +1 @@ -newNew | Source Academy Modules

    Function newNew

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newNew | Source Academy Modules

    Function newNew

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.newPop.html b/documentation/functions/copy_gc.newPop.html index e35da5e48..97a9cd4a4 100644 --- a/documentation/functions/copy_gc.newPop.html +++ b/documentation/functions/copy_gc.newPop.html @@ -1 +1 @@ -newPop | Source Academy Modules

    Function newPop

    • newPop(res, left, right, heap): void

    • Parameters

      • res: any
      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newPop | Source Academy Modules

    Function newPop

    • newPop(res, left, right, heap): void

    • Parameters

      • res: any
      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.newPush.html b/documentation/functions/copy_gc.newPush.html index bb5741eb9..b69aeda1d 100644 --- a/documentation/functions/copy_gc.newPush.html +++ b/documentation/functions/copy_gc.newPush.html @@ -1 +1 @@ -newPush | Source Academy Modules

    Function newPush

    • newPush(left, right, heap): void

    • Parameters

      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newPush | Source Academy Modules

    Function newPush

    • newPush(left, right, heap): void

    • Parameters

      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.resetFromSpace.html b/documentation/functions/copy_gc.resetFromSpace.html index 3af18469d..65267e1ae 100644 --- a/documentation/functions/copy_gc.resetFromSpace.html +++ b/documentation/functions/copy_gc.resetFromSpace.html @@ -1 +1 @@ -resetFromSpace | Source Academy Modules

    Function resetFromSpace

    • resetFromSpace(fromSpace, heap): number[]

    • Parameters

      • fromSpace: any
      • heap: any

      Returns number[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +resetFromSpace | Source Academy Modules

    Function resetFromSpace

    • resetFromSpace(fromSpace, heap): number[]

    • Parameters

      • fromSpace: any
      • heap: any

      Returns number[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.resetRoots.html b/documentation/functions/copy_gc.resetRoots.html index 30a56f309..91ee86b2c 100644 --- a/documentation/functions/copy_gc.resetRoots.html +++ b/documentation/functions/copy_gc.resetRoots.html @@ -1 +1 @@ -resetRoots | Source Academy Modules

    Function resetRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +resetRoots | Source Academy Modules

    Function resetRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.scanFlip.html b/documentation/functions/copy_gc.scanFlip.html index 9dd39d109..2f5cfafc6 100644 --- a/documentation/functions/copy_gc.scanFlip.html +++ b/documentation/functions/copy_gc.scanFlip.html @@ -1 +1 @@ -scanFlip | Source Academy Modules

    Function scanFlip

    • scanFlip(left, right, scan, free, heap): void

    • Parameters

      • left: any
      • right: any
      • scan: any
      • free: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +scanFlip | Source Academy Modules

    Function scanFlip

    • scanFlip(left, right, scan, free, heap): void

    • Parameters

      • left: any
      • right: any
      • scan: any
      • free: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.showRoots.html b/documentation/functions/copy_gc.showRoots.html index f73674006..0e42fe9c9 100644 --- a/documentation/functions/copy_gc.showRoots.html +++ b/documentation/functions/copy_gc.showRoots.html @@ -1 +1 @@ -showRoots | Source Academy Modules

    Function showRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +showRoots | Source Academy Modules

    Function showRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.startFlip.html b/documentation/functions/copy_gc.startFlip.html index b28642e8e..4847b256c 100644 --- a/documentation/functions/copy_gc.startFlip.html +++ b/documentation/functions/copy_gc.startFlip.html @@ -1 +1 @@ -startFlip | Source Academy Modules

    Function startFlip

    • startFlip(toSpace, fromSpace, heap): void

    • Parameters

      • toSpace: any
      • fromSpace: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +startFlip | Source Academy Modules

    Function startFlip

    • startFlip(toSpace, fromSpace, heap): void

    • Parameters

      • toSpace: any
      • fromSpace: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.updateRoots.html b/documentation/functions/copy_gc.updateRoots.html index e8d400c63..10a0c9414 100644 --- a/documentation/functions/copy_gc.updateRoots.html +++ b/documentation/functions/copy_gc.updateRoots.html @@ -1 +1 @@ -updateRoots | Source Academy Modules

    Function updateRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +updateRoots | Source Academy Modules

    Function updateRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/copy_gc.updateSlotSegment.html b/documentation/functions/copy_gc.updateSlotSegment.html index 45f2c103c..686b8fc0e 100644 --- a/documentation/functions/copy_gc.updateSlotSegment.html +++ b/documentation/functions/copy_gc.updateSlotSegment.html @@ -1 +1 @@ -updateSlotSegment | Source Academy Modules

    Function updateSlotSegment

    • updateSlotSegment(tag, size, first, last): void

    • Parameters

      • tag: number
      • size: number
      • first: number
      • last: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +updateSlotSegment | Source Academy Modules

    Function updateSlotSegment

    • updateSlotSegment(tag, size, first, last): void

    • Parameters

      • tag: number
      • size: number
      • first: number
      • last: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.bounding_box.html b/documentation/functions/csg.bounding_box.html index 20180c2c7..5a5eb14f9 100644 --- a/documentation/functions/csg.bounding_box.html +++ b/documentation/functions/csg.bounding_box.html @@ -10,4 +10,4 @@

    Parameters

    Returns ((axis, minMax) => number)

    bounding box getter function

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.cone.html b/documentation/functions/csg.cone.html index 2d9c50f09..485f2ae88 100644 --- a/documentation/functions/csg.cone.html +++ b/documentation/functions/csg.cone.html @@ -5,4 +5,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.cube.html b/documentation/functions/csg.cube.html index 65411cf6c..d7f17d75c 100644 --- a/documentation/functions/csg.cube.html +++ b/documentation/functions/csg.cube.html @@ -4,4 +4,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.cylinder.html b/documentation/functions/csg.cylinder.html index cf7618a69..f6e62d3ac 100644 --- a/documentation/functions/csg.cylinder.html +++ b/documentation/functions/csg.cylinder.html @@ -5,4 +5,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.download_shape_stl.html b/documentation/functions/csg.download_shape_stl.html index 6e39bf126..620d3cbf5 100644 --- a/documentation/functions/csg.download_shape_stl.html +++ b/documentation/functions/csg.download_shape_stl.html @@ -1,4 +1,4 @@ download_shape_stl | Source Academy Modules

    Function download_shape_stl

    • download_shape_stl(shape): Promise<void>

    • Exports the specified Shape as an STL file, downloaded to your device.

      The file can be used for purposes such as 3D printing.

      Parameters

      • shape: Shape

        Shape to export

        -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.empty_shape.html b/documentation/functions/csg.empty_shape.html index b466711e9..2a2cee8ac 100644 --- a/documentation/functions/csg.empty_shape.html +++ b/documentation/functions/csg.empty_shape.html @@ -1,2 +1,2 @@ empty_shape | Source Academy Modules

    Function empty_shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.geodesic_sphere.html b/documentation/functions/csg.geodesic_sphere.html index 7ab59c486..63825626d 100644 --- a/documentation/functions/csg.geodesic_sphere.html +++ b/documentation/functions/csg.geodesic_sphere.html @@ -4,4 +4,4 @@
  • Center: Floating at (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.group.html b/documentation/functions/csg.group.html index 54ea124c5..5ac712586 100644 --- a/documentation/functions/csg.group.html +++ b/documentation/functions/csg.group.html @@ -5,4 +5,4 @@ scale(group, 5, 5, 5) is.

    Parameters

    Returns Group

    new Group

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.intersect.html b/documentation/functions/csg.intersect.html index 8940dd518..21901ce8f 100644 --- a/documentation/functions/csg.intersect.html +++ b/documentation/functions/csg.intersect.html @@ -2,4 +2,4 @@

    Parameters

    Returns Shape

    intersected Shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.is_group.html b/documentation/functions/csg.is_group.html index 58b971659..babbd0a38 100644 --- a/documentation/functions/csg.is_group.html +++ b/documentation/functions/csg.is_group.html @@ -1,4 +1,4 @@ is_group | Source Academy Modules

    Function is_group

    • is_group(parameter): boolean

    • Checks if the given parameter is a Group.

      Parameters

      • parameter: unknown

        parameter to check

      Returns boolean

      whether parameter is a Group

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.is_shape.html b/documentation/functions/csg.is_shape.html index 708aa54e2..6d28c7e4e 100644 --- a/documentation/functions/csg.is_shape.html +++ b/documentation/functions/csg.is_shape.html @@ -1,4 +1,4 @@ is_shape | Source Academy Modules

    Function is_shape

    • is_shape(parameter): boolean

    • Checks if the given parameter is a Shape.

      Parameters

      • parameter: unknown

        parameter to check

      Returns boolean

      whether parameter is a Shape

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.prism.html b/documentation/functions/csg.prism.html index 222acd278..bff4746e1 100644 --- a/documentation/functions/csg.prism.html +++ b/documentation/functions/csg.prism.html @@ -5,4 +5,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.pyramid.html b/documentation/functions/csg.pyramid.html index d8a62a8ec..28d2a9f97 100644 --- a/documentation/functions/csg.pyramid.html +++ b/documentation/functions/csg.pyramid.html @@ -5,4 +5,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.render.html b/documentation/functions/csg.render.html index 207ad934a..411ee7338 100644 --- a/documentation/functions/csg.render.html +++ b/documentation/functions/csg.render.html @@ -1,3 +1,3 @@ render | Source Academy Modules

    Function render

    • render(operable): RenderGroup

    • Renders the specified Operable.

      Parameters

      • operable: Operable

        Shape or Group to render

        -

      Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.render_axes.html b/documentation/functions/csg.render_axes.html index 5fad40256..f6681a756 100644 --- a/documentation/functions/csg.render_axes.html +++ b/documentation/functions/csg.render_axes.html @@ -1,3 +1,3 @@ render_axes | Source Academy Modules

    Function render_axes

    • render_axes(operable): RenderGroup

    • Renders the specified Operable, along with z, y, and z axes.

      Parameters

      • operable: Operable

        Shape or Group to render

        -

      Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.render_grid.html b/documentation/functions/csg.render_grid.html index 9e3279cae..945a354d0 100644 --- a/documentation/functions/csg.render_grid.html +++ b/documentation/functions/csg.render_grid.html @@ -1,3 +1,3 @@ render_grid | Source Academy Modules

    Function render_grid

    • render_grid(operable): RenderGroup

    • Renders the specified Operable, along with a grid.

      Parameters

      • operable: Operable

        Shape or Group to render

        -

      Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.render_grid_axes.html b/documentation/functions/csg.render_grid_axes.html index 237139b8f..18a0be766 100644 --- a/documentation/functions/csg.render_grid_axes.html +++ b/documentation/functions/csg.render_grid_axes.html @@ -1,3 +1,3 @@ render_grid_axes | Source Academy Modules

    Function render_grid_axes

    • render_grid_axes(operable): RenderGroup

    • Renders the specified Operable, along with both a grid and axes.

      Parameters

      • operable: Operable

        Shape or Group to render

        -

      Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns RenderGroup

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.rgb.html b/documentation/functions/csg.rgb.html index 86cdba8ca..23e7280a6 100644 --- a/documentation/functions/csg.rgb.html +++ b/documentation/functions/csg.rgb.html @@ -3,4 +3,4 @@
  • greenValue: number

    green value of the color

  • blueValue: number

    blue value of the color

    • Returns string

    hex color code

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.rotate.html b/documentation/functions/csg.rotate.html index e53ef0c4c..3edb08652 100644 --- a/documentation/functions/csg.rotate.html +++ b/documentation/functions/csg.rotate.html @@ -8,4 +8,4 @@
  • yAngle: number

    y angle in radians

  • zAngle: number

    z angle in radians

    • Returns Operable

    rotated Shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.rounded_cube.html b/documentation/functions/csg.rounded_cube.html index 307daf324..706b47e83 100644 --- a/documentation/functions/csg.rounded_cube.html +++ b/documentation/functions/csg.rounded_cube.html @@ -4,4 +4,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.rounded_cylinder.html b/documentation/functions/csg.rounded_cylinder.html index c9c73681f..7205069a1 100644 --- a/documentation/functions/csg.rounded_cylinder.html +++ b/documentation/functions/csg.rounded_cylinder.html @@ -5,4 +5,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.scale.html b/documentation/functions/csg.scale.html index 3db619312..7d2cbecda 100644 --- a/documentation/functions/csg.scale.html +++ b/documentation/functions/csg.scale.html @@ -8,4 +8,4 @@
  • yFactor: number

    y scaling factor

  • zFactor: number

    z scaling factor

    • Returns Operable

    scaled Shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.sphere.html b/documentation/functions/csg.sphere.html index ba02e8054..7d19d1bec 100644 --- a/documentation/functions/csg.sphere.html +++ b/documentation/functions/csg.sphere.html @@ -4,4 +4,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.star.html b/documentation/functions/csg.star.html index 5dd89ce03..408a27ed1 100644 --- a/documentation/functions/csg.star.html +++ b/documentation/functions/csg.star.html @@ -4,4 +4,4 @@
  • Center: (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.subtract.html b/documentation/functions/csg.subtract.html index 8f64126da..a74920afe 100644 --- a/documentation/functions/csg.subtract.html +++ b/documentation/functions/csg.subtract.html @@ -3,4 +3,4 @@

    Parameters

    Returns Shape

    subtracted Shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.torus.html b/documentation/functions/csg.torus.html index 3b1613f41..28418981d 100644 --- a/documentation/functions/csg.torus.html +++ b/documentation/functions/csg.torus.html @@ -5,4 +5,4 @@
  • Center: Floating at (0.5, 0.5, 0.5)

    • Parameters

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Shape

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.translate.html b/documentation/functions/csg.translate.html index ee83a5423..372d717e4 100644 --- a/documentation/functions/csg.translate.html +++ b/documentation/functions/csg.translate.html @@ -5,4 +5,4 @@
  • yOffset: number

    y offset

  • zOffset: number

    z offset

    • Returns Operable

    translated Shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.ungroup.html b/documentation/functions/csg.ungroup.html index 3a826f693..8af53318e 100644 --- a/documentation/functions/csg.ungroup.html +++ b/documentation/functions/csg.ungroup.html @@ -2,4 +2,4 @@ Groups contained within.

    Parameters

    Returns List

    ungrouped list of Shapes and/or Groups

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/csg.union.html b/documentation/functions/csg.union.html index 21954e922..e158bbb25 100644 --- a/documentation/functions/csg.union.html +++ b/documentation/functions/csg.union.html @@ -2,4 +2,4 @@

    Parameters

    Returns Shape

    unioned Shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.animate_3D_curve.html b/documentation/functions/curve.animate_3D_curve.html index d9860cb54..43d4a32ef 100644 --- a/documentation/functions/curve.animate_3D_curve.html +++ b/documentation/functions/curve.animate_3D_curve.html @@ -4,4 +4,4 @@
  • drawer: RenderFunction

    Draw function to the generated curves with

  • func: CurveAnimation

    Curve generating function. Takes in a timestamp value and returns a curve

    • Returns AnimatedCurve

    3D Curve Animation

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.animate_curve.html b/documentation/functions/curve.animate_curve.html index acca1b536..47e7f1dae 100644 --- a/documentation/functions/curve.animate_curve.html +++ b/documentation/functions/curve.animate_curve.html @@ -4,4 +4,4 @@
  • drawer: RenderFunction

    Draw function to the generated curves with

  • func: CurveAnimation

    Curve generating function. Takes in a timestamp value and returns a curve

    • Returns AnimatedCurve

    Curve Animation

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.arc.html b/documentation/functions/curve.arc.html index ff86cf901..55f752be7 100644 --- a/documentation/functions/curve.arc.html +++ b/documentation/functions/curve.arc.html @@ -4,4 +4,4 @@ (0, -1).

    Parameters

    Returns Point

    Point in the arc at t

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.b_of.html b/documentation/functions/curve.b_of.html index 90e715f0b..25e0bdefe 100644 --- a/documentation/functions/curve.b_of.html +++ b/documentation/functions/curve.b_of.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    Blue component of the Point

    Example

    const point = make_color_point(1, 2, 3, 50, 100, 150);
    b_of(point); // Returns 150
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.connect_ends.html b/documentation/functions/curve.connect_ends.html index e07629d38..e063e0a81 100644 --- a/documentation/functions/curve.connect_ends.html +++ b/documentation/functions/curve.connect_ends.html @@ -7,4 +7,4 @@

    Parameters

    Returns Curve

    result Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.connect_rigidly.html b/documentation/functions/curve.connect_rigidly.html index d25050711..c29b40d60 100644 --- a/documentation/functions/curve.connect_rigidly.html +++ b/documentation/functions/curve.connect_rigidly.html @@ -6,4 +6,4 @@

    Parameters

    Returns Curve

    result Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_3D_connected.html b/documentation/functions/curve.draw_3D_connected.html index 2b99b46db..49a28e02f 100644 --- a/documentation/functions/curve.draw_3D_connected.html +++ b/documentation/functions/curve.draw_3D_connected.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_3D_connected(100)(t => make_3D_point(t, t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_3D_connected_full_view.html b/documentation/functions/curve.draw_3D_connected_full_view.html index f9ad37d4c..ed00e7329 100644 --- a/documentation/functions/curve.draw_3D_connected_full_view.html +++ b/documentation/functions/curve.draw_3D_connected_full_view.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_3D_connected_full_view(100)(t => make_3D_point(t, t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_3D_connected_full_view_proportional.html b/documentation/functions/curve.draw_3D_connected_full_view_proportional.html index 5fdac8186..9768439a9 100644 --- a/documentation/functions/curve.draw_3D_connected_full_view_proportional.html +++ b/documentation/functions/curve.draw_3D_connected_full_view_proportional.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_3D_connected_full_view_proportional(100)(t => make_3D_point(t, t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_3D_points.html b/documentation/functions/curve.draw_3D_points.html index da85b18c6..04b72911c 100644 --- a/documentation/functions/curve.draw_3D_points.html +++ b/documentation/functions/curve.draw_3D_points.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_3D_points(100)(t => make_3D_point(t, t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_3D_points_full_view.html b/documentation/functions/curve.draw_3D_points_full_view.html index 50ca91f2b..7f04979e2 100644 --- a/documentation/functions/curve.draw_3D_points_full_view.html +++ b/documentation/functions/curve.draw_3D_points_full_view.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_3D_points_full_view(100)(t => make_3D_point(t, t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_3D_points_full_view_proportional.html b/documentation/functions/curve.draw_3D_points_full_view_proportional.html index 979ef6f71..875183124 100644 --- a/documentation/functions/curve.draw_3D_points_full_view_proportional.html +++ b/documentation/functions/curve.draw_3D_points_full_view_proportional.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_3D_points_full_view_proportional(100)(t => make_3D_point(t, t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_connected.html b/documentation/functions/curve.draw_connected.html index d14b828c0..cee537752 100644 --- a/documentation/functions/curve.draw_connected.html +++ b/documentation/functions/curve.draw_connected.html @@ -4,4 +4,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_connected(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_connected_full_view.html b/documentation/functions/curve.draw_connected_full_view.html index d818cf2bb..824415530 100644 --- a/documentation/functions/curve.draw_connected_full_view.html +++ b/documentation/functions/curve.draw_connected_full_view.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_connected_full_view(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_connected_full_view_proportional.html b/documentation/functions/curve.draw_connected_full_view_proportional.html index b0b2ce140..2987abaeb 100644 --- a/documentation/functions/curve.draw_connected_full_view_proportional.html +++ b/documentation/functions/curve.draw_connected_full_view_proportional.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_connected_full_view_proportional(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_points.html b/documentation/functions/curve.draw_points.html index 43d3aad5e..c94c38ffc 100644 --- a/documentation/functions/curve.draw_points.html +++ b/documentation/functions/curve.draw_points.html @@ -5,4 +5,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_points(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_points_full_view.html b/documentation/functions/curve.draw_points_full_view.html index 91301fb48..30d94b21a 100644 --- a/documentation/functions/curve.draw_points_full_view.html +++ b/documentation/functions/curve.draw_points_full_view.html @@ -6,4 +6,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_points_full_view(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.draw_points_full_view_proportional.html b/documentation/functions/curve.draw_points_full_view_proportional.html index 4f78cc205..755173191 100644 --- a/documentation/functions/curve.draw_points_full_view_proportional.html +++ b/documentation/functions/curve.draw_points_full_view_proportional.html @@ -6,4 +6,4 @@

    Parameters

    Returns RenderFunction

    function of type Curve → Drawing

    Example

    draw_points_full_view_proportional(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.g_of.html b/documentation/functions/curve.g_of.html index 2d940d1cc..81b22b517 100644 --- a/documentation/functions/curve.g_of.html +++ b/documentation/functions/curve.g_of.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    Green component of the Point

    Example

    const point = make_color_point(1, 2, 3, 50, 100, 150);
    g_of(point); // Returns 100
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.invert.html b/documentation/functions/curve.invert.html index c40e0ec8a..505c40659 100644 --- a/documentation/functions/curve.invert.html +++ b/documentation/functions/curve.invert.html @@ -3,4 +3,4 @@ original Curve, but in reverse: The result Curve applied to 0 is the original Curve applied to 1 and vice versa.

    Parameters

    Returns Curve

    result Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.make_3D_color_point.html b/documentation/functions/curve.make_3D_color_point.html index 5ca2d3171..5f2f499f8 100644 --- a/documentation/functions/curve.make_3D_color_point.html +++ b/documentation/functions/curve.make_3D_color_point.html @@ -10,4 +10,4 @@

    Returns Point

    with x, y and z as coordinates, and r, g and b as RGB values

    Example

    const redPoint = make_color_point(0.5, 0.5, 0.5, 255, 0, 0);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.make_3D_point.html b/documentation/functions/curve.make_3D_point.html index b696b3a22..b756fd6fa 100644 --- a/documentation/functions/curve.make_3D_point.html +++ b/documentation/functions/curve.make_3D_point.html @@ -5,4 +5,4 @@

    Returns Point

    with x, y and z as coordinates

    Example

    const point = make_3D_point(0.5, 0.5, 0.5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.make_color_point.html b/documentation/functions/curve.make_color_point.html index 098531edb..ace1595dc 100644 --- a/documentation/functions/curve.make_color_point.html +++ b/documentation/functions/curve.make_color_point.html @@ -9,4 +9,4 @@

    Returns Point

    with x and y as coordinates, and r, g and b as RGB values

    Example

    const redPoint = make_color_point(0.5, 0.5, 255, 0, 0);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.make_point.html b/documentation/functions/curve.make_point.html index 4d55f3bef..f5de4fd14 100644 --- a/documentation/functions/curve.make_point.html +++ b/documentation/functions/curve.make_point.html @@ -4,4 +4,4 @@

    Returns Point

    with x and y as coordinates

    Example

    const point = make_point(0.5, 0.5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.put_in_standard_position.html b/documentation/functions/curve.put_in_standard_position.html index 21b025ee8..6c97dbf01 100644 --- a/documentation/functions/curve.put_in_standard_position.html +++ b/documentation/functions/curve.put_in_standard_position.html @@ -7,4 +7,4 @@ on closed Curves where start-point equal end-point.

    Parameters

    Returns Curve

    result Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.r_of.html b/documentation/functions/curve.r_of.html index 47aa7840e..4c9a2c8ef 100644 --- a/documentation/functions/curve.r_of.html +++ b/documentation/functions/curve.r_of.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    Red component of the Point

    Example

    const point = make_color_point(1, 2, 3, 50, 100, 150);
    r_of(point); // Returns 50
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.rotate_around_origin.html b/documentation/functions/curve.rotate_around_origin.html index e61c5ec73..39aacb659 100644 --- a/documentation/functions/curve.rotate_around_origin.html +++ b/documentation/functions/curve.rotate_around_origin.html @@ -4,4 +4,4 @@ extrinsically with Euler angles (a, b, c) about x, y, and z axes.

    Parameters

    Returns CurveTransformer

    function that takes a Curve and returns a Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.scale.html b/documentation/functions/curve.scale.html index 728d4aa41..15b7a3802 100644 --- a/documentation/functions/curve.scale.html +++ b/documentation/functions/curve.scale.html @@ -6,4 +6,4 @@
  • b: number

    scaling factor in y-direction

  • c: number

    scaling factor in z-direction

    • Returns CurveTransformer

    function that takes a Curve and returns a Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.scale_proportional.html b/documentation/functions/curve.scale_proportional.html index 7481488cc..f14232b0a 100644 --- a/documentation/functions/curve.scale_proportional.html +++ b/documentation/functions/curve.scale_proportional.html @@ -2,4 +2,4 @@ transformation that scales a given Curve by s in x, y and z direction.

    Parameters

    Returns CurveTransformer

    function that takes a Curve and returns a Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.translate.html b/documentation/functions/curve.translate.html index abf2a8585..b1f9a250b 100644 --- a/documentation/functions/curve.translate.html +++ b/documentation/functions/curve.translate.html @@ -7,4 +7,4 @@
  • y0: number

    y-value

  • z0: number

    z-value

    • Returns CurveTransformer

    Curve transformation

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.unit_circle.html b/documentation/functions/curve.unit_circle.html index 856447be7..849cbd85f 100644 --- a/documentation/functions/curve.unit_circle.html +++ b/documentation/functions/curve.unit_circle.html @@ -3,4 +3,4 @@ 0.25, they reach Point (0,1), when t is 0.5, they reach Point (-1, 0), etc.

    Parameters

    Returns Point

    Point on the circle at t

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.unit_line.html b/documentation/functions/curve.unit_line.html index 7cc819422..03186fd3e 100644 --- a/documentation/functions/curve.unit_line.html +++ b/documentation/functions/curve.unit_line.html @@ -2,4 +2,4 @@ x-coordinate at fraction t is t, and the y-coordinate is 0.

    Parameters

    Returns Point

    Point on the line at t

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.unit_line_at.html b/documentation/functions/curve.unit_line_at.html index 8a3e9d57e..994eeec28 100644 --- a/documentation/functions/curve.unit_line_at.html +++ b/documentation/functions/curve.unit_line_at.html @@ -3,4 +3,4 @@ points with the given y-coordinate.

    Parameters

    Returns Curve

    horizontal Curve

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.x_of.html b/documentation/functions/curve.x_of.html index bbc72c463..95591cc5f 100644 --- a/documentation/functions/curve.x_of.html +++ b/documentation/functions/curve.x_of.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    x-coordinate of the Point

    Example

    const point = make_color_point(1, 2, 3, 50, 100, 150);
    x_of(point); // Returns 1
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.y_of.html b/documentation/functions/curve.y_of.html index 703563cfa..9a93b1e97 100644 --- a/documentation/functions/curve.y_of.html +++ b/documentation/functions/curve.y_of.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    y-coordinate of the Point

    Example

    const point = make_color_point(1, 2, 3, 50, 100, 150);
    y_of(point); // Returns 2
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/curve.z_of.html b/documentation/functions/curve.z_of.html index ab583ee86..671960c13 100644 --- a/documentation/functions/curve.z_of.html +++ b/documentation/functions/curve.z_of.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    z-coordinate of the Point

    Example

    const point = make_color_point(1, 2, 3, 50, 100, 150);
    z_of(point); // Returns 3
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.add.html b/documentation/functions/game.add.html index 5e4f9feff..4133ba26f 100644 --- a/documentation/functions/game.add.html +++ b/documentation/functions/game.add.html @@ -1,4 +1,4 @@ add | Source Academy Modules

    Function add

    • add(obj): GameObject | undefined

    • Add the object to the scene. Only objects added to the scene will appear.

      Parameters

      • obj: GameObject

        game object to be added

        -

      Returns GameObject | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns GameObject | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.add_keyboard_listener.html b/documentation/functions/game.add_keyboard_listener.html index 90c10af2d..66a24470d 100644 --- a/documentation/functions/game.add_keyboard_listener.html +++ b/documentation/functions/game.add_keyboard_listener.html @@ -9,4 +9,4 @@
  • event: string

    the event name

  • callback: Function

    listener function, executed on event

    • Returns GameObject

    listener game object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.add_listener.html b/documentation/functions/game.add_listener.html index f693480e1..86dd74eed 100644 --- a/documentation/functions/game.add_listener.html +++ b/documentation/functions/game.add_listener.html @@ -7,4 +7,4 @@
  • event: string

    the event name

  • callback: Function

    listener function, executed on event

    • Returns GameObject | undefined

    listener game object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.add_to_container.html b/documentation/functions/game.add_to_container.html index 0e56b6a4c..dd21185d8 100644 --- a/documentation/functions/game.add_to_container.html +++ b/documentation/functions/game.add_to_container.html @@ -3,4 +3,4 @@

    Parameters

    Returns GameObject | undefined

    container object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.add_tween.html b/documentation/functions/game.add_tween.html index a0cd651dd..276f0d7bf 100644 --- a/documentation/functions/game.add_tween.html +++ b/documentation/functions/game.add_tween.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<GameObject | undefined>

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_anim.html b/documentation/functions/game.create_anim.html index 7d37d5078..355a05189 100644 --- a/documentation/functions/game.create_anim.html +++ b/documentation/functions/game.create_anim.html @@ -6,4 +6,4 @@ (key is specified within the anim_config); false if the key is already in use.

    Parameters

    Returns boolean

    true if animation is successfully created, false otherwise

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_anim_config.html b/documentation/functions/game.create_anim_config.html index 6566a66f0..a5642d60f 100644 --- a/documentation/functions/game.create_anim_config.html +++ b/documentation/functions/game.create_anim_config.html @@ -11,4 +11,4 @@
  • show_on_start: boolean = true

    should the sprite be visible when the anims start?

  • hide_on_complete: boolean = false

    should the sprite be not visible when the anims finish?

    • Returns ObjectConfig

    animation config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_anim_frame_config.html b/documentation/functions/game.create_anim_frame_config.html index 6e80f6de8..03958042f 100644 --- a/documentation/functions/game.create_anim_frame_config.html +++ b/documentation/functions/game.create_anim_frame_config.html @@ -7,4 +7,4 @@
  • duration: number = 0

    duration, in ms, of this frame of the animation

  • visible: boolean = true

    should the parent object be visible during this frame?

    • Returns ObjectConfig

    animation frame config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_anim_spritesheet_frame_configs.html b/documentation/functions/game.create_anim_spritesheet_frame_configs.html index 81510c3cf..daffee891 100644 --- a/documentation/functions/game.create_anim_spritesheet_frame_configs.html +++ b/documentation/functions/game.create_anim_spritesheet_frame_configs.html @@ -9,4 +9,4 @@ a spritesheet.

    Parameters

    Returns ObjectConfig[] | undefined

    animation frame configs

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_award.html b/documentation/functions/game.create_award.html index 7f0f75021..a64f9892f 100644 --- a/documentation/functions/game.create_award.html +++ b/documentation/functions/game.create_award.html @@ -9,4 +9,4 @@
  • y: number

    y position of the image. 0 is at the top side

  • award_key: string

    key for award

    • Returns GameObject

    award game object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_config.html b/documentation/functions/game.create_config.html index dbd93d399..142c8bc2f 100644 --- a/documentation/functions/game.create_config.html +++ b/documentation/functions/game.create_config.html @@ -3,4 +3,4 @@

    e.g list(pair("alpha", 0), pair("duration", 1000))

    Parameters

    Returns ObjectConfig

    object config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_container.html b/documentation/functions/game.create_container.html index 20dcf351c..3aedfd1f3 100644 --- a/documentation/functions/game.create_container.html +++ b/documentation/functions/game.create_container.html @@ -9,4 +9,4 @@

    Parameters

    Returns GameObject

    container object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_ellipse.html b/documentation/functions/game.create_ellipse.html index ce8a69ced..a2df0f8d0 100644 --- a/documentation/functions/game.create_ellipse.html +++ b/documentation/functions/game.create_ellipse.html @@ -6,4 +6,4 @@
  • fill: number = 0

    colour fill, in hext e.g 0xffffff

  • alpha: number = 1

    value between 0 and 1 to denote alpha

    • Returns GameObject

    ellipse object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_image.html b/documentation/functions/game.create_image.html index b10afc526..09e576deb 100644 --- a/documentation/functions/game.create_image.html +++ b/documentation/functions/game.create_image.html @@ -5,4 +5,4 @@
  • y: number

    y position of the image. 0 is at the top side

  • asset_key: string

    key to loaded image

    • Returns GameObject | undefined

    image game object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_interactive_config.html b/documentation/functions/game.create_interactive_config.html index 8110d387f..c5bf4b5bc 100644 --- a/documentation/functions/game.create_interactive_config.html +++ b/documentation/functions/game.create_interactive_config.html @@ -6,4 +6,4 @@
  • pixel_perfect: boolean = false

    pixel perfect function will be set for the hit area. Only works for texture based object

  • alpha_tolerance: number = 1

    if pixel_perfect is set, this is the alpha tolerance threshold value used in the callback

    • Returns ObjectConfig

    interactive config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_rect.html b/documentation/functions/game.create_rect.html index f2c5955a9..fe5fb2742 100644 --- a/documentation/functions/game.create_rect.html +++ b/documentation/functions/game.create_rect.html @@ -7,4 +7,4 @@
  • fill: number = 0

    colour fill, in hext e.g 0xffffff

  • alpha: number = 1

    value between 0 and 1 to denote alpha

    • Returns GameObject

    rectangle object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_sound_config.html b/documentation/functions/game.create_sound_config.html index baaba2b6a..ff344a55f 100644 --- a/documentation/functions/game.create_sound_config.html +++ b/documentation/functions/game.create_sound_config.html @@ -9,4 +9,4 @@
  • loop: boolean = false

    whether or not the sound should loop

  • delay: number = 0

    time, in seconds, that elapse before the sound actually starts

    • Returns ObjectConfig

    sound config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_spritesheet_config.html b/documentation/functions/game.create_spritesheet_config.html index 1416c7b97..c0d0fff14 100644 --- a/documentation/functions/game.create_spritesheet_config.html +++ b/documentation/functions/game.create_spritesheet_config.html @@ -6,4 +6,4 @@
  • margin: number = 0

    margin in the image; this is the space around the edge of the frames

  • spacing: number = 0

    the spacing between each frame in the image

    • Returns ObjectConfig

    spritesheet config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_text.html b/documentation/functions/game.create_text.html index 6c4328a11..220af14a3 100644 --- a/documentation/functions/game.create_text.html +++ b/documentation/functions/game.create_text.html @@ -5,4 +5,4 @@
  • text: string

    text to be shown

  • config: ObjectConfig = {}

    text configuration to be used

    • Returns GameObject

    text game object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_text_config.html b/documentation/functions/game.create_text_config.html index 2df8fe72f..abaf33ef1 100644 --- a/documentation/functions/game.create_text_config.html +++ b/documentation/functions/game.create_text_config.html @@ -11,4 +11,4 @@
  • stroke_thickness: number = 0

    thickness of stroke

  • align: string = 'left'

    text alignment

    • Returns ObjectConfig

    text config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.create_tween_config.html b/documentation/functions/game.create_tween_config.html index 6b4090e18..ffb46a8dd 100644 --- a/documentation/functions/game.create_tween_config.html +++ b/documentation/functions/game.create_tween_config.html @@ -12,4 +12,4 @@
  • loop_delay: number = 0

    The time the tween will pause before starting either a yoyo or returning to the start for a repeat

  • on_loop: Function = nullFn

    function to execute each time the tween loops

    • Returns ObjectConfig

    tween config

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.destroy_obj.html b/documentation/functions/game.destroy_obj.html index f578c5464..3d1c427ee 100644 --- a/documentation/functions/game.destroy_obj.html +++ b/documentation/functions/game.destroy_obj.html @@ -2,4 +2,4 @@ is removed from the scene, and all of its listeners is also removed.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.get_screen_display_height.html b/documentation/functions/game.get_screen_display_height.html index ab177bd58..5f7959ec7 100644 --- a/documentation/functions/game.get_screen_display_height.html +++ b/documentation/functions/game.get_screen_display_height.html @@ -1,3 +1,3 @@ get_screen_display_height | Source Academy Modules

    Function get_screen_display_height

    • get_screen_display_height(): number

    • Get game screen display height (accounting window size).

      Returns number

      screen display height

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.get_screen_display_width.html b/documentation/functions/game.get_screen_display_width.html index e5fcbb9f9..d47ceeb0b 100644 --- a/documentation/functions/game.get_screen_display_width.html +++ b/documentation/functions/game.get_screen_display_width.html @@ -1,3 +1,3 @@ get_screen_display_width | Source Academy Modules

    Function get_screen_display_width

    • get_screen_display_width(): number

    • Get game screen display width (accounting window size).

      Returns number

      screen display width

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.get_screen_height.html b/documentation/functions/game.get_screen_height.html index 5e38a06bc..bcbf3ccbc 100644 --- a/documentation/functions/game.get_screen_height.html +++ b/documentation/functions/game.get_screen_height.html @@ -1,3 +1,3 @@ get_screen_height | Source Academy Modules

    Function get_screen_height

    • get_screen_height(): number

    • Get in-game screen height.

      Returns number

      screen height

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.get_screen_width.html b/documentation/functions/game.get_screen_width.html index 5047addda..016a94dd2 100644 --- a/documentation/functions/game.get_screen_width.html +++ b/documentation/functions/game.get_screen_width.html @@ -1,3 +1,3 @@ get_screen_width | Source Academy Modules

    Function get_screen_width

    • get_screen_width(): number

    • Get in-game screen width.

      Returns number

      screen width

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.load_image.html b/documentation/functions/game.load_image.html index d7d83d075..180b75a7c 100644 --- a/documentation/functions/game.load_image.html +++ b/documentation/functions/game.load_image.html @@ -2,4 +2,4 @@ must be loaded before used in create_image.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.load_sound.html b/documentation/functions/game.load_sound.html index 99e98ef3f..7fb105ac4 100644 --- a/documentation/functions/game.load_sound.html +++ b/documentation/functions/game.load_sound.html @@ -2,4 +2,4 @@ must be loaded before used in play_sound.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.load_spritesheet.html b/documentation/functions/game.load_spritesheet.html index 1fe28c9b0..050847a05 100644 --- a/documentation/functions/game.load_spritesheet.html +++ b/documentation/functions/game.load_spritesheet.html @@ -3,4 +3,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.play_anim_on_image.html b/documentation/functions/game.play_anim_on_image.html index a93bdedfd..01b05531a 100644 --- a/documentation/functions/game.play_anim_on_image.html +++ b/documentation/functions/game.play_anim_on_image.html @@ -1,4 +1,4 @@ play_anim_on_image | Source Academy Modules

    Function play_anim_on_image

    • play_anim_on_image(image, anims_key): GameObject | undefined

    • Start playing the given animation on image game object.

      Parameters

      • image: GameObject

        image game object

      • anims_key: string

        key associated with an animation

        -

      Returns GameObject | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns GameObject | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.play_sound.html b/documentation/functions/game.play_sound.html index de9107ca6..59b24a2c4 100644 --- a/documentation/functions/game.play_sound.html +++ b/documentation/functions/game.play_sound.html @@ -2,4 +2,4 @@ Throws error if key is non-existent.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.prepend_remote_url.html b/documentation/functions/game.prepend_remote_url.html index a18d0d623..23ced589c 100644 --- a/documentation/functions/game.prepend_remote_url.html +++ b/documentation/functions/game.prepend_remote_url.html @@ -1,3 +1,3 @@ prepend_remote_url | Source Academy Modules

    Function prepend_remote_url

    • prepend_remote_url(asset_key): string

    • Prepend the given asset key with the remote path (S3 path).

      Parameters

      • asset_key: string

      Returns string

      prepended path

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.remove_listener.html b/documentation/functions/game.remove_listener.html index 7e736f8e1..815ac356a 100644 --- a/documentation/functions/game.remove_listener.html +++ b/documentation/functions/game.remove_listener.html @@ -1,3 +1,3 @@ remove_listener | Source Academy Modules

    Function remove_listener

    • remove_listener(listener): boolean

    • Deactivate and remove listener.

      Parameters

      • listener: GameObject

      Returns boolean

      if successful

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_alpha.html b/documentation/functions/game.set_alpha.html index 5bb30163e..f80ceddab 100644 --- a/documentation/functions/game.set_alpha.html +++ b/documentation/functions/game.set_alpha.html @@ -3,4 +3,4 @@

    Parameters

    Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_display_size.html b/documentation/functions/game.set_display_size.html index 97160a7f4..31717a7b7 100644 --- a/documentation/functions/game.set_display_size.html +++ b/documentation/functions/game.set_display_size.html @@ -4,4 +4,4 @@
  • x: number

    new display width size

  • y: number

    new display height size

    • Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_flip.html b/documentation/functions/game.set_flip.html index f4b32291e..9f705f89a 100644 --- a/documentation/functions/game.set_flip.html +++ b/documentation/functions/game.set_flip.html @@ -4,4 +4,4 @@
  • x: boolean

    to flip in the horizontal state

  • y: boolean

    to flip in the vertical state

    • Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_interactive.html b/documentation/functions/game.set_interactive.html index 3d208aa9e..5870c8475 100644 --- a/documentation/functions/game.set_interactive.html +++ b/documentation/functions/game.set_interactive.html @@ -5,4 +5,4 @@

    Parameters

    Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_origin.html b/documentation/functions/game.set_origin.html index dff3ec721..6382649e4 100644 --- a/documentation/functions/game.set_origin.html +++ b/documentation/functions/game.set_origin.html @@ -5,4 +5,4 @@
  • x: number

    new anchor x coordinate, between value 0 to 1.

  • y: number

    new anchor y coordinate, between value 0 to 1.

    • Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_position.html b/documentation/functions/game.set_position.html index ef3d0d90b..be3a30a01 100644 --- a/documentation/functions/game.set_position.html +++ b/documentation/functions/game.set_position.html @@ -4,4 +4,4 @@
  • x: number

    new x position

  • y: number

    new y position

    • Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_rotation.html b/documentation/functions/game.set_rotation.html index 186ff1f1a..6ec42ab4d 100644 --- a/documentation/functions/game.set_rotation.html +++ b/documentation/functions/game.set_rotation.html @@ -3,4 +3,4 @@

    Parameters

    Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/game.set_scale.html b/documentation/functions/game.set_scale.html index ca715b1bd..a4a9cd9fc 100644 --- a/documentation/functions/game.set_scale.html +++ b/documentation/functions/game.set_scale.html @@ -4,4 +4,4 @@
  • x: number

    new x scale

  • y: number

    new y scale

    • Returns GameObject | undefined

    game object itself

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.addRoots.html b/documentation/functions/mark_sweep.addRoots.html index 4b987cdad..fed0f784e 100644 --- a/documentation/functions/mark_sweep.addRoots.html +++ b/documentation/functions/mark_sweep.addRoots.html @@ -1 +1 @@ -addRoots | Source Academy Modules

    Function addRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +addRoots | Source Academy Modules

    Function addRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.allHeap.html b/documentation/functions/mark_sweep.allHeap.html index 6c91e1744..ad2c2ccb4 100644 --- a/documentation/functions/mark_sweep.allHeap.html +++ b/documentation/functions/mark_sweep.allHeap.html @@ -1 +1 @@ -allHeap | Source Academy Modules

    Function allHeap

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +allHeap | Source Academy Modules

    Function allHeap

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.endGC.html b/documentation/functions/mark_sweep.endGC.html index b31d28cb0..0ffd91214 100644 --- a/documentation/functions/mark_sweep.endGC.html +++ b/documentation/functions/mark_sweep.endGC.html @@ -1 +1 @@ -endGC | Source Academy Modules

    Function endGC

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +endGC | Source Academy Modules

    Function endGC

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.generateMemory.html b/documentation/functions/mark_sweep.generateMemory.html index 8145b21af..167727bf2 100644 --- a/documentation/functions/mark_sweep.generateMemory.html +++ b/documentation/functions/mark_sweep.generateMemory.html @@ -1 +1 @@ -generateMemory | Source Academy Modules

    Function generateMemory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +generateMemory | Source Academy Modules

    Function generateMemory

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.init.html b/documentation/functions/mark_sweep.init.html index 238e8a50a..6bc5f9a57 100644 --- a/documentation/functions/mark_sweep.init.html +++ b/documentation/functions/mark_sweep.init.html @@ -1 +1 @@ -init | Source Academy Modules

    Function init

    • init(): {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_marked: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_matrix: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_types: (() => String[]);
          get_unmarked: (() => number);
          toReplString: (() => string);
      }

    • Returns {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_marked: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_matrix: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_types: (() => String[]);
          get_unmarked: (() => number);
          toReplString: (() => string);
      }

      • get_column_size: (() => number)
          • (): number

          • Returns number

      • get_command: (() => CommandHeapObject[])
          • (): CommandHeapObject[]

          • Returns CommandHeapObject[]

      • get_flips: (() => number[])
          • (): number[]

          • Returns number[]

      • get_marked: (() => number)
          • (): number

          • Returns number

      • get_memory_heap: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_memory_matrix: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_memory_size: (() => number)
          • (): number

          • Returns number

      • get_roots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_row_size: (() => number)
          • (): number

          • Returns number

      • get_slots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_tags: (() => Tag[])
          • (): Tag[]

          • Returns Tag[]

      • get_types: (() => String[])
          • (): String[]

          • Returns String[]

      • get_unmarked: (() => number)
          • (): number

          • Returns number

      • toReplString: (() => string)
          • (): string

          • Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +init | Source Academy Modules

    Function init

    • init(): {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_marked: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_matrix: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_types: (() => String[]);
          get_unmarked: (() => number);
          toReplString: (() => string);
      }

    • Returns {
          get_column_size: (() => number);
          get_command: (() => CommandHeapObject[]);
          get_flips: (() => number[]);
          get_marked: (() => number);
          get_memory_heap: (() => MemoryHeaps);
          get_memory_matrix: (() => MemoryHeaps);
          get_memory_size: (() => number);
          get_roots: (() => number[]);
          get_row_size: (() => number);
          get_slots: (() => number[]);
          get_tags: (() => Tag[]);
          get_types: (() => String[]);
          get_unmarked: (() => number);
          toReplString: (() => string);
      }

      • get_column_size: (() => number)
          • (): number

          • Returns number

      • get_command: (() => CommandHeapObject[])
          • (): CommandHeapObject[]

          • Returns CommandHeapObject[]

      • get_flips: (() => number[])
          • (): number[]

          • Returns number[]

      • get_marked: (() => number)
          • (): number

          • Returns number

      • get_memory_heap: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_memory_matrix: (() => MemoryHeaps)
          • (): MemoryHeaps

          • Returns MemoryHeaps

      • get_memory_size: (() => number)
          • (): number

          • Returns number

      • get_roots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_row_size: (() => number)
          • (): number

          • Returns number

      • get_slots: (() => number[])
          • (): number[]

          • Returns number[]

      • get_tags: (() => Tag[])
          • (): Tag[]

          • Returns Tag[]

      • get_types: (() => String[])
          • (): String[]

          • Returns String[]

      • get_unmarked: (() => number)
          • (): number

          • Returns number

      • toReplString: (() => string)
          • (): string

          • Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.initialize_memory.html b/documentation/functions/mark_sweep.initialize_memory.html index 7a99884d0..c1d4a5333 100644 --- a/documentation/functions/mark_sweep.initialize_memory.html +++ b/documentation/functions/mark_sweep.initialize_memory.html @@ -1 +1 @@ -initialize_memory | Source Academy Modules

    Function initialize_memory

    • initialize_memory(memorySize, nodeSize, marked, unmarked): void

    • Parameters

      • memorySize: number
      • nodeSize: any
      • marked: any
      • unmarked: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +initialize_memory | Source Academy Modules

    Function initialize_memory

    • initialize_memory(memorySize, nodeSize, marked, unmarked): void

    • Parameters

      • memorySize: number
      • nodeSize: any
      • marked: any
      • unmarked: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.initialize_tag.html b/documentation/functions/mark_sweep.initialize_tag.html index 0a25ec6ef..7c0b8a421 100644 --- a/documentation/functions/mark_sweep.initialize_tag.html +++ b/documentation/functions/mark_sweep.initialize_tag.html @@ -1 +1 @@ -initialize_tag | Source Academy Modules

    Function initialize_tag

    • initialize_tag(allTag, types): void

    • Parameters

      • allTag: number[]
      • types: string[]

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +initialize_tag | Source Academy Modules

    Function initialize_tag

    • initialize_tag(allTag, types): void

    • Parameters

      • allTag: number[]
      • types: string[]

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newAssign.html b/documentation/functions/mark_sweep.newAssign.html index 3d5d04d88..e23f5f600 100644 --- a/documentation/functions/mark_sweep.newAssign.html +++ b/documentation/functions/mark_sweep.newAssign.html @@ -1 +1 @@ -newAssign | Source Academy Modules

    Function newAssign

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newAssign | Source Academy Modules

    Function newAssign

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newCommand.html b/documentation/functions/mark_sweep.newCommand.html index 4254afda8..a451db713 100644 --- a/documentation/functions/mark_sweep.newCommand.html +++ b/documentation/functions/mark_sweep.newCommand.html @@ -1 +1 @@ -newCommand | Source Academy Modules

    Function newCommand

    • newCommand(type, left, right, sizeLeft, sizeRight, heap, description, firstDesc, lastDesc, queue?): void

    • Parameters

      • type: any
      • left: any
      • right: any
      • sizeLeft: any
      • sizeRight: any
      • heap: any
      • description: any
      • firstDesc: any
      • lastDesc: any
      • queue: never[] = []

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newCommand | Source Academy Modules

    Function newCommand

    • newCommand(type, left, right, sizeLeft, sizeRight, heap, description, firstDesc, lastDesc, queue?): void

    • Parameters

      • type: any
      • left: any
      • right: any
      • sizeLeft: any
      • sizeRight: any
      • heap: any
      • description: any
      • firstDesc: any
      • lastDesc: any
      • queue: never[] = []

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newGC.html b/documentation/functions/mark_sweep.newGC.html index d9a2e774e..3284ddb8d 100644 --- a/documentation/functions/mark_sweep.newGC.html +++ b/documentation/functions/mark_sweep.newGC.html @@ -1 +1 @@ -newGC | Source Academy Modules

    Function newGC

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newGC | Source Academy Modules

    Function newGC

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newMark.html b/documentation/functions/mark_sweep.newMark.html index a634863f4..8d7b3a3db 100644 --- a/documentation/functions/mark_sweep.newMark.html +++ b/documentation/functions/mark_sweep.newMark.html @@ -1 +1 @@ -newMark | Source Academy Modules

    Function newMark

    • newMark(left, heap, queue): void

    • Parameters

      • left: any
      • heap: any
      • queue: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newMark | Source Academy Modules

    Function newMark

    • newMark(left, heap, queue): void

    • Parameters

      • left: any
      • heap: any
      • queue: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newNew.html b/documentation/functions/mark_sweep.newNew.html index c096a9e5b..daa0fe751 100644 --- a/documentation/functions/mark_sweep.newNew.html +++ b/documentation/functions/mark_sweep.newNew.html @@ -1 +1 @@ -newNew | Source Academy Modules

    Function newNew

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newNew | Source Academy Modules

    Function newNew

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newPop.html b/documentation/functions/mark_sweep.newPop.html index c06e3cc4c..8bde44267 100644 --- a/documentation/functions/mark_sweep.newPop.html +++ b/documentation/functions/mark_sweep.newPop.html @@ -1 +1 @@ -newPop | Source Academy Modules

    Function newPop

    • newPop(res, left, right, heap): void

    • Parameters

      • res: any
      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newPop | Source Academy Modules

    Function newPop

    • newPop(res, left, right, heap): void

    • Parameters

      • res: any
      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newPush.html b/documentation/functions/mark_sweep.newPush.html index 249b2775d..5978ea2c9 100644 --- a/documentation/functions/mark_sweep.newPush.html +++ b/documentation/functions/mark_sweep.newPush.html @@ -1 +1 @@ -newPush | Source Academy Modules

    Function newPush

    • newPush(left, right, heap): void

    • Parameters

      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newPush | Source Academy Modules

    Function newPush

    • newPush(left, right, heap): void

    • Parameters

      • left: any
      • right: any
      • heap: any

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newSweep.html b/documentation/functions/mark_sweep.newSweep.html index b2bfa7ea6..309e7f47b 100644 --- a/documentation/functions/mark_sweep.newSweep.html +++ b/documentation/functions/mark_sweep.newSweep.html @@ -1 +1 @@ -newSweep | Source Academy Modules

    Function newSweep

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newSweep | Source Academy Modules

    Function newSweep

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.newUpdateSweep.html b/documentation/functions/mark_sweep.newUpdateSweep.html index 40324e7f8..8a00534a7 100644 --- a/documentation/functions/mark_sweep.newUpdateSweep.html +++ b/documentation/functions/mark_sweep.newUpdateSweep.html @@ -1 +1 @@ -newUpdateSweep | Source Academy Modules

    Function newUpdateSweep

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +newUpdateSweep | Source Academy Modules

    Function newUpdateSweep

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.showRoot.html b/documentation/functions/mark_sweep.showRoot.html index 0d670526b..0dd8482af 100644 --- a/documentation/functions/mark_sweep.showRoot.html +++ b/documentation/functions/mark_sweep.showRoot.html @@ -1 +1 @@ -showRoot | Source Academy Modules

    Function showRoot

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +showRoot | Source Academy Modules

    Function showRoot

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.showRoots.html b/documentation/functions/mark_sweep.showRoots.html index c2f298ad1..491e8a7b5 100644 --- a/documentation/functions/mark_sweep.showRoots.html +++ b/documentation/functions/mark_sweep.showRoots.html @@ -1 +1 @@ -showRoots | Source Academy Modules

    Function showRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +showRoots | Source Academy Modules

    Function showRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.updateRoots.html b/documentation/functions/mark_sweep.updateRoots.html index bdf1ab450..782a573e5 100644 --- a/documentation/functions/mark_sweep.updateRoots.html +++ b/documentation/functions/mark_sweep.updateRoots.html @@ -1 +1 @@ -updateRoots | Source Academy Modules

    Function updateRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +updateRoots | Source Academy Modules

    Function updateRoots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/mark_sweep.updateSlotSegment.html b/documentation/functions/mark_sweep.updateSlotSegment.html index 3bb4fa767..6deb20ec2 100644 --- a/documentation/functions/mark_sweep.updateSlotSegment.html +++ b/documentation/functions/mark_sweep.updateSlotSegment.html @@ -1 +1 @@ -updateSlotSegment | Source Academy Modules

    Function updateSlotSegment

    • updateSlotSegment(tag, size, first, last): void

    • Parameters

      • tag: number
      • size: number
      • first: number
      • last: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +updateSlotSegment | Source Academy Modules

    Function updateSlotSegment

    • updateSlotSegment(tag, size, first, last): void

    • Parameters

      • tag: number
      • size: number
      • first: number
      • last: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.addVectors.html b/documentation/functions/nbody.addVectors.html index 555a73978..5d261925f 100644 --- a/documentation/functions/nbody.addVectors.html +++ b/documentation/functions/nbody.addVectors.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector3

    The sum of the two vectors.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.clone.html b/documentation/functions/nbody.clone.html index 58de42bbb..f6cd7cd8a 100644 --- a/documentation/functions/nbody.clone.html +++ b/documentation/functions/nbody.clone.html @@ -1,4 +1,4 @@ clone | Source Academy Modules

    Function clone

    • clone(obj): CelestialBody | State | Universe | Vector3

    • Deep clone an object.

      Parameters

      • obj: Vector3 | CelestialBody | State | Universe

        The object to clone.

      Returns CelestialBody | State | Universe | Vector3

      The cloned object.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createBodyCenterTransformation.html b/documentation/functions/nbody.createBodyCenterTransformation.html index 68afc0ef5..ebeb1a35c 100644 --- a/documentation/functions/nbody.createBodyCenterTransformation.html +++ b/documentation/functions/nbody.createBodyCenterTransformation.html @@ -1,4 +1,4 @@ createBodyCenterTransformation | Source Academy Modules

    Function createBodyCenterTransformation

    • createBodyCenterTransformation(i?): BodyCenterTransformation

    • Create a frame of reference transformation that moves the origin to the center of ith both.

      Parameters

      • Optional i: number

        The index of the body to center on.

      Returns BodyCenterTransformation

      A new body center transformation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createCelestialBody.html b/documentation/functions/nbody.createCelestialBody.html index 9ee2e77c3..f45d40679 100644 --- a/documentation/functions/nbody.createCelestialBody.html +++ b/documentation/functions/nbody.createCelestialBody.html @@ -5,4 +5,4 @@
  • Optional velocity: Vector3

    velocity of the body.

  • Optional acceleration: Vector3

    acceleration of the body.

    • Returns CelestialBody

    A new celestial body.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createCentripetalForce.html b/documentation/functions/nbody.createCentripetalForce.html index 5a6a86fa3..caa61b1bb 100644 --- a/documentation/functions/nbody.createCentripetalForce.html +++ b/documentation/functions/nbody.createCentripetalForce.html @@ -1,4 +1,4 @@ createCentripetalForce | Source Academy Modules

    Function createCentripetalForce

    • createCentripetalForce(center?): CentripetalForce

    • Create a centripetal force that pulls bodies towards a center.

      Parameters

      • Optional center: Vector3

        The center of the centripetal force.

      Returns CentripetalForce

      A new centripetal force.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createCoMTransformation.html b/documentation/functions/nbody.createCoMTransformation.html index 4a2dcfefc..1a3e0e766 100644 --- a/documentation/functions/nbody.createCoMTransformation.html +++ b/documentation/functions/nbody.createCoMTransformation.html @@ -1,3 +1,3 @@ createCoMTransformation | Source Academy Modules

    Function createCoMTransformation

    • createCoMTransformation(): CoMTransformation

    • Create a frame of reference transformation that moves the origin to the center of mass of the system.

      Returns CoMTransformation

      A new center of mass transformation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createCombinedForce.html b/documentation/functions/nbody.createCombinedForce.html index b2640aae1..c82b03747 100644 --- a/documentation/functions/nbody.createCombinedForce.html +++ b/documentation/functions/nbody.createCombinedForce.html @@ -1,4 +1,4 @@ createCombinedForce | Source Academy Modules

    Function createCombinedForce

    • createCombinedForce(forces): CombinedForce

    • Create a combined force that is an additive combination of all the given forces.

      Parameters

      • forces: Force[]

        The forces to combine.

      Returns CombinedForce

      A new combined force.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createExplicitEulerSim.html b/documentation/functions/nbody.createExplicitEulerSim.html index 6030f5720..964b374b6 100644 --- a/documentation/functions/nbody.createExplicitEulerSim.html +++ b/documentation/functions/nbody.createExplicitEulerSim.html @@ -1,4 +1,4 @@ createExplicitEulerSim | Source Academy Modules

    Function createExplicitEulerSim

    • createExplicitEulerSim(force?): ExplicitEulerSim

    • Create an explicit euler integrator to be used as the simulation function.

      Parameters

      • Optional force: Force

        The force that applies to the nbody system.

      Returns ExplicitEulerSim

      A new explicit Euler simulation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createForce.html b/documentation/functions/nbody.createForce.html index 613d3a836..a9f4daa73 100644 --- a/documentation/functions/nbody.createForce.html +++ b/documentation/functions/nbody.createForce.html @@ -1,4 +1,4 @@ createForce | Source Academy Modules

    Function createForce

    • createForce(fn): Force

    • Create a force that applies to all bodies using the provided higher order/lambda/arrow/anonymous function.

      Parameters

      • fn: ((bodies) => Vector3[])

        A function that takes an array of bodies and returns an array of forces of the same length.

          • (bodies): Vector3[]

          • Parameters

            • bodies: CelestialBody[]

            Returns Vector3[]

      Returns Force

      A new lambda force.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createGravity.html b/documentation/functions/nbody.createGravity.html index 13ba51517..c53c8a7e4 100644 --- a/documentation/functions/nbody.createGravity.html +++ b/documentation/functions/nbody.createGravity.html @@ -1,4 +1,4 @@ createGravity | Source Academy Modules

    Function createGravity

    • createGravity(G?): Gravity

    • Create a force that applies to all bodies.

      Parameters

      • Optional G: number

        The gravitational constant.

      Returns Gravity

      A new gravity force.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createLambdaSim.html b/documentation/functions/nbody.createLambdaSim.html index df92ecaf8..843a9eeab 100644 --- a/documentation/functions/nbody.createLambdaSim.html +++ b/documentation/functions/nbody.createLambdaSim.html @@ -1,4 +1,4 @@ createLambdaSim | Source Academy Modules

    Function createLambdaSim

    • createLambdaSim(fn): LambdaSim

    • Create a simulate function (usually a numerical integrator) that is used to simulate the nbody system using the provided higher order/lambda/arrow/anonymous function.

      Parameters

      • fn: ((deltaT, prevState, currState) => State)

        The function to be used as the simulate function.

          • (deltaT, prevState, currState): State

          • Parameters

            • deltaT: number
            • prevState: State
            • currState: State

            Returns State

      Returns LambdaSim

      A new lambda simulation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createLambdaTransformation.html b/documentation/functions/nbody.createLambdaTransformation.html index 5cb58ac86..6dd525a0d 100644 --- a/documentation/functions/nbody.createLambdaTransformation.html +++ b/documentation/functions/nbody.createLambdaTransformation.html @@ -1,4 +1,4 @@ createLambdaTransformation | Source Academy Modules

    Function createLambdaTransformation

    • createLambdaTransformation(fn): LambdaTransformation

    • Create a frame of reference transformation using a higher order/lambda/arrow/anonymous function.

      Parameters

      • fn: ((state) => State)

        A function that takes a state and returns a new transformed state.

          • (state): State

          • Parameters

            • state: State

            Returns State

      Returns LambdaTransformation

      A new lambda transformation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createPinTransformation.html b/documentation/functions/nbody.createPinTransformation.html index fb3620627..b4e42de7f 100644 --- a/documentation/functions/nbody.createPinTransformation.html +++ b/documentation/functions/nbody.createPinTransformation.html @@ -2,4 +2,4 @@

    Parameters

    Returns PinTransformation

    A new pin transformation.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createRotateTransformation.html b/documentation/functions/nbody.createRotateTransformation.html index d35c6f34a..09e5aa763 100644 --- a/documentation/functions/nbody.createRotateTransformation.html +++ b/documentation/functions/nbody.createRotateTransformation.html @@ -2,4 +2,4 @@

    Parameters

    Returns RotateTransformation

    A new rotate transformation.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createRungeKutta4Sim.html b/documentation/functions/nbody.createRungeKutta4Sim.html index f22c7c387..84b1a18b1 100644 --- a/documentation/functions/nbody.createRungeKutta4Sim.html +++ b/documentation/functions/nbody.createRungeKutta4Sim.html @@ -2,4 +2,4 @@

    Parameters

    Returns RungeKutta4Sim

    A new Runge-Kutta 4 simulation.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createSemiImplicitEulerSim.html b/documentation/functions/nbody.createSemiImplicitEulerSim.html index 99843d3ef..21c25d9a4 100644 --- a/documentation/functions/nbody.createSemiImplicitEulerSim.html +++ b/documentation/functions/nbody.createSemiImplicitEulerSim.html @@ -1,4 +1,4 @@ createSemiImplicitEulerSim | Source Academy Modules

    Function createSemiImplicitEulerSim

    • createSemiImplicitEulerSim(force?): SemiImplicitEulerSim

    • Create a numerical integrator that uses the semi-implicit Euler method to simulate the nbody system.

      Parameters

      • Optional force: Force

        The force that applies to the nbody system.

      Returns SemiImplicitEulerSim

      A new semi-implicit Euler simulation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createSimulation.html b/documentation/functions/nbody.createSimulation.html index a0716a157..ea798154d 100644 --- a/documentation/functions/nbody.createSimulation.html +++ b/documentation/functions/nbody.createSimulation.html @@ -6,4 +6,4 @@
  • Optional showTrails: boolean

    Whether to show trails.

  • Optional maxTrailLength: number

    The maximum length of trails.

    • Returns Simulation

    A new simulation.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createState.html b/documentation/functions/nbody.createState.html index 63f5bf0bd..7b3c67e39 100644 --- a/documentation/functions/nbody.createState.html +++ b/documentation/functions/nbody.createState.html @@ -1,4 +1,4 @@ createState | Source Academy Modules

    Function createState

    • createState(bodies): State

    • Create a new state snapshot of the universe.

      Parameters

      • bodies: CelestialBody[]

        The bodies in the state.

      Returns State

      A new state.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createTimedRotateTransformation.html b/documentation/functions/nbody.createTimedRotateTransformation.html index 3425b5649..6118bb460 100644 --- a/documentation/functions/nbody.createTimedRotateTransformation.html +++ b/documentation/functions/nbody.createTimedRotateTransformation.html @@ -2,4 +2,4 @@

    Parameters

    Returns TimedRotateTransformation

    A new timed rotate transformation.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createUniverse.html b/documentation/functions/nbody.createUniverse.html index 4d2ee4e7c..84c068c11 100644 --- a/documentation/functions/nbody.createUniverse.html +++ b/documentation/functions/nbody.createUniverse.html @@ -6,4 +6,4 @@
  • simFunc: SimulateFunction

    The simulation function of the universe.

  • transformations: Transformation[]

    The transformations of the universe.

    • Returns Universe

    A new universe.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createVector.html b/documentation/functions/nbody.createVector.html index 2a320f2b0..dda45ad1e 100644 --- a/documentation/functions/nbody.createVector.html +++ b/documentation/functions/nbody.createVector.html @@ -3,4 +3,4 @@
  • y: number

    y component of the vector.

  • z: number

    z component of the vector.

    • Returns Vector3

    A new 3D vector.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.createVelocityVerletSim.html b/documentation/functions/nbody.createVelocityVerletSim.html index 857ef3dda..57ecec199 100644 --- a/documentation/functions/nbody.createVelocityVerletSim.html +++ b/documentation/functions/nbody.createVelocityVerletSim.html @@ -1,4 +1,4 @@ createVelocityVerletSim | Source Academy Modules

    Function createVelocityVerletSim

    • createVelocityVerletSim(force): VelocityVerletSim

    • Create a numerical integrator that uses the velocity Verlet method to simulate the nbody system.

      Parameters

      • force: Force

        The force that applies to the nbody system.

      Returns VelocityVerletSim

      A new velocity Verlet simulation.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.getBodies.html b/documentation/functions/nbody.getBodies.html index 79262f832..82c003bb7 100644 --- a/documentation/functions/nbody.getBodies.html +++ b/documentation/functions/nbody.getBodies.html @@ -1,4 +1,4 @@ getBodies | Source Academy Modules

    Function getBodies

    • getBodies(state): CelestialBody[]

    • Get the bodies in a state.

      Parameters

      • state: State

        The state.

      Returns CelestialBody[]

      The bodies in the state.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.getX.html b/documentation/functions/nbody.getX.html index 5bf3686d8..a736bbfc8 100644 --- a/documentation/functions/nbody.getX.html +++ b/documentation/functions/nbody.getX.html @@ -1,4 +1,4 @@ getX | Source Academy Modules

    Function getX

    • getX(v): number

    • Get the x component of a vector.

      Parameters

      • v: Vector3

        The vector.

      Returns number

      The x component of the vector.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.getY.html b/documentation/functions/nbody.getY.html index 327d05406..7bf0e40d1 100644 --- a/documentation/functions/nbody.getY.html +++ b/documentation/functions/nbody.getY.html @@ -1,4 +1,4 @@ getY | Source Academy Modules

    Function getY

    • getY(v): number

    • Get the y component of a vector.

      Parameters

      • v: Vector3

        The vector.

      Returns number

      The y component of the vector.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.getZ.html b/documentation/functions/nbody.getZ.html index 4b08c4117..aa3b8a488 100644 --- a/documentation/functions/nbody.getZ.html +++ b/documentation/functions/nbody.getZ.html @@ -1,4 +1,4 @@ getZ | Source Academy Modules

    Function getZ

    • getZ(v): number

    • Get the z component of a vector.

      Parameters

      • v: Vector3

        The vector.

      Returns number

      The z component of the vector.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.multiplyScalar.html b/documentation/functions/nbody.multiplyScalar.html index bcb90557e..0558c088c 100644 --- a/documentation/functions/nbody.multiplyScalar.html +++ b/documentation/functions/nbody.multiplyScalar.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector3

    The vector multiplied by the scalar.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.playSim.html b/documentation/functions/nbody.playSim.html index 51dc45781..3b995859e 100644 --- a/documentation/functions/nbody.playSim.html +++ b/documentation/functions/nbody.playSim.html @@ -1,3 +1,3 @@ playSim | Source Academy Modules

    Function playSim

    • playSim(sim): void

    • Play a simulation.

      Parameters

      • sim: Simulation

        The simulation to play.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.recordSim.html b/documentation/functions/nbody.recordSim.html index 840d93dc3..c8e393901 100644 --- a/documentation/functions/nbody.recordSim.html +++ b/documentation/functions/nbody.recordSim.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.setX.html b/documentation/functions/nbody.setX.html index 41a68af12..a15a82b7d 100644 --- a/documentation/functions/nbody.setX.html +++ b/documentation/functions/nbody.setX.html @@ -1,4 +1,4 @@ setX | Source Academy Modules

    Function setX

    • setX(v, x): void

    • Set the x component of a vector.

      Parameters

      • v: Vector3

        The vector.

      • x: number

        The new x component.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.setY.html b/documentation/functions/nbody.setY.html index 377bb5d3e..9ac09a167 100644 --- a/documentation/functions/nbody.setY.html +++ b/documentation/functions/nbody.setY.html @@ -1,4 +1,4 @@ setY | Source Academy Modules

    Function setY

    • setY(v, y): void

    • Set the y component of a vector.

      Parameters

      • v: Vector3

        The vector.

      • y: number

        The new y component.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.setZ.html b/documentation/functions/nbody.setZ.html index ea0ae3b7c..a9c102c8c 100644 --- a/documentation/functions/nbody.setZ.html +++ b/documentation/functions/nbody.setZ.html @@ -1,4 +1,4 @@ setZ | Source Academy Modules

    Function setZ

    • setZ(v, z): void

    • Set the z component of a vector.

      Parameters

      • v: Vector3

        The vector.

      • z: number

        The new z component.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/nbody.subVectors.html b/documentation/functions/nbody.subVectors.html index 70702816c..1fd22e1ef 100644 --- a/documentation/functions/nbody.subVectors.html +++ b/documentation/functions/nbody.subVectors.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector3

    The difference of the two vectors.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/painter.display_painter.html b/documentation/functions/painter.display_painter.html index c9465a778..9bed14d25 100644 --- a/documentation/functions/painter.display_painter.html +++ b/documentation/functions/painter.display_painter.html @@ -5,4 +5,4 @@ *

    Example

    display_painter(flipped_outline_painter)(unit_frame);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/painter.draw_line.html b/documentation/functions/painter.draw_line.html index 4bec1b39a..38e158f78 100644 --- a/documentation/functions/painter.draw_line.html +++ b/documentation/functions/painter.draw_line.html @@ -3,4 +3,4 @@
  • v_end: number[]

    vector of the second point

    • Returns void

    Example

    const v1 = pair(1,2);
    const v2 = pair(2,3);
    draw_line(v1, v2);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.add_box_object.html b/documentation/functions/physics_2d.add_box_object.html index 5e81daf33..3f1e62068 100644 --- a/documentation/functions/physics_2d.add_box_object.html +++ b/documentation/functions/physics_2d.add_box_object.html @@ -4,4 +4,4 @@
  • velc: Vector2

    initial velocity vector

  • size: Vector2

    size

  • isStatic: boolean

    • Returns PhysicsObject

    new box object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.add_circle_object.html b/documentation/functions/physics_2d.add_circle_object.html index 8b712e229..68c4aae22 100644 --- a/documentation/functions/physics_2d.add_circle_object.html +++ b/documentation/functions/physics_2d.add_circle_object.html @@ -4,4 +4,4 @@
  • velc: Vector2

    initial velocity vector

  • radius: number

    radius

  • isStatic: boolean

    • Returns PhysicsObject

    new circle object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.add_triangle_object.html b/documentation/functions/physics_2d.add_triangle_object.html index 22777818f..aa2b16ac5 100644 --- a/documentation/functions/physics_2d.add_triangle_object.html +++ b/documentation/functions/physics_2d.add_triangle_object.html @@ -5,4 +5,4 @@
  • base: number

    base

  • height: number

    height

  • isStatic: boolean

    • Returns PhysicsObject

    new triangle object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.add_vector.html b/documentation/functions/physics_2d.add_vector.html index 7294e095f..d6ab9f173 100644 --- a/documentation/functions/physics_2d.add_vector.html +++ b/documentation/functions/physics_2d.add_vector.html @@ -1,3 +1,3 @@ add_vector | Source Academy Modules

    Function add_vector

    • add_vector(vec1, vec2): Vector2

    • Adds two vectors together and returns the resultant vector.

      Parameters

      • vec1: Vector2
      • vec2: Vector2

      Returns Vector2

      vector 2d

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.add_wall.html b/documentation/functions/physics_2d.add_wall.html index 769710865..c99cae17b 100644 --- a/documentation/functions/physics_2d.add_wall.html +++ b/documentation/functions/physics_2d.add_wall.html @@ -3,4 +3,4 @@
  • rot: number

    rotation of the wall

  • size: Vector2

    size of the wall

    • Returns PhysicsObject

    new box (wall) object

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.apply_force.html b/documentation/functions/physics_2d.apply_force.html index 361fd1119..6886e64bb 100644 --- a/documentation/functions/physics_2d.apply_force.html +++ b/documentation/functions/physics_2d.apply_force.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.apply_force_to_center.html b/documentation/functions/physics_2d.apply_force_to_center.html index 36933fc5d..49b5e1f19 100644 --- a/documentation/functions/physics_2d.apply_force_to_center.html +++ b/documentation/functions/physics_2d.apply_force_to_center.html @@ -1,4 +1,4 @@ apply_force_to_center | Source Academy Modules

    Function apply_force_to_center

    • apply_force_to_center(force, obj): void

    • Applies a force to given object at its center.

      Parameters

      • force: Force

        existing force

      • obj: PhysicsObject

        existing object the force applies on

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.array_to_vector.html b/documentation/functions/physics_2d.array_to_vector.html index 6a1ba1dfa..63321859e 100644 --- a/documentation/functions/physics_2d.array_to_vector.html +++ b/documentation/functions/physics_2d.array_to_vector.html @@ -1,4 +1,4 @@ array_to_vector | Source Academy Modules

    Function array_to_vector

    • array_to_vector(arr): Vector2

    • Converts an array of 2 numbers into a 2d vector.

      Parameters

      • arr: [number, number]

        array with [x, y]

      Returns Vector2

      vector 2d

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.get_angular_velocity.html b/documentation/functions/physics_2d.get_angular_velocity.html index 944c33fc9..ec583823c 100644 --- a/documentation/functions/physics_2d.get_angular_velocity.html +++ b/documentation/functions/physics_2d.get_angular_velocity.html @@ -1,4 +1,4 @@ get_angular_velocity | Source Academy Modules

    Function get_angular_velocity

    • get_angular_velocity(obj): Vector2

    • Gets angular velocity of the object at current world time.

      Parameters

      • obj: PhysicsObject

        exisiting object

      Returns Vector2

      angular velocity vector

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.get_position.html b/documentation/functions/physics_2d.get_position.html index 8a8d4f6d6..7282ed3b7 100644 --- a/documentation/functions/physics_2d.get_position.html +++ b/documentation/functions/physics_2d.get_position.html @@ -1,4 +1,4 @@ get_position | Source Academy Modules

    Function get_position

    • get_position(obj): Vector2

    • Gets position of the object at current world time.

      Parameters

      • obj: PhysicsObject

        existing object

      Returns Vector2

      position of center

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.get_rotation.html b/documentation/functions/physics_2d.get_rotation.html index 9e40de692..e8e00a13b 100644 --- a/documentation/functions/physics_2d.get_rotation.html +++ b/documentation/functions/physics_2d.get_rotation.html @@ -1,4 +1,4 @@ get_rotation | Source Academy Modules

    Function get_rotation

    • get_rotation(obj): number

    • Gets rotation of the object at current world time.

      Parameters

      • obj: PhysicsObject

        existing object

      Returns number

      rotation of object

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.get_velocity.html b/documentation/functions/physics_2d.get_velocity.html index 6949e9c26..f60d96a58 100644 --- a/documentation/functions/physics_2d.get_velocity.html +++ b/documentation/functions/physics_2d.get_velocity.html @@ -1,4 +1,4 @@ get_velocity | Source Academy Modules

    Function get_velocity

    • get_velocity(obj): Vector2

    • Gets velocity of the object at current world time.

      Parameters

      • obj: PhysicsObject

        exisiting object

      Returns Vector2

      velocity vector

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.impact_start_time.html b/documentation/functions/physics_2d.impact_start_time.html index 6ffe60a2f..bec371d01 100644 --- a/documentation/functions/physics_2d.impact_start_time.html +++ b/documentation/functions/physics_2d.impact_start_time.html @@ -1,4 +1,4 @@ impact_start_time | Source Academy Modules

    Function impact_start_time

    • impact_start_time(obj1, obj2): number

    • Gets the impact start time of two currently touching objects. Returns -1 if they are not touching.

      Parameters

      • obj1: PhysicsObject
      • obj2: PhysicsObject

      Returns number

      impact start time

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.is_touching.html b/documentation/functions/physics_2d.is_touching.html index 23d0d09ea..eb6131d83 100644 --- a/documentation/functions/physics_2d.is_touching.html +++ b/documentation/functions/physics_2d.is_touching.html @@ -1,3 +1,3 @@ is_touching | Source Academy Modules

    Function is_touching

    • is_touching(obj1, obj2): boolean

    • Checks if two objects are touching at current world time.

      Parameters

      • obj1: PhysicsObject
      • obj2: PhysicsObject

      Returns boolean

      touching state

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.make_force.html b/documentation/functions/physics_2d.make_force.html index d61c4c456..c644b6d91 100644 --- a/documentation/functions/physics_2d.make_force.html +++ b/documentation/functions/physics_2d.make_force.html @@ -4,4 +4,4 @@
  • dur: number

    duration of force

  • start: number

    start time of force

    • Returns Force

    new force

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.make_ground.html b/documentation/functions/physics_2d.make_ground.html index b85ac017c..721ae6ab2 100644 --- a/documentation/functions/physics_2d.make_ground.html +++ b/documentation/functions/physics_2d.make_ground.html @@ -1,4 +1,4 @@ make_ground | Source Academy Modules

    Function make_ground

    • make_ground(height, friction): void

    • Makes the ground body of the world.

      Parameters

      • height: number

        height of ground

      • friction: number

        friction of ground

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.make_vector.html b/documentation/functions/physics_2d.make_vector.html index 0b564a734..abcf02407 100644 --- a/documentation/functions/physics_2d.make_vector.html +++ b/documentation/functions/physics_2d.make_vector.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector2

    with x, y as components

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.scale_size.html b/documentation/functions/physics_2d.scale_size.html index 4cc8e4187..ed2acd884 100644 --- a/documentation/functions/physics_2d.scale_size.html +++ b/documentation/functions/physics_2d.scale_size.html @@ -1,4 +1,4 @@ scale_size | Source Academy Modules

    Function scale_size

    • scale_size(obj, scale): void

    • Resizes the object with given scale factor.

      Parameters

      • obj: PhysicsObject

        existinig object

      • scale: number

        scaling size

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.set_angular_velocity.html b/documentation/functions/physics_2d.set_angular_velocity.html index 06a838bba..e3cbcba44 100644 --- a/documentation/functions/physics_2d.set_angular_velocity.html +++ b/documentation/functions/physics_2d.set_angular_velocity.html @@ -1,4 +1,4 @@ set_angular_velocity | Source Academy Modules

    Function set_angular_velocity

    • set_angular_velocity(obj, velc): void

    • Sets current angular velocity of the object.

      Parameters

      • obj: PhysicsObject

        exisiting object

      • velc: number

        angular velocity number

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.set_density.html b/documentation/functions/physics_2d.set_density.html index 9c4424562..69d66c627 100644 --- a/documentation/functions/physics_2d.set_density.html +++ b/documentation/functions/physics_2d.set_density.html @@ -1,4 +1,4 @@ set_density | Source Academy Modules

    Function set_density

    • set_density(obj, density): void

    • Set density of the object.

      Parameters

      • obj: PhysicsObject

        existing object

      • density: number

        density

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.set_friction.html b/documentation/functions/physics_2d.set_friction.html index 91474cc9c..bae785fa0 100644 --- a/documentation/functions/physics_2d.set_friction.html +++ b/documentation/functions/physics_2d.set_friction.html @@ -1,2 +1,2 @@ set_friction | Source Academy Modules

    Function set_friction

    • set_friction(obj, friction): void

    • Sets the friction value of the object.

      -

      Parameters

      • obj: PhysicsObject
      • friction: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.set_gravity.html b/documentation/functions/physics_2d.set_gravity.html index 4f22ae575..17f154d46 100644 --- a/documentation/functions/physics_2d.set_gravity.html +++ b/documentation/functions/physics_2d.set_gravity.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Example

    set_gravity(0, -9.8); // gravity vector for real world
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.set_position.html b/documentation/functions/physics_2d.set_position.html index 41063d04c..da1a14b52 100644 --- a/documentation/functions/physics_2d.set_position.html +++ b/documentation/functions/physics_2d.set_position.html @@ -1,4 +1,4 @@ set_position | Source Academy Modules

    Function set_position

    • set_position(obj, pos): void

    • Sets the position of the object.

      Parameters

      • obj: PhysicsObject

        existing object

      • pos: Vector2

        new position

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.set_rotation.html b/documentation/functions/physics_2d.set_rotation.html index cd4a53e41..d0a5ce2bb 100644 --- a/documentation/functions/physics_2d.set_rotation.html +++ b/documentation/functions/physics_2d.set_rotation.html @@ -1,4 +1,4 @@ set_rotation | Source Academy Modules

    Function set_rotation

    • set_rotation(obj, rot): void

    • Sets the rotation of the object.

      Parameters

      • obj: PhysicsObject

        existing object

      • rot: number

        new rotation

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.set_velocity.html b/documentation/functions/physics_2d.set_velocity.html index 2a8287c83..81fee3958 100644 --- a/documentation/functions/physics_2d.set_velocity.html +++ b/documentation/functions/physics_2d.set_velocity.html @@ -1,4 +1,4 @@ set_velocity | Source Academy Modules

    Function set_velocity

    • set_velocity(obj, velc): void

    • Sets current velocity of the object.

      Parameters

      • obj: PhysicsObject

        exisiting object

      • velc: Vector2

        new velocity

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.simulate_world.html b/documentation/functions/physics_2d.simulate_world.html index 827d839fd..df0ed274d 100644 --- a/documentation/functions/physics_2d.simulate_world.html +++ b/documentation/functions/physics_2d.simulate_world.html @@ -1,3 +1,3 @@ simulate_world | Source Academy Modules

    Function simulate_world

    • simulate_world(total_time): void

    • Simulates the world for given duration.

      Parameters

      • total_time: number

        total time to simulate

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.subtract_vector.html b/documentation/functions/physics_2d.subtract_vector.html index fb2d9e7a2..cb758b2d3 100644 --- a/documentation/functions/physics_2d.subtract_vector.html +++ b/documentation/functions/physics_2d.subtract_vector.html @@ -1,3 +1,3 @@ subtract_vector | Source Academy Modules

    Function subtract_vector

    • subtract_vector(vec1, vec2): Vector2

    • Subtract the second vector from the first and returns the resultant vector.

      Parameters

      • vec1: Vector2
      • vec2: Vector2

      Returns Vector2

      vector 2d

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.update_world.html b/documentation/functions/physics_2d.update_world.html index b37b19352..746abf00c 100644 --- a/documentation/functions/physics_2d.update_world.html +++ b/documentation/functions/physics_2d.update_world.html @@ -1,3 +1,3 @@ update_world | Source Academy Modules

    Function update_world

    • update_world(dt): void

    • Updates the world once with the given time step.

      Parameters

      • dt: number

        value of fixed time step

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/physics_2d.vector_to_array.html b/documentation/functions/physics_2d.vector_to_array.html index 25c7d9b3a..ccc5d26d2 100644 --- a/documentation/functions/physics_2d.vector_to_array.html +++ b/documentation/functions/physics_2d.vector_to_array.html @@ -1,4 +1,4 @@ vector_to_array | Source Academy Modules

    Function vector_to_array

    • vector_to_array(vec): number[]

    • Converts a 2d vector into an array.

      Parameters

      • vec: Vector2

        2D vector to convert

      Returns number[]

      array with [x, y]

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.alpha_of.html b/documentation/functions/pix_n_flix.alpha_of.html index 716caad9c..4686f0cc9 100644 --- a/documentation/functions/pix_n_flix.alpha_of.html +++ b/documentation/functions/pix_n_flix.alpha_of.html @@ -1,4 +1,4 @@ alpha_of | Source Academy Modules

    Function alpha_of

    • alpha_of(pixel): number

    • Returns the alpha component of the given pixel.

      Parameters

      • pixel: Pixel

        The given pixel

      Returns number

      The alpha component as a number between 0 and 255

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.blue_of.html b/documentation/functions/pix_n_flix.blue_of.html index 310b19072..bec048cd1 100644 --- a/documentation/functions/pix_n_flix.blue_of.html +++ b/documentation/functions/pix_n_flix.blue_of.html @@ -1,4 +1,4 @@ blue_of | Source Academy Modules

    Function blue_of

    • blue_of(pixel): number

    • Returns the blue component of the given pixel.

      Parameters

      • pixel: Pixel

        The given pixel

      Returns number

      The blue component as a number between 0 and 255

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.compose_filter.html b/documentation/functions/pix_n_flix.compose_filter.html index 22fdfbd43..16f8f7525 100644 --- a/documentation/functions/pix_n_flix.compose_filter.html +++ b/documentation/functions/pix_n_flix.compose_filter.html @@ -3,4 +3,4 @@

    Parameters

    Returns Filter

    The filter equivalent to applying filter1 and then filter2

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.copy_image.html b/documentation/functions/pix_n_flix.copy_image.html index a95133315..bfdfa6e38 100644 --- a/documentation/functions/pix_n_flix.copy_image.html +++ b/documentation/functions/pix_n_flix.copy_image.html @@ -2,4 +2,4 @@ destination image.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.get_video_time.html b/documentation/functions/pix_n_flix.get_video_time.html index 78ffc40ac..03b2274a2 100644 --- a/documentation/functions/pix_n_flix.get_video_time.html +++ b/documentation/functions/pix_n_flix.get_video_time.html @@ -1,3 +1,3 @@ get_video_time | Source Academy Modules

    Function get_video_time

    • get_video_time(): number

    • Returns the elapsed time in milliseconds since the start of the video.

      Returns number

      The elapsed time in milliseconds since the start of the video

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.green_of.html b/documentation/functions/pix_n_flix.green_of.html index a8539dad3..9ca2604bb 100644 --- a/documentation/functions/pix_n_flix.green_of.html +++ b/documentation/functions/pix_n_flix.green_of.html @@ -1,4 +1,4 @@ green_of | Source Academy Modules

    Function green_of

    • green_of(pixel): number

    • Returns the green component of the given pixel.

      Parameters

      • pixel: Pixel

        The given pixel

      Returns number

      The green component as a number between 0 and 255

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.image_height.html b/documentation/functions/pix_n_flix.image_height.html index b12e9a708..f4aa93534 100644 --- a/documentation/functions/pix_n_flix.image_height.html +++ b/documentation/functions/pix_n_flix.image_height.html @@ -1,4 +1,4 @@ image_height | Source Academy Modules

    Function image_height

    • image_height(): number

    • Returns the current height of the displayed images in pixels, i.e. the number of pixels in the vertical dimension.

      Returns number

      The height of the displayed images (in pixels)

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.image_width.html b/documentation/functions/pix_n_flix.image_width.html index f352ff355..d1b14dc25 100644 --- a/documentation/functions/pix_n_flix.image_width.html +++ b/documentation/functions/pix_n_flix.image_width.html @@ -1,4 +1,4 @@ image_width | Source Academy Modules

    Function image_width

    • image_width(): number

    • Returns the current width of the displayed images in pixels, i.e. the number of pixels in the horizontal dimension.

      Returns number

      The width of the displayed images (in pixels)

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.install_filter.html b/documentation/functions/pix_n_flix.install_filter.html index 1ae12bc1e..9788587c3 100644 --- a/documentation/functions/pix_n_flix.install_filter.html +++ b/documentation/functions/pix_n_flix.install_filter.html @@ -4,4 +4,4 @@

    A filter is a function that is applied to two two-dimensional arrays of Pixels: the source image and the destination image.

    -

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.keep_aspect_ratio.html b/documentation/functions/pix_n_flix.keep_aspect_ratio.html index 522bca678..e31e153e8 100644 --- a/documentation/functions/pix_n_flix.keep_aspect_ratio.html +++ b/documentation/functions/pix_n_flix.keep_aspect_ratio.html @@ -1,2 +1,2 @@ keep_aspect_ratio | Source Academy Modules

    Function keep_aspect_ratio

    • keep_aspect_ratio(_keepAspectRatio): void

    • Sets pix_n_flix to preserve the aspect ratio of the video or image

      -

      Parameters

      • _keepAspectRatio: boolean

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.pause_at.html b/documentation/functions/pix_n_flix.pause_at.html index 4d9178f3b..5511e72ba 100644 --- a/documentation/functions/pix_n_flix.pause_at.html +++ b/documentation/functions/pix_n_flix.pause_at.html @@ -1,3 +1,3 @@ pause_at | Source Academy Modules

    Function pause_at

    • pause_at(pause_time): void

    • Pauses the video at a set time after the video starts.

      Parameters

      • pause_time: number

        Time in ms after the video starts.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.red_of.html b/documentation/functions/pix_n_flix.red_of.html index 4f03ed59b..1f51350de 100644 --- a/documentation/functions/pix_n_flix.red_of.html +++ b/documentation/functions/pix_n_flix.red_of.html @@ -1,4 +1,4 @@ red_of | Source Academy Modules

    Function red_of

    • red_of(pixel): number

    • Returns the red component of the given pixel.

      Parameters

      • pixel: Pixel

        The given pixel

      Returns number

      The red component as a number between 0 and 255

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.reset_filter.html b/documentation/functions/pix_n_flix.reset_filter.html index 45dca938a..9cd75d05e 100644 --- a/documentation/functions/pix_n_flix.reset_filter.html +++ b/documentation/functions/pix_n_flix.reset_filter.html @@ -1,2 +1,2 @@ reset_filter | Source Academy Modules

    Function reset_filter

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.set_dimensions.html b/documentation/functions/pix_n_flix.set_dimensions.html index 4f9c00e15..a3321319c 100644 --- a/documentation/functions/pix_n_flix.set_dimensions.html +++ b/documentation/functions/pix_n_flix.set_dimensions.html @@ -2,4 +2,4 @@ Note: Only accepts width and height values within the range of 1 to 500.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.set_fps.html b/documentation/functions/pix_n_flix.set_fps.html index c69d68265..f103451e8 100644 --- a/documentation/functions/pix_n_flix.set_fps.html +++ b/documentation/functions/pix_n_flix.set_fps.html @@ -1,4 +1,4 @@ set_fps | Source Academy Modules

    Function set_fps

    • set_fps(fps): void

    • Sets the framerate (i.e. frames per second (FPS)) of the video. Note: Only accepts FPS values within the range of 2 to 30.

      Parameters

      • fps: number

        FPS of video (default value: 10)

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.set_loop_count.html b/documentation/functions/pix_n_flix.set_loop_count.html index d260debe3..d325d0c3d 100644 --- a/documentation/functions/pix_n_flix.set_loop_count.html +++ b/documentation/functions/pix_n_flix.set_loop_count.html @@ -1,4 +1,4 @@ set_loop_count | Source Academy Modules

    Function set_loop_count

    • set_loop_count(n): void

    • Sets the number of times the video is played. If the number of times the video repeats is negative, the video will loop forever.

      Parameters

      • n: number

        number of times the video repeats after the first iteration. If n < 1, n will be taken to be 1. (Default value of Infinity)

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.set_rgba.html b/documentation/functions/pix_n_flix.set_rgba.html index 27cd39f2c..0fd245d35 100644 --- a/documentation/functions/pix_n_flix.set_rgba.html +++ b/documentation/functions/pix_n_flix.set_rgba.html @@ -5,4 +5,4 @@
  • g: number

    The green component as a number between 0 and 255

  • b: number

    The blue component as a number between 0 and 255

  • a: number

    The alpha component as a number between 0 and 255

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.set_volume.html b/documentation/functions/pix_n_flix.set_volume.html index 69cc1d02f..457c1f735 100644 --- a/documentation/functions/pix_n_flix.set_volume.html +++ b/documentation/functions/pix_n_flix.set_volume.html @@ -1,4 +1,4 @@ set_volume | Source Academy Modules

    Function set_volume

    • set_volume(volume): void

    • Sets the audio volume of the local video file played. Note: Only accepts volume value within the range of 0 to 100.

      Parameters

      • volume: number

        Volume of video (Default value of 50)

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.start.html b/documentation/functions/pix_n_flix.start.html index 3c207f35a..faf6388cc 100644 --- a/documentation/functions/pix_n_flix.start.html +++ b/documentation/functions/pix_n_flix.start.html @@ -1,2 +1,2 @@ start | Source Academy Modules

    Function start

    • start(): StartPacket

    • Starts processing the image or video using the installed filter.

      -

      Returns StartPacket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns StartPacket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.use_image_url.html b/documentation/functions/pix_n_flix.use_image_url.html index 82ae7822f..57b84fac3 100644 --- a/documentation/functions/pix_n_flix.use_image_url.html +++ b/documentation/functions/pix_n_flix.use_image_url.html @@ -1,4 +1,4 @@ use_image_url | Source Academy Modules

    Function use_image_url

    • use_image_url(URL): void

    • Sets pix_n_flix to use the image from the given URL as the image feed instead of using the default live camera feed.

      Parameters

      • URL: string

        URL of the image

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.use_local_file.html b/documentation/functions/pix_n_flix.use_local_file.html index 73f8dd340..3d0946ee6 100644 --- a/documentation/functions/pix_n_flix.use_local_file.html +++ b/documentation/functions/pix_n_flix.use_local_file.html @@ -1,3 +1,3 @@ use_local_file | Source Academy Modules

    Function use_local_file

    • use_local_file(): void

    • Sets pix_n_flix to use video or image feed from a local file instead of using the default live camera feed.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/pix_n_flix.use_video_url.html b/documentation/functions/pix_n_flix.use_video_url.html index 65e7d28cd..af0ac382c 100644 --- a/documentation/functions/pix_n_flix.use_video_url.html +++ b/documentation/functions/pix_n_flix.use_video_url.html @@ -1,4 +1,4 @@ use_video_url | Source Academy Modules

    Function use_video_url

    • use_video_url(URL): void

    • Sets pix_n_flix to use the video from the given URL as the video feed instead of using the default live camera feed.

      Parameters

      • URL: string

        URL of the video

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/plotly.draw_connected_2d.html b/documentation/functions/plotly.draw_connected_2d.html index 77f0ff952..a3892ad14 100644 --- a/documentation/functions/plotly.draw_connected_2d.html +++ b/documentation/functions/plotly.draw_connected_2d.html @@ -3,4 +3,4 @@

    Parameters

    Returns CurvePlotFunction

    function of type Curve → Drawing

    Example

    draw_connected_2d(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/plotly.draw_connected_3d.html b/documentation/functions/plotly.draw_connected_3d.html index 52b552293..7097b2ad0 100644 --- a/documentation/functions/plotly.draw_connected_3d.html +++ b/documentation/functions/plotly.draw_connected_3d.html @@ -3,4 +3,4 @@

    Parameters

    Returns CurvePlotFunction

    function of type 3D Curve → Drawing

    Example

    draw_connected_3d(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/plotly.draw_points_2d.html b/documentation/functions/plotly.draw_points_2d.html index 12806245f..5e6d9af87 100644 --- a/documentation/functions/plotly.draw_points_2d.html +++ b/documentation/functions/plotly.draw_points_2d.html @@ -7,4 +7,4 @@

    Parameters

    Returns CurvePlotFunction

    function of type 2D Curve → Drawing

    Example

    draw_points_2d(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/plotly.draw_points_3d.html b/documentation/functions/plotly.draw_points_3d.html index becef3baf..9930844ab 100644 --- a/documentation/functions/plotly.draw_points_3d.html +++ b/documentation/functions/plotly.draw_points_3d.html @@ -7,4 +7,4 @@

    Parameters

    Returns CurvePlotFunction

    function of type 3D Curve → Drawing

    Example

    draw_points_3d(100)(t => make_point(t, t));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/plotly.draw_sound_2d.html b/documentation/functions/plotly.draw_sound_2d.html index ee5b2a229..7f572f072 100644 --- a/documentation/functions/plotly.draw_sound_2d.html +++ b/documentation/functions/plotly.draw_sound_2d.html @@ -1,3 +1,3 @@ draw_sound_2d | Source Academy Modules

    Function draw_sound_2d

    • draw_sound_2d(sound): void

    • Visualizes the sound on a 2d line graph

      Parameters

      • sound: Sound

        the sound which is to be visualized on plotly

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/plotly.new_plot.html b/documentation/functions/plotly.new_plot.html index e3d557b74..1575333a0 100644 --- a/documentation/functions/plotly.new_plot.html +++ b/documentation/functions/plotly.new_plot.html @@ -6,4 +6,4 @@

    Types

    // The data format for input [{field_name}, value] from among the following fields
     data = {
       type: PlotType;
       x: Datum[] | Datum[][];
       y: Datum[] | Datum[][];
       z: Datum[] | Datum[][] | Datum[][][];
       mode:
          | 'lines'
          | 'markers'
          | 'text'
          | 'lines+markers'
          | 'text+markers'
          | 'text+lines'
          | 'text+lines+markers'
     }


     type Datum = string | number | Date | null;
     type PlotType =
     | 'bar'
     | 'barpolar'
     | 'box'
     | 'candlestick'
     | 'carpet'
     | 'choropleth'
     | 'choroplethmapbox'
     | 'cone'
     | 'contour'
     | 'contourcarpet'
     | 'densitymapbox'
     | 'funnel'
     | 'funnelarea'
     | 'heatmap'
     | 'heatmapgl'
     | 'histogram'
     | 'histogram2d'
     | 'histogram2dcontour'
     | 'image'
     | 'indicator'
     | 'isosurface'
     | 'mesh3d'
     | 'ohlc'
     | 'parcats'
     | 'parcoords'
     | 'pie'
     | 'pointcloud'
     | 'sankey'
     | 'scatter'
     | 'scatter3d'
     | 'scattercarpet'
     | 'scattergeo'
     | 'scattergl'
     | 'scattermapbox'
     | 'scatterpolar'
     | 'scatterpolargl'
     | 'scatterternary'
     | 'splom'
     | 'streamtube'
     | 'sunburst'
     | 'surface'
     | 'table'
     | 'treemap'
     | 'violin'
     | 'volume'
     | 'waterfall';
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/plotly.new_plot_json.html b/documentation/functions/plotly.new_plot_json.html index c8ce5663f..e77a57766 100644 --- a/documentation/functions/plotly.new_plot_json.html +++ b/documentation/functions/plotly.new_plot_json.html @@ -4,4 +4,4 @@

    Types

    // The data format for input [{field_name}, value] from among the following fields
     data = {
       type: PlotType;
       x: Datum[] | Datum[][];
       y: Datum[] | Datum[][];
       z: Datum[] | Datum[][] | Datum[][][];
       mode:
          | 'lines'
          | 'markers'
          | 'text'
          | 'lines+markers'
          | 'text+markers'
          | 'text+lines'
          | 'text+lines+markers'
     }[]


     type Datum = string | number | Date | null;
     type PlotType =
     | 'bar'
     | 'barpolar'
     | 'box'
     | 'candlestick'
     | 'carpet'
     | 'choropleth'
     | 'choroplethmapbox'
     | 'cone'
     | 'contour'
     | 'contourcarpet'
     | 'densitymapbox'
     | 'funnel'
     | 'funnelarea'
     | 'heatmap'
     | 'heatmapgl'
     | 'histogram'
     | 'histogram2d'
     | 'histogram2dcontour'
     | 'image'
     | 'indicator'
     | 'isosurface'
     | 'mesh3d'
     | 'ohlc'
     | 'parcats'
     | 'parcoords'
     | 'pie'
     | 'pointcloud'
     | 'sankey'
     | 'scatter'
     | 'scatter3d'
     | 'scattercarpet'
     | 'scattergeo'
     | 'scattergl'
     | 'scattermapbox'
     | 'scatterpolar'
     | 'scatterpolargl'
     | 'scatterternary'
     | 'splom'
     | 'streamtube'
     | 'sunburst'
     | 'surface'
     | 'table'
     | 'treemap'
     | 'violin'
     | 'volume'
     | 'waterfall';
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repeat.repeat.html b/documentation/functions/repeat.repeat.html index b88c3ca0b..28805a2c8 100644 --- a/documentation/functions/repeat.repeat.html +++ b/documentation/functions/repeat.repeat.html @@ -5,4 +5,4 @@

    Returns Function

    the new function that has the same effect as func repeated n times

    Example

    const plusTen = repeat(x => x + 2, 5);
    plusTen(0); // Returns 10
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repeat.thrice.html b/documentation/functions/repeat.thrice.html index b099389ad..a4be755f9 100644 --- a/documentation/functions/repeat.thrice.html +++ b/documentation/functions/repeat.thrice.html @@ -4,4 +4,4 @@

    Returns Function

    the new function that has the same effect as (x => func(func(func(x))))

    Example

    const plusNine = thrice(x => x + 3);
    plusNine(0); // Returns 9
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repeat.twice.html b/documentation/functions/repeat.twice.html index 691b629e9..317530fac 100644 --- a/documentation/functions/repeat.twice.html +++ b/documentation/functions/repeat.twice.html @@ -4,4 +4,4 @@

    Returns Function

    the new function that has the same effect as (x => func(func(x)))

    Example

    const plusTwo = twice(x => x + 1);
    plusTwo(2); // Returns 4
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repl.default_js_slang.html b/documentation/functions/repl.default_js_slang.html index b7c03e009..093f90b5b 100644 --- a/documentation/functions/repl.default_js_slang.html +++ b/documentation/functions/repl.default_js_slang.html @@ -1,2 +1,2 @@ default_js_slang | Source Academy Modules

    Function default_js_slang

    • default_js_slang(_program): any

    • When use this function as the entrance function in the parameter of "set_evaluator", the Programmable Repl will directly use the default js-slang interpreter to run your program in Programmable Repl editor. Do not directly call this function in your own code.

      -

      Parameters

      • _program: string

      Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repl.repl_display.html b/documentation/functions/repl.repl_display.html index f336cf95d..e763ca4f1 100644 --- a/documentation/functions/repl.repl_display.html +++ b/documentation/functions/repl.repl_display.html @@ -28,4 +28,4 @@
  • Note that if you apply the conflicting attributes together, only one conflicted style will take effect and other conflicting styles will be discarded, like "pair(pair(pair("123", small), medium), large) " (Set conflicting font size for the same text)
  • Also note that for safety matters, certain words and characters are not allowed to appear under rich text display mode.
    • -

    Parameters

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repl.set_background_image.html b/documentation/functions/repl.set_background_image.html index 3df925ad1..1de7204a5 100644 --- a/documentation/functions/repl.set_background_image.html +++ b/documentation/functions/repl.set_background_image.html @@ -1,2 +1,2 @@ set_background_image | Source Academy Modules

    Function set_background_image

    • set_background_image(img_url, background_color_alpha): void

    • Set Programmable Repl editor background image with a customized image URL

      -

      Parameters

      • img_url: string
      • background_color_alpha: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repl.set_evaluator.html b/documentation/functions/repl.set_evaluator.html index e28eed814..fb16d8bff 100644 --- a/documentation/functions/repl.set_evaluator.html +++ b/documentation/functions/repl.set_evaluator.html @@ -3,4 +3,4 @@ 
    function parse_and_evaluate(code) {
      // ...
    }

    Parameters

    Returns {
        toReplString: (() => string);
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns {
        toReplString: (() => string);
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repl.set_font_size.html b/documentation/functions/repl.set_font_size.html index 726503e7c..ac9861390 100644 --- a/documentation/functions/repl.set_font_size.html +++ b/documentation/functions/repl.set_font_size.html @@ -1,2 +1,2 @@ set_font_size | Source Academy Modules

    Function set_font_size

    • set_font_size(font_size_px): void

    • Set Programmable Repl editor font size

      -

      Parameters

      • font_size_px: number

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/repl.set_program_text.html b/documentation/functions/repl.set_program_text.html index 3411ccdaf..e96463144 100644 --- a/documentation/functions/repl.set_program_text.html +++ b/documentation/functions/repl.set_program_text.html @@ -1,2 +1,2 @@ set_program_text | Source Academy Modules

    Function set_program_text

    • set_program_text(text): void

    • Set program text in the Repl editor to the given string

      -

      Parameters

      • text: string

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.addControllerToWorld.html b/documentation/functions/robot_simulation.addControllerToWorld.html index 9d08b8894..66d047109 100644 --- a/documentation/functions/robot_simulation.addControllerToWorld.html +++ b/documentation/functions/robot_simulation.addControllerToWorld.html @@ -5,4 +5,4 @@

    The controller should be added to the world using this function in order for the simulation to access the controller's logic.

    *This is a Utility function and should be called within init_simulation.

    -

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createCSE.html b/documentation/functions/robot_simulation.createCSE.html index d174cee47..ce543a58b 100644 --- a/documentation/functions/robot_simulation.createCSE.html +++ b/documentation/functions/robot_simulation.createCSE.html @@ -4,4 +4,4 @@

    The returned Program object is designed to be added to the world using addControllerToWorld.

    This is a Controller function and should be called within init_simulation.

    Returns Program

    Program

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createCuboid.html b/documentation/functions/robot_simulation.createCuboid.html index 010a9f2f1..a0acacaa2 100644 --- a/documentation/functions/robot_simulation.createCuboid.html +++ b/documentation/functions/robot_simulation.createCuboid.html @@ -16,4 +16,4 @@

    Returns Cuboid

    Cuboid

    Example

    init_simulation(() => {
        const physics = createPhysics();
        const renderer = createRenderer();
        const timer = createTimer();
        const robot_console = createRobotConsole();
        const world = createWorld(physics, renderer, timer, robot_console);

        const cuboid = createCuboid(...);
        addControllerToWorld(cuboid, world);

        return world;
      });
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createCustomPhysics.html b/documentation/functions/robot_simulation.createCustomPhysics.html index 0e3ab13e4..0ed3a51f6 100644 --- a/documentation/functions/robot_simulation.createCustomPhysics.html +++ b/documentation/functions/robot_simulation.createCustomPhysics.html @@ -5,4 +5,4 @@

    Parameters

    Returns Physics

    Physics

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createEv3.html b/documentation/functions/robot_simulation.createEv3.html index 0d805dabb..da873869d 100644 --- a/documentation/functions/robot_simulation.createEv3.html +++ b/documentation/functions/robot_simulation.createEv3.html @@ -7,4 +7,4 @@

    Returns DefaultEv3

    EV3

    Example

    init_simulation(() => {
      ...
      const ev3 = createEv3(physics, renderer);
      saveToContext('ev3', ev3);
    })
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createFloor.html b/documentation/functions/robot_simulation.createFloor.html index 44054b206..48571b944 100644 --- a/documentation/functions/robot_simulation.createFloor.html +++ b/documentation/functions/robot_simulation.createFloor.html @@ -4,4 +4,4 @@

    Parameters

    Returns Cuboid

    Cuboid

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createPaper.html b/documentation/functions/robot_simulation.createPaper.html index de44765b7..f09cb1c9a 100644 --- a/documentation/functions/robot_simulation.createPaper.html +++ b/documentation/functions/robot_simulation.createPaper.html @@ -9,4 +9,4 @@
  • y: number

    The y position of the paper.

  • rotation: number

    The rotation of the paper in degrees.

    • Returns Paper

    Paper

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createPhysics.html b/documentation/functions/robot_simulation.createPhysics.html index 7227b36c6..6b6fd777b 100644 --- a/documentation/functions/robot_simulation.createPhysics.html +++ b/documentation/functions/robot_simulation.createPhysics.html @@ -3,4 +3,4 @@

    The returned Physics object is designed to be passed into createWorld.

    This is a configuration function and should be called within init_simulation.

    Returns Physics

    Physics

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createRenderer.html b/documentation/functions/robot_simulation.createRenderer.html index b3c0dfc6d..104ec4568 100644 --- a/documentation/functions/robot_simulation.createRenderer.html +++ b/documentation/functions/robot_simulation.createRenderer.html @@ -2,4 +2,4 @@

    The returned Renderer object is designed to be passed into createWorld.

    This is a configuration function and should be called within init_simulation.

    Returns Renderer

    Renderer

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createRobotConsole.html b/documentation/functions/robot_simulation.createRobotConsole.html index 78f455969..05409c545 100644 --- a/documentation/functions/robot_simulation.createRobotConsole.html +++ b/documentation/functions/robot_simulation.createRobotConsole.html @@ -4,4 +4,4 @@

    The returned RobotConsole object is designed to be passed into createWorld.

    This is a configuration function and should be called within init_simulation.

    Returns RobotConsole

    RobotConsole

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createTimer.html b/documentation/functions/robot_simulation.createTimer.html index 2b6c53b38..ff7ced989 100644 --- a/documentation/functions/robot_simulation.createTimer.html +++ b/documentation/functions/robot_simulation.createTimer.html @@ -2,4 +2,4 @@

    The returned Timer object is designed to be passed into createWorld.

    This is a configuration function and should be called within init_simulation.

    Returns Timer

    Timer

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createWall.html b/documentation/functions/robot_simulation.createWall.html index e53389f3a..bbe179780 100644 --- a/documentation/functions/robot_simulation.createWall.html +++ b/documentation/functions/robot_simulation.createWall.html @@ -9,4 +9,4 @@
  • length: number

    The length of the wall in meters

  • height: number

    The height of the wall in meters

    • Returns Cuboid

    Cuboid

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.createWorld.html b/documentation/functions/robot_simulation.createWorld.html index 73307d4f2..d5ab2d9f8 100644 --- a/documentation/functions/robot_simulation.createWorld.html +++ b/documentation/functions/robot_simulation.createWorld.html @@ -13,4 +13,4 @@

    Example

    An empty simulation

    init_simulation(() => {
        const physics = createPhysics();
        const renderer = createRenderer();
        const timer = createTimer();
        const robot_console = createRobotConsole();
        const world = createWorld(physics, renderer, timer, robot_console);

        return world;
      });
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_colorSensor.html b/documentation/functions/robot_simulation.ev3_colorSensor.html index 3fc38a30c..91b03c982 100644 --- a/documentation/functions/robot_simulation.ev3_colorSensor.html +++ b/documentation/functions/robot_simulation.ev3_colorSensor.html @@ -1,3 +1,3 @@ ev3_colorSensor | Source Academy Modules

    Function ev3_colorSensor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_colorSensorBlue.html b/documentation/functions/robot_simulation.ev3_colorSensorBlue.html index c9acdb9c7..7e3912e5f 100644 --- a/documentation/functions/robot_simulation.ev3_colorSensorBlue.html +++ b/documentation/functions/robot_simulation.ev3_colorSensorBlue.html @@ -1,4 +1,4 @@ ev3_colorSensorBlue | Source Academy Modules

    Function ev3_colorSensorBlue

    • ev3_colorSensorBlue(colorSensor): number

    • Gets the amount of blue seen by the colour sensor.

      Parameters

      • colorSensor: ColorSensor

        The color sensor

      Returns number

      The amount of blue, in sensor-specific units.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_colorSensorGreen.html b/documentation/functions/robot_simulation.ev3_colorSensorGreen.html index 47732620b..1bde8dc5c 100644 --- a/documentation/functions/robot_simulation.ev3_colorSensorGreen.html +++ b/documentation/functions/robot_simulation.ev3_colorSensorGreen.html @@ -1,4 +1,4 @@ ev3_colorSensorGreen | Source Academy Modules

    Function ev3_colorSensorGreen

    • ev3_colorSensorGreen(colorSensor): number

    • Gets the amount of green seen by the colour sensor.

      Parameters

      • colorSensor: ColorSensor

        The color sensor

      Returns number

      The amount of green, in sensor-specific units.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_colorSensorRed.html b/documentation/functions/robot_simulation.ev3_colorSensorRed.html index 6f0434514..8af5b6a45 100644 --- a/documentation/functions/robot_simulation.ev3_colorSensorRed.html +++ b/documentation/functions/robot_simulation.ev3_colorSensorRed.html @@ -1,4 +1,4 @@ ev3_colorSensorRed | Source Academy Modules

    Function ev3_colorSensorRed

    • ev3_colorSensorRed(colorSensor): number

    • Gets the amount of red seen by the colour sensor.

      Parameters

      • colorSensor: ColorSensor

        The color sensor

      Returns number

      The amount of blue, in sensor-specific units.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_motorA.html b/documentation/functions/robot_simulation.ev3_motorA.html index f9c79c459..644cfbfbe 100644 --- a/documentation/functions/robot_simulation.ev3_motorA.html +++ b/documentation/functions/robot_simulation.ev3_motorA.html @@ -1,3 +1,3 @@ ev3_motorA | Source Academy Modules

    Function ev3_motorA

    • ev3_motorA(): MotorFunctionReturnType

    • Gets the motor connected to port A.

      Returns MotorFunctionReturnType

      The motor connected to port A

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_motorB.html b/documentation/functions/robot_simulation.ev3_motorB.html index 9cfa63a78..6400ac59d 100644 --- a/documentation/functions/robot_simulation.ev3_motorB.html +++ b/documentation/functions/robot_simulation.ev3_motorB.html @@ -1,3 +1,3 @@ ev3_motorB | Source Academy Modules

    Function ev3_motorB

    • ev3_motorB(): MotorFunctionReturnType

    • Gets the motor connected to port B.

      Returns MotorFunctionReturnType

      The motor connected to port B

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_motorC.html b/documentation/functions/robot_simulation.ev3_motorC.html index 34435007c..395b9800e 100644 --- a/documentation/functions/robot_simulation.ev3_motorC.html +++ b/documentation/functions/robot_simulation.ev3_motorC.html @@ -1,3 +1,3 @@ ev3_motorC | Source Academy Modules

    Function ev3_motorC

    • ev3_motorC(): MotorFunctionReturnType

    • Gets the motor connected to port C.

      Returns MotorFunctionReturnType

      The motor connected to port C

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_motorD.html b/documentation/functions/robot_simulation.ev3_motorD.html index d747c8f90..4c4d5f304 100644 --- a/documentation/functions/robot_simulation.ev3_motorD.html +++ b/documentation/functions/robot_simulation.ev3_motorD.html @@ -1,3 +1,3 @@ ev3_motorD | Source Academy Modules

    Function ev3_motorD

    • ev3_motorD(): MotorFunctionReturnType

    • Gets the motor connected to port D.

      Returns MotorFunctionReturnType

      The motor connected to port D

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_pause.html b/documentation/functions/robot_simulation.ev3_pause.html index 3c910ad29..c64a627f0 100644 --- a/documentation/functions/robot_simulation.ev3_pause.html +++ b/documentation/functions/robot_simulation.ev3_pause.html @@ -1,3 +1,3 @@ ev3_pause | Source Academy Modules

    Function ev3_pause

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_runToRelativePosition.html b/documentation/functions/robot_simulation.ev3_runToRelativePosition.html index fba6161fc..9b4f07cd4 100644 --- a/documentation/functions/robot_simulation.ev3_runToRelativePosition.html +++ b/documentation/functions/robot_simulation.ev3_runToRelativePosition.html @@ -5,4 +5,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_ultrasonicSensor.html b/documentation/functions/robot_simulation.ev3_ultrasonicSensor.html index 1dd0959a4..60f4db239 100644 --- a/documentation/functions/robot_simulation.ev3_ultrasonicSensor.html +++ b/documentation/functions/robot_simulation.ev3_ultrasonicSensor.html @@ -1,3 +1,3 @@ ev3_ultrasonicSensor | Source Academy Modules

    Function ev3_ultrasonicSensor

    • ev3_ultrasonicSensor(): UltrasonicSensor

    • Gets the ultrasonic sensor connected any of ports 1, 2, 3 or 4.

      Returns UltrasonicSensor

      The ultrasonic sensor

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.ev3_ultrasonicSensorDistance.html b/documentation/functions/robot_simulation.ev3_ultrasonicSensorDistance.html index f8231cda4..114a67893 100644 --- a/documentation/functions/robot_simulation.ev3_ultrasonicSensorDistance.html +++ b/documentation/functions/robot_simulation.ev3_ultrasonicSensorDistance.html @@ -1,4 +1,4 @@ ev3_ultrasonicSensorDistance | Source Academy Modules

    Function ev3_ultrasonicSensorDistance

    • ev3_ultrasonicSensorDistance(ultraSonicSensor): number

    • Gets the distance read by the ultrasonic sensor in centimeters.

      Parameters

      • ultraSonicSensor: UltrasonicSensor

        The ultrasonic sensor

      Returns number

      The distance, in centimeters.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.init_simulation.html b/documentation/functions/robot_simulation.init_simulation.html index e53154c8f..3bb6eaf0a 100644 --- a/documentation/functions/robot_simulation.init_simulation.html +++ b/documentation/functions/robot_simulation.init_simulation.html @@ -6,4 +6,4 @@ The world should be saved to the context using saveToContext.

    Parameters

    Returns void

    void

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/robot_simulation.saveToContext.html b/documentation/functions/robot_simulation.saveToContext.html index 7851a06cd..862b7d694 100644 --- a/documentation/functions/robot_simulation.saveToContext.html +++ b/documentation/functions/robot_simulation.saveToContext.html @@ -5,4 +5,4 @@

    Parameters

    Returns void

    void

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.anaglyph.html b/documentation/functions/rune.anaglyph.html index e14ad399a..9d6e6acab 100644 --- a/documentation/functions/rune.anaglyph.html +++ b/documentation/functions/rune.anaglyph.html @@ -2,4 +2,4 @@ anaglyph.

    Parameters

    Returns Rune

    The specified Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.animate_anaglyph.html b/documentation/functions/rune.animate_anaglyph.html index beb128908..3f39f80a0 100644 --- a/documentation/functions/rune.animate_anaglyph.html +++ b/documentation/functions/rune.animate_anaglyph.html @@ -3,4 +3,4 @@
  • fps: number

    Duration of each frame in frames per seconds

  • func: RuneAnimation

    Takes in the timestamp and returns a Rune to draw

    • Returns AnimatedRune

    A rune animation

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.animate_rune.html b/documentation/functions/rune.animate_rune.html index db7ac4a48..4260aac4c 100644 --- a/documentation/functions/rune.animate_rune.html +++ b/documentation/functions/rune.animate_rune.html @@ -3,4 +3,4 @@
  • fps: number

    Duration of each frame in frames per seconds

  • func: RuneAnimation

    Takes in the timestamp and returns a Rune to draw

    • Returns AnimatedRune

    A rune animation

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.beside.html b/documentation/functions/rune.beside.html index 854dfbca2..d9af18cbd 100644 --- a/documentation/functions/rune.beside.html +++ b/documentation/functions/rune.beside.html @@ -5,4 +5,4 @@

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.beside_frac.html b/documentation/functions/rune.beside_frac.html index c9bfc4400..9ec6df858 100644 --- a/documentation/functions/rune.beside_frac.html +++ b/documentation/functions/rune.beside_frac.html @@ -7,4 +7,4 @@
  • rune1: Rune

    Given Rune

  • rune2: Rune

    Given Rune

    • Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.black.html b/documentation/functions/rune.black.html index d297f82e5..c62dadc7c 100644 --- a/documentation/functions/rune.black.html +++ b/documentation/functions/rune.black.html @@ -1,4 +1,4 @@ black | Source Academy Modules

    Function black

    • black(rune): Rune

    • Colors the given rune black (#000000).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.blue.html b/documentation/functions/rune.blue.html index 30901ca78..a3ecaf7f2 100644 --- a/documentation/functions/rune.blue.html +++ b/documentation/functions/rune.blue.html @@ -1,4 +1,4 @@ blue | Source Academy Modules

    Function blue

    • blue(rune): Rune

    • Colors the given rune blue (#2196F3).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.brown.html b/documentation/functions/rune.brown.html index a9ef2e053..04b7c05b7 100644 --- a/documentation/functions/rune.brown.html +++ b/documentation/functions/rune.brown.html @@ -1,4 +1,4 @@ brown | Source Academy Modules

    Function brown

    • brown(rune): Rune

    • Colors the given rune brown.

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.color.html b/documentation/functions/rune.color.html index cde66b14e..e7c35738b 100644 --- a/documentation/functions/rune.color.html +++ b/documentation/functions/rune.color.html @@ -7,4 +7,4 @@
  • g: number

    Green value [0.0-1.0]

  • b: number

    Blue value [0.0-1.0]

    • Returns Rune

    The colored Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.flip_horiz.html b/documentation/functions/rune.flip_horiz.html index e73778990..d4e5bf178 100644 --- a/documentation/functions/rune.flip_horiz.html +++ b/documentation/functions/rune.flip_horiz.html @@ -3,4 +3,4 @@ creating a mirror image

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.flip_vert.html b/documentation/functions/rune.flip_vert.html index e494cc857..c46b023d6 100644 --- a/documentation/functions/rune.flip_vert.html +++ b/documentation/functions/rune.flip_vert.html @@ -3,4 +3,4 @@ turning it upside down

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.from_url.html b/documentation/functions/rune.from_url.html index 59ff73070..42c055520 100644 --- a/documentation/functions/rune.from_url.html +++ b/documentation/functions/rune.from_url.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rune

    Rune created using the image.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.green.html b/documentation/functions/rune.green.html index eed0d3bb8..dc76e8492 100644 --- a/documentation/functions/rune.green.html +++ b/documentation/functions/rune.green.html @@ -1,4 +1,4 @@ green | Source Academy Modules

    Function green

    • green(rune): Rune

    • Colors the given rune green (#4CAF50).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.hollusion.html b/documentation/functions/rune.hollusion.html index e89527107..506bf54ba 100644 --- a/documentation/functions/rune.hollusion.html +++ b/documentation/functions/rune.hollusion.html @@ -2,4 +2,4 @@ of 0.1.

    Parameters

    Returns Rune

    The specified Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.hollusion_magnitude.html b/documentation/functions/rune.hollusion_magnitude.html index 019917889..c54c23934 100644 --- a/documentation/functions/rune.hollusion_magnitude.html +++ b/documentation/functions/rune.hollusion_magnitude.html @@ -3,4 +3,4 @@

    Parameters

    Returns Rune

    The specified Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.indigo.html b/documentation/functions/rune.indigo.html index e1233a0fa..3fa5548ef 100644 --- a/documentation/functions/rune.indigo.html +++ b/documentation/functions/rune.indigo.html @@ -1,4 +1,4 @@ indigo | Source Academy Modules

    Function indigo

    • indigo(rune): Rune

    • Colors the given rune indigo (#3F51B5).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.make_cross.html b/documentation/functions/rune.make_cross.html index 004a362fa..cf580657d 100644 --- a/documentation/functions/rune.make_cross.html +++ b/documentation/functions/rune.make_cross.html @@ -3,4 +3,4 @@ given Rune in different orientations

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.orange.html b/documentation/functions/rune.orange.html index 34e0c8d4a..12125589c 100644 --- a/documentation/functions/rune.orange.html +++ b/documentation/functions/rune.orange.html @@ -1,4 +1,4 @@ orange | Source Academy Modules

    Function orange

    • orange(rune): Rune

    • Colors the given rune orange (#FF9800).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.overlay.html b/documentation/functions/rune.overlay.html index 9105538aa..9c5c54ab1 100644 --- a/documentation/functions/rune.overlay.html +++ b/documentation/functions/rune.overlay.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rune

    Resulting Runes

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.overlay_frac.html b/documentation/functions/rune.overlay_frac.html index 25909968d..38857b1d5 100644 --- a/documentation/functions/rune.overlay_frac.html +++ b/documentation/functions/rune.overlay_frac.html @@ -3,4 +3,4 @@
  • rune1: Rune

    Given Rune

  • rune2: Rune

    Given Rune

    • Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.pink.html b/documentation/functions/rune.pink.html index d061da771..a01b129d8 100644 --- a/documentation/functions/rune.pink.html +++ b/documentation/functions/rune.pink.html @@ -1,4 +1,4 @@ pink | Source Academy Modules

    Function pink

    • pink(rune): Rune

    • Colors the given rune pink (#E91E63s).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.purple.html b/documentation/functions/rune.purple.html index c6fe9e431..384bd2ce5 100644 --- a/documentation/functions/rune.purple.html +++ b/documentation/functions/rune.purple.html @@ -1,4 +1,4 @@ purple | Source Academy Modules

    Function purple

    • purple(rune): Rune

    • Colors the given rune purple (#AA00FF).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.quarter_turn_left.html b/documentation/functions/rune.quarter_turn_left.html index 975493552..03c4c30eb 100644 --- a/documentation/functions/rune.quarter_turn_left.html +++ b/documentation/functions/rune.quarter_turn_left.html @@ -3,4 +3,4 @@ anti-clockwise direction.

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.quarter_turn_right.html b/documentation/functions/rune.quarter_turn_right.html index 56945bafe..6df991990 100644 --- a/documentation/functions/rune.quarter_turn_right.html +++ b/documentation/functions/rune.quarter_turn_right.html @@ -3,4 +3,4 @@ clockwise direction.

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.random_color.html b/documentation/functions/rune.random_color.html index d1fa531ff..38bdebc94 100644 --- a/documentation/functions/rune.random_color.html +++ b/documentation/functions/rune.random_color.html @@ -3,4 +3,4 @@ colors: red, pink, purple, indigo, blue, green, yellow, orange, brown

    Parameters

    Returns Rune

    The colored Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.red.html b/documentation/functions/rune.red.html index c9c8f871e..c5ace7c3e 100644 --- a/documentation/functions/rune.red.html +++ b/documentation/functions/rune.red.html @@ -1,4 +1,4 @@ red | Source Academy Modules

    Function red

    • red(rune): Rune

    • Colors the given rune red (#F44336).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.repeat_pattern.html b/documentation/functions/rune.repeat_pattern.html index 60ff092b4..cdb141d21 100644 --- a/documentation/functions/rune.repeat_pattern.html +++ b/documentation/functions/rune.repeat_pattern.html @@ -6,4 +6,4 @@
  • Result of n times application of pattern to initial: pattern(pattern(...pattern(pattern(initial))...))
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.rotate.html b/documentation/functions/rune.rotate.html index 10c9a8887..3d30b0970 100644 --- a/documentation/functions/rune.rotate.html +++ b/documentation/functions/rune.rotate.html @@ -5,4 +5,4 @@

    Parameters

    Returns Rune

    Rotated Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.scale.html b/documentation/functions/rune.scale.html index 4df3bf8f7..4180cca72 100644 --- a/documentation/functions/rune.scale.html +++ b/documentation/functions/rune.scale.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rune

    Resulting scaled Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.scale_independent.html b/documentation/functions/rune.scale_independent.html index 9566afb49..0665cafcb 100644 --- a/documentation/functions/rune.scale_independent.html +++ b/documentation/functions/rune.scale_independent.html @@ -3,4 +3,4 @@
  • ratio_y: number

    Scaling factor in y direction

  • rune: Rune

    Given Rune

    • Returns Rune

    Resulting scaled Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.show.html b/documentation/functions/rune.show.html index 5c6444c52..5d1ff7f73 100644 --- a/documentation/functions/rune.show.html +++ b/documentation/functions/rune.show.html @@ -1,4 +1,4 @@ show | Source Academy Modules

    Function show

    • show(rune): Rune

    • Renders the specified Rune in a tab as a basic drawing.

      Parameters

      • rune: Rune

        The Rune to render

      Returns Rune

      The specified Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.stack.html b/documentation/functions/rune.stack.html index e79226e2d..75d423cc4 100644 --- a/documentation/functions/rune.stack.html +++ b/documentation/functions/rune.stack.html @@ -5,4 +5,4 @@

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.stack_frac.html b/documentation/functions/rune.stack_frac.html index 9f40740f0..1b45bff36 100644 --- a/documentation/functions/rune.stack_frac.html +++ b/documentation/functions/rune.stack_frac.html @@ -7,4 +7,4 @@
  • rune1: Rune

    Given Rune

  • rune2: Rune

    Given Rune

    • Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.stackn.html b/documentation/functions/rune.stackn.html index 4868aea1e..b95e385cb 100644 --- a/documentation/functions/rune.stackn.html +++ b/documentation/functions/rune.stackn.html @@ -3,4 +3,4 @@

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.translate.html b/documentation/functions/rune.translate.html index 879a9500e..79add0ea1 100644 --- a/documentation/functions/rune.translate.html +++ b/documentation/functions/rune.translate.html @@ -3,4 +3,4 @@
  • y: number

    Translation in y direction

  • rune: Rune

    Given Rune

    • Returns Rune

    Resulting translated Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.turn_upside_down.html b/documentation/functions/rune.turn_upside_down.html index 7c65044fc..68f320c0f 100644 --- a/documentation/functions/rune.turn_upside_down.html +++ b/documentation/functions/rune.turn_upside_down.html @@ -2,4 +2,4 @@ by turning it upside-down

    Parameters

    Returns Rune

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.white.html b/documentation/functions/rune.white.html index 72af8f5d6..b5ee387d5 100644 --- a/documentation/functions/rune.white.html +++ b/documentation/functions/rune.white.html @@ -1,4 +1,4 @@ white | Source Academy Modules

    Function white

    • white(rune): Rune

    • Colors the given rune white (#FFFFFF).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune.yellow.html b/documentation/functions/rune.yellow.html index 4024f42a7..cd78767c9 100644 --- a/documentation/functions/rune.yellow.html +++ b/documentation/functions/rune.yellow.html @@ -1,4 +1,4 @@ yellow | Source Academy Modules

    Function yellow

    • yellow(rune): Rune

    • Colors the given rune yellow (#FFEB3B).

      Parameters

      • rune: Rune

        The rune to color

      Returns Rune

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.anaglyph.html b/documentation/functions/rune_in_words.anaglyph.html index 4cbce691b..f4f1bd0c6 100644 --- a/documentation/functions/rune_in_words.anaglyph.html +++ b/documentation/functions/rune_in_words.anaglyph.html @@ -2,4 +2,4 @@ anaglyph.

    Parameters

    Returns string

    The specified Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.beside.html b/documentation/functions/rune_in_words.beside.html index f983e2ea1..8997a67ea 100644 --- a/documentation/functions/rune_in_words.beside.html +++ b/documentation/functions/rune_in_words.beside.html @@ -5,4 +5,4 @@

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.beside_frac.html b/documentation/functions/rune_in_words.beside_frac.html index b7e3dc199..6720640fa 100644 --- a/documentation/functions/rune_in_words.beside_frac.html +++ b/documentation/functions/rune_in_words.beside_frac.html @@ -7,4 +7,4 @@
  • rune1: string

    Given Rune

  • rune2: string

    Given Rune

    • Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.black.html b/documentation/functions/rune_in_words.black.html index 4950bc58c..2cc687e51 100644 --- a/documentation/functions/rune_in_words.black.html +++ b/documentation/functions/rune_in_words.black.html @@ -1,4 +1,4 @@ black | Source Academy Modules

    Function black

    • black(rune): string

    • Colors the given rune black (#000000).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.blue.html b/documentation/functions/rune_in_words.blue.html index 86cfb18bd..370b86a11 100644 --- a/documentation/functions/rune_in_words.blue.html +++ b/documentation/functions/rune_in_words.blue.html @@ -1,4 +1,4 @@ blue | Source Academy Modules

    Function blue

    • blue(rune): string

    • Colors the given rune blue (#2196F3).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.brown.html b/documentation/functions/rune_in_words.brown.html index 9ec90e538..b46e5b4f8 100644 --- a/documentation/functions/rune_in_words.brown.html +++ b/documentation/functions/rune_in_words.brown.html @@ -1,4 +1,4 @@ brown | Source Academy Modules

    Function brown

    • brown(rune): string

    • Colors the given rune brown.

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.color.html b/documentation/functions/rune_in_words.color.html index 39097b235..4ce0b2b62 100644 --- a/documentation/functions/rune_in_words.color.html +++ b/documentation/functions/rune_in_words.color.html @@ -7,4 +7,4 @@
  • g: number

    Green value [0.0-1.0]

  • b: number

    Blue value [0.0-1.0]

    • Returns string

    The colored Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.flip_horiz.html b/documentation/functions/rune_in_words.flip_horiz.html index 113ce7f19..3ab702aa0 100644 --- a/documentation/functions/rune_in_words.flip_horiz.html +++ b/documentation/functions/rune_in_words.flip_horiz.html @@ -3,4 +3,4 @@ creating a mirror image

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.flip_vert.html b/documentation/functions/rune_in_words.flip_vert.html index 87af357f3..a6d22db78 100644 --- a/documentation/functions/rune_in_words.flip_vert.html +++ b/documentation/functions/rune_in_words.flip_vert.html @@ -3,4 +3,4 @@ turning it upside down

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.from_url.html b/documentation/functions/rune_in_words.from_url.html index 5fa40472d..83c22fb39 100644 --- a/documentation/functions/rune_in_words.from_url.html +++ b/documentation/functions/rune_in_words.from_url.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    Rune created using the image.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.green.html b/documentation/functions/rune_in_words.green.html index 9683b6647..a65173488 100644 --- a/documentation/functions/rune_in_words.green.html +++ b/documentation/functions/rune_in_words.green.html @@ -1,4 +1,4 @@ green | Source Academy Modules

    Function green

    • green(rune): string

    • Colors the given rune green (#4CAF50).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.hollusion.html b/documentation/functions/rune_in_words.hollusion.html index 218ba0633..72a9e6c05 100644 --- a/documentation/functions/rune_in_words.hollusion.html +++ b/documentation/functions/rune_in_words.hollusion.html @@ -2,4 +2,4 @@ of 0.1.

    Parameters

    Returns string

    The specified Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.indigo.html b/documentation/functions/rune_in_words.indigo.html index a161f6a68..e91887d75 100644 --- a/documentation/functions/rune_in_words.indigo.html +++ b/documentation/functions/rune_in_words.indigo.html @@ -1,4 +1,4 @@ indigo | Source Academy Modules

    Function indigo

    • indigo(rune): string

    • Colors the given rune indigo (#3F51B5).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.make_cross.html b/documentation/functions/rune_in_words.make_cross.html index 02c129be5..68265080d 100644 --- a/documentation/functions/rune_in_words.make_cross.html +++ b/documentation/functions/rune_in_words.make_cross.html @@ -3,4 +3,4 @@ given Rune in different orientations

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.orange.html b/documentation/functions/rune_in_words.orange.html index ac4a41cc4..5b6d17983 100644 --- a/documentation/functions/rune_in_words.orange.html +++ b/documentation/functions/rune_in_words.orange.html @@ -1,4 +1,4 @@ orange | Source Academy Modules

    Function orange

    • orange(rune): string

    • Colors the given rune orange (#FF9800).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.overlay.html b/documentation/functions/rune_in_words.overlay.html index cc696841e..e9a146bc0 100644 --- a/documentation/functions/rune_in_words.overlay.html +++ b/documentation/functions/rune_in_words.overlay.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    Resulting Runes

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.overlay_frac.html b/documentation/functions/rune_in_words.overlay_frac.html index 65d474d28..e4e973fa5 100644 --- a/documentation/functions/rune_in_words.overlay_frac.html +++ b/documentation/functions/rune_in_words.overlay_frac.html @@ -3,4 +3,4 @@
  • rune1: string

    Given Rune

  • rune2: string

    Given Rune

    • Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.pink.html b/documentation/functions/rune_in_words.pink.html index 796a8882a..a14dcf7bf 100644 --- a/documentation/functions/rune_in_words.pink.html +++ b/documentation/functions/rune_in_words.pink.html @@ -1,4 +1,4 @@ pink | Source Academy Modules

    Function pink

    • pink(rune): string

    • Colors the given rune pink (#E91E63s).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.purple.html b/documentation/functions/rune_in_words.purple.html index 54f7d7890..e30c34898 100644 --- a/documentation/functions/rune_in_words.purple.html +++ b/documentation/functions/rune_in_words.purple.html @@ -1,4 +1,4 @@ purple | Source Academy Modules

    Function purple

    • purple(rune): string

    • Colors the given rune purple (#AA00FF).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.quarter_turn_left.html b/documentation/functions/rune_in_words.quarter_turn_left.html index d66dd3356..6a8524041 100644 --- a/documentation/functions/rune_in_words.quarter_turn_left.html +++ b/documentation/functions/rune_in_words.quarter_turn_left.html @@ -3,4 +3,4 @@ anti-clockwise direction.

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.quarter_turn_right.html b/documentation/functions/rune_in_words.quarter_turn_right.html index dc7696ff8..b3bb48933 100644 --- a/documentation/functions/rune_in_words.quarter_turn_right.html +++ b/documentation/functions/rune_in_words.quarter_turn_right.html @@ -3,4 +3,4 @@ clockwise direction.

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.random_color.html b/documentation/functions/rune_in_words.random_color.html index 342259c22..539ee6b00 100644 --- a/documentation/functions/rune_in_words.random_color.html +++ b/documentation/functions/rune_in_words.random_color.html @@ -3,4 +3,4 @@ colors: red, pink, purple, indigo, blue, green, yellow, orange, brown

    Parameters

    Returns string

    The colored Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.red.html b/documentation/functions/rune_in_words.red.html index cbdb32dfa..5a2e1778a 100644 --- a/documentation/functions/rune_in_words.red.html +++ b/documentation/functions/rune_in_words.red.html @@ -1,4 +1,4 @@ red | Source Academy Modules

    Function red

    • red(rune): string

    • Colors the given rune red (#F44336).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.repeat_pattern.html b/documentation/functions/rune_in_words.repeat_pattern.html index c333ca75a..1a2f39cf2 100644 --- a/documentation/functions/rune_in_words.repeat_pattern.html +++ b/documentation/functions/rune_in_words.repeat_pattern.html @@ -6,4 +6,4 @@
  • Result of n times application of pattern to initial: pattern(pattern(...pattern(pattern(initial))...))
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.rotate.html b/documentation/functions/rune_in_words.rotate.html index 6ea8d77a0..71bed866e 100644 --- a/documentation/functions/rune_in_words.rotate.html +++ b/documentation/functions/rune_in_words.rotate.html @@ -5,4 +5,4 @@

    Parameters

    Returns string

    Rotated Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.scale.html b/documentation/functions/rune_in_words.scale.html index fe19d6b57..ddb425841 100644 --- a/documentation/functions/rune_in_words.scale.html +++ b/documentation/functions/rune_in_words.scale.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    Resulting scaled Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.scale_independent.html b/documentation/functions/rune_in_words.scale_independent.html index b5155836a..d3f4f7ffb 100644 --- a/documentation/functions/rune_in_words.scale_independent.html +++ b/documentation/functions/rune_in_words.scale_independent.html @@ -3,4 +3,4 @@
  • ratio_y: number

    Scaling factor in y direction

  • rune: string

    Given Rune

    • Returns string

    Resulting scaled Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.show.html b/documentation/functions/rune_in_words.show.html index efb46ee76..bff212cf0 100644 --- a/documentation/functions/rune_in_words.show.html +++ b/documentation/functions/rune_in_words.show.html @@ -1,4 +1,4 @@ show | Source Academy Modules

    Function show

    • show(rune): string

    • Renders the specified Rune in a tab as a basic drawing.

      Parameters

      • rune: string

        The Rune to render

      Returns string

      The specified Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.stack.html b/documentation/functions/rune_in_words.stack.html index 7b71e1faf..adf2512de 100644 --- a/documentation/functions/rune_in_words.stack.html +++ b/documentation/functions/rune_in_words.stack.html @@ -5,4 +5,4 @@

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.stack_frac.html b/documentation/functions/rune_in_words.stack_frac.html index 90f66ac36..5a2bbb617 100644 --- a/documentation/functions/rune_in_words.stack_frac.html +++ b/documentation/functions/rune_in_words.stack_frac.html @@ -7,4 +7,4 @@
  • rune1: string

    Given Rune

  • rune2: string

    Given Rune

    • Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.stackn.html b/documentation/functions/rune_in_words.stackn.html index d4f80845b..221a9a7b3 100644 --- a/documentation/functions/rune_in_words.stackn.html +++ b/documentation/functions/rune_in_words.stackn.html @@ -3,4 +3,4 @@

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.translate.html b/documentation/functions/rune_in_words.translate.html index 17d431620..522cb6e64 100644 --- a/documentation/functions/rune_in_words.translate.html +++ b/documentation/functions/rune_in_words.translate.html @@ -3,4 +3,4 @@
  • y: number

    Translation in y direction

  • rune: string

    Given Rune

    • Returns string

    Resulting translated Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.turn_upside_down.html b/documentation/functions/rune_in_words.turn_upside_down.html index 55b4136de..64f326127 100644 --- a/documentation/functions/rune_in_words.turn_upside_down.html +++ b/documentation/functions/rune_in_words.turn_upside_down.html @@ -2,4 +2,4 @@ by turning it upside-down

    Parameters

    Returns string

    Resulting Rune

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.white.html b/documentation/functions/rune_in_words.white.html index 8473dca0d..aea7489cf 100644 --- a/documentation/functions/rune_in_words.white.html +++ b/documentation/functions/rune_in_words.white.html @@ -1,4 +1,4 @@ white | Source Academy Modules

    Function white

    • white(rune): string

    • Colors the given rune white (#FFFFFF).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/rune_in_words.yellow.html b/documentation/functions/rune_in_words.yellow.html index 0c5609cd5..52e65a689 100644 --- a/documentation/functions/rune_in_words.yellow.html +++ b/documentation/functions/rune_in_words.yellow.html @@ -1,4 +1,4 @@ yellow | Source Academy Modules

    Function yellow

    • yellow(rune): string

    • Colors the given rune yellow (#FFEB3B).

      Parameters

      • rune: string

        The rune to color

      Returns string

      The colored Rune

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.adsr.html b/documentation/functions/sound.adsr.html index 0c93e4144..9d6970ed5 100644 --- a/documentation/functions/sound.adsr.html +++ b/documentation/functions/sound.adsr.html @@ -12,4 +12,4 @@

    Returns SoundTransformer

    Envelope a function from Sound to Sound

    Example

    adsr(0.2, 0.3, 0.3, 0.1)(sound);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.bell.html b/documentation/functions/sound.bell.html index 1c254a025..cd20943ab 100644 --- a/documentation/functions/sound.bell.html +++ b/documentation/functions/sound.bell.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting bell Sound with given pitch and duration

    Example

    bell(40, 1);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.cello.html b/documentation/functions/sound.cello.html index d41372f2b..49ea9ed26 100644 --- a/documentation/functions/sound.cello.html +++ b/documentation/functions/sound.cello.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting cello Sound with given pitch and duration

    Example

    cello(36, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.consecutively.html b/documentation/functions/sound.consecutively.html index 0a56d36cb..5567cfbc8 100644 --- a/documentation/functions/sound.consecutively.html +++ b/documentation/functions/sound.consecutively.html @@ -6,4 +6,4 @@

    Returns Sound

    the combined Sound

    Example

    consecutively(list(sine_sound(200, 2), sine_sound(400, 3)));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.get_duration.html b/documentation/functions/sound.get_duration.html index 51931a3ce..03fd35be5 100644 --- a/documentation/functions/sound.get_duration.html +++ b/documentation/functions/sound.get_duration.html @@ -3,4 +3,4 @@

    Returns number

    the duration of the Sound

    Example

    get_duration(make_sound(t => Math_sin(2 * Math_PI * 440 * t), 5)); // Returns 5
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.get_wave.html b/documentation/functions/sound.get_wave.html index 1e5ad9359..157ea3046 100644 --- a/documentation/functions/sound.get_wave.html +++ b/documentation/functions/sound.get_wave.html @@ -3,4 +3,4 @@

    Returns Wave

    the wave function of the Sound

    Example

    get_wave(make_sound(t => Math_sin(2 * Math_PI * 440 * t), 5)); // Returns t => Math_sin(2 * Math_PI * 440 * t)
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.init_record.html b/documentation/functions/sound.init_record.html index 0480d8f10..945b47bc9 100644 --- a/documentation/functions/sound.init_record.html +++ b/documentation/functions/sound.init_record.html @@ -1,4 +1,4 @@ init_record | Source Academy Modules

    Function init_record

    • init_record(): string

    • Initialize recording by obtaining permission to use the default device microphone

      Returns string

      string "obtaining recording permission"

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.is_sound.html b/documentation/functions/sound.is_sound.html index ce74f2c14..e64db0392 100644 --- a/documentation/functions/sound.is_sound.html +++ b/documentation/functions/sound.is_sound.html @@ -3,4 +3,4 @@

    Returns x is Sound

    true if x is a Sound, false otherwise

    Example

    is_sound(make_sound(t => 0, 2)); // Returns true
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.letter_name_to_frequency.html b/documentation/functions/sound.letter_name_to_frequency.html index 0e7403c26..9615bb83b 100644 --- a/documentation/functions/sound.letter_name_to_frequency.html +++ b/documentation/functions/sound.letter_name_to_frequency.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    the corresponding frequency

    Example

    letter_name_to_frequency("A4"); // Returns 440
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.letter_name_to_midi_note.html b/documentation/functions/sound.letter_name_to_midi_note.html index 59ef0126c..2f35c93e6 100644 --- a/documentation/functions/sound.letter_name_to_midi_note.html +++ b/documentation/functions/sound.letter_name_to_midi_note.html @@ -6,4 +6,4 @@

    Parameters

    Returns number

    the corresponding midi note

    Example

    letter_name_to_midi_note("C4"); // Returns 60
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.make_sound.html b/documentation/functions/sound.make_sound.html index 0777d24ca..5a416997c 100644 --- a/documentation/functions/sound.make_sound.html +++ b/documentation/functions/sound.make_sound.html @@ -7,4 +7,4 @@

    Returns Sound

    with wave as wave function and duration as duration

    Example

    const s = make_sound(t => Math_sin(2 * Math_PI * 440 * t), 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.midi_note_to_frequency.html b/documentation/functions/sound.midi_note_to_frequency.html index 253fb79fc..cf0d2456a 100644 --- a/documentation/functions/sound.midi_note_to_frequency.html +++ b/documentation/functions/sound.midi_note_to_frequency.html @@ -3,4 +3,4 @@

    Returns number

    the frequency of the MIDI note

    Example

    midi_note_to_frequency(69); // Returns 440
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.noise_sound.html b/documentation/functions/sound.noise_sound.html index 29b4a9ac0..1b9660b63 100644 --- a/documentation/functions/sound.noise_sound.html +++ b/documentation/functions/sound.noise_sound.html @@ -3,4 +3,4 @@

    Returns Sound

    resulting noise Sound

    Example

    noise_sound(5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.phase_mod.html b/documentation/functions/sound.phase_mod.html index 5e6356c44..4f2cfe8b1 100644 --- a/documentation/functions/sound.phase_mod.html +++ b/documentation/functions/sound.phase_mod.html @@ -10,4 +10,4 @@

    Returns SoundTransformer

    function which takes in a Sound and returns a Sound

    Example

    phase_mod(440, 5, 1)(sine_sound(220, 5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.piano.html b/documentation/functions/sound.piano.html index f28c93bb5..f31ca7daf 100644 --- a/documentation/functions/sound.piano.html +++ b/documentation/functions/sound.piano.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting piano Sound with given pitch and duration

    Example

    piano(48, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.play.html b/documentation/functions/sound.play.html index 2fa9d9f56..ab6c23d9e 100644 --- a/documentation/functions/sound.play.html +++ b/documentation/functions/sound.play.html @@ -4,4 +4,4 @@

    Returns Sound

    the given Sound

    Example

    play(sine_sound(440, 5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.play_in_tab.html b/documentation/functions/sound.play_in_tab.html index 5bc9642ef..cdfff3362 100644 --- a/documentation/functions/sound.play_in_tab.html +++ b/documentation/functions/sound.play_in_tab.html @@ -5,4 +5,4 @@

    Returns Sound

    the given Sound

    Example

    play_in_tab(sine_sound(440, 5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.play_wave.html b/documentation/functions/sound.play_wave.html index deca0fca0..9fbbc8a95 100644 --- a/documentation/functions/sound.play_wave.html +++ b/documentation/functions/sound.play_wave.html @@ -4,4 +4,4 @@
  • duration: number

    • Returns Sound

    the resulting Sound

    Example

    play_wave(t => math_sin(t * 3000), 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.record.html b/documentation/functions/sound.record.html index 9d7062a0c..abee97f1d 100644 --- a/documentation/functions/sound.record.html +++ b/documentation/functions/sound.record.html @@ -13,4 +13,4 @@

    Returns (() => (() => Sound))

    nullary stop function; stop() stops the recording and returns a Sound promise: a nullary function that returns the recorded Sound

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.record_for.html b/documentation/functions/sound.record_for.html index 2d7d59e51..3a4e6000e 100644 --- a/documentation/functions/sound.record_for.html +++ b/documentation/functions/sound.record_for.html @@ -9,4 +9,4 @@

    Parameters

    Returns (() => Sound)

    promise: nullary function which returns recorded Sound

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.sawtooth_sound.html b/documentation/functions/sound.sawtooth_sound.html index 1d9ccdd35..45cd28213 100644 --- a/documentation/functions/sound.sawtooth_sound.html +++ b/documentation/functions/sound.sawtooth_sound.html @@ -4,4 +4,4 @@

    Returns Sound

    resulting sawtooth wave Sound

    Example

    sawtooth_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.silence_sound.html b/documentation/functions/sound.silence_sound.html index b96e1b09b..a3491fac4 100644 --- a/documentation/functions/sound.silence_sound.html +++ b/documentation/functions/sound.silence_sound.html @@ -3,4 +3,4 @@

    Returns Sound

    resulting silence Sound

    Example

    silence_sound(5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.simultaneously.html b/documentation/functions/sound.simultaneously.html index 56c48af1d..84b4c6d64 100644 --- a/documentation/functions/sound.simultaneously.html +++ b/documentation/functions/sound.simultaneously.html @@ -7,4 +7,4 @@

    Returns Sound

    the combined Sound

    Example

    simultaneously(list(sine_sound(200, 2), sine_sound(400, 3)))
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.sine_sound.html b/documentation/functions/sound.sine_sound.html index 98d607258..9c6d9d00f 100644 --- a/documentation/functions/sound.sine_sound.html +++ b/documentation/functions/sound.sine_sound.html @@ -4,4 +4,4 @@

    Returns Sound

    resulting sine wave Sound

    Example

    sine_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.square_sound.html b/documentation/functions/sound.square_sound.html index 2014a0b0b..9d39e455c 100644 --- a/documentation/functions/sound.square_sound.html +++ b/documentation/functions/sound.square_sound.html @@ -3,4 +3,4 @@

    Returns Sound

    resulting square wave Sound

    Example

    square_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.stacking_adsr.html b/documentation/functions/sound.stacking_adsr.html index c10b65a32..bf3a25eac 100644 --- a/documentation/functions/sound.stacking_adsr.html +++ b/documentation/functions/sound.stacking_adsr.html @@ -13,4 +13,4 @@

    Returns Sound

    Sound resulting Sound

    Example

    stacking_adsr(sine_sound, 300, 5, list(adsr(0.1, 0.3, 0.2, 0.5), adsr(0.2, 0.5, 0.6, 0.1), adsr(0.3, 0.1, 0.7, 0.3)));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.stop.html b/documentation/functions/sound.stop.html index ab9c18c46..0ad6660a8 100644 --- a/documentation/functions/sound.stop.html +++ b/documentation/functions/sound.stop.html @@ -1,2 +1,2 @@ stop | Source Academy Modules

    Function stop

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.triangle_sound.html b/documentation/functions/sound.triangle_sound.html index 10e846d47..d698255f6 100644 --- a/documentation/functions/sound.triangle_sound.html +++ b/documentation/functions/sound.triangle_sound.html @@ -4,4 +4,4 @@

    Returns Sound

    resulting triangle wave Sound

    Example

    triangle_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.trombone.html b/documentation/functions/sound.trombone.html index e9d378b9d..1d1dc5a1b 100644 --- a/documentation/functions/sound.trombone.html +++ b/documentation/functions/sound.trombone.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting trombone Sound with given pitch and duration

    Example

    trombone(60, 2);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound.violin.html b/documentation/functions/sound.violin.html index 8300e86b5..4fed0c510 100644 --- a/documentation/functions/sound.violin.html +++ b/documentation/functions/sound.violin.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting violin Sound with given pitch and duration

    Example

    violin(53, 4);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound_matrix.clear_all_timeout.html b/documentation/functions/sound_matrix.clear_all_timeout.html index 35503b4ec..85287302e 100644 --- a/documentation/functions/sound_matrix.clear_all_timeout.html +++ b/documentation/functions/sound_matrix.clear_all_timeout.html @@ -1 +1 @@ -clear_all_timeout | Source Academy Modules

    Function clear_all_timeout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +clear_all_timeout | Source Academy Modules

    Function clear_all_timeout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound_matrix.get_matrix.html b/documentation/functions/sound_matrix.get_matrix.html index bc4b835ab..9f5a691e6 100644 --- a/documentation/functions/sound_matrix.get_matrix.html +++ b/documentation/functions/sound_matrix.get_matrix.html @@ -1 +1 @@ -get_matrix | Source Academy Modules

    Function get_matrix

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +get_matrix | Source Academy Modules

    Function get_matrix

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/sound_matrix.set_timeout.html b/documentation/functions/sound_matrix.set_timeout.html index 23442c363..4f1f7bb79 100644 --- a/documentation/functions/sound_matrix.set_timeout.html +++ b/documentation/functions/sound_matrix.set_timeout.html @@ -1 +1 @@ -set_timeout | Source Academy Modules

    Function set_timeout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +set_timeout | Source Academy Modules

    Function set_timeout

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.adsr.html b/documentation/functions/stereo_sound.adsr.html index 6f96c8c60..bf67ef1e6 100644 --- a/documentation/functions/stereo_sound.adsr.html +++ b/documentation/functions/stereo_sound.adsr.html @@ -12,4 +12,4 @@

    Returns SoundTransformer

    Envelope a function from Sound to Sound

    Example

    adsr(0.2, 0.3, 0.3, 0.1)(sound);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.bell.html b/documentation/functions/stereo_sound.bell.html index b252d2ca8..b50a96094 100644 --- a/documentation/functions/stereo_sound.bell.html +++ b/documentation/functions/stereo_sound.bell.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting bell Sound with given pitch and duration

    Example

    bell(40, 1);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.cello.html b/documentation/functions/stereo_sound.cello.html index 3e1b182f4..29113fb0b 100644 --- a/documentation/functions/stereo_sound.cello.html +++ b/documentation/functions/stereo_sound.cello.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting cello Sound with given pitch and duration

    Example

    cello(36, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.consecutively.html b/documentation/functions/stereo_sound.consecutively.html index 616ef3393..8a5217f60 100644 --- a/documentation/functions/stereo_sound.consecutively.html +++ b/documentation/functions/stereo_sound.consecutively.html @@ -6,4 +6,4 @@

    Returns Sound

    the combined Sound

    Example

    consecutively(list(sine_sound(200, 2), sine_sound(400, 3)));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.get_duration.html b/documentation/functions/stereo_sound.get_duration.html index 36c6b3283..a51ef8f1c 100644 --- a/documentation/functions/stereo_sound.get_duration.html +++ b/documentation/functions/stereo_sound.get_duration.html @@ -3,4 +3,4 @@

    Returns number

    the duration of the Sound

    Example

    get_duration(make_sound(t => math_sin(2 * math_PI * 440 * t), 5)); // Returns 5
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.get_left_wave.html b/documentation/functions/stereo_sound.get_left_wave.html index 1a7443bb9..b389328ed 100644 --- a/documentation/functions/stereo_sound.get_left_wave.html +++ b/documentation/functions/stereo_sound.get_left_wave.html @@ -3,4 +3,4 @@

    Returns Wave

    the wave function of the Sound

    Example

    get_wave(make_sound(t => math_sin(2 * math_PI * 440 * t), 5)); // Returns t => math_sin(2 * math_PI * 440 * t)
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.get_right_wave.html b/documentation/functions/stereo_sound.get_right_wave.html index 3fb7d6603..01c5dd288 100644 --- a/documentation/functions/stereo_sound.get_right_wave.html +++ b/documentation/functions/stereo_sound.get_right_wave.html @@ -3,4 +3,4 @@

    Returns Wave

    the wave function of the Sound

    Example

    get_wave(make_sound(t => math_sin(2 * math_PI * 440 * t), 5)); // Returns t => math_sin(2 * math_PI * 440 * t)
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.init_record.html b/documentation/functions/stereo_sound.init_record.html index 64c348f76..43e28ca9e 100644 --- a/documentation/functions/stereo_sound.init_record.html +++ b/documentation/functions/stereo_sound.init_record.html @@ -1,4 +1,4 @@ init_record | Source Academy Modules

    Function init_record

    • init_record(): string

    • Initialize recording by obtaining permission to use the default device microphone

      Returns string

      string "obtaining recording permission"

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.is_sound.html b/documentation/functions/stereo_sound.is_sound.html index 3b0b31a9e..fa058cb5a 100644 --- a/documentation/functions/stereo_sound.is_sound.html +++ b/documentation/functions/stereo_sound.is_sound.html @@ -3,4 +3,4 @@

    Returns boolean

    true if x is a Sound, false otherwise

    Example

    is_sound(make_sound(t => 0, 2)); // Returns true
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.letter_name_to_frequency.html b/documentation/functions/stereo_sound.letter_name_to_frequency.html index d14937a82..457eed2aa 100644 --- a/documentation/functions/stereo_sound.letter_name_to_frequency.html +++ b/documentation/functions/stereo_sound.letter_name_to_frequency.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    the corresponding frequency

    Example

    letter_name_to_frequency("A4"); // Returns 440
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.letter_name_to_midi_note.html b/documentation/functions/stereo_sound.letter_name_to_midi_note.html index 166509f9c..3eb5159e8 100644 --- a/documentation/functions/stereo_sound.letter_name_to_midi_note.html +++ b/documentation/functions/stereo_sound.letter_name_to_midi_note.html @@ -6,4 +6,4 @@

    Parameters

    Returns number

    the corresponding midi note

    Example

    letter_name_to_midi_note("C4"); // Returns 60
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.make_sound.html b/documentation/functions/stereo_sound.make_sound.html index 9dd8a3d54..a64b28cfb 100644 --- a/documentation/functions/stereo_sound.make_sound.html +++ b/documentation/functions/stereo_sound.make_sound.html @@ -7,4 +7,4 @@

    Returns Sound

    Sound with the given wave function for both channels and duration as duration

    Example

    const s = make_sound(t => math_sin(2 * math_PI * 440 * t), 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.make_stereo_sound.html b/documentation/functions/stereo_sound.make_stereo_sound.html index 68e62dd00..aebd8db43 100644 --- a/documentation/functions/stereo_sound.make_stereo_sound.html +++ b/documentation/functions/stereo_sound.make_stereo_sound.html @@ -8,4 +8,4 @@

    Returns Sound

    resulting stereo Sound

    Example

    const s = make_stereo_sound(t => math_sin(2 * math_PI * 440 * t), t => math_sin(2 * math_PI * 300 * t), 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.midi_note_to_frequency.html b/documentation/functions/stereo_sound.midi_note_to_frequency.html index a2c93c3a4..c304477c3 100644 --- a/documentation/functions/stereo_sound.midi_note_to_frequency.html +++ b/documentation/functions/stereo_sound.midi_note_to_frequency.html @@ -3,4 +3,4 @@

    Returns number

    the frequency of the MIDI note

    Example

    midi_note_to_frequency(69); // Returns 440
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.noise_sound.html b/documentation/functions/stereo_sound.noise_sound.html index 4959e0405..846361ec8 100644 --- a/documentation/functions/stereo_sound.noise_sound.html +++ b/documentation/functions/stereo_sound.noise_sound.html @@ -3,4 +3,4 @@

    Returns Sound

    resulting noise sound

    Example

    noise_sound(5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.pan.html b/documentation/functions/stereo_sound.pan.html index 9e624d089..fe582eac7 100644 --- a/documentation/functions/stereo_sound.pan.html +++ b/documentation/functions/stereo_sound.pan.html @@ -3,4 +3,4 @@ An amount of -1 is a hard left pan, 0 is balanced, 1 is hard right pan.

    Parameters

    Returns SoundTransformer

    a Sound Transformer that pans a Sound

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.pan_mod.html b/documentation/functions/stereo_sound.pan_mod.html index 29ffe38ae..250c81c45 100644 --- a/documentation/functions/stereo_sound.pan_mod.html +++ b/documentation/functions/stereo_sound.pan_mod.html @@ -4,4 +4,4 @@ -1 is a hard left pan, 0 is balanced, 1 is hard right pan.

    Parameters

    Returns SoundTransformer

    a Sound Transformer that pans a Sound

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.phase_mod.html b/documentation/functions/stereo_sound.phase_mod.html index 1cc3e1899..e89391743 100644 --- a/documentation/functions/stereo_sound.phase_mod.html +++ b/documentation/functions/stereo_sound.phase_mod.html @@ -10,4 +10,4 @@

    Returns SoundTransformer

    function which takes in a Sound and returns a Sound

    Example

    phase_mod(440, 5, 1)(sine_sound(220, 5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.piano.html b/documentation/functions/stereo_sound.piano.html index 2aee7f6e7..2d4bce6ed 100644 --- a/documentation/functions/stereo_sound.piano.html +++ b/documentation/functions/stereo_sound.piano.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting piano Sound with given pitch and duration

    Example

    piano(48, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.play.html b/documentation/functions/stereo_sound.play.html index 0ff6ace5f..8f75ee3d7 100644 --- a/documentation/functions/stereo_sound.play.html +++ b/documentation/functions/stereo_sound.play.html @@ -4,4 +4,4 @@

    Returns Sound

    the given Sound

    Example

    play(sine_sound(440, 5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.play_in_tab.html b/documentation/functions/stereo_sound.play_in_tab.html index 8f73cfbf8..266ff97a7 100644 --- a/documentation/functions/stereo_sound.play_in_tab.html +++ b/documentation/functions/stereo_sound.play_in_tab.html @@ -5,4 +5,4 @@

    Returns Sound

    the given Sound

    Example

    play_in_tab(sine_sound(440, 5));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.play_wave.html b/documentation/functions/stereo_sound.play_wave.html index f453ff957..3147e646f 100644 --- a/documentation/functions/stereo_sound.play_wave.html +++ b/documentation/functions/stereo_sound.play_wave.html @@ -4,4 +4,4 @@
  • duration: number

    • Returns Sound

    the given Sound

    Example

    play_wave(t => math_sin(t * 3000), 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.play_waves.html b/documentation/functions/stereo_sound.play_waves.html index e4a924b11..f7945e7c3 100644 --- a/documentation/functions/stereo_sound.play_waves.html +++ b/documentation/functions/stereo_sound.play_waves.html @@ -6,4 +6,4 @@
  • duration: number

    • Returns Sound

    the given Sound

    Example

    play_waves(t => math_sin(t * 3000), t => math_sin(t * 6000), 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.record.html b/documentation/functions/stereo_sound.record.html index aa49c81f8..f537940e4 100644 --- a/documentation/functions/stereo_sound.record.html +++ b/documentation/functions/stereo_sound.record.html @@ -13,4 +13,4 @@

    Returns (() => (() => Sound))

    nullary stop function; stop() stops the recording and returns a sound promise: a nullary function that returns the recorded Sound

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.record_for.html b/documentation/functions/stereo_sound.record_for.html index ee4a73add..7c8de8874 100644 --- a/documentation/functions/stereo_sound.record_for.html +++ b/documentation/functions/stereo_sound.record_for.html @@ -9,4 +9,4 @@

    Parameters

    Returns (() => Sound)

    promise: nullary function which returns the recorded sound

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.sawtooth_sound.html b/documentation/functions/stereo_sound.sawtooth_sound.html index fbb71b8ee..9c30822bf 100644 --- a/documentation/functions/stereo_sound.sawtooth_sound.html +++ b/documentation/functions/stereo_sound.sawtooth_sound.html @@ -4,4 +4,4 @@

    Returns Sound

    resulting sawtooth wave sound

    Example

    sawtooth_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.silence_sound.html b/documentation/functions/stereo_sound.silence_sound.html index 06c15095d..b60aa14a4 100644 --- a/documentation/functions/stereo_sound.silence_sound.html +++ b/documentation/functions/stereo_sound.silence_sound.html @@ -3,4 +3,4 @@

    Returns Sound

    resulting silence sound

    Example

    silence_sound(5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.simultaneously.html b/documentation/functions/stereo_sound.simultaneously.html index 6f1039a89..30e4f6fd8 100644 --- a/documentation/functions/stereo_sound.simultaneously.html +++ b/documentation/functions/stereo_sound.simultaneously.html @@ -7,4 +7,4 @@

    Returns Sound

    the combined Sound

    Example

    simultaneously(list(sine_sound(200, 2), sine_sound(400, 3)))
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.sine_sound.html b/documentation/functions/stereo_sound.sine_sound.html index 102fbd483..1ed533064 100644 --- a/documentation/functions/stereo_sound.sine_sound.html +++ b/documentation/functions/stereo_sound.sine_sound.html @@ -4,4 +4,4 @@

    Returns Sound

    resulting sine wave sound

    Example

    sine_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.square_sound.html b/documentation/functions/stereo_sound.square_sound.html index 29a934245..845eb7e4b 100644 --- a/documentation/functions/stereo_sound.square_sound.html +++ b/documentation/functions/stereo_sound.square_sound.html @@ -3,4 +3,4 @@

    Returns Sound

    resulting square wave sound

    Example

    square_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.squash.html b/documentation/functions/stereo_sound.squash.html index 8bf8dfac3..1fad4ef02 100644 --- a/documentation/functions/stereo_sound.squash.html +++ b/documentation/functions/stereo_sound.squash.html @@ -2,4 +2,4 @@ resulting in an effectively mono sound.

    Parameters

    Returns Sound

    a new sound with the left and right channels averaged

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.stacking_adsr.html b/documentation/functions/stereo_sound.stacking_adsr.html index ec7c6fbb4..0b48c50e8 100644 --- a/documentation/functions/stereo_sound.stacking_adsr.html +++ b/documentation/functions/stereo_sound.stacking_adsr.html @@ -13,4 +13,4 @@

    Returns Sound

    Sound resulting Sound

    Example

    stacking_adsr(sine_sound, 300, 5, list(adsr(0.1, 0.3, 0.2, 0.5), adsr(0.2, 0.5, 0.6, 0.1), adsr(0.3, 0.1, 0.7, 0.3)));
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.stop.html b/documentation/functions/stereo_sound.stop.html index d61da183d..bd63959e3 100644 --- a/documentation/functions/stereo_sound.stop.html +++ b/documentation/functions/stereo_sound.stop.html @@ -1,2 +1,2 @@ stop | Source Academy Modules

    Function stop

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.triangle_sound.html b/documentation/functions/stereo_sound.triangle_sound.html index 184c05a40..83d9244db 100644 --- a/documentation/functions/stereo_sound.triangle_sound.html +++ b/documentation/functions/stereo_sound.triangle_sound.html @@ -4,4 +4,4 @@

    Returns Sound

    resulting triangle wave sound

    Example

    triangle_sound(440, 5);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.trombone.html b/documentation/functions/stereo_sound.trombone.html index a75dfd52d..6979183ba 100644 --- a/documentation/functions/stereo_sound.trombone.html +++ b/documentation/functions/stereo_sound.trombone.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting trombone Sound with given pitch and duration

    Example

    trombone(60, 2);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/stereo_sound.violin.html b/documentation/functions/stereo_sound.violin.html index 43df146b3..1d7170f33 100644 --- a/documentation/functions/stereo_sound.violin.html +++ b/documentation/functions/stereo_sound.violin.html @@ -5,4 +5,4 @@

    Returns Sound

    Sound resulting violin Sound with given pitch and duration

    Example

    violin(53, 4);
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.add_impulse_force.html b/documentation/functions/unity_academy.add_impulse_force.html index 52e832387..7dc4a5f15 100644 --- a/documentation/functions/unity_academy.add_impulse_force.html +++ b/documentation/functions/unity_academy.add_impulse_force.html @@ -1,4 +1,4 @@ add_impulse_force | Source Academy Modules

    Function add_impulse_force

    • add_impulse_force(gameObjectIdentifier, force): void

    • Add an impulse force on the Rigidbody attached on the GameObject, using its mass.

      Usage of all physics functions under the Physics category requires calling apply_rigidbody first on the applied game objects.

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to add the force.

        -
      • force: Vector3

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • force: Vector3

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.add_vectors.html b/documentation/functions/unity_academy.add_vectors.html index 1ffe149de..14155596d 100644 --- a/documentation/functions/unity_academy.add_vectors.html +++ b/documentation/functions/unity_academy.add_vectors.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector3

    The sum of the two vectors

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.apply_rigidbody.html b/documentation/functions/unity_academy.apply_rigidbody.html index e791619f3..f01242a37 100644 --- a/documentation/functions/unity_academy.apply_rigidbody.html +++ b/documentation/functions/unity_academy.apply_rigidbody.html @@ -6,4 +6,4 @@
  • https://docs.unity3d.com/ScriptReference/Rigidbody2D.html (For 2D Mode)

    • Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.copy_position.html b/documentation/functions/unity_academy.copy_position.html index 5b062631b..45d04f1b8 100644 --- a/documentation/functions/unity_academy.copy_position.html +++ b/documentation/functions/unity_academy.copy_position.html @@ -3,4 +3,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.copy_rotation.html b/documentation/functions/unity_academy.copy_rotation.html index 30cac0f9d..e998f9260 100644 --- a/documentation/functions/unity_academy.copy_rotation.html +++ b/documentation/functions/unity_academy.copy_rotation.html @@ -3,4 +3,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.copy_scale.html b/documentation/functions/unity_academy.copy_scale.html index 30c7c6811..5c3476aa2 100644 --- a/documentation/functions/unity_academy.copy_scale.html +++ b/documentation/functions/unity_academy.copy_scale.html @@ -3,4 +3,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.cross.html b/documentation/functions/unity_academy.cross.html index 4b896ff82..7de85383d 100644 --- a/documentation/functions/unity_academy.cross.html +++ b/documentation/functions/unity_academy.cross.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector3

    The cross product

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.debug_log.html b/documentation/functions/unity_academy.debug_log.html index 54d516671..f386e0e67 100644 --- a/documentation/functions/unity_academy.debug_log.html +++ b/documentation/functions/unity_academy.debug_log.html @@ -1,4 +1,4 @@ debug_log | Source Academy Modules

    Function debug_log

    • debug_log(content): void

    • Log to Unity Academy Embedded Frontend's console.

      You can use rich text for the parameter content.

      Parameters

      • content: any

        The content of the log message.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.debug_logerror.html b/documentation/functions/unity_academy.debug_logerror.html index 2f8d5c2a2..3f7733b2f 100644 --- a/documentation/functions/unity_academy.debug_logerror.html +++ b/documentation/functions/unity_academy.debug_logerror.html @@ -2,4 +2,4 @@

    Note that this function does not "really" throw any error. It just logs a message with red font color and the student code will continue running normally after calling this function to log the error.

    You can use rich text for the parameter content.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.debug_logwarning.html b/documentation/functions/unity_academy.debug_logwarning.html index 2fd8d31f5..f72b19008 100644 --- a/documentation/functions/unity_academy.debug_logwarning.html +++ b/documentation/functions/unity_academy.debug_logwarning.html @@ -1,4 +1,4 @@ debug_logwarning | Source Academy Modules

    Function debug_logwarning

    • debug_logwarning(content): void

    • Log to Unity Academy Embedded Frontend's console, with yellow font color as highlighting.

      You can use rich text for the parameter content.

      Parameters

      • content: any

        The content of the log message.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.delta_time.html b/documentation/functions/unity_academy.delta_time.html index d3361ad7d..1d87e12b7 100644 --- a/documentation/functions/unity_academy.delta_time.html +++ b/documentation/functions/unity_academy.delta_time.html @@ -6,4 +6,4 @@

    By assigning the above code to a GameObject with set_update, that GameObject will move in a constant speed for about 3 units per second along world +Z axis.

    For more information, see https://docs.unity3d.com/ScriptReference/Time-deltaTime.html

    Returns number

    the delta time value in decimal

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.destroy.html b/documentation/functions/unity_academy.destroy.html index b9945cf3f..9e8700f0a 100644 --- a/documentation/functions/unity_academy.destroy.html +++ b/documentation/functions/unity_academy.destroy.html @@ -2,4 +2,4 @@

    Note that this won't remove the GameObject immediately, the actual removal will happen at the end of the current main cycle loop.

    For more information, see https://docs.unity3d.com/ScriptReference/Object.Destroy.html

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.dot.html b/documentation/functions/unity_academy.dot.html index 1dc492a34..a5cff2fc7 100644 --- a/documentation/functions/unity_academy.dot.html +++ b/documentation/functions/unity_academy.dot.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    The dot product

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.gameobject_distance.html b/documentation/functions/unity_academy.gameobject_distance.html index 7c3855d01..4095f37b1 100644 --- a/documentation/functions/unity_academy.gameobject_distance.html +++ b/documentation/functions/unity_academy.gameobject_distance.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    The value of the distance between these two GameObjects

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_angular_velocity.html b/documentation/functions/unity_academy.get_angular_velocity.html index b4a73e0ea..eac37df02 100644 --- a/documentation/functions/unity_academy.get_angular_velocity.html +++ b/documentation/functions/unity_academy.get_angular_velocity.html @@ -3,4 +3,4 @@

    **2D Mode Special: **In 2D mode there is no angular velocity on X nor Y axis, so in the X and Y values in the returned Vector3 will always be zero.

    Parameters

    Returns Vector3

    the angular velocity at this moment represented in a Vector3.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_custom_prop.html b/documentation/functions/unity_academy.get_custom_prop.html index 67e0278c7..65b3facff 100644 --- a/documentation/functions/unity_academy.get_custom_prop.html +++ b/documentation/functions/unity_academy.get_custom_prop.html @@ -2,4 +2,4 @@

    Parameters

    Returns any

    The value of the custom property with the given name on the given GameObject. If the property value is not set, this function will return undefined.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_key.html b/documentation/functions/unity_academy.get_key.html index e24d6815f..4df2f8973 100644 --- a/documentation/functions/unity_academy.get_key.html +++ b/documentation/functions/unity_academy.get_key.html @@ -2,4 +2,4 @@

    For more information, see https://docs.unity3d.com/ScriptReference/Input.GetKey.html

    Parameters

    Returns boolean

    A boolean value equivalent to Input.GetKey(keyCode) in Unity.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_key_down.html b/documentation/functions/unity_academy.get_key_down.html index 3eaee8ca7..6029d86dc 100644 --- a/documentation/functions/unity_academy.get_key_down.html +++ b/documentation/functions/unity_academy.get_key_down.html @@ -2,4 +2,4 @@

    For more information, see https://docs.unity3d.com/ScriptReference/Input.GetKeyDown.html

    Parameters

    Returns boolean

    A boolean value equivalent to Input.GetKeyDown(keyCode) in Unity.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_key_up.html b/documentation/functions/unity_academy.get_key_up.html index 752442c81..f319f9ad1 100644 --- a/documentation/functions/unity_academy.get_key_up.html +++ b/documentation/functions/unity_academy.get_key_up.html @@ -2,4 +2,4 @@

    For more information, see https://docs.unity3d.com/ScriptReference/Input.GetKeyUp.html

    Parameters

    Returns boolean

    A boolean value equivalent to Input.GetKeyUp(keyCode) in Unity.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_main_camera_following_target.html b/documentation/functions/unity_academy.get_main_camera_following_target.html index f8d38b593..fee0489b6 100644 --- a/documentation/functions/unity_academy.get_main_camera_following_target.html +++ b/documentation/functions/unity_academy.get_main_camera_following_target.html @@ -6,4 +6,4 @@

    The main camera following target GameObject is a primitive GameObject. This means that you are not allowed to destroy it and/or instantiate it during runtime. Multiple calls to this function will return GameObject identifiers that refer to the same primitive GameObject.

    If default main camera controllers are disabled (you have called request_for_main_camera_control), then the following target GameObject is useless.

    Returns GameObjectIdentifier

    The GameObject idenfitier for the main camera following target GameObject.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_mass.html b/documentation/functions/unity_academy.get_mass.html index c3f812056..f5dbba979 100644 --- a/documentation/functions/unity_academy.get_mass.html +++ b/documentation/functions/unity_academy.get_mass.html @@ -2,4 +2,4 @@

    Usage of all physics functions under the Physics - Rigidbody category requires calling apply_rigidbody first on the applied game objects.

    Parameters

    Returns number

    The mass of the rigidbody attached on the GameObject

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_position.html b/documentation/functions/unity_academy.get_position.html index 38da7d65d..eae441b78 100644 --- a/documentation/functions/unity_academy.get_position.html +++ b/documentation/functions/unity_academy.get_position.html @@ -1,4 +1,4 @@ get_position | Source Academy Modules

    Function get_position

    • get_position(gameObjectIdentifier): Vector3

    • Returns the world position of a given GameObject

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to get position for.

      Returns Vector3

      The position represented in a Vector3.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_rotation_euler.html b/documentation/functions/unity_academy.get_rotation_euler.html index 568eea81b..794e63afe 100644 --- a/documentation/functions/unity_academy.get_rotation_euler.html +++ b/documentation/functions/unity_academy.get_rotation_euler.html @@ -1,4 +1,4 @@ get_rotation_euler | Source Academy Modules

    Function get_rotation_euler

    • get_rotation_euler(gameObjectIdentifier): Vector3

    • Returns the world Euler angle rotation of a given GameObject

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to get rotation for.

      Returns Vector3

      The Euler angle rotation represented in a Vector3.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_scale.html b/documentation/functions/unity_academy.get_scale.html index 73eb4b904..05e0f190f 100644 --- a/documentation/functions/unity_academy.get_scale.html +++ b/documentation/functions/unity_academy.get_scale.html @@ -2,4 +2,4 @@

    By default the scale of a GameObject is (1, 1, 1)

    Parameters

    Returns Vector3

    The scale represented in a Vector3.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_velocity.html b/documentation/functions/unity_academy.get_velocity.html index 80771b9c0..d071e90c0 100644 --- a/documentation/functions/unity_academy.get_velocity.html +++ b/documentation/functions/unity_academy.get_velocity.html @@ -2,4 +2,4 @@

    Usage of all physics functions under the Physics - Rigidbody category requires calling apply_rigidbody first on the applied game objects.

    Parameters

    Returns Vector3

    the velocity at this moment represented in a Vector3.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_x.html b/documentation/functions/unity_academy.get_x.html index eab067919..0cea3852b 100644 --- a/documentation/functions/unity_academy.get_x.html +++ b/documentation/functions/unity_academy.get_x.html @@ -1,4 +1,4 @@ get_x | Source Academy Modules

    Function get_x

    • get_x(vector): number

    • Get the X component of a 3D vector

      Parameters

      • vector: Vector3

        The 3D vector

      Returns number

      The X component of the given vector

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_y.html b/documentation/functions/unity_academy.get_y.html index a33542ac8..adf374f88 100644 --- a/documentation/functions/unity_academy.get_y.html +++ b/documentation/functions/unity_academy.get_y.html @@ -1,4 +1,4 @@ get_y | Source Academy Modules

    Function get_y

    • get_y(vector): number

    • Get the Y component of a 3D vector

      Parameters

      • vector: Vector3

        The 3D vector

      Returns number

      The Y component of the given vector

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.get_z.html b/documentation/functions/unity_academy.get_z.html index e1719301d..12e20a386 100644 --- a/documentation/functions/unity_academy.get_z.html +++ b/documentation/functions/unity_academy.get_z.html @@ -1,4 +1,4 @@ get_z | Source Academy Modules

    Function get_z

    • get_z(vector): number

    • Get the Z component of a 3D vector

      Parameters

      • vector: Vector3

        The 3D vector

      Returns number

      The Z component of the given vector

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.gui_button.html b/documentation/functions/unity_academy.gui_button.html index ae4b99989..c753b5b8c 100644 --- a/documentation/functions/unity_academy.gui_button.html +++ b/documentation/functions/unity_academy.gui_button.html @@ -14,4 +14,4 @@
  • width: number

    The width for the button.

  • height: number

    The height for the button.

  • onClick: Function

    The function that will be called when user clicks the button on screen.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.gui_label.html b/documentation/functions/unity_academy.gui_label.html index 5424344ab..66a656c0c 100644 --- a/documentation/functions/unity_academy.gui_label.html +++ b/documentation/functions/unity_academy.gui_label.html @@ -5,4 +5,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.init_unity_academy_2d.html b/documentation/functions/unity_academy.init_unity_academy_2d.html index 2c3608e6b..a61c5c583 100644 --- a/documentation/functions/unity_academy.init_unity_academy_2d.html +++ b/documentation/functions/unity_academy.init_unity_academy_2d.html @@ -1,3 +1,3 @@ init_unity_academy_2d | Source Academy Modules

    Function init_unity_academy_2d

    • init_unity_academy_2d(): void

    • Load and initialize Unity Academy WebGL player and set it to 2D mode. All other functions (except Maths functions) in this module requires calling this function or init_unity_academy_3d first.

      I recommand you just call this function at the beginning of your Source Unity program under the 'import' statements.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.init_unity_academy_3d.html b/documentation/functions/unity_academy.init_unity_academy_3d.html index e3b93c884..3eee07903 100644 --- a/documentation/functions/unity_academy.init_unity_academy_3d.html +++ b/documentation/functions/unity_academy.init_unity_academy_3d.html @@ -1,3 +1,3 @@ init_unity_academy_3d | Source Academy Modules

    Function init_unity_academy_3d

    • init_unity_academy_3d(): void

    • Load and initialize Unity Academy WebGL player and set it to 3D mode. All other functions (except Maths functions) in this module requires calling this function or init_unity_academy_2d first.

      I recommand you just call this function at the beginning of your Source Unity program under the 'import' statements.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.instantiate.html b/documentation/functions/unity_academy.instantiate.html index cfb81ac20..c79ddb9ff 100644 --- a/documentation/functions/unity_academy.instantiate.html +++ b/documentation/functions/unity_academy.instantiate.html @@ -4,4 +4,4 @@

    Available Prefab Information: Click Here

    Parameters

    Returns GameObjectIdentifier

    the identifier of the newly created GameObject

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.instantiate_empty.html b/documentation/functions/unity_academy.instantiate_empty.html index 3777a3c10..a58c3f55f 100644 --- a/documentation/functions/unity_academy.instantiate_empty.html +++ b/documentation/functions/unity_academy.instantiate_empty.html @@ -2,4 +2,4 @@

    An empty GameObject is invisible and only have transform properties by default.

    You may use the empty GameObject to run some general game management code or use the position of the empty GameObject to represent a point in the scene that the rest of your codes can access and utilize.

    Returns GameObjectIdentifier

    the identifier of the newly created GameObject

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.instantiate_sprite.html b/documentation/functions/unity_academy.instantiate_sprite.html index 06d1edbc7..a350e151b 100644 --- a/documentation/functions/unity_academy.instantiate_sprite.html +++ b/documentation/functions/unity_academy.instantiate_sprite.html @@ -4,4 +4,4 @@

    2D mode only

    Parameters

    Returns GameObjectIdentifier

    the identifier of the newly created GameObject

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.look_at.html b/documentation/functions/unity_academy.look_at.html index b49dc8118..49d24b39e 100644 --- a/documentation/functions/unity_academy.look_at.html +++ b/documentation/functions/unity_academy.look_at.html @@ -3,4 +3,4 @@

    For more information, see https://docs.unity3d.com/ScriptReference/Transform.LookAt.html

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.magnitude.html b/documentation/functions/unity_academy.magnitude.html index 87a909945..f3794fd6b 100644 --- a/documentation/functions/unity_academy.magnitude.html +++ b/documentation/functions/unity_academy.magnitude.html @@ -1,4 +1,4 @@ magnitude | Source Academy Modules

    Function magnitude

    • magnitude(vector): number

    • Calcuate the magnitude of a vector

      Parameters

      • vector: Vector3

        The vector

      Returns number

      The magnitude of the vector

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.normalize.html b/documentation/functions/unity_academy.normalize.html index 297ac3008..f623d6997 100644 --- a/documentation/functions/unity_academy.normalize.html +++ b/documentation/functions/unity_academy.normalize.html @@ -1,4 +1,4 @@ normalize | Source Academy Modules

    Function normalize

    • normalize(vector): Vector3

    • Normalize a vector. The returned vector will have the same direction as the original vector but have a magnitude of 1.

      Parameters

      • vector: Vector3

        The original vector

      Returns Vector3

      The normalized vector. This function will return a zero vector if the original vector is a zero vector.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.on_collision_enter.html b/documentation/functions/unity_academy.on_collision_enter.html index 94301ac14..ef6cf0a60 100644 --- a/documentation/functions/unity_academy.on_collision_enter.html +++ b/documentation/functions/unity_academy.on_collision_enter.html @@ -15,4 +15,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.on_collision_exit.html b/documentation/functions/unity_academy.on_collision_exit.html index 9c580b819..f0688b16a 100644 --- a/documentation/functions/unity_academy.on_collision_exit.html +++ b/documentation/functions/unity_academy.on_collision_exit.html @@ -15,4 +15,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.on_collision_stay.html b/documentation/functions/unity_academy.on_collision_stay.html index d34f95c07..6f82e5d29 100644 --- a/documentation/functions/unity_academy.on_collision_stay.html +++ b/documentation/functions/unity_academy.on_collision_stay.html @@ -15,4 +15,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.play_animator_state.html b/documentation/functions/unity_academy.play_animator_state.html index 2842e660d..8751f884f 100644 --- a/documentation/functions/unity_academy.play_animator_state.html +++ b/documentation/functions/unity_academy.play_animator_state.html @@ -3,4 +3,4 @@

    3D mode only

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.point_distance.html b/documentation/functions/unity_academy.point_distance.html index 2d49be04f..9159a4ced 100644 --- a/documentation/functions/unity_academy.point_distance.html +++ b/documentation/functions/unity_academy.point_distance.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    The value of the distance between the two points

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.remove_collider_components.html b/documentation/functions/unity_academy.remove_collider_components.html index 2404b22ef..75142df70 100644 --- a/documentation/functions/unity_academy.remove_collider_components.html +++ b/documentation/functions/unity_academy.remove_collider_components.html @@ -2,4 +2,4 @@

    You can use this function on GameObjects those you don't want them to collide with other GameObjects.

    For example, you may use this on the background image sprite GameObject in 2D scene.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.request_for_main_camera_control.html b/documentation/functions/unity_academy.request_for_main_camera_control.html index 0d5b1e5d6..09fb02337 100644 --- a/documentation/functions/unity_academy.request_for_main_camera_control.html +++ b/documentation/functions/unity_academy.request_for_main_camera_control.html @@ -2,4 +2,4 @@

    When you request for the direct control over main camera with this function, the default camera controllers will be disabled, thus the GameObject identifier returned by get_main_camera_following_target will become useless, as you can no longer use the default main camera controllers.

    This function is for totally customizing the position and rotation of the main camera. If you'd like to simplify the camera controlling with the help of the default camera controllers in Unity Academy, please consider use get_main_camera_following_target function.

    Returns GameObjectIdentifier

    The GameObject identifier that can directly be used to control the main camera's position and rotation

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.rotate_world.html b/documentation/functions/unity_academy.rotate_world.html index eca5cf537..de9668bc2 100644 --- a/documentation/functions/unity_academy.rotate_world.html +++ b/documentation/functions/unity_academy.rotate_world.html @@ -1,4 +1,4 @@ rotate_world | Source Academy Modules

    Function rotate_world

    • rotate_world(gameObjectIdentifier, angles): void

    • Rotates a GameObject with given x, y and z values (Euler angle)

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to rotate.

      • angles: Vector3

        The values you want to rotate along each axis with respect to the world space

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.same_gameobject.html b/documentation/functions/unity_academy.same_gameobject.html index 6a5ce6db1..5ae28e40b 100644 --- a/documentation/functions/unity_academy.same_gameobject.html +++ b/documentation/functions/unity_academy.same_gameobject.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    Returns true if the two GameObject identifiers refers to the same GameObject and false otherwise.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.scale_vector.html b/documentation/functions/unity_academy.scale_vector.html index 9b86c6962..1f95c9acb 100644 --- a/documentation/functions/unity_academy.scale_vector.html +++ b/documentation/functions/unity_academy.scale_vector.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector3

    The scaled vector

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_angular_drag.html b/documentation/functions/unity_academy.set_angular_drag.html index 87efa5288..14ee269df 100644 --- a/documentation/functions/unity_academy.set_angular_drag.html +++ b/documentation/functions/unity_academy.set_angular_drag.html @@ -3,4 +3,4 @@

    Usage of all physics functions under the Physics - Rigidbody category requires calling apply_rigidbody first on the applied game objects.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_angular_velocity.html b/documentation/functions/unity_academy.set_angular_velocity.html index 2daef4c37..94ec920c7 100644 --- a/documentation/functions/unity_academy.set_angular_velocity.html +++ b/documentation/functions/unity_academy.set_angular_velocity.html @@ -3,4 +3,4 @@

    **2D Mode Special: **In 2D mode there is no angular velocity on X nor Y axis, so the X and Y values in the Vector3 is ignored.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_custom_prop.html b/documentation/functions/unity_academy.set_custom_prop.html index 96ad26ff5..d1601c770 100644 --- a/documentation/functions/unity_academy.set_custom_prop.html +++ b/documentation/functions/unity_academy.set_custom_prop.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_drag.html b/documentation/functions/unity_academy.set_drag.html index 10687596e..2e02eb764 100644 --- a/documentation/functions/unity_academy.set_drag.html +++ b/documentation/functions/unity_academy.set_drag.html @@ -3,4 +3,4 @@

    Usage of all physics functions under the Physics - Rigidbody category requires calling apply_rigidbody first on the applied game objects.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_mass.html b/documentation/functions/unity_academy.set_mass.html index 0de7525b5..4eb3e4495 100644 --- a/documentation/functions/unity_academy.set_mass.html +++ b/documentation/functions/unity_academy.set_mass.html @@ -2,4 +2,4 @@

    Usage of all physics functions under the Physics - Rigidbody category requires calling apply_rigidbody first on the applied game objects.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_position.html b/documentation/functions/unity_academy.set_position.html index 89d06ff26..1e9e01282 100644 --- a/documentation/functions/unity_academy.set_position.html +++ b/documentation/functions/unity_academy.set_position.html @@ -1,4 +1,4 @@ set_position | Source Academy Modules

    Function set_position

    • set_position(gameObjectIdentifier, position): void

    • Set the world position of a given GameObject

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to change position for.

      • position: Vector3

        The new position for the GameObject.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_rotation_euler.html b/documentation/functions/unity_academy.set_rotation_euler.html index 333bfa0cf..7675101da 100644 --- a/documentation/functions/unity_academy.set_rotation_euler.html +++ b/documentation/functions/unity_academy.set_rotation_euler.html @@ -1,4 +1,4 @@ set_rotation_euler | Source Academy Modules

    Function set_rotation_euler

    • set_rotation_euler(gameObjectIdentifier, rotation): void

    • Set the world rotation of a given GameObject with given Euler angle rotation.

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to change rotation for.

      • rotation: Vector3

        The new rotation (in Euler angles) for the GameObject.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_scale.html b/documentation/functions/unity_academy.set_scale.html index dcdcf1a0e..be717a5b8 100644 --- a/documentation/functions/unity_academy.set_scale.html +++ b/documentation/functions/unity_academy.set_scale.html @@ -1,4 +1,4 @@ set_scale | Source Academy Modules

    Function set_scale

    • set_scale(gameObjectIdentifier, scale): void

    • Set the scale (size) of a given GameObject

      By default the scale of a GameObject is (1, 1, 1). Changing the scale of a GameObject along one axis will lead to a stretch or squeeze of the GameObject along that axis.

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to change scale for.

        -
      • scale: Vector3

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • scale: Vector3

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_start.html b/documentation/functions/unity_academy.set_start.html index a47d3f4b6..15cc4582d 100644 --- a/documentation/functions/unity_academy.set_start.html +++ b/documentation/functions/unity_academy.set_start.html @@ -1,4 +1,4 @@ set_start | Source Academy Modules

    Function set_start

    • set_start(gameObjectIdentifier, startFunction): void

    • Sets the Start function of a given GameObject

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to bind the Start function on.

      • startFunction: Function

        The Start function you want to assign to this GameObject. The Start function should contain one parameter, that Unity will pass the owner GameObject's identifier to this parameter.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_update.html b/documentation/functions/unity_academy.set_update.html index 64ac0c443..29d3604a2 100644 --- a/documentation/functions/unity_academy.set_update.html +++ b/documentation/functions/unity_academy.set_update.html @@ -1,4 +1,4 @@ set_update | Source Academy Modules

    Function set_update

    • set_update(gameObjectIdentifier, updateFunction): void

    • Sets the Update function of a given GameObject

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to bind the Update function on.

      • updateFunction: Function

        The Update function you want to assign to this GameObject. The Update function should contain one parameter, that Unity will pass the owner GameObject's identifier to this parameter.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_use_gravity.html b/documentation/functions/unity_academy.set_use_gravity.html index b9b6cb216..5ddebd741 100644 --- a/documentation/functions/unity_academy.set_use_gravity.html +++ b/documentation/functions/unity_academy.set_use_gravity.html @@ -1,4 +1,4 @@ set_use_gravity | Source Academy Modules

    Function set_use_gravity

    • set_use_gravity(gameObjectIdentifier, useGravity): void

    • Set whether the rigidbody attached on the game object should calculate for gravity.

      Usage of all physics functions under the Physics - Rigidbody category requires calling apply_rigidbody first on the applied game objects.

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to enable/disable gravity on its rigidbody.

        -
      • useGravity: boolean

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • useGravity: boolean

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.set_velocity.html b/documentation/functions/unity_academy.set_velocity.html index 7fc535e5f..12dd5f977 100644 --- a/documentation/functions/unity_academy.set_velocity.html +++ b/documentation/functions/unity_academy.set_velocity.html @@ -2,4 +2,4 @@

    Usage of all physics functions under the Physics - Rigidbody category requires calling apply_rigidbody first on the applied game objects.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.translate_local.html b/documentation/functions/unity_academy.translate_local.html index 1bdd06b03..4f5ec1be4 100644 --- a/documentation/functions/unity_academy.translate_local.html +++ b/documentation/functions/unity_academy.translate_local.html @@ -3,4 +3,4 @@

    In Unity, usually, the direction of +Z axis denotes forward.

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.translate_world.html b/documentation/functions/unity_academy.translate_world.html index 30ebb2415..7bff8fa10 100644 --- a/documentation/functions/unity_academy.translate_world.html +++ b/documentation/functions/unity_academy.translate_world.html @@ -1,4 +1,4 @@ translate_world | Source Academy Modules

    Function translate_world

    • translate_world(gameObjectIdentifier, deltaPosition): void

    • Moves a GameObject with given x, y and z values

      Parameters

      • gameObjectIdentifier: GameObjectIdentifier

        The identifier for the GameObject that you want to translate.

      • deltaPosition: Vector3

        The values you want to move the GameObject along each axis with respect to the world space.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.vector3.html b/documentation/functions/unity_academy.vector3.html index 9496315db..a6739e3af 100644 --- a/documentation/functions/unity_academy.vector3.html +++ b/documentation/functions/unity_academy.vector3.html @@ -3,4 +3,4 @@
  • y: number

    The y component of the new vector

  • z: number

    The z component of the new vector

    • Returns Vector3

    The 3D vector (x, y, z)

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.vector_difference.html b/documentation/functions/unity_academy.vector_difference.html index 2f51fa35c..1fcc33c6b 100644 --- a/documentation/functions/unity_academy.vector_difference.html +++ b/documentation/functions/unity_academy.vector_difference.html @@ -2,4 +2,4 @@

    Parameters

    Returns Vector3

    The result for vectorA - vectorB

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/unity_academy.zero_vector.html b/documentation/functions/unity_academy.zero_vector.html index 20fc9055d..c659e651f 100644 --- a/documentation/functions/unity_academy.zero_vector.html +++ b/documentation/functions/unity_academy.zero_vector.html @@ -1,3 +1,3 @@ zero_vector | Source Academy Modules

    Function zero_vector

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/wasm.wcompile.html b/documentation/functions/wasm.wcompile.html index dc0ace933..792f81266 100644 --- a/documentation/functions/wasm.wcompile.html +++ b/documentation/functions/wasm.wcompile.html @@ -1,4 +1,4 @@ wcompile | Source Academy Modules

    Function wcompile

    • wcompile(program): number[]

    • Compile a (hopefully valid) WebAssembly Text module to binary.

      Parameters

      • program: string

        program to compile

      Returns number[]

      an array of 8-bit unsigned integers.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/functions/wasm.wrun.html b/documentation/functions/wasm.wrun.html index 6ae85f48f..1bb7b1e6e 100644 --- a/documentation/functions/wasm.wrun.html +++ b/documentation/functions/wasm.wrun.html @@ -1,4 +1,4 @@ wrun | Source Academy Modules

    Function wrun

    • wrun(buffer): AlternatingLinkedList<string, ExportValue>

    • Run a compiled WebAssembly Binary Buffer.

      Parameters

      • buffer: number[] | Uint8Array

        an array of 8-bit unsigned integers to run

      Returns AlternatingLinkedList<string, ExportValue>

      a linked list of exports that the relevant WebAssembly Module exports

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/modules/ar.html b/documentation/modules/ar.html index 11a274734..1868b0f9b 100644 --- a/documentation/modules/ar.html +++ b/documentation/modules/ar.html @@ -3,7 +3,7 @@ Currently only works on Android. Desktop version of Chrome can be used to run an emulator via WebXR API Emulator plugin.

    Author

    Chong Wen Hao

    -

    Index

    Variables

    alignmentBottom +

    Index

    Variables

    alignmentBottom alignmentCenter alignmentLeft alignmentMiddle diff --git a/documentation/modules/arcade_2d.html b/documentation/modules/arcade_2d.html index c7e098574..22309462c 100644 --- a/documentation/modules/arcade_2d.html +++ b/documentation/modules/arcade_2d.html @@ -21,7 +21,7 @@

    Author

    Titus Chew Xuan Jun

    Author

    Xenos Fiorenzo Anong

    -

    Index

    Functions - Audio

    create_audio +

    Index

    Functions - Audio

    create_audio loop_audio play_audio stop_audio diff --git a/documentation/modules/binary_tree.html b/documentation/modules/binary_tree.html index d673120d6..44c96a903 100644 --- a/documentation/modules/binary_tree.html +++ b/documentation/modules/binary_tree.html @@ -5,7 +5,7 @@

    Author

    Martin Henz

    Author

    Joel Lee

    Author

    Loh Xian Ze, Bryan

    -

    Index

    Functions

    entry +

    Index

    Functions

    entry is_empty_tree is_tree left_branch diff --git a/documentation/modules/communication.html b/documentation/modules/communication.html index 4a0bfafeb..062feea79 100644 --- a/documentation/modules/communication.html +++ b/documentation/modules/communication.html @@ -5,7 +5,7 @@
  • Global State - Maintain a global state on all devices.

    • Author

    Chong Wen Hao

    -

    Index

    Variables

    STATE_CONNECTED +

    Index

    Variables

    STATE_CONNECTED STATE_DISCONNECTED STATE_OFFLINE STATE_RECONNECTING diff --git a/documentation/modules/copy_gc.html b/documentation/modules/copy_gc.html index 33f920f81..265b21e87 100644 --- a/documentation/modules/copy_gc.html +++ b/documentation/modules/copy_gc.html @@ -1,4 +1,4 @@ -copy_gc | Source Academy Modules

    Module copy_gc

    Index

    Functions

    allHeap +copy_gc | Source Academy Modules

    Module copy_gc

    Index

    Functions

    allHeap doneShowRoot endFlip generateMemory diff --git a/documentation/modules/csg.html b/documentation/modules/csg.html index e3bb65b58..1aed81da5 100644 --- a/documentation/modules/csg.html +++ b/documentation/modules/csg.html @@ -26,7 +26,7 @@

    Author

    Liu Muchen

    Author

    Ng Yin Joe

    Author

    Yu Chenbo

    -

    Index

    Variables - Colors

    black +

    Index

    Variables - Colors

    black blue crimson cyan diff --git a/documentation/modules/curve.html b/documentation/modules/curve.html index 994630217..c76986e8b 100644 --- a/documentation/modules/curve.html +++ b/documentation/modules/curve.html @@ -20,7 +20,7 @@

    draws a full circle in the display tab.

    Author

    Lee Zheng Han

    Author

    Ng Yong Xiang

    -

    Index

    Functions

    animate_3D_curve +

    Index

    Functions

    animate_3D_curve animate_curve arc b_of diff --git a/documentation/modules/game.html b/documentation/modules/game.html index 7062d0ce6..a1aa4e0ee 100644 --- a/documentation/modules/game.html +++ b/documentation/modules/game.html @@ -7,7 +7,7 @@

    Author

    Chi Xu

    Author

    Chong Sia Tiffany

    Author

    Gokul Rajiv

    -

    Index

    Functions

    add +

    Index

    Functions

    add add_keyboard_listener add_listener add_to_container diff --git a/documentation/modules/mark_sweep.html b/documentation/modules/mark_sweep.html index 47560baf9..e4b7baf06 100644 --- a/documentation/modules/mark_sweep.html +++ b/documentation/modules/mark_sweep.html @@ -1,4 +1,4 @@ -mark_sweep | Source Academy Modules

    Module mark_sweep

    Index

    Functions

    addRoots +mark_sweep | Source Academy Modules

    Module mark_sweep

    Index

    Functions

    addRoots allHeap endGC generateMemory diff --git a/documentation/modules/nbody.html b/documentation/modules/nbody.html index a6db4ca7e..422a6dc0a 100644 --- a/documentation/modules/nbody.html +++ b/documentation/modules/nbody.html @@ -3,7 +3,7 @@ 
    import { createCelestialBody, createGravity, createRungeKutta4Sim,
    createVelocityVerletSim, createSimulation, playSim, createState, createUniverse,
    createVector, clone, recordSim } from 'nbody';

    const force = createGravity(1);
    const sim = createRungeKutta4Sim(force, [1, 2, 2, 1]);
    const a = createCelestialBody(
        "a",
        1,
        1,
        createVector(-0.97000436, 0.24308753, 0),
        createVector(0.466203685, 0.43236573, 0),
        createVector(0, 0, 0)
      );
    const b = createCelestialBody(
        "b",
        1,
        1,
        createVector(0.97000436, -0.24308753, 0),
        createVector(0.466203685, 0.43236573, 0),
        createVector(0, 0, 0)
    );
    const c = createCelestialBody(
        "c",
        1,
        1,
        createVector(0, 0, 0),
        createVector(-2 * 0.466203685, -2 * 0.43236573, 0),
        createVector(0, 0, 0)
    );

    const state = createState([a, b, c]);

    const universe = createUniverse(
        "Universe 1",
        "rgba(254, 209, 106, 1)",
        undefined,
        state,
        createVelocityVerletSim(force),
        []
    );
    const universe2 = createUniverse(
        "Universe 2",
        "rgba(254, 0, 0, 1)",
        undefined,
        clone(state),
        createRungeKutta4Sim(force, [1, 2, 2, 1]),
        []
    );

    const simulation = createSimulation([universe, universe2], "3D", false, undefined, true, 100);
    playSim(simulation);

    Author

    Yeluri Ketan

    -

    Index

    Functions - Celestial Body

    clone +

    Index

    Functions - Celestial Body

    clone createCelestialBody

    Functions - Forces

    createCentripetalForce createCombinedForce diff --git a/documentation/modules/painter.html b/documentation/modules/painter.html index d606ed83b..e9cc8528f 100644 --- a/documentation/modules/painter.html +++ b/documentation/modules/painter.html @@ -1,5 +1,5 @@ painter | Source Academy Modules

    Module painter

    The module painter provides functions for visualizing painters in SICP JS 2.2.4 plots using the plotly.js library.

    Author

    Sourabh Raj Jaiswal

    -

    Index

    Functions

    display_painter +

    Index

    Functions

    display_painter draw_line

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/modules/physics_2d.html b/documentation/modules/physics_2d.html index fc2c10f56..e290a5c5d 100644 --- a/documentation/modules/physics_2d.html +++ b/documentation/modules/physics_2d.html @@ -45,7 +45,7 @@

    Author

    Muhammad Fikri Bin Abdul Kalam

    Author

    Yu Jiali

    -

    Index

    Functions - Body

    add_box_object +

    Index

    Functions - Body

    add_box_object add_circle_object add_triangle_object get_angular_velocity diff --git a/documentation/modules/pix_n_flix.html b/documentation/modules/pix_n_flix.html index db0ceeab8..85f164b77 100644 --- a/documentation/modules/pix_n_flix.html +++ b/documentation/modules/pix_n_flix.html @@ -14,7 +14,7 @@ can use the functions image_width and image_height.

    Author

    Loh Xian Ze, Bryan

    Author

    Tang Xin Kye, Marcus

    -

    Index

    Functions

    alpha_of +

    Index

    Functions

    alpha_of blue_of compose_filter copy_image diff --git a/documentation/modules/plotly.html b/documentation/modules/plotly.html index f9b1477e6..65f94237e 100644 --- a/documentation/modules/plotly.html +++ b/documentation/modules/plotly.html @@ -1,4 +1,4 @@ -plotly | Source Academy Modules

    Module plotly

    Index

    Functions

    draw_connected_2d +plotly | Source Academy Modules

    Module plotly

    Index

    Functions

    draw_connected_2d draw_connected_3d draw_points_2d draw_points_3d diff --git a/documentation/modules/remote_execution.html b/documentation/modules/remote_execution.html index 5d119afee..400fea092 100644 --- a/documentation/modules/remote_execution.html +++ b/documentation/modules/remote_execution.html @@ -1,4 +1,4 @@ remote_execution | Source Academy Modules

    Module remote_execution

    Module responsible for execution of Source on remote devices.

    Author

    Richard Dominick

    -

    Index

    Variables

    EV3 +

    Index

    Variables

    EV3

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/modules/repeat.html b/documentation/modules/repeat.html index aebb4c23b..feb2f5159 100644 --- a/documentation/modules/repeat.html +++ b/documentation/modules/repeat.html @@ -1,4 +1,4 @@ -repeat | Source Academy Modules

    Module repeat

    Index

    Functions

    repeat +repeat | Source Academy Modules

    Module repeat

    Index

    Functions

    repeat thrice twice

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/modules/repl.html b/documentation/modules/repl.html index d4f4e21be..184720833 100644 --- a/documentation/modules/repl.html +++ b/documentation/modules/repl.html @@ -6,7 +6,7 @@

    Customize Editor Appearance

    import { set_background_image, set_font_size } from "repl";
    set_background_image("https://www.some_image_website.xyz/your_favorite_image.png");  // Set the background image of the editor in repl tab
    set_font_size(20.5);  // Set the font size of the editor in repl tab

    Author

    Wang Zihan

    -

    Index

    Functions - Main

    default_js_slang +

    Index

    Functions - Main

    default_js_slang repl_display set_background_image set_evaluator diff --git a/documentation/modules/robot_simulation.html b/documentation/modules/robot_simulation.html index b07c039ee..4f90fd828 100644 --- a/documentation/modules/robot_simulation.html +++ b/documentation/modules/robot_simulation.html @@ -1,6 +1,6 @@ robot_simulation | Source Academy Modules

    Module robot_simulation

    Robot simulator for EV3.

    Author

    Joel Chan

    -

    Index

    Functions - Configuration

    createCustomPhysics +

    Index

    Functions - Configuration

    createCustomPhysics createPhysics createRenderer createRobotConsole diff --git a/documentation/modules/rune.html b/documentation/modules/rune.html index fe874f423..489e3fc1e 100644 --- a/documentation/modules/rune.html +++ b/documentation/modules/rune.html @@ -1,7 +1,7 @@ rune | Source Academy Modules

    Module rune

    The module rune provides functions for drawing runes.

    A Rune is defined by its vertices (x,y,z,t), the colors on its vertices (r,g,b,a), a transformation matrix for rendering the Rune and a (could be empty) list of its sub-Runes.

    Author

    Hou Ruomu

    -

    Index

    Variables - Primitive

    blank +

    Index

    Variables - Primitive

    blank circle corner heart diff --git a/documentation/modules/rune_in_words.html b/documentation/modules/rune_in_words.html index 87df0eb35..34074c3ed 100644 --- a/documentation/modules/rune_in_words.html +++ b/documentation/modules/rune_in_words.html @@ -1,7 +1,7 @@ rune_in_words | Source Academy Modules

    Module rune_in_words

    The module rune_in_words provides functions for computing with runes using text instead of graphics.

    A Rune is defined by its vertices (x,y,z,t), the colors on its vertices (r,g,b,a), a transformation matrix for rendering the Rune and a (could be empty) list of its sub-Runes. In this module, runes are represented as strings that approximate the way they are created. No graphical output is generated.

    Author

    Martin Henz

    -

    Index

    Variables - Primitive

    blank +

    Index

    Variables - Primitive

    blank circle corner heart diff --git a/documentation/modules/scrabble.html b/documentation/modules/scrabble.html index ebd194095..71480f3c3 100644 --- a/documentation/modules/scrabble.html +++ b/documentation/modules/scrabble.html @@ -1,4 +1,4 @@ -scrabble | Source Academy Modules

    Module scrabble

    Index

    Variables

    scrabble_letters +scrabble | Source Academy Modules

    Module scrabble

    Index

    Variables

    scrabble_letters scrabble_letters_tiny scrabble_words scrabble_words_tiny diff --git a/documentation/modules/sound.html b/documentation/modules/sound.html index 0d2121c69..8b5e01082 100644 --- a/documentation/modules/sound.html +++ b/documentation/modules/sound.html @@ -14,7 +14,7 @@ computer's sound system.

    Author

    Koh Shang Hui

    Author

    Samyukta Sounderraman

    -

    Index

    Functions

    adsr +

    Index

    Functions

    adsr bell cello consecutively diff --git a/documentation/modules/sound_matrix.html b/documentation/modules/sound_matrix.html index ed4929e1e..65ae88f87 100644 --- a/documentation/modules/sound_matrix.html +++ b/documentation/modules/sound_matrix.html @@ -1,4 +1,4 @@ -sound_matrix | Source Academy Modules

    Module sound_matrix

    References

    clear_matrix +sound_matrix | Source Academy Modules

    Module sound_matrix

    References

    clear_matrix

    Variables

    ToneMatrix

    Functions

    clear_all_timeout get_matrix diff --git a/documentation/modules/stereo_sound.html b/documentation/modules/stereo_sound.html index 0c82ef1b0..7cfa2b831 100644 --- a/documentation/modules/stereo_sound.html +++ b/documentation/modules/stereo_sound.html @@ -6,7 +6,7 @@ The make_sound constructor from sounds is syntatic sugar for make_stereo_sounds with equal waves.

    Author

    Koh Shang Hui

    Author

    Samyukta Sounderraman

    -

    Index

    Functions

    adsr +

    Index

    Functions

    adsr bell cello consecutively diff --git a/documentation/modules/unity_academy.html b/documentation/modules/unity_academy.html index e955c2cb3..27117973e 100644 --- a/documentation/modules/unity_academy.html +++ b/documentation/modules/unity_academy.html @@ -78,7 +78,7 @@
  • In Unity Academy, only tags b, i, size and color are supported.

    • Author

    Wang Zihan

    -

    Index

    Functions - Application Initialization

    init_unity_academy_2d +

    Index

    Functions - Application Initialization

    init_unity_academy_2d init_unity_academy_3d

    Functions - Camera

    get_main_camera_following_target request_for_main_camera_control diff --git a/documentation/modules/wasm.html b/documentation/modules/wasm.html index d311ebba9..ab1c3036e 100644 --- a/documentation/modules/wasm.html +++ b/documentation/modules/wasm.html @@ -72,6 +72,6 @@ display(add(10, 0));

    Author

    Kim Yongbeom

    -

    Index

    Functions

    wcompile +

    Index

    Functions

    wcompile wrun

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/ar.alignmentBottom.html b/documentation/variables/ar.alignmentBottom.html index a4227a791..ed760f04f 100644 --- a/documentation/variables/ar.alignmentBottom.html +++ b/documentation/variables/ar.alignmentBottom.html @@ -1 +1 @@ -alignmentBottom | Source Academy Modules

    Variable alignmentBottomConst

    alignmentBottom: Bottom = VerticalAlignment.Bottom

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +alignmentBottom | Source Academy Modules

    Variable alignmentBottomConst

    alignmentBottom: Bottom = VerticalAlignment.Bottom

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/ar.alignmentCenter.html b/documentation/variables/ar.alignmentCenter.html index 4ea5887c0..ac7122e6f 100644 --- a/documentation/variables/ar.alignmentCenter.html +++ b/documentation/variables/ar.alignmentCenter.html @@ -1 +1 @@ -alignmentCenter | Source Academy Modules

    Variable alignmentCenterConst

    alignmentCenter: Center = HorizontalAlignment.Center

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +alignmentCenter | Source Academy Modules

    Variable alignmentCenterConst

    alignmentCenter: Center = HorizontalAlignment.Center

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/ar.alignmentLeft.html b/documentation/variables/ar.alignmentLeft.html index a9a744b5e..6ac2f8711 100644 --- a/documentation/variables/ar.alignmentLeft.html +++ b/documentation/variables/ar.alignmentLeft.html @@ -1 +1 @@ -alignmentLeft | Source Academy Modules

    Variable alignmentLeftConst

    alignmentLeft: Left = HorizontalAlignment.Left

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +alignmentLeft | Source Academy Modules

    Variable alignmentLeftConst

    alignmentLeft: Left = HorizontalAlignment.Left

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/ar.alignmentMiddle.html b/documentation/variables/ar.alignmentMiddle.html index 0b3781964..2810d89ea 100644 --- a/documentation/variables/ar.alignmentMiddle.html +++ b/documentation/variables/ar.alignmentMiddle.html @@ -1 +1 @@ -alignmentMiddle | Source Academy Modules

    Variable alignmentMiddleConst

    alignmentMiddle: Middle = VerticalAlignment.Middle

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +alignmentMiddle | Source Academy Modules

    Variable alignmentMiddleConst

    alignmentMiddle: Middle = VerticalAlignment.Middle

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/ar.alignmentRight.html b/documentation/variables/ar.alignmentRight.html index c873bca18..2ba5bb6b1 100644 --- a/documentation/variables/ar.alignmentRight.html +++ b/documentation/variables/ar.alignmentRight.html @@ -1 +1 @@ -alignmentRight | Source Academy Modules

    Variable alignmentRightConst

    alignmentRight: Right = HorizontalAlignment.Right

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +alignmentRight | Source Academy Modules

    Variable alignmentRightConst

    alignmentRight: Right = HorizontalAlignment.Right

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/ar.alignmentTop.html b/documentation/variables/ar.alignmentTop.html index 7a81467d4..c40e317b9 100644 --- a/documentation/variables/ar.alignmentTop.html +++ b/documentation/variables/ar.alignmentTop.html @@ -1 +1 @@ -alignmentTop | Source Academy Modules

    Variable alignmentTopConst

    alignmentTop: Top = VerticalAlignment.Top

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +alignmentTop | Source Academy Modules

    Variable alignmentTopConst

    alignmentTop: Top = VerticalAlignment.Top

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/communication.STATE_CONNECTED.html b/documentation/variables/communication.STATE_CONNECTED.html index 8b90d988f..651e0a785 100644 --- a/documentation/variables/communication.STATE_CONNECTED.html +++ b/documentation/variables/communication.STATE_CONNECTED.html @@ -1 +1 @@ -STATE_CONNECTED | Source Academy Modules

    Variable STATE_CONNECTEDConst

    STATE_CONNECTED: "Connected" = 'Connected'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +STATE_CONNECTED | Source Academy Modules

    Variable STATE_CONNECTEDConst

    STATE_CONNECTED: "Connected" = 'Connected'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/communication.STATE_DISCONNECTED.html b/documentation/variables/communication.STATE_DISCONNECTED.html index 215d2aa5e..7a22cd726 100644 --- a/documentation/variables/communication.STATE_DISCONNECTED.html +++ b/documentation/variables/communication.STATE_DISCONNECTED.html @@ -1 +1 @@ -STATE_DISCONNECTED | Source Academy Modules

    Variable STATE_DISCONNECTEDConst

    STATE_DISCONNECTED: "Disconnected" = 'Disconnected'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +STATE_DISCONNECTED | Source Academy Modules

    Variable STATE_DISCONNECTEDConst

    STATE_DISCONNECTED: "Disconnected" = 'Disconnected'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/communication.STATE_OFFLINE.html b/documentation/variables/communication.STATE_OFFLINE.html index 6c6650144..8d79304a5 100644 --- a/documentation/variables/communication.STATE_OFFLINE.html +++ b/documentation/variables/communication.STATE_OFFLINE.html @@ -1 +1 @@ -STATE_OFFLINE | Source Academy Modules

    Variable STATE_OFFLINEConst

    STATE_OFFLINE: "Offline" = 'Offline'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +STATE_OFFLINE | Source Academy Modules

    Variable STATE_OFFLINEConst

    STATE_OFFLINE: "Offline" = 'Offline'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/communication.STATE_RECONNECTING.html b/documentation/variables/communication.STATE_RECONNECTING.html index b55b52d2e..df62e77fc 100644 --- a/documentation/variables/communication.STATE_RECONNECTING.html +++ b/documentation/variables/communication.STATE_RECONNECTING.html @@ -1 +1 @@ -STATE_RECONNECTING | Source Academy Modules

    Variable STATE_RECONNECTINGConst

    STATE_RECONNECTING: "Reconnecting" = 'Reconnecting'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +STATE_RECONNECTING | Source Academy Modules

    Variable STATE_RECONNECTINGConst

    STATE_RECONNECTING: "Reconnecting" = 'Reconnecting'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.black.html b/documentation/variables/csg.black.html index 5a56693d8..504cf80e9 100644 --- a/documentation/variables/csg.black.html +++ b/documentation/variables/csg.black.html @@ -1,2 +1,2 @@ black | Source Academy Modules

    Variable blackConst

    black: string = '#000000'

    A hex color code for black (#000000).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.blue.html b/documentation/variables/csg.blue.html index 839a58f2a..dd1d738a9 100644 --- a/documentation/variables/csg.blue.html +++ b/documentation/variables/csg.blue.html @@ -1,2 +1,2 @@ blue | Source Academy Modules

    Variable blueConst

    blue: string = '#5555FF'

    A hex color code for blue (#5555FF).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.crimson.html b/documentation/variables/csg.crimson.html index ca35abfad..92c14180f 100644 --- a/documentation/variables/csg.crimson.html +++ b/documentation/variables/csg.crimson.html @@ -1,2 +1,2 @@ crimson | Source Academy Modules

    Variable crimsonConst

    crimson: string = '#AA0000'

    A hex color code for dark red (#AA0000).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.cyan.html b/documentation/variables/csg.cyan.html index 7e865fd6d..e811251a7 100644 --- a/documentation/variables/csg.cyan.html +++ b/documentation/variables/csg.cyan.html @@ -1,2 +1,2 @@ cyan | Source Academy Modules

    Variable cyanConst

    cyan: string = '#55FFFF'

    A hex color code for cyan (#55FFFF).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.gray.html b/documentation/variables/csg.gray.html index 1c65d157c..fb7efa31f 100644 --- a/documentation/variables/csg.gray.html +++ b/documentation/variables/csg.gray.html @@ -1,2 +1,2 @@ gray | Source Academy Modules

    Variable grayConst

    gray: string = '#555555'

    A hex color code for dark gray (#555555).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.green.html b/documentation/variables/csg.green.html index 367672afd..a9cc9610f 100644 --- a/documentation/variables/csg.green.html +++ b/documentation/variables/csg.green.html @@ -1,2 +1,2 @@ green | Source Academy Modules

    Variable greenConst

    green: string = '#00AA00'

    A hex color code for green (#00AA00).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.lime.html b/documentation/variables/csg.lime.html index 814a361d2..6e974ea57 100644 --- a/documentation/variables/csg.lime.html +++ b/documentation/variables/csg.lime.html @@ -1,2 +1,2 @@ lime | Source Academy Modules

    Variable limeConst

    lime: string = '#55FF55'

    A hex color code for light green (#55FF55).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.navy.html b/documentation/variables/csg.navy.html index 9712e4e65..79365f153 100644 --- a/documentation/variables/csg.navy.html +++ b/documentation/variables/csg.navy.html @@ -1,2 +1,2 @@ navy | Source Academy Modules

    Variable navyConst

    navy: string = '#0000AA'

    A hex color code for dark blue (#0000AA).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.orange.html b/documentation/variables/csg.orange.html index ad696cb59..3afedf70f 100644 --- a/documentation/variables/csg.orange.html +++ b/documentation/variables/csg.orange.html @@ -1,2 +1,2 @@ orange | Source Academy Modules

    Variable orangeConst

    orange: string = '#FFAA00'

    A hex color code for orange (#FFAA00).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.pink.html b/documentation/variables/csg.pink.html index 36a262496..f1c5d6f62 100644 --- a/documentation/variables/csg.pink.html +++ b/documentation/variables/csg.pink.html @@ -1,2 +1,2 @@ pink | Source Academy Modules

    Variable pinkConst

    pink: string = '#FF55FF'

    A hex color code for pink (#FF55FF).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.purple.html b/documentation/variables/csg.purple.html index 31c30a19e..51d335892 100644 --- a/documentation/variables/csg.purple.html +++ b/documentation/variables/csg.purple.html @@ -1,2 +1,2 @@ purple | Source Academy Modules

    Variable purpleConst

    purple: string = '#AA00AA'

    A hex color code for purple (#AA00AA).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.rose.html b/documentation/variables/csg.rose.html index f363205cc..6f5219d12 100644 --- a/documentation/variables/csg.rose.html +++ b/documentation/variables/csg.rose.html @@ -1,2 +1,2 @@ rose | Source Academy Modules

    Variable roseConst

    rose: string = '#FF5555'

    A hex color code for light red (#FF5555).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.silver.html b/documentation/variables/csg.silver.html index 549843815..94461e0d4 100644 --- a/documentation/variables/csg.silver.html +++ b/documentation/variables/csg.silver.html @@ -1,2 +1,2 @@ silver | Source Academy Modules

    Variable silverConst

    silver: string = '#AAAAAA'

    A hex color code for light gray (#AAAAAA).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.teal.html b/documentation/variables/csg.teal.html index 388a43a33..80963159a 100644 --- a/documentation/variables/csg.teal.html +++ b/documentation/variables/csg.teal.html @@ -1,2 +1,2 @@ teal | Source Academy Modules

    Variable tealConst

    teal: string = '#00AAAA'

    A hex color code for dark cyan (#00AAAA).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.white.html b/documentation/variables/csg.white.html index b447b1b21..6dce6a809 100644 --- a/documentation/variables/csg.white.html +++ b/documentation/variables/csg.white.html @@ -1,2 +1,2 @@ white | Source Academy Modules

    Variable whiteConst

    white: string = '#FFFFFF'

    A hex color code for white (#FFFFFF).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/csg.yellow.html b/documentation/variables/csg.yellow.html index 22e9d800d..516f3f22f 100644 --- a/documentation/variables/csg.yellow.html +++ b/documentation/variables/csg.yellow.html @@ -1,2 +1,2 @@ yellow | Source Academy Modules

    Variable yellowConst

    yellow: string = '#FFFF55'

    A hex color code for yellow (#FFFF55).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/remote_execution.EV3.html b/documentation/variables/remote_execution.EV3.html index a1546d7d3..4bc7e1f6d 100644 --- a/documentation/variables/remote_execution.EV3.html +++ b/documentation/variables/remote_execution.EV3.html @@ -1 +1 @@ -EV3 | Source Academy Modules

    Variable EV3Const

    EV3: {
        id: string;
        internalFunctions: string[];
        languageChapter: Chapter;
        name: string;
    } = ...

    Type declaration

    • id: string
    • internalFunctions: string[]
    • languageChapter: Chapter
    • name: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EV3 | Source Academy Modules

    Variable EV3Const

    EV3: {
        id: string;
        internalFunctions: string[];
        languageChapter: Chapter;
        name: string;
    } = ...

    Type declaration

    • id: string
    • internalFunctions: string[]
    • languageChapter: Chapter
    • name: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.blank.html b/documentation/variables/rune.blank.html index ed0f78b63..e4bebc65d 100644 --- a/documentation/variables/rune.blank.html +++ b/documentation/variables/rune.blank.html @@ -1,2 +1,2 @@ blank | Source Academy Modules

    Variable blankConst

    blank: Rune = ...

    Rune with the shape of a blank square

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.circle.html b/documentation/variables/rune.circle.html index bdb70c247..8a1b9a121 100644 --- a/documentation/variables/rune.circle.html +++ b/documentation/variables/rune.circle.html @@ -1,2 +1,2 @@ circle | Source Academy Modules

    Variable circleConst

    circle: Rune = ...

    Rune with the shape of a circle

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.corner.html b/documentation/variables/rune.corner.html index 33bda183b..d9cd9440e 100644 --- a/documentation/variables/rune.corner.html +++ b/documentation/variables/rune.corner.html @@ -1,3 +1,3 @@ corner | Source Academy Modules

    Variable cornerConst

    corner: Rune = ...

    Rune with black triangle, filling upper right corner

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.heart.html b/documentation/variables/rune.heart.html index abf42a2bd..002067061 100644 --- a/documentation/variables/rune.heart.html +++ b/documentation/variables/rune.heart.html @@ -1,2 +1,2 @@ heart | Source Academy Modules

    Variable heartConst

    heart: Rune = ...

    Rune with the shape of a heart

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.nova.html b/documentation/variables/rune.nova.html index d92911bad..4bce4e024 100644 --- a/documentation/variables/rune.nova.html +++ b/documentation/variables/rune.nova.html @@ -1,4 +1,4 @@ nova | Source Academy Modules

    Variable novaConst

    nova: Rune = ...

    Rune with the shape of two overlapping triangles, residing in the upper half of the shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.pentagram.html b/documentation/variables/rune.pentagram.html index f6f0e96c0..aea960e0b 100644 --- a/documentation/variables/rune.pentagram.html +++ b/documentation/variables/rune.pentagram.html @@ -1,2 +1,2 @@ pentagram | Source Academy Modules

    Variable pentagramConst

    pentagram: Rune = ...

    Rune with the shape of a pentagram

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.rcross.html b/documentation/variables/rune.rcross.html index 0d2c463ff..c1505acf4 100644 --- a/documentation/variables/rune.rcross.html +++ b/documentation/variables/rune.rcross.html @@ -2,4 +2,4 @@ small square inside a large square, each diagonally split into a black and white half

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.ribbon.html b/documentation/variables/rune.ribbon.html index e6e805379..9aab094ef 100644 --- a/documentation/variables/rune.ribbon.html +++ b/documentation/variables/rune.ribbon.html @@ -1,3 +1,3 @@ ribbon | Source Academy Modules

    Variable ribbonConst

    ribbon: Rune = ...

    Rune with the shape of a ribbon winding outwards in an anticlockwise spiral

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.sail.html b/documentation/variables/rune.sail.html index bddab4c4f..d4e21fbf1 100644 --- a/documentation/variables/rune.sail.html +++ b/documentation/variables/rune.sail.html @@ -1,2 +1,2 @@ sail | Source Academy Modules

    Variable sailConst

    sail: Rune = ...

    Rune with the shape of a sail

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.square.html b/documentation/variables/rune.square.html index 67794b608..1d67eaf67 100644 --- a/documentation/variables/rune.square.html +++ b/documentation/variables/rune.square.html @@ -1,2 +1,2 @@ square | Source Academy Modules

    Variable squareConst

    square: Rune = ...

    Rune with the shape of a full square

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune.triangle.html b/documentation/variables/rune.triangle.html index 49da0ce7a..1b8fee97b 100644 --- a/documentation/variables/rune.triangle.html +++ b/documentation/variables/rune.triangle.html @@ -1,2 +1,2 @@ triangle | Source Academy Modules

    Variable triangleConst

    triangle: Rune = ...

    Rune with the shape of a triangle

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.blank.html b/documentation/variables/rune_in_words.blank.html index 702289fed..7079f991f 100644 --- a/documentation/variables/rune_in_words.blank.html +++ b/documentation/variables/rune_in_words.blank.html @@ -1,2 +1,2 @@ blank | Source Academy Modules

    Variable blankConst

    blank: string = ...

    Rune with the shape of a blank square

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.circle.html b/documentation/variables/rune_in_words.circle.html index 6d3cb7613..e89679da3 100644 --- a/documentation/variables/rune_in_words.circle.html +++ b/documentation/variables/rune_in_words.circle.html @@ -1,2 +1,2 @@ circle | Source Academy Modules

    Variable circleConst

    circle: string = ...

    Rune with the shape of a circle

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.corner.html b/documentation/variables/rune_in_words.corner.html index 507747c01..425c4baf7 100644 --- a/documentation/variables/rune_in_words.corner.html +++ b/documentation/variables/rune_in_words.corner.html @@ -1,3 +1,3 @@ corner | Source Academy Modules

    Variable cornerConst

    corner: string = ...

    Rune with black triangle, filling upper right corner

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.heart.html b/documentation/variables/rune_in_words.heart.html index 019ebca81..9838e6a3b 100644 --- a/documentation/variables/rune_in_words.heart.html +++ b/documentation/variables/rune_in_words.heart.html @@ -1,2 +1,2 @@ heart | Source Academy Modules

    Variable heartConst

    heart: string = ...

    Rune with the shape of a heart

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.nova.html b/documentation/variables/rune_in_words.nova.html index 59e552e5a..245a36ccc 100644 --- a/documentation/variables/rune_in_words.nova.html +++ b/documentation/variables/rune_in_words.nova.html @@ -1,4 +1,4 @@ nova | Source Academy Modules

    Variable novaConst

    nova: string = ...

    Rune with the shape of two overlapping triangles, residing in the upper half of the shape

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.pentagram.html b/documentation/variables/rune_in_words.pentagram.html index c1dd23f61..031db091b 100644 --- a/documentation/variables/rune_in_words.pentagram.html +++ b/documentation/variables/rune_in_words.pentagram.html @@ -1,2 +1,2 @@ pentagram | Source Academy Modules

    Variable pentagramConst

    pentagram: string = ...

    Rune with the shape of a pentagram

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.rcross.html b/documentation/variables/rune_in_words.rcross.html index ed97ef255..28c023a88 100644 --- a/documentation/variables/rune_in_words.rcross.html +++ b/documentation/variables/rune_in_words.rcross.html @@ -2,4 +2,4 @@ small square inside a large square, each diagonally split into a black and white half

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.ribbon.html b/documentation/variables/rune_in_words.ribbon.html index 009b38a67..1762aa499 100644 --- a/documentation/variables/rune_in_words.ribbon.html +++ b/documentation/variables/rune_in_words.ribbon.html @@ -1,3 +1,3 @@ ribbon | Source Academy Modules

    Variable ribbonConst

    ribbon: string = ...

    Rune with the shape of a ribbon winding outwards in an anticlockwise spiral

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.sail.html b/documentation/variables/rune_in_words.sail.html index 05229454b..7318ce381 100644 --- a/documentation/variables/rune_in_words.sail.html +++ b/documentation/variables/rune_in_words.sail.html @@ -1,2 +1,2 @@ sail | Source Academy Modules

    Variable sailConst

    sail: string = ...

    Rune with the shape of a sail

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.square.html b/documentation/variables/rune_in_words.square.html index 1fd43cd73..a78572663 100644 --- a/documentation/variables/rune_in_words.square.html +++ b/documentation/variables/rune_in_words.square.html @@ -1,2 +1,2 @@ square | Source Academy Modules

    Variable squareConst

    square: string = ...

    Rune with the shape of a full square

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/rune_in_words.triangle.html b/documentation/variables/rune_in_words.triangle.html index e8da9d34e..9c3e380f7 100644 --- a/documentation/variables/rune_in_words.triangle.html +++ b/documentation/variables/rune_in_words.triangle.html @@ -1,2 +1,2 @@ triangle | Source Academy Modules

    Variable triangleConst

    triangle: string = ...

    Rune with the shape of a triangle

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/scrabble.scrabble_letters.html b/documentation/variables/scrabble.scrabble_letters.html index 7e8519df3..a7d6c6e1a 100644 --- a/documentation/variables/scrabble.scrabble_letters.html +++ b/documentation/variables/scrabble.scrabble_letters.html @@ -2,4 +2,4 @@ of strings represents an allowed word in Scrabble and contains the letters of that word as single-character strings in the order in which the letters appear in the word.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/scrabble.scrabble_letters_tiny.html b/documentation/variables/scrabble.scrabble_letters_tiny.html index 1487a184b..f1fd782ec 100644 --- a/documentation/variables/scrabble.scrabble_letters_tiny.html +++ b/documentation/variables/scrabble.scrabble_letters_tiny.html @@ -1 +1 @@ -scrabble_letters_tiny | Source Academy Modules

    Variable scrabble_letters_tinyConst

    scrabble_letters_tiny: string[][] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +scrabble_letters_tiny | Source Academy Modules

    Variable scrabble_letters_tinyConst

    scrabble_letters_tiny: string[][] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/scrabble.scrabble_words.html b/documentation/variables/scrabble.scrabble_words.html index 0a56df3a6..484fe4cb3 100644 --- a/documentation/variables/scrabble.scrabble_words.html +++ b/documentation/variables/scrabble.scrabble_words.html @@ -1,3 +1,3 @@ scrabble_words | Source Academy Modules

    Variable scrabble_wordsConst

    scrabble_words: string[] = ...

    scrabble_words is an array of strings, each representing an allowed word in Scrabble.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/scrabble.scrabble_words_tiny.html b/documentation/variables/scrabble.scrabble_words_tiny.html index d56a0efc1..138cc81bf 100644 --- a/documentation/variables/scrabble.scrabble_words_tiny.html +++ b/documentation/variables/scrabble.scrabble_words_tiny.html @@ -1 +1 @@ -scrabble_words_tiny | Source Academy Modules

    Variable scrabble_words_tinyConst

    scrabble_words_tiny: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +scrabble_words_tiny | Source Academy Modules

    Variable scrabble_words_tinyConst

    scrabble_words_tiny: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/variables/sound_matrix.ToneMatrix.html b/documentation/variables/sound_matrix.ToneMatrix.html index 56eddf136..2c192f307 100644 --- a/documentation/variables/sound_matrix.ToneMatrix.html +++ b/documentation/variables/sound_matrix.ToneMatrix.html @@ -1 +1 @@ -ToneMatrix | Source Academy Modules

    Variable ToneMatrixConst

    ToneMatrix: {
        bindMatrixButtons: (() => void);
        clear_matrix: (() => void);
        initialise_matrix: (($container) => void);
        randomise_matrix: (() => void);
    } = ...

    Type declaration

    • bindMatrixButtons: (() => void)
        • (): void

        • Returns void

    • clear_matrix: (() => void)
        • (): void

        • Returns void

    • initialise_matrix: (($container) => void)
        • ($container): void

        • Parameters

          • $container: HTMLElement

          Returns void

    • randomise_matrix: (() => void)
        • (): void

        • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ToneMatrix | Source Academy Modules

    Variable ToneMatrixConst

    ToneMatrix: {
        bindMatrixButtons: (() => void);
        clear_matrix: (() => void);
        initialise_matrix: (($container) => void);
        randomise_matrix: (() => void);
    } = ...

    Type declaration

    • bindMatrixButtons: (() => void)
        • (): void

        • Returns void

    • clear_matrix: (() => void)
        • (): void

        • Returns void

    • initialise_matrix: (($container) => void)
        • ($container): void

        • Parameters

          • $container: HTMLElement

          Returns void

    • randomise_matrix: (() => void)
        • (): void

        • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/tabs/Painter.js b/tabs/Painter.js index 9f857b2c4..8b6dc3ec6 100644 --- a/tabs/Painter.js +++ b/tabs/Painter.js @@ -150,7 +150,15 @@ export default require => { return (0, import_jsx_runtime2.jsxs)(import_jsx_runtime2.Fragment, { children: [(0, import_jsx_runtime2.jsx)("div", { onClick: () => this.handleOpen(drawnPainter), - children: "Click here to open Modal" + style: { + cursor: "pointer", + padding: "5px 10px", + backgroundColor: "#474F5E", + border: "1px solid #aaa", + borderRadius: "4px", + display: "inline-block" + }, + children: "Popout plot" }), (0, import_jsx_runtime2.jsx)("div", { id: divId, ref: () => { diff --git a/tabs/Plotly.js b/tabs/Plotly.js index b27acee28..859bf0b4f 100644 --- a/tabs/Plotly.js +++ b/tabs/Plotly.js @@ -210785,7 +210785,15 @@ export default require => { }, children: [(0, import_jsx_runtime2.jsx)("div", { onClick: () => this.handleOpen(drawnPlot), - children: "Click here to open Modal" + style: { + cursor: "pointer", + padding: "5px 10px", + backgroundColor: "#474F5E", + border: "1px solid #aaa", + borderRadius: "4px", + display: "inline-block" + }, + children: "Popout plot" }), (0, import_jsx_runtime2.jsx)("div", { id: divId, style: { @@ -210809,7 +210817,7 @@ export default require => { body: debuggerContext => (0, import_jsx_runtime2.jsx)(Plotly, { debuggerContext }), - label: "Plotly Test Tab", + label: "Plotly", iconName: "scatter-plot" }; return __toCommonJS(Plotly_exports);