diff --git a/documentation/functions/ar.addARObject.html b/documentation/functions/ar.addARObject.html index b0e8b2139..9b64bba65 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 41e795181..5544219cd 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 46bda1ad5..835b6e799 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 1d61cacdb..6d36c927b 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 3c6a3739f..5f7fc6a1e 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 f164675df..b64fa74c5 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 d7b16f4dc..f1fc05518 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 19f0a3dbf..59dae7a24 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 528422dc0..344c72d20 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 433055e1e..b9c6aad60 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 a0c21842b..ed41e859f 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 22a0e727f..9b30cdb2e 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 ece1546c4..86aae5c0a 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 2ea912bb9..2bd2892f6 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 1adbb1a59..137a7fbfa 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 5d6363fc7..321cd947e 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 4c35c1eb1..bdac323de 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 9f943513d..8d86833e2 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 b738fc911..a3b2e1099 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 bac84f505..70ce90aff 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 788824877..72b258726 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 65d3f3784..3906f2582 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 bf58de33d..0beca5ff4 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 21f2ebc49..f2086b441 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 44635833d..05161d7b6 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 85ccc89ee..5725c3832 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 75918e8bd..a16a6cd15 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 7cb123009..c13e3f179 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 4b50af19b..229fbb002 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 156998e22..9515e78d8 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 664d07669..4d11a9908 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 265da4e6f..faee34fa2 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 941947b07..9bf9a91ce 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 fe325356e..656cf5977 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 0c01e9a83..e33430645 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 66a6230db..433f3b7e8 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 a88726da2..538cffad2 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 963a6bfec..57170898f 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 996f24b61..f1da44b93 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 937f80860..78acc4f10 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 0d6c2e6bb..99c76aea3 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 907c53a2e..e76d0e7b7 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 334779a5f..351eeabab 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 ec49034c1..c8cec97af 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 56b43c985..236478340 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 4211bacc9..815f9f046 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 b4c40ed00..84eca0ae6 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 1746d8818..5f982606b 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 8b17552e3..c5ced2194 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 fa9e34f12..7e41e42b1 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 d8ff77dca..598c9f1a0 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 70e3c9534..e1f1ef125 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 fb8680893..8abb884b6 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 b3bc42d56..b5129a891 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 f05a6d320..917633446 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 ac25681ca..d4066f32a 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 a44043475..a1095cc99 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 54bf90381..4c6bdd0b4 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 c36782eb6..67062617a 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 7ff5699bc..212f2b65c 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 0c7577f67..f0fdca446 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 408a90b7a..51a593f6b 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 d532b9f2d..37fa131d5 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 9659190ef..377fc9dbf 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 28b974d06..9f2fbceb7 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 af4459bff..3239865fd 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 d17038b90..93b210ba7 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 4aaab7bab..fcc494bc4 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 a5fae5479..93953b10f 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 68414555f..cb77da154 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 83ba8a5c6..0c1bc4ee0 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 4a8e185ec..1d2842377 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 6da98fca7..b7d5c29e6 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 c456c738c..a6d7b5c82 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 98812f6f3..f9b43f706 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 d007925e9..4f9239050 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 06486e7e1..70af0339b 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 bd9eac0d2..5d96976a4 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 452a65637..847e53834 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 e646c1ee7..c60916153 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 5867d6d6f..f218a9562 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 67fb32d08..20d67a4af 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 f27590f2d..66542846f 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 151ebb723..4f05bdd55 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 a3f60f96e..078890205 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 02ccf2cd7..9081e1862 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 9d6e85b27..1b0cb0166 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 0913d7f7e..76dbc05da 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 54f446881..42ae1b1ca 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 74d665fbd..862790758 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 f567b4adb..2245db7aa 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 16adc0b75..d80e4b14c 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 de0db78e0..27047893f 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 d88ff933b..5a25955ac 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 12a47691b..c2978c918 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 dbb3cb0a5..f4bcba30e 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 752846073..8b8ef1067 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 36e23df54..07253d3ff 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 0d239b31d..4ef403702 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 296396be4..66d48fd39 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 bef233be9..cd8005735 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 20d611e71..2c4319e19 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 f4e4ce635..d44374017 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 1d6ff0bfc..928a79598 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 69b88450b..410cdcaab 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 0751a21a9..5ba30ee8b 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 2b131c1c7..ddea6c56f 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 52c7f8623..323e46714 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 a9e66e705..8e6034477 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 991e33b4e..6f666caa3 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 ff35dd609..3766c5639 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 b0a210ca8..c86740a0c 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 9327f87ed..60331a6bd 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 e504f263b..ab7a103c7 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 e4820d163..8a4e9db57 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 2e47823a5..d3bb1a3d9 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 157dfa078..d27c96db6 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 04861be88..a37880d6d 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 a4213a3da..9ecb5bce8 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 81768eeb9..3a6e691c3 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 444c47647..bb2a353bc 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 6206644d4..8b66d8263 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 6b1bf17d9..bdd3a4236 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 f37c2d3e2..c08e6097b 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 ff8306ec1..7d9554162 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 39205c8c2..6209986b7 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 c490f7560..24dbf208d 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 e8b8c2bc3..73ff95b9a 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 e7cef1f71..e11ae336a 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 a1bd993e7..e8311528e 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 dcb73752a..cd78ffa69 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 e1c396d06..4c2a8c9e1 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 3970a61ec..cde11a69c 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 36bd707d7..7be1984b7 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 cdce1f14c..61cdc9336 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 b91d67f41..4e60d3771 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 8c257a923..3cf21b75c 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 51accc0f2..60f3e77af 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 7541fa3ba..033590de6 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 bc01c0003..c389d99fe 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 c35f6ea2e..8227da765 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 6e2b45990..86f103524 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 44cdfb9ec..ee7050ebe 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 5252ccc6a..bf18a81e8 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 d808d30c5..512f9d8c3 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 ae9e51184..b9aedef84 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 6b9ce8e37..1fa7cbcfc 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 481158111..24d559d53 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 a15f1d5cc..4994ae32c 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 7547b2662..76414fefe 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 57eca9c64..dc864207a 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 88f7577cf..a480e3616 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 188270b88..c9823d3d3 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 c0cfa89a0..81cbf1ac0 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 ed4c23546..3e8f38591 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 6d97a3476..f307ddd10 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 00d6d48ad..983f29d36 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 b0aa3a495..4d61ddfd1 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 99a613ac3..0e90bf592 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 315f1a1f8..4e72ea044 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 e2cfa3048..b338cc52d 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 80f50c5f8..fa3988fbc 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 1490e705c..6eae28b99 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 0cc1a4cd6..f70f1cd4b 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 7d9901abe..a7de17df0 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 5537931ed..6afdf4ef6 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 1fdc45385..dc6610d4d 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 ac829b476..fe4e4f3bf 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 d000408b1..1e74d716f 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 90318bc1c..8b86cb184 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 13e54c24a..adc474916 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 17e56c4f7..771142fc9 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 5aeea3e1e..c4682fc1d 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 e0dd29e45..2eed19bde 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 844256ddb..af24d3ee1 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 53e784c79..c6a5c34e4 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 0576d3323..e3043ccd7 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 98eccc8c0..09f4b2a84 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 5b3853ef4..b14239340 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 b3ff1b462..84bcc34c0 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 e4dba067c..e75276498 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 3377e82e9..c4150139f 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 cbf247bc8..22ec264fd 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 c184448d9..4dea6af4f 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 c4621a834..b106751cd 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 135b6549a..5a422540e 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 e08dfc6da..1c62957be 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 8dd92ea39..0c5572cbb 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 0ea32272b..f78a92006 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 881413d77..a0ec042de 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 9ba1215e8..77beb6c6c 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 0c593790d..a9fd26c0c 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 71325636e..90d1e3ef7 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 954dc4057..e989d5346 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 4a507bfaa..e7ba2529e 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 a941d41c6..559b90b66 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 b0c31fd9d..80f4ae877 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 074c08c8b..2f80f3c6f 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 b96c4c197..1a6230b8e 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 1fbedd39f..cf1d47f01 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 49b7f4b4b..cda599058 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 eba24de14..4bb17cf13 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 fba80c131..c9b541a36 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 8436638c6..25ae85222 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 cee09b1c8..1c40ac018 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 4913ac8f2..d43255887 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 8ff1c91db..6561152e4 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 d448a437f..2051e87bb 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 364ddefc8..6ee24a58f 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 659096df3..3968f0e6e 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 57ff6b26b..e738dee01 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 0522716cb..7fefb1d75 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 b4f358eb6..53844c40f 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 b1b069dc8..561b679d5 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 72adebfe8..c22405663 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 4a99fee54..87e3918be 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 eca690bb9..141984bbc 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 749b2626d..21e19a837 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 41fe0b224..3e4e366fa 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 041e863c5..f1449afbf 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 4147968f8..b36e09d60 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 a5110f489..85a92ea46 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 099d25bdb..a2810eb07 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 b9d406585..35f5b4a3f 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 acb11b919..211575593 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 3a8a37fcf..94085d7d8 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 fd070b234..9c0ce9ada 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 687931016..89d952de3 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 91b88e72f..ada84d9d2 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 df4bdb295..74531c9d7 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 b00378687..7072f36e5 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 274ece134..3bbf1ff2f 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 6d0a02346..41ac2b789 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 fe7a53081..5ef8a7584 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 b01918973..ff3b13770 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 ef2df5e60..8ae0b979f 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 97b909e7d..874c07cbf 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 6b92a8cb6..a5a87eb76 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 117bd61ae..91914706b 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 50fbadc2a..926d33dfd 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 c78327b8d..37540d3a9 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 80b409975..fb20f4aaf 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 0d12be307..3bbae9c1c 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 65d4da5c2..5545d3000 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 d4689380b..5b76e1612 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 d2ddecd09..b9d1518d6 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 4eec15f6a..68fdcf941 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 14df3988c..4013763d3 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 1b70b8181..738008e5c 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 0e2b1cfef..db6fa0089 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 ee94ad800..b909b8bda 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 bf0bbfd2c..84d666e08 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 f0964801f..e63169bf1 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 dc7c9ca00..65782eb97 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 c3ef570c4..fd8ef280d 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 3092e48a8..e232f6b18 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 120e8dffd..78e4e8c94 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 374ea8ea4..6a1ff9748 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 744440491..dbc3c12fc 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 cfe98b6f1..425cfa170 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 1613c5595..9083d6476 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 313c18513..a3fffcde4 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 b39fa2d42..8c9e28589 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 8fdb3d268..a86b6d274 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 8a5f3521d..8e5c0dc76 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 4bbe874a9..3b73559f7 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 128e96aea..bdd4b8765 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 776b98c36..2b4a325bf 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 7cbffdee0..6af599f25 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 514f6db89..7c419d4fb 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 ef7578fa9..3d7a16457 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 181106e26..74f9b0501 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 ecf25addc..a0532caa1 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 94ede17f6..50279e57b 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 3ffa613bf..8b5ecd390 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 909389b94..eceae3c84 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 25c3bfd1b..97065c927 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 e9ab1190f..fdac38d76 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 d60582440..2b2bca38a 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 671bcfe27..2eda2c3cf 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 b1057a7e5..a785e2299 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 935c1d191..1bdd23a4c 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 92d877634..52a9a9726 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 bbdba671b..c551d77a3 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 cf60c53c7..3ecc75dda 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 9ced72bfc..2866caf85 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 e637c3341..49efdb184 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 93f71fc47..ef86d72cf 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 bffc83faf..2ef4c8364 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 8267842b1..2a9a0c861 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 3bd0eb07a..dc0138979 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 b72244edf..ab53ca2ab 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 94cee512b..85f71be41 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 0c3ffb1ad..362c04527 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 ee50e48c9..9b3ae47cf 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 737f685c6..a60b7e315 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 c090690ad..89108faf1 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 1bdd657c4..441211b03 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 c8e81becb..d21953c55 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 44d1295e7..65fbe2382 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 78d8fea48..3b3d3c41b 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 b841ca2a0..b6b3848a1 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 b8a13cf04..47f6e82d6 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 f10fd0517..830378847 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 d19f4c4ba..f3b097582 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 63e6f7d3b..00a4067ca 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 5b2c46635..f613b89fe 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 c21170310..1aa25c1c7 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 2b71ef87d..49c965e5e 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 35882eafa..c7a6ea008 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 0428f904d..a515caeef 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 72e9b79c9..88b6d10ef 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 13d33d964..cd463c0e1 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 dd2cc1e91..a21fb869c 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 f157bd4df..ebb4b6ce9 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 800f06992..ae2f28c2f 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 efd22979a..093cd0061 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 67617beb1..a32ba3f8e 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 a358b31f8..0a384099a 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 84a6c0517..9574a567c 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 97885d906..fa15be064 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 192793d52..a4380c537 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 a5df11d2c..2e68f5c49 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 e383c2622..99689c272 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 3c3d92dd9..bcf3384d8 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 a3f6bb558..9671566a7 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 ca3872bad..7c3472792 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 f8fb22676..714d9c743 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 243394f02..670e9be62 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 9c68d0415..d0ddd2108 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 8dc8a6147..305544ecf 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 f6001e40b..6d3b6a2e7 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 dc3f0f123..507cd7d66 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 af183487e..b10be319f 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 f47cd11ee..c1aeb1bb0 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 882d316c7..9eef304bd 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 917d93526..1108417fd 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 07d087db2..969fee850 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 d89e0223b..b024d3f09 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 472e605d4..59de02e0e 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 9d1639309..584132f47 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 fbe311106..c3e79f782 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 7e64499d1..cf003a01b 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 84ca26b39..8885805e3 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 f2ca1872b..5f03cdbeb 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 85aa34f12..4de89b436 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 a1924c303..fbb14d8ea 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 1613c0d8c..1191690db 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 6b0ee0643..fa5033cb9 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 30b42f485..a9743e622 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 906a819fa..619fed12f 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 08a60cdc5..63ea99d15 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 1cc8198cb..503ae1c3c 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 329908c71..d9ec838bb 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 3f9c6d4d6..0a0289630 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 8f9a356ed..8e26c50ff 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 8b1cb1f58..b16ba8370 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 bf0287b0a..1fc215a63 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 c2cfefa95..f6ad8a16c 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 0c2ac02d2..4654a52eb 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 ec1c01a80..288009613 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 a7fd41356..bdb66ff4e 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 3f0519af1..7b2c01401 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 0e0eddf94..bd9624aec 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 19c203f96..522a5b37b 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 98234b53b..4e287926b 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 d09cdd197..345de7feb 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 ca2be69f3..13d1f4346 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 ab18d421e..7c1d5ba37 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 f3e26249f..51c24a858 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 69a98163e..ad21dd6da 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 2b59faddb..70bcaa3fb 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 19fa9b804..fe230a3a8 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 ea0e4f538..c462b6ccb 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 550d7623c..df62aa47b 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 ee4f28d73..630e12cb6 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 99c3f700b..ee88016f2 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 a4b1e5eb2..efe977b4d 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 6894d14f2..8c0ae6148 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 cd1c8b9e5..ed6e696ea 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 148e77464..bcb9ae6d6 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 6e5a8ecce..38af13148 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 d4c409b3e..0d9df6cd1 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 bf6f5affa..484d076ae 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 2b4527d8e..7e1bd4268 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 fcd8a2e5d..c098e260e 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 94134dc8b..3d9fed39c 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 d087d0e7c..c44217e65 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 e305d0661..a02722510 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 7ebd19bc9..dab04ceb3 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 3c74f02bc..f8e86a891 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 b8ad8f4a4..58f9b83df 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 85f6ebd1e..276266bfc 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 a5711c5be..8040a94c7 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 49a80cf33..221fc2a02 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 b39b6200c..d41192bc6 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 3d173c59e..f66abc15b 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 ce40341ac..79c85cde5 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 1e8b6003d..f2a220d3e 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 15e91ed81..c8b413627 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 52032e2c6..1d80ccaa9 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 521970cd9..426a81a6b 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 8ead9dcdf..5848f3c08 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 88d45abef..68af0106e 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 bbf33dd4d..33bfb4c90 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 664854e35..399f75a56 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 ed787cf5a..689a4f97f 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 976583aa5..009f02fc9 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 18cf53a93..f17451a2d 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 7734942b5..c8aa18a45 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 de7e29a29..f11c59cbe 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 874d537a3..b53cd5afb 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 ab11676a8..94bb243bf 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 271fe1e12..39852e624 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 15138a200..743e895bc 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 037a29f28..df9ee8834 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 4344656ea..e7f15cb2e 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 721e7420f..9b46ce796 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 69d15c008..1fd77b9d6 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 b0663dfec..18bd0d142 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 464def7d7..a1564368c 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 509ba17a4..70647ae70 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 3cc2cdbbf..b3ffe2274 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 35c4c8ba2..9574e714c 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 147123919..9404963e0 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 d33bc7980..cafd3cc28 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 98e9b4b30..c85dbf61b 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 482e5c1d4..08a6a7650 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 65da63eac..58bd5318a 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 5169774d3..6517b9a9b 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 f41aa0641..03ed2afab 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 55e4c6b38..28bb25cc0 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 284858d0b..d24ca73f7 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 5622bfceb..f59d81ce5 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 97204c195..c6fdd6b23 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 d0c34584e..241efa13d 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 2526512b2..33ccad8fe 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 b9c15989d..a8f427911 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 e2c341d5a..0eecde07a 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 bb4d6bcc2..bc2dee7a3 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 ee57f5b29..9be52e04a 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 d2ed915e3..8b572c07a 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 3d9d9cfbb..3ac4cabc5 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 66b9503d3..15e1b38e0 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 cf4d3d143..958427834 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 0cb7a39aa..9d5381138 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 03493e629..461181fc4 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 2415026fe..f2a19bd56 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 d49019d31..02d4ad482 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 36b5f5d94..87327fae8 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 a7ed4e7bb..043dba8a3 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 2589b37eb..53db23292 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 29df9245d..309911cea 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 87176c083..67191568e 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 0178378f0..3e304ced3 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 1b552e6e3..d4c33b35e 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 47fa092ee..807ee1e99 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 09439417f..4a2dd88bc 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 1775bcff4..3871ae2cf 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 0a019fd94..d1f59960b 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 e485049b5..90c3bce0c 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 0dc2b8179..0770efabf 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 e51e65df1..08cf2773b 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 186639bdb..2132519f5 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 0af76386c..a4290b1b2 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 a52ee01ca..0d814d0ba 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 cc97cc0a9..a142de98c 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 97a68bb02..d5bf39aaf 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 39265c712..e2d4349bf 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 f9451fb42..d2fd3b7ce 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 450f22709..4102ce440 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 d4ddfb8b4..e7941c3c7 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 965020004..efde2e2e8 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 af8ace7bd..81bf6eff4 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 5953b4e2f..4b52a5180 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 c78820241..a2530a691 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 958714b8c..6dbc067a5 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 4584442c5..8da73e509 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 b61d2c4d0..ad083d21f 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 ad1c5837d..ef34ca86e 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 36ad4b85e..46843f322 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 2cb708c4c..460391557 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 debfcd262..a81e9ce8a 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 d965f3741..7b87741c7 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 cc8320a3d..5e022f8b9 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 304445c96..7de6a9c32 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 063a70606..772e7a979 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 381508f03..7a08bf8f4 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 377b12a93..ab72424ea 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 601a00128..9a2a1af8a 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 aa00f242e..5256745e4 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 f335ee477..ab4e59c02 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 9b4a80ee5..4645719cd 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 bf4e1a77d..6b3db407b 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 87681780f..b121f3b84 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 467b1f620..026f1c709 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 433f72566..4d2707809 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 b3eb6a642..318414e52 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 0a51fc20d..e99c8a140 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 58a7bf23d..fe3145f0c 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 903035ec5..11ca7c862 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 ebc448cb0..20c9a8e4d 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 44b87de17..b48fe554e 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 bbd397d99..1b31fc009 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 c723612d6..e3173c236 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 c1c441b8e..eaf6317c5 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 9def8d888..26dd4b3a9 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 2282f0678..0cd2edf21 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 62b2f9b21..2d2297e3d 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 bdcef897e..d1a1ee6f6 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 50b71ad92..e21a42627 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 2b27ade08..875657383 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 86d31ff1b..4088ee4bd 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 7421ccf8c..ddeecf110 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 502a14802..f0d95ea42 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 035b0afb2..3001c9827 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 16ade7274..a8d943d2d 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 4b7cb51e0..8f5eb6170 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 35c7b68ae..4b0772bbc 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 9f404053a..d8ce0fefe 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 71d3e580d..6ce430dc9 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 28db2e4f5..eeeeb7515 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 224d9038b..2f8240b8f 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 82ad02d36..e2ede764f 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 3716a1d37..b40402a64 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 f92117ed7..8e3ab9681 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 0e64a86cb..78f56f364 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 687687288..4abd9bfbf 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 234aa6fe3..415687357 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 515d4a0ce..4cce631c5 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 77b905af3..c2d7e0aa8 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 1ea200c74..ff8d6e2b4 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 bf62c1567..f5ea95699 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 077fe5e31..88003302e 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 6fb9ee165..7eb8d7892 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 10e936e01..798e9f1a6 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 b601cf6fb..9bc10866e 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 1f6693655..aa0b515a5 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 67dd83e28..93de100fd 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 0d93d0660..7b6b4439c 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 b0bea3945..ea5dff1fe 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 bbac7a159..9c2307888 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 e01ee6287..aaa5d368f 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 30d36e340..f6eeebffb 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 e899fc6d1..c84e4f5eb 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 37465e5ff..3e5e63551 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 0ddad7bb2..8c030ea99 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 28a2765f0..1f657f661 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 23fe5b200..ad165ba96 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 c2ddfbfaf..6503bdc11 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 1c597397a..a54432d85 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 36e43a220..253a5af04 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 237f03a31..8996bf082 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 fd53772c7..d9356987f 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 a2c62d7e9..7226341ac 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 039200d9f..013d3bc35 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 e797bfa6a..b41ce996e 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 b7e0585ed..4badd36cc 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 231fe17af..0b3df2f57 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 1c0e93de9..aec9d594e 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 f9f468263..6ddfb476f 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 811cae08d..060069091 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 3c867ac5e..db8a6d0cd 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 59fcee27c..b85b398ef 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 df512121d..e6e0748a3 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 563c12c3e..113575e52 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 f5004e12b..e747b561e 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 47d2d8917..8235d4b0f 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 25f4f748e..e564501ba 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 33315673c..99b08ea24 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 eef785830..3e71c5ea9 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 dd95bc2cf..88d746621 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 976d4f840..28a1ad539 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 2541e849d..3cf593e14 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 60f6ced2b..2b5062669 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 dad4988ea..7adacdc6f 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 41f7a49d3..81300be39 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 16725e2d7..4053739c7 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 51548e5bd..4694eb077 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 5cc5df3ae..4ceb0268f 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 464013b8d..19101c526 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 860953a58..cdca518ba 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 cdbc05fc4..a92674928 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 f951689be..da95bb0ac 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 da7d5409d..0943b91cd 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 960210a07..c45988419 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 f81cde157..b989fc072 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 7767ca1f9..b451ff8e9 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 e55d6b043..5fb6d3821 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 685f99f23..900bf6dc1 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 70938a434..c908b415b 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 f64015b0a..b453cc59e 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 99244b63d..7ec43fa1d 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 42abed12d..0c2742e6f 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 4dc940250..b2967eae9 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 63e18ba9b..3a2aeb054 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 58dd83177..48ea2c063 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 cb2387467..7462d0b2c 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 006db0c4d..a2ef2831c 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 043082e70..a6f3f8f20 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 abedd39fd..70e1a2851 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 0b86199af..d86199844 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 45a940c43..2cb697ed2 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 c08073ef7..875378d8a 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 d33dbdfa8..9d7d77141 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 0d008c762..0e81d63f4 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 ce79e1690..4d44a2d4f 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 5801545ca..919aad21b 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 642c5fef6..3cadbcb94 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 703bb83ef..9803a8d93 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 5f014cfc0..6ee584af8 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 ca74fbd66..fe6fb7eb6 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 86abfa0be..7cde37a9a 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 0d02305c7..e328c7db5 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 13f158d51..6e9e66b6f 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 48d273c7f..85b9a2c02 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 2c92cf08e..273ff51ee 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 bf75a2e61..7f072f504 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 d35789d22..bcd9fe90d 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 d9f0e34a8..15afe9147 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 c355ecb0b..4a66b6276 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 ca9cd6058..f23465c0a 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 48bf037d7..0c7024a44 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 8f09d1f27..e9694a7ce 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 afa31f3e8..3390c4d38 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 1fd8b6823..88789e0fd 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 91a779e40..32c33fc98 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 c04992f97..35d2c122f 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 58a5ac389..8050b7459 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 2eb53a473..1bdd7744f 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 646f81797..35ca52244 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 b8f6c3bf3..5a72056fc 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 10d30dcbf..76f1a659d 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 f953d7e75..7096cec59 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 9d3fc673b..7bd575b65 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 098ec2140..dc3d7bf61 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 094006a5e..7b38a3732 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 edbb5bf4f..902371289 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 3d1fe994d..0b9d202ed 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 93817ad22..ca41ecbeb 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 a349573a5..772075fcb 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 556704195..b388e8fd9 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 f76b2c7f0..27f0fe00b 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 d13b2932d..e1a153688 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 b773ae533..b97577f55 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 836b4e9ea..e301d5fc2 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 2607a4bed..46816075a 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 07cdc680c..1fa79e747 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 f145c4fcf..e35d28fa7 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 004ce3ffc..c33dac6fa 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 1e1712174..53988a80e 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 0160ade13..ba812e021 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 294b2256b..dcc6160fa 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 8ef17b9a3..69aba9cd0 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 79e51925d..a2a4df6cc 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 c230122dc..dab33da4b 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 93a3d36ca..8124de543 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 8ffb647b3..848e33556 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 8c1cb631d..f0f22a481 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 a10cad7bb..e1ca1f1ea 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