From bd13d5be4e87db17f98248e45f022478c5b5aad2 Mon Sep 17 00:00:00 2001 From: RichDom2185 Date: Sun, 1 Sep 2024 03:56:00 +0000 Subject: [PATCH] deploy: a70e537a801c2645772eebee584905a122092997 --- documentation/functions/ar.addARObject.html | 2 +- documentation/functions/ar.clearARObjects.html | 2 +- documentation/functions/ar.clearMovement.html | 2 +- documentation/functions/ar.createCubeObject.html | 2 +- documentation/functions/ar.createGltfObject.html | 2 +- documentation/functions/ar.createInterfaceBase64Image.html | 2 +- documentation/functions/ar.createInterfaceColumn.html | 2 +- documentation/functions/ar.createInterfaceImage.html | 2 +- documentation/functions/ar.createInterfaceObject.html | 2 +- documentation/functions/ar.createInterfaceRow.html | 2 +- documentation/functions/ar.createInterfaceText.html | 2 +- documentation/functions/ar.createLightObject.html | 2 +- documentation/functions/ar.createPathItem.html | 2 +- documentation/functions/ar.createSphereObject.html | 2 +- documentation/functions/ar.createVector3.html | 2 +- documentation/functions/ar.getARObjects.html | 2 +- documentation/functions/ar.getFrontObject.html | 2 +- documentation/functions/ar.getJsonChild.html | 2 +- documentation/functions/ar.getXPosition.html | 2 +- documentation/functions/ar.getYPosition.html | 2 +- documentation/functions/ar.getZPosition.html | 2 +- documentation/functions/ar.initAR.html | 2 +- documentation/functions/ar.moveARObject.html | 2 +- documentation/functions/ar.removeARObject.html | 2 +- documentation/functions/ar.removeCenterToggle.html | 2 +- documentation/functions/ar.removeLeftToggle.html | 2 +- documentation/functions/ar.removeRightToggle.html | 2 +- documentation/functions/ar.selectObject.html | 2 +- documentation/functions/ar.setAlwaysRender.html | 2 +- documentation/functions/ar.setAsARObjects.html | 2 +- documentation/functions/ar.setCenterToggle.html | 2 +- documentation/functions/ar.setFixedRotation.html | 2 +- documentation/functions/ar.setHighlightFrontObject.html | 2 +- documentation/functions/ar.setLeftToggle.html | 2 +- documentation/functions/ar.setOrbitMovement.html | 2 +- documentation/functions/ar.setPathMovement.html | 2 +- documentation/functions/ar.setRenderDistance.html | 2 +- documentation/functions/ar.setRightToggle.html | 2 +- documentation/functions/ar.setRotateAroundY.html | 2 +- documentation/functions/ar.setRotateToUser.html | 2 +- documentation/functions/ar.setSpringMovement.html | 2 +- documentation/functions/arcade_2d.build_game.html | 2 +- documentation/functions/arcade_2d.create_audio.html | 2 +- documentation/functions/arcade_2d.create_circle.html | 2 +- documentation/functions/arcade_2d.create_rectangle.html | 2 +- documentation/functions/arcade_2d.create_sprite.html | 2 +- documentation/functions/arcade_2d.create_text.html | 2 +- documentation/functions/arcade_2d.create_triangle.html | 2 +- documentation/functions/arcade_2d.debug_log.html | 2 +- documentation/functions/arcade_2d.enable_debug.html | 2 +- documentation/functions/arcade_2d.gameobjects_overlap.html | 2 +- documentation/functions/arcade_2d.get_game_time.html | 2 +- documentation/functions/arcade_2d.get_loop_count.html | 2 +- documentation/functions/arcade_2d.input_key_down.html | 2 +- documentation/functions/arcade_2d.input_left_mouse_down.html | 2 +- documentation/functions/arcade_2d.input_right_mouse_down.html | 2 +- documentation/functions/arcade_2d.loop_audio.html | 2 +- documentation/functions/arcade_2d.play_audio.html | 2 +- documentation/functions/arcade_2d.pointer_over_gameobject.html | 2 +- documentation/functions/arcade_2d.query_color.html | 2 +- documentation/functions/arcade_2d.query_flip.html | 2 +- documentation/functions/arcade_2d.query_id.html | 2 +- documentation/functions/arcade_2d.query_pointer_position.html | 2 +- documentation/functions/arcade_2d.query_position.html | 2 +- documentation/functions/arcade_2d.query_rotation.html | 2 +- documentation/functions/arcade_2d.query_scale.html | 2 +- documentation/functions/arcade_2d.query_text.html | 2 +- documentation/functions/arcade_2d.set_dimensions.html | 2 +- documentation/functions/arcade_2d.set_fps.html | 2 +- documentation/functions/arcade_2d.set_scale.html | 2 +- documentation/functions/arcade_2d.stop_audio.html | 2 +- documentation/functions/arcade_2d.update_color.html | 2 +- documentation/functions/arcade_2d.update_flip.html | 2 +- documentation/functions/arcade_2d.update_loop.html | 2 +- documentation/functions/arcade_2d.update_position.html | 2 +- documentation/functions/arcade_2d.update_rotation.html | 2 +- documentation/functions/arcade_2d.update_scale.html | 2 +- documentation/functions/arcade_2d.update_text.html | 2 +- documentation/functions/arcade_2d.update_to_top.html | 2 +- documentation/functions/binary_tree.entry.html | 2 +- documentation/functions/binary_tree.is_empty_tree.html | 2 +- documentation/functions/binary_tree.is_tree.html | 2 +- documentation/functions/binary_tree.left_branch.html | 2 +- documentation/functions/binary_tree.make_empty_tree.html | 2 +- documentation/functions/binary_tree.make_tree.html | 2 +- documentation/functions/binary_tree.right_branch.html | 2 +- documentation/functions/communication.callFunction.html | 2 +- documentation/functions/communication.expose.html | 2 +- documentation/functions/communication.getGlobalState.html | 2 +- documentation/functions/communication.getUserId.html | 2 +- documentation/functions/communication.initCommunications.html | 2 +- documentation/functions/communication.initGlobalState.html | 2 +- documentation/functions/communication.initRpc.html | 2 +- documentation/functions/communication.keepRunning.html | 2 +- documentation/functions/communication.stopRunning.html | 2 +- documentation/functions/communication.updateGlobalState.html | 2 +- documentation/functions/copy_gc.allHeap.html | 2 +- documentation/functions/copy_gc.doneShowRoot.html | 2 +- documentation/functions/copy_gc.endFlip.html | 2 +- documentation/functions/copy_gc.generateMemory.html | 2 +- documentation/functions/copy_gc.init.html | 2 +- documentation/functions/copy_gc.initialize_memory.html | 2 +- documentation/functions/copy_gc.initialize_tag.html | 2 +- documentation/functions/copy_gc.newAssign.html | 2 +- documentation/functions/copy_gc.newCommand.html | 2 +- documentation/functions/copy_gc.newCopy.html | 2 +- documentation/functions/copy_gc.newNew.html | 2 +- documentation/functions/copy_gc.newPop.html | 2 +- documentation/functions/copy_gc.newPush.html | 2 +- documentation/functions/copy_gc.resetFromSpace.html | 2 +- documentation/functions/copy_gc.resetRoots.html | 2 +- documentation/functions/copy_gc.scanFlip.html | 2 +- documentation/functions/copy_gc.showRoots.html | 2 +- documentation/functions/copy_gc.startFlip.html | 2 +- documentation/functions/copy_gc.updateRoots.html | 2 +- documentation/functions/copy_gc.updateSlotSegment.html | 2 +- documentation/functions/csg.bounding_box.html | 2 +- documentation/functions/csg.cone.html | 2 +- documentation/functions/csg.cube.html | 2 +- documentation/functions/csg.cylinder.html | 2 +- documentation/functions/csg.download_shape_stl.html | 2 +- documentation/functions/csg.empty_shape.html | 2 +- documentation/functions/csg.geodesic_sphere.html | 2 +- documentation/functions/csg.group.html | 2 +- documentation/functions/csg.intersect.html | 2 +- documentation/functions/csg.is_group.html | 2 +- documentation/functions/csg.is_shape.html | 2 +- documentation/functions/csg.prism.html | 2 +- documentation/functions/csg.pyramid.html | 2 +- documentation/functions/csg.render.html | 2 +- documentation/functions/csg.render_axes.html | 2 +- documentation/functions/csg.render_grid.html | 2 +- documentation/functions/csg.render_grid_axes.html | 2 +- documentation/functions/csg.rgb.html | 2 +- documentation/functions/csg.rotate.html | 2 +- documentation/functions/csg.rounded_cube.html | 2 +- documentation/functions/csg.rounded_cylinder.html | 2 +- documentation/functions/csg.scale.html | 2 +- documentation/functions/csg.sphere.html | 2 +- documentation/functions/csg.star.html | 2 +- documentation/functions/csg.subtract.html | 2 +- documentation/functions/csg.torus.html | 2 +- documentation/functions/csg.translate.html | 2 +- documentation/functions/csg.ungroup.html | 2 +- documentation/functions/csg.union.html | 2 +- documentation/functions/curve.animate_3D_curve.html | 2 +- documentation/functions/curve.animate_curve.html | 2 +- documentation/functions/curve.arc.html | 2 +- documentation/functions/curve.b_of.html | 2 +- documentation/functions/curve.connect_ends.html | 2 +- documentation/functions/curve.connect_rigidly.html | 2 +- documentation/functions/curve.draw_3D_connected.html | 2 +- documentation/functions/curve.draw_3D_connected_full_view.html | 2 +- .../curve.draw_3D_connected_full_view_proportional.html | 2 +- documentation/functions/curve.draw_3D_points.html | 2 +- documentation/functions/curve.draw_3D_points_full_view.html | 2 +- .../functions/curve.draw_3D_points_full_view_proportional.html | 2 +- documentation/functions/curve.draw_connected.html | 2 +- documentation/functions/curve.draw_connected_full_view.html | 2 +- .../functions/curve.draw_connected_full_view_proportional.html | 2 +- documentation/functions/curve.draw_points.html | 2 +- documentation/functions/curve.draw_points_full_view.html | 2 +- .../functions/curve.draw_points_full_view_proportional.html | 2 +- documentation/functions/curve.g_of.html | 2 +- documentation/functions/curve.invert.html | 2 +- documentation/functions/curve.make_3D_color_point.html | 2 +- documentation/functions/curve.make_3D_point.html | 2 +- documentation/functions/curve.make_color_point.html | 2 +- documentation/functions/curve.make_point.html | 2 +- documentation/functions/curve.put_in_standard_position.html | 2 +- documentation/functions/curve.r_of.html | 2 +- documentation/functions/curve.rotate_around_origin.html | 2 +- documentation/functions/curve.scale.html | 2 +- documentation/functions/curve.scale_proportional.html | 2 +- documentation/functions/curve.translate.html | 2 +- documentation/functions/curve.unit_circle.html | 2 +- documentation/functions/curve.unit_line.html | 2 +- documentation/functions/curve.unit_line_at.html | 2 +- documentation/functions/curve.x_of.html | 2 +- documentation/functions/curve.y_of.html | 2 +- documentation/functions/curve.z_of.html | 2 +- documentation/functions/game.add.html | 2 +- documentation/functions/game.add_keyboard_listener.html | 2 +- documentation/functions/game.add_listener.html | 2 +- documentation/functions/game.add_to_container.html | 2 +- documentation/functions/game.add_tween.html | 2 +- documentation/functions/game.create_anim.html | 2 +- documentation/functions/game.create_anim_config.html | 2 +- documentation/functions/game.create_anim_frame_config.html | 2 +- .../functions/game.create_anim_spritesheet_frame_configs.html | 2 +- documentation/functions/game.create_award.html | 2 +- documentation/functions/game.create_config.html | 2 +- documentation/functions/game.create_container.html | 2 +- documentation/functions/game.create_ellipse.html | 2 +- documentation/functions/game.create_image.html | 2 +- documentation/functions/game.create_interactive_config.html | 2 +- documentation/functions/game.create_rect.html | 2 +- documentation/functions/game.create_sound_config.html | 2 +- documentation/functions/game.create_spritesheet_config.html | 2 +- documentation/functions/game.create_text.html | 2 +- documentation/functions/game.create_text_config.html | 2 +- documentation/functions/game.create_tween_config.html | 2 +- documentation/functions/game.destroy_obj.html | 2 +- documentation/functions/game.get_screen_display_height.html | 2 +- documentation/functions/game.get_screen_display_width.html | 2 +- documentation/functions/game.get_screen_height.html | 2 +- documentation/functions/game.get_screen_width.html | 2 +- documentation/functions/game.load_image.html | 2 +- documentation/functions/game.load_sound.html | 2 +- documentation/functions/game.load_spritesheet.html | 2 +- documentation/functions/game.play_anim_on_image.html | 2 +- documentation/functions/game.play_sound.html | 2 +- documentation/functions/game.prepend_remote_url.html | 2 +- documentation/functions/game.remove_listener.html | 2 +- documentation/functions/game.set_alpha.html | 2 +- documentation/functions/game.set_display_size.html | 2 +- documentation/functions/game.set_flip.html | 2 +- documentation/functions/game.set_interactive.html | 2 +- documentation/functions/game.set_origin.html | 2 +- documentation/functions/game.set_position.html | 2 +- documentation/functions/game.set_rotation.html | 2 +- documentation/functions/game.set_scale.html | 2 +- documentation/functions/mark_sweep.addRoots.html | 2 +- documentation/functions/mark_sweep.allHeap.html | 2 +- documentation/functions/mark_sweep.endGC.html | 2 +- documentation/functions/mark_sweep.generateMemory.html | 2 +- documentation/functions/mark_sweep.init.html | 2 +- documentation/functions/mark_sweep.initialize_memory.html | 2 +- documentation/functions/mark_sweep.initialize_tag.html | 2 +- documentation/functions/mark_sweep.newAssign.html | 2 +- documentation/functions/mark_sweep.newCommand.html | 2 +- documentation/functions/mark_sweep.newGC.html | 2 +- documentation/functions/mark_sweep.newMark.html | 2 +- documentation/functions/mark_sweep.newNew.html | 2 +- documentation/functions/mark_sweep.newPop.html | 2 +- documentation/functions/mark_sweep.newPush.html | 2 +- documentation/functions/mark_sweep.newSweep.html | 2 +- documentation/functions/mark_sweep.newUpdateSweep.html | 2 +- documentation/functions/mark_sweep.showRoot.html | 2 +- documentation/functions/mark_sweep.showRoots.html | 2 +- documentation/functions/mark_sweep.updateRoots.html | 2 +- documentation/functions/mark_sweep.updateSlotSegment.html | 2 +- documentation/functions/nbody.addVectors.html | 2 +- documentation/functions/nbody.clone.html | 2 +- .../functions/nbody.createBodyCenterTransformation.html | 2 +- documentation/functions/nbody.createCelestialBody.html | 2 +- documentation/functions/nbody.createCentripetalForce.html | 2 +- documentation/functions/nbody.createCoMTransformation.html | 2 +- documentation/functions/nbody.createCombinedForce.html | 2 +- documentation/functions/nbody.createExplicitEulerSim.html | 2 +- documentation/functions/nbody.createForce.html | 2 +- documentation/functions/nbody.createGravity.html | 2 +- documentation/functions/nbody.createLambdaSim.html | 2 +- documentation/functions/nbody.createLambdaTransformation.html | 2 +- documentation/functions/nbody.createPinTransformation.html | 2 +- documentation/functions/nbody.createRotateTransformation.html | 2 +- documentation/functions/nbody.createRungeKutta4Sim.html | 2 +- documentation/functions/nbody.createSemiImplicitEulerSim.html | 2 +- documentation/functions/nbody.createSimulation.html | 2 +- documentation/functions/nbody.createState.html | 2 +- .../functions/nbody.createTimedRotateTransformation.html | 2 +- documentation/functions/nbody.createUniverse.html | 2 +- documentation/functions/nbody.createVector.html | 2 +- documentation/functions/nbody.createVelocityVerletSim.html | 2 +- documentation/functions/nbody.getBodies.html | 2 +- documentation/functions/nbody.getX.html | 2 +- documentation/functions/nbody.getY.html | 2 +- documentation/functions/nbody.getZ.html | 2 +- documentation/functions/nbody.multiplyScalar.html | 2 +- documentation/functions/nbody.playSim.html | 2 +- documentation/functions/nbody.recordSim.html | 2 +- documentation/functions/nbody.setX.html | 2 +- documentation/functions/nbody.setY.html | 2 +- documentation/functions/nbody.setZ.html | 2 +- documentation/functions/nbody.subVectors.html | 2 +- documentation/functions/painter.display_painter.html | 2 +- documentation/functions/painter.draw_line.html | 2 +- documentation/functions/physics_2d.add_box_object.html | 2 +- documentation/functions/physics_2d.add_circle_object.html | 2 +- documentation/functions/physics_2d.add_triangle_object.html | 2 +- documentation/functions/physics_2d.add_vector.html | 2 +- documentation/functions/physics_2d.add_wall.html | 2 +- documentation/functions/physics_2d.apply_force.html | 2 +- documentation/functions/physics_2d.apply_force_to_center.html | 2 +- documentation/functions/physics_2d.array_to_vector.html | 2 +- documentation/functions/physics_2d.get_angular_velocity.html | 2 +- documentation/functions/physics_2d.get_position.html | 2 +- documentation/functions/physics_2d.get_rotation.html | 2 +- documentation/functions/physics_2d.get_velocity.html | 2 +- documentation/functions/physics_2d.impact_start_time.html | 2 +- documentation/functions/physics_2d.is_touching.html | 2 +- documentation/functions/physics_2d.make_force.html | 2 +- documentation/functions/physics_2d.make_ground.html | 2 +- documentation/functions/physics_2d.make_vector.html | 2 +- documentation/functions/physics_2d.scale_size.html | 2 +- documentation/functions/physics_2d.set_angular_velocity.html | 2 +- documentation/functions/physics_2d.set_density.html | 2 +- documentation/functions/physics_2d.set_friction.html | 2 +- documentation/functions/physics_2d.set_gravity.html | 2 +- documentation/functions/physics_2d.set_position.html | 2 +- documentation/functions/physics_2d.set_rotation.html | 2 +- documentation/functions/physics_2d.set_velocity.html | 2 +- documentation/functions/physics_2d.simulate_world.html | 2 +- documentation/functions/physics_2d.subtract_vector.html | 2 +- documentation/functions/physics_2d.update_world.html | 2 +- documentation/functions/physics_2d.vector_to_array.html | 2 +- documentation/functions/pix_n_flix.alpha_of.html | 2 +- documentation/functions/pix_n_flix.blue_of.html | 2 +- documentation/functions/pix_n_flix.compose_filter.html | 2 +- documentation/functions/pix_n_flix.copy_image.html | 2 +- documentation/functions/pix_n_flix.get_video_time.html | 2 +- documentation/functions/pix_n_flix.green_of.html | 2 +- documentation/functions/pix_n_flix.image_height.html | 2 +- documentation/functions/pix_n_flix.image_width.html | 2 +- documentation/functions/pix_n_flix.install_filter.html | 2 +- documentation/functions/pix_n_flix.keep_aspect_ratio.html | 2 +- documentation/functions/pix_n_flix.pause_at.html | 2 +- documentation/functions/pix_n_flix.red_of.html | 2 +- documentation/functions/pix_n_flix.reset_filter.html | 2 +- documentation/functions/pix_n_flix.set_dimensions.html | 2 +- documentation/functions/pix_n_flix.set_fps.html | 2 +- documentation/functions/pix_n_flix.set_loop_count.html | 2 +- documentation/functions/pix_n_flix.set_rgba.html | 2 +- documentation/functions/pix_n_flix.set_volume.html | 2 +- documentation/functions/pix_n_flix.start.html | 2 +- documentation/functions/pix_n_flix.use_image_url.html | 2 +- documentation/functions/pix_n_flix.use_local_file.html | 2 +- documentation/functions/pix_n_flix.use_video_url.html | 2 +- documentation/functions/plotly.draw_connected_2d.html | 2 +- documentation/functions/plotly.draw_connected_3d.html | 2 +- documentation/functions/plotly.draw_points_2d.html | 2 +- documentation/functions/plotly.draw_points_3d.html | 2 +- documentation/functions/plotly.draw_sound_2d.html | 2 +- documentation/functions/plotly.new_plot.html | 2 +- documentation/functions/plotly.new_plot_json.html | 2 +- documentation/functions/repeat.repeat.html | 2 +- documentation/functions/repeat.thrice.html | 2 +- documentation/functions/repeat.twice.html | 2 +- documentation/functions/repl.default_js_slang.html | 2 +- documentation/functions/repl.repl_display.html | 2 +- documentation/functions/repl.set_background_image.html | 2 +- documentation/functions/repl.set_evaluator.html | 2 +- documentation/functions/repl.set_font_size.html | 2 +- documentation/functions/repl.set_program_text.html | 2 +- .../functions/robot_simulation.addControllerToWorld.html | 2 +- documentation/functions/robot_simulation.createCSE.html | 2 +- documentation/functions/robot_simulation.createCuboid.html | 2 +- .../functions/robot_simulation.createCustomPhysics.html | 2 +- documentation/functions/robot_simulation.createEv3.html | 2 +- documentation/functions/robot_simulation.createFloor.html | 2 +- documentation/functions/robot_simulation.createPaper.html | 2 +- documentation/functions/robot_simulation.createPhysics.html | 2 +- documentation/functions/robot_simulation.createRenderer.html | 2 +- .../functions/robot_simulation.createRobotConsole.html | 2 +- documentation/functions/robot_simulation.createTimer.html | 2 +- documentation/functions/robot_simulation.createWall.html | 2 +- documentation/functions/robot_simulation.createWorld.html | 2 +- documentation/functions/robot_simulation.ev3_colorSensor.html | 2 +- .../functions/robot_simulation.ev3_colorSensorBlue.html | 2 +- .../functions/robot_simulation.ev3_colorSensorGreen.html | 2 +- .../functions/robot_simulation.ev3_colorSensorRed.html | 2 +- documentation/functions/robot_simulation.ev3_motorA.html | 2 +- documentation/functions/robot_simulation.ev3_motorB.html | 2 +- documentation/functions/robot_simulation.ev3_motorC.html | 2 +- documentation/functions/robot_simulation.ev3_motorD.html | 2 +- documentation/functions/robot_simulation.ev3_pause.html | 2 +- .../functions/robot_simulation.ev3_runToRelativePosition.html | 2 +- .../functions/robot_simulation.ev3_ultrasonicSensor.html | 2 +- .../robot_simulation.ev3_ultrasonicSensorDistance.html | 2 +- documentation/functions/robot_simulation.init_simulation.html | 2 +- documentation/functions/robot_simulation.saveToContext.html | 2 +- documentation/functions/rune.anaglyph.html | 2 +- documentation/functions/rune.animate_anaglyph.html | 2 +- documentation/functions/rune.animate_rune.html | 2 +- documentation/functions/rune.beside.html | 2 +- documentation/functions/rune.beside_frac.html | 2 +- documentation/functions/rune.black.html | 2 +- documentation/functions/rune.blue.html | 2 +- documentation/functions/rune.brown.html | 2 +- documentation/functions/rune.color.html | 2 +- documentation/functions/rune.flip_horiz.html | 2 +- documentation/functions/rune.flip_vert.html | 2 +- documentation/functions/rune.from_url.html | 2 +- documentation/functions/rune.green.html | 2 +- documentation/functions/rune.hollusion.html | 2 +- documentation/functions/rune.hollusion_magnitude.html | 2 +- documentation/functions/rune.indigo.html | 2 +- documentation/functions/rune.make_cross.html | 2 +- documentation/functions/rune.orange.html | 2 +- documentation/functions/rune.overlay.html | 2 +- documentation/functions/rune.overlay_frac.html | 2 +- documentation/functions/rune.pink.html | 2 +- documentation/functions/rune.purple.html | 2 +- documentation/functions/rune.quarter_turn_left.html | 2 +- documentation/functions/rune.quarter_turn_right.html | 2 +- documentation/functions/rune.random_color.html | 2 +- documentation/functions/rune.red.html | 2 +- documentation/functions/rune.repeat_pattern.html | 2 +- documentation/functions/rune.rotate.html | 2 +- documentation/functions/rune.scale.html | 2 +- documentation/functions/rune.scale_independent.html | 2 +- documentation/functions/rune.show.html | 2 +- documentation/functions/rune.stack.html | 2 +- documentation/functions/rune.stack_frac.html | 2 +- documentation/functions/rune.stackn.html | 2 +- documentation/functions/rune.translate.html | 2 +- documentation/functions/rune.turn_upside_down.html | 2 +- documentation/functions/rune.white.html | 2 +- documentation/functions/rune.yellow.html | 2 +- documentation/functions/rune_in_words.anaglyph.html | 2 +- documentation/functions/rune_in_words.beside.html | 2 +- documentation/functions/rune_in_words.beside_frac.html | 2 +- documentation/functions/rune_in_words.black.html | 2 +- documentation/functions/rune_in_words.blue.html | 2 +- documentation/functions/rune_in_words.brown.html | 2 +- documentation/functions/rune_in_words.color.html | 2 +- documentation/functions/rune_in_words.flip_horiz.html | 2 +- documentation/functions/rune_in_words.flip_vert.html | 2 +- documentation/functions/rune_in_words.from_url.html | 2 +- documentation/functions/rune_in_words.green.html | 2 +- documentation/functions/rune_in_words.hollusion.html | 2 +- documentation/functions/rune_in_words.indigo.html | 2 +- documentation/functions/rune_in_words.make_cross.html | 2 +- documentation/functions/rune_in_words.orange.html | 2 +- documentation/functions/rune_in_words.overlay.html | 2 +- documentation/functions/rune_in_words.overlay_frac.html | 2 +- documentation/functions/rune_in_words.pink.html | 2 +- documentation/functions/rune_in_words.purple.html | 2 +- documentation/functions/rune_in_words.quarter_turn_left.html | 2 +- documentation/functions/rune_in_words.quarter_turn_right.html | 2 +- documentation/functions/rune_in_words.random_color.html | 2 +- documentation/functions/rune_in_words.red.html | 2 +- documentation/functions/rune_in_words.repeat_pattern.html | 2 +- documentation/functions/rune_in_words.rotate.html | 2 +- documentation/functions/rune_in_words.scale.html | 2 +- documentation/functions/rune_in_words.scale_independent.html | 2 +- documentation/functions/rune_in_words.show.html | 2 +- documentation/functions/rune_in_words.stack.html | 2 +- documentation/functions/rune_in_words.stack_frac.html | 2 +- documentation/functions/rune_in_words.stackn.html | 2 +- documentation/functions/rune_in_words.translate.html | 2 +- documentation/functions/rune_in_words.turn_upside_down.html | 2 +- documentation/functions/rune_in_words.white.html | 2 +- documentation/functions/rune_in_words.yellow.html | 2 +- documentation/functions/sound.adsr.html | 2 +- documentation/functions/sound.bell.html | 2 +- documentation/functions/sound.cello.html | 2 +- documentation/functions/sound.consecutively.html | 2 +- documentation/functions/sound.get_duration.html | 2 +- documentation/functions/sound.get_wave.html | 2 +- documentation/functions/sound.init_record.html | 2 +- documentation/functions/sound.is_sound.html | 2 +- documentation/functions/sound.letter_name_to_frequency.html | 2 +- documentation/functions/sound.letter_name_to_midi_note.html | 2 +- documentation/functions/sound.make_sound.html | 2 +- documentation/functions/sound.midi_note_to_frequency.html | 2 +- documentation/functions/sound.noise_sound.html | 2 +- documentation/functions/sound.phase_mod.html | 2 +- documentation/functions/sound.piano.html | 2 +- documentation/functions/sound.play.html | 2 +- documentation/functions/sound.play_in_tab.html | 2 +- documentation/functions/sound.play_wave.html | 2 +- documentation/functions/sound.record.html | 2 +- documentation/functions/sound.record_for.html | 2 +- documentation/functions/sound.sawtooth_sound.html | 2 +- documentation/functions/sound.silence_sound.html | 2 +- documentation/functions/sound.simultaneously.html | 2 +- documentation/functions/sound.sine_sound.html | 2 +- documentation/functions/sound.square_sound.html | 2 +- documentation/functions/sound.stacking_adsr.html | 2 +- documentation/functions/sound.stop.html | 2 +- documentation/functions/sound.triangle_sound.html | 2 +- documentation/functions/sound.trombone.html | 2 +- documentation/functions/sound.violin.html | 2 +- documentation/functions/sound_matrix.clear_all_timeout.html | 2 +- documentation/functions/sound_matrix.get_matrix.html | 2 +- documentation/functions/sound_matrix.set_timeout.html | 2 +- documentation/functions/stereo_sound.adsr.html | 2 +- documentation/functions/stereo_sound.bell.html | 2 +- documentation/functions/stereo_sound.cello.html | 2 +- documentation/functions/stereo_sound.consecutively.html | 2 +- documentation/functions/stereo_sound.get_duration.html | 2 +- documentation/functions/stereo_sound.get_left_wave.html | 2 +- documentation/functions/stereo_sound.get_right_wave.html | 2 +- documentation/functions/stereo_sound.init_record.html | 2 +- documentation/functions/stereo_sound.is_sound.html | 2 +- .../functions/stereo_sound.letter_name_to_frequency.html | 2 +- .../functions/stereo_sound.letter_name_to_midi_note.html | 2 +- documentation/functions/stereo_sound.make_sound.html | 2 +- documentation/functions/stereo_sound.make_stereo_sound.html | 2 +- .../functions/stereo_sound.midi_note_to_frequency.html | 2 +- documentation/functions/stereo_sound.noise_sound.html | 2 +- documentation/functions/stereo_sound.pan.html | 2 +- documentation/functions/stereo_sound.pan_mod.html | 2 +- documentation/functions/stereo_sound.phase_mod.html | 2 +- documentation/functions/stereo_sound.piano.html | 2 +- documentation/functions/stereo_sound.play.html | 2 +- documentation/functions/stereo_sound.play_in_tab.html | 2 +- documentation/functions/stereo_sound.play_wave.html | 2 +- documentation/functions/stereo_sound.play_waves.html | 2 +- documentation/functions/stereo_sound.record.html | 2 +- documentation/functions/stereo_sound.record_for.html | 2 +- documentation/functions/stereo_sound.sawtooth_sound.html | 2 +- documentation/functions/stereo_sound.silence_sound.html | 2 +- documentation/functions/stereo_sound.simultaneously.html | 2 +- documentation/functions/stereo_sound.sine_sound.html | 2 +- documentation/functions/stereo_sound.square_sound.html | 2 +- documentation/functions/stereo_sound.squash.html | 2 +- documentation/functions/stereo_sound.stacking_adsr.html | 2 +- documentation/functions/stereo_sound.stop.html | 2 +- documentation/functions/stereo_sound.triangle_sound.html | 2 +- documentation/functions/stereo_sound.trombone.html | 2 +- documentation/functions/stereo_sound.violin.html | 2 +- documentation/functions/unity_academy.add_impulse_force.html | 2 +- documentation/functions/unity_academy.add_vectors.html | 2 +- documentation/functions/unity_academy.apply_rigidbody.html | 2 +- documentation/functions/unity_academy.copy_position.html | 2 +- documentation/functions/unity_academy.copy_rotation.html | 2 +- documentation/functions/unity_academy.copy_scale.html | 2 +- documentation/functions/unity_academy.cross.html | 2 +- documentation/functions/unity_academy.debug_log.html | 2 +- documentation/functions/unity_academy.debug_logerror.html | 2 +- documentation/functions/unity_academy.debug_logwarning.html | 2 +- documentation/functions/unity_academy.delta_time.html | 2 +- documentation/functions/unity_academy.destroy.html | 2 +- documentation/functions/unity_academy.dot.html | 2 +- documentation/functions/unity_academy.gameobject_distance.html | 2 +- documentation/functions/unity_academy.get_angular_velocity.html | 2 +- documentation/functions/unity_academy.get_custom_prop.html | 2 +- documentation/functions/unity_academy.get_key.html | 2 +- documentation/functions/unity_academy.get_key_down.html | 2 +- documentation/functions/unity_academy.get_key_up.html | 2 +- .../unity_academy.get_main_camera_following_target.html | 2 +- documentation/functions/unity_academy.get_mass.html | 2 +- documentation/functions/unity_academy.get_position.html | 2 +- documentation/functions/unity_academy.get_rotation_euler.html | 2 +- documentation/functions/unity_academy.get_scale.html | 2 +- documentation/functions/unity_academy.get_velocity.html | 2 +- documentation/functions/unity_academy.get_x.html | 2 +- documentation/functions/unity_academy.get_y.html | 2 +- documentation/functions/unity_academy.get_z.html | 2 +- documentation/functions/unity_academy.gui_button.html | 2 +- documentation/functions/unity_academy.gui_label.html | 2 +- .../functions/unity_academy.init_unity_academy_2d.html | 2 +- .../functions/unity_academy.init_unity_academy_3d.html | 2 +- documentation/functions/unity_academy.instantiate.html | 2 +- documentation/functions/unity_academy.instantiate_empty.html | 2 +- documentation/functions/unity_academy.instantiate_sprite.html | 2 +- documentation/functions/unity_academy.look_at.html | 2 +- documentation/functions/unity_academy.magnitude.html | 2 +- documentation/functions/unity_academy.normalize.html | 2 +- documentation/functions/unity_academy.on_collision_enter.html | 2 +- documentation/functions/unity_academy.on_collision_exit.html | 2 +- documentation/functions/unity_academy.on_collision_stay.html | 2 +- documentation/functions/unity_academy.play_animator_state.html | 2 +- documentation/functions/unity_academy.point_distance.html | 2 +- .../functions/unity_academy.remove_collider_components.html | 2 +- .../unity_academy.request_for_main_camera_control.html | 2 +- documentation/functions/unity_academy.rotate_world.html | 2 +- documentation/functions/unity_academy.same_gameobject.html | 2 +- documentation/functions/unity_academy.scale_vector.html | 2 +- documentation/functions/unity_academy.set_angular_drag.html | 2 +- documentation/functions/unity_academy.set_angular_velocity.html | 2 +- documentation/functions/unity_academy.set_custom_prop.html | 2 +- documentation/functions/unity_academy.set_drag.html | 2 +- documentation/functions/unity_academy.set_mass.html | 2 +- documentation/functions/unity_academy.set_position.html | 2 +- documentation/functions/unity_academy.set_rotation_euler.html | 2 +- documentation/functions/unity_academy.set_scale.html | 2 +- documentation/functions/unity_academy.set_start.html | 2 +- documentation/functions/unity_academy.set_update.html | 2 +- documentation/functions/unity_academy.set_use_gravity.html | 2 +- documentation/functions/unity_academy.set_velocity.html | 2 +- documentation/functions/unity_academy.translate_local.html | 2 +- documentation/functions/unity_academy.translate_world.html | 2 +- documentation/functions/unity_academy.vector3.html | 2 +- documentation/functions/unity_academy.vector_difference.html | 2 +- documentation/functions/unity_academy.zero_vector.html | 2 +- documentation/functions/wasm.wcompile.html | 2 +- documentation/functions/wasm.wrun.html | 2 +- documentation/modules/ar.html | 2 +- documentation/modules/arcade_2d.html | 2 +- documentation/modules/binary_tree.html | 2 +- documentation/modules/communication.html | 2 +- documentation/modules/copy_gc.html | 2 +- documentation/modules/csg.html | 2 +- documentation/modules/curve.html | 2 +- documentation/modules/game.html | 2 +- documentation/modules/mark_sweep.html | 2 +- documentation/modules/nbody.html | 2 +- documentation/modules/painter.html | 2 +- documentation/modules/physics_2d.html | 2 +- documentation/modules/pix_n_flix.html | 2 +- documentation/modules/plotly.html | 2 +- documentation/modules/remote_execution.html | 2 +- documentation/modules/repeat.html | 2 +- documentation/modules/repl.html | 2 +- documentation/modules/robot_simulation.html | 2 +- documentation/modules/rune.html | 2 +- documentation/modules/rune_in_words.html | 2 +- documentation/modules/scrabble.html | 2 +- documentation/modules/sound.html | 2 +- documentation/modules/sound_matrix.html | 2 +- documentation/modules/stereo_sound.html | 2 +- documentation/modules/unity_academy.html | 2 +- documentation/modules/wasm.html | 2 +- documentation/variables/ar.alignmentBottom.html | 2 +- documentation/variables/ar.alignmentCenter.html | 2 +- documentation/variables/ar.alignmentLeft.html | 2 +- documentation/variables/ar.alignmentMiddle.html | 2 +- documentation/variables/ar.alignmentRight.html | 2 +- documentation/variables/ar.alignmentTop.html | 2 +- documentation/variables/communication.STATE_CONNECTED.html | 2 +- documentation/variables/communication.STATE_DISCONNECTED.html | 2 +- documentation/variables/communication.STATE_OFFLINE.html | 2 +- documentation/variables/communication.STATE_RECONNECTING.html | 2 +- documentation/variables/csg.black.html | 2 +- documentation/variables/csg.blue.html | 2 +- documentation/variables/csg.crimson.html | 2 +- documentation/variables/csg.cyan.html | 2 +- documentation/variables/csg.gray.html | 2 +- documentation/variables/csg.green.html | 2 +- documentation/variables/csg.lime.html | 2 +- documentation/variables/csg.navy.html | 2 +- documentation/variables/csg.orange.html | 2 +- documentation/variables/csg.pink.html | 2 +- documentation/variables/csg.purple.html | 2 +- documentation/variables/csg.rose.html | 2 +- documentation/variables/csg.silver.html | 2 +- documentation/variables/csg.teal.html | 2 +- documentation/variables/csg.white.html | 2 +- documentation/variables/csg.yellow.html | 2 +- documentation/variables/remote_execution.EV3.html | 2 +- documentation/variables/rune.blank.html | 2 +- documentation/variables/rune.circle.html | 2 +- documentation/variables/rune.corner.html | 2 +- documentation/variables/rune.heart.html | 2 +- documentation/variables/rune.nova.html | 2 +- documentation/variables/rune.pentagram.html | 2 +- documentation/variables/rune.rcross.html | 2 +- documentation/variables/rune.ribbon.html | 2 +- documentation/variables/rune.sail.html | 2 +- documentation/variables/rune.square.html | 2 +- documentation/variables/rune.triangle.html | 2 +- documentation/variables/rune_in_words.blank.html | 2 +- documentation/variables/rune_in_words.circle.html | 2 +- documentation/variables/rune_in_words.corner.html | 2 +- documentation/variables/rune_in_words.heart.html | 2 +- documentation/variables/rune_in_words.nova.html | 2 +- documentation/variables/rune_in_words.pentagram.html | 2 +- documentation/variables/rune_in_words.rcross.html | 2 +- documentation/variables/rune_in_words.ribbon.html | 2 +- documentation/variables/rune_in_words.sail.html | 2 +- documentation/variables/rune_in_words.square.html | 2 +- documentation/variables/rune_in_words.triangle.html | 2 +- documentation/variables/scrabble.scrabble_letters.html | 2 +- documentation/variables/scrabble.scrabble_letters_tiny.html | 2 +- documentation/variables/scrabble.scrabble_words.html | 2 +- documentation/variables/scrabble.scrabble_words_tiny.html | 2 +- documentation/variables/sound_matrix.ToneMatrix.html | 2 +- 660 files changed, 660 insertions(+), 660 deletions(-) diff --git a/documentation/functions/ar.addARObject.html b/documentation/functions/ar.addARObject.html index 36bfe3f25..361c7ba12 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 fef4d12b4..df0fd9887 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 aa14ef732..10a0174ea 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 2a8785708..d65399735 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 722287a38..8b19dd9cb 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 79bbc85c8..5440eb48f 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 f358175be..00a168794 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 c2e4f3b1f..9b20c54aa 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 e1fbf486a..10c30d728 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 f398028e7..7f2d3fdd2 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 3f3a4ae3a..58becd913 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 8791aa963..1fafcbaa2 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 11f7490ce..59bca8041 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 1d917f44e..3077eee03 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 b6741148e..e0b18ad4a 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 fc8072134..e8983680f 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 dd5fd3c65..77bc84715 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 e979fa05e..5779af5fd 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 5bc7fcab4..a02ef82b2 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 e746b4a4e..2871db8ca 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 0b412d3cb..64f8dda43 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 d1bbba022..d9362f702 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 e8409a2d0..a0c9ab4d5 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 63b381c19..a8a531e93 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 c09c35642..2d24e08da 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 9cd404985..49d7918cb 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 d09080a0d..366653089 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 527334bde..956964745 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 b7245ca4b..0c7ccfdd5 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 4106382df..190616fc5 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 2e5232a6b..a569b85c6 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 6f1dfa4f7..9b9558381 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 c87fe986f..6eb80bba0 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 d2e2cc378..b8da1ff59 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 624374a51..45a8d6495 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 b762e6f33..adbb3886a 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 0401a1375..97d5ff130 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 cb2286d7f..6a89d8607 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 bb2df3a0e..a6523a84d 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 a2b434054..b735d6e50 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 e7047b9f1..585e9dcb6 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 10a1c152f..1bb829f56 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 930eb7d22..a98f7cd5f 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 7eb9c89dd..94c758f73 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 7d2f7bc51..7b042a2d3 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 829e5d77b..2eb40405c 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 33e6e3e26..a305cc8d0 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 69509c21e..d840a5298 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 90ae4dfb1..10c5a37d5 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 f6445ab74..b9e2d24e7 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 39909e5f0..d81abda3c 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 ea55d512f..93c4e547b 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 63d5d08c7..256cc5ee3 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 a74e9da88..af9834ac9 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 890deced0..5cefaf8f0 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 3ec4cb4ad..8bf423721 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 2d86215e4..cb335d492 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 543f74e9b..ac7cb00fc 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 a2a0d17bc..bc3b0b7f4 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 6af4e4b16..087844f6c 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 d93accc1c..1029b90a6 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 cf9b49adb..f9af74834 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 768de0be1..42cda8115 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 c9878dcad..853e1863c 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 546d1979f..44fd0e0cc 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 91202aa5c..1c3730c5f 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 48bb705fe..f17deb20d 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 a684a92af..79ea83218 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 53e9577ab..e7fe9de48 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 2cf90b982..70764cab9 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 2696211c3..3562ed73b 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 796ff6a35..3f336c10c 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 ba8183a99..d5a4e6b5b 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 dd7188469..3cd315a8d 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 757444928..d00caddbc 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 b77b6274a..ea2158690 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 6c63ee68d..2fe12acfc 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 8bfc763fb..4d7932935 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 d73b74272..f348113e3 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 3a7ee82d2..814383132 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 c91bfc8de..e099890e3 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 099488153..545e5cf18 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 822d1790a..611bfa693 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 a3b4f3866..ca4e5d6ee 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 30a325515..6b7311727 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 6fe41e3ae..d12da19ca 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 fa38cc1e5..29c3ec31f 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 de2847468..cf2f3d379 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 dbe34cda2..709585774 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 bb4ab1e0f..5040eecb0 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 e157b45fb..e96ceb2b1 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 31c3475fa..f360677c0 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 97a318dc5..a3ea8de8f 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 245f90b36..1af3b5fc1 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 d6086a414..99a5a8dd4 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 d82f8b692..9350f16f0 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 ead184695..4eb95938d 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 47356bc8c..1c499c9ef 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 47f20cd01..603955f7b 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 610e19a66..6c36ae4df 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 5557a009b..1fcf45629 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 b499b498d..1778de70a 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 b3a122223..284a8a63f 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 7e0741c4b..7cb3abd09 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 c416a7494..eea7dc2bd 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 084888af2..6e2874ff5 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 07b08d6fd..68bcacfdf 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 ba4fa405d..95d589452 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 f8730328f..6871a2d67 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 ee1e6a2df..1779c74df 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 229ab9f6b..cfbf9c86b 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 5e4a49c34..d31693e52 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 6d2b708d3..65f996561 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 8fba586f4..18907f8f1 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 007cdfcdb..3759c850c 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 0a78563e2..0de9c8525 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 a585853d8..be5699d2a 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 615bbba4a..8e554ac0a 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 2a6f9ae8d..f3ae5e662 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 5ff5ca347..519c6db86 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 c4c9fd2d3..96ceca78e 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 3213b9359..f579b6031 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 1aa7a20d2..b271ecf7b 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 d00655ccc..ca9ba99f0 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 0cbe84fe8..05e8ef0af 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 432e416e6..1e7c6dc76 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 d6bef3ce7..a484bc18d 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 b777a6675..52788e3ed 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 c7b30401c..96e240f7e 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 6e235d01d..4856cdc01 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 be4897e8b..85ef40322 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 db0c8762a..c2678616f 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 56e26b136..42ceefa17 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 b7e3b21d4..f45813bf1 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 8b7ac5c91..b4c335e0a 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 5b9f9cb87..05e72c2d3 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 d70cad0fb..ee1d3b717 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 cf58100a6..87babeb24 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 446670c54..41008038f 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 69022f811..108d153f3 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 323aed992..66ae21a7a 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 a34489145..1e41ebfb2 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 33174bab7..0a5975c2c 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 71642a386..347756bf1 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 e0adad2c8..b792d0e38 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 244f47bd2..44722d997 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 3bfbc01b9..a436d20eb 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 694ef5831..272f066b1 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 233ed2492..ed0bac667 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 cc938d673..b3bebaf4b 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 6319e44ea..931f8a145 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 7e30198a5..d190a7967 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 8bb45e1ac..a3d8ccbde 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 2c98ad18a..9dfc62f81 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 1549b1363..6b396f904 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 293e0c589..7e23d97da 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 8e2966cdf..6e87469b2 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 291a301a0..658fd1ee7 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 3b3a98f36..cfbd5e682 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 e74451b57..5453f3c41 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 f6bf4726a..daa643803 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 a6512007f..7eb040b91 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 8d03b92f8..b3d5eb2ca 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 e729818af..d22af0743 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 fda0f72ec..3343176f3 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 fa89d13bc..0809c2658 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 e73da8323..a9e941f93 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 a4a66837d..add40f29c 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 2126ba372..b298085fe 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 849973641..211d5c6a8 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 0b6a2c4e5..af34f5925 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 1660106c4..1bf7ca46b 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 ab0a1a664..5edffdca2 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 240fc95a0..580e72486 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 08a92415d..2fb5d525c 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 dfabe5651..8bf557150 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 11ab6610d..e92265508 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 44b0a7038..fd91b8a8a 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 c05d14e18..55aaabd49 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 269195236..e7f77aa40 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 9abc56184..610921b50 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 96c9c7dbb..ab07547d4 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 7d2531951..c59a9ad6c 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 2c682cc1a..2dbf6bf0e 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 7fb9af4b5..2f365d083 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 1062805c7..cc0caa3c2 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 112e5ac64..a288f18e4 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 9481335b5..4625f4ef0 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 01473b128..bc831e8ca 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 59ef2ed9f..fdbe98a95 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 0a9e2e06e..aec4c9563 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 614d11ce6..a24e712ed 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 b2ecd056e..6974d1c50 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 9cab20c8f..ebac93aa9 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 1fc81e6ff..3fbd1aac1 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 65a44f98c..8c7322367 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 13ec73a8c..95bc31328 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 7d233d287..1613376f8 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 605468f8b..9732eedbd 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 4b6e8f466..6f48367eb 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 c458bd68d..3f2dd1961 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 1f4040e87..f3724ca75 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 280405533..694b4f49c 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 9dce08b8a..1ee7ebd2e 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 cc4ef0f43..011740a8b 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 9af9e88d0..70e7a29b1 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 e05c2d463..050867aa4 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 8d82ab606..07cb9fb8e 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 af2a02d7c..646c8daea 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 90ccf059e..6365cafab 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 c15309e0e..e66b48d21 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 42bb5f4ed..1d6869135 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 6c2f8d858..1e449075a 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 98e03e739..9c6f630dd 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 752801461..2ab3eb617 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 aebe1d808..1354cf9d8 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 a567feb5f..18a7337a4 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 8fbd2bebf..a06d49ed3 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 9dc051138..b2455a502 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 7712d9f73..a8fe4978f 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 89366fbd8..70be51125 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 dec30f545..f4c4394ba 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 76ae8bf05..99695891b 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 992356ffe..13a32731b 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 7f6dff441..ec29ae212 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 653102710..cde46ab16 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 11dd88187..f6774aa63 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 f5e25b9fa..b64fc019f 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 08fe7541e..4a61aeefc 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 f46d6081d..590929d1a 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 767df8810..1ffcda806 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 6b6980b32..dcdb864e5 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 2216337b8..25e240c62 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 ff94789e7..4729d9046 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 84159c07f..d09709167 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 4012fd63a..126cea4b8 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 0b326ddd6..02403a98c 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 6f0b8f927..5f7d7b700 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 65c039920..0ce3e08d2 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 bf45da16c..3ba30cd5f 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 f0a1dd742..393eee931 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 e9adec6a9..7347e6d17 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 73dc57d4a..0e887bde4 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 6a428a82c..0415b21aa 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 9b405ea70..4dbbd3508 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 78e72e043..7463ae8d2 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 28c91f5b8..dd7824693 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 c5ac7016f..14761a66f 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 1267f4ae7..974c8ae36 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 65747677e..2b765946d 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 1266bada1..44e8908b9 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 26098756c..261c892e6 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 121458ea5..ddb11ea9d 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 309ac8cf2..3426006fb 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 c500c7340..2102aa486 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 41ad7bf1b..9f7950245 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 1875b3292..1a9a360e2 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 7b0e00e72..a88adbf47 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 ea9d6432d..4955b24b3 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 7efa2996f..8d09d3cf0 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 1df941144..2a9c03f3b 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 d2f416a99..5fe2adf30 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 4c0c0beab..6b3e47588 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 424019aae..be05ba344 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 81385d26b..07f2801cf 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 f1ebaf4ec..96ec2fa74 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 e3b8360c3..18d23bf46 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 009ab11a1..f0bb5fa56 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 22c797661..114f93f00 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 63bc64795..02b357be5 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 f27c57707..2e09052c8 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 f142c22ea..15ff96006 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 f6e7c5f81..04c3c68d1 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 ce4fca729..eb98e53cf 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 f379c7f0b..4c1829551 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 dc99cc332..cee282319 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 f1e9af722..bf45e7e3c 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 fa1e071bb..e7c4de911 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 cca04b35e..288e7d534 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 0f7a6c839..293b658c5 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 90ce5b59e..250564c09 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 6a5633a2e..5d0d38d20 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 f4c5ecd46..1a7184c04 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 e638f9d47..fe9407b96 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 e3962a4e4..d86e598f6 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 ee4ac95d8..5adb3ec70 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 60f84fa19..a503eacda 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 339e7ed42..9da00b9bb 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 5bd40570e..798957b2b 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 3ed55d876..1d9e905ea 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 5abc6dedf..ce44b955d 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 3f0c0a63d..e42b56765 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 abb53be2c..75fdb5fec 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 dd011646a..c4fa446c1 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 c0852a9fe..82cd5578e 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 3faa1984a..4eae90304 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 d29904773..d4c6e6e12 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 4053bfa87..83120801f 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 59a555c38..5d3bb7453 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 553fa613e..cec6cd4ef 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 1b678951d..f1f44169b 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 7a26be178..58e98a826 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 0d0b15318..5879b5a0d 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 c83cf67d8..fd2e6986f 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 d3899c7b4..8efbb2dcc 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 4fcd5af2f..fa1d5e220 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 f4744f88b..0266d1968 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 5a49d8642..c5139a579 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 97c58a17a..5ed676bcc 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 142573cda..2142fc2f9 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 15c5a474a..bc9af0e93 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 bbc7ff106..d81235c63 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 9d71d0e9f..cb4b1add7 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 4dd6a0929..095d622d3 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 e4671cc53..c7e7b1367 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 d784bd4b3..a3ac5bd2b 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 a050b85f3..6b7db107a 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 e3bd35d4f..f5de4c8b6 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 c615c25fa..9a2b00914 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 60d98072f..da3d25f8e 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 474298cde..53aec7beb 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 ac2f7b52b..c072db5b8 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 0e6266d8f..12b9fe55d 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 b2ee9ae84..a4149125e 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 73a79c95a..1e0c62e68 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 92bf324d3..40080ee36 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 2ed78081f..4edbfa89f 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 6de0d30bc..e03fd1c73 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 3c643f947..132e24033 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 43e5d580b..018242844 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 e8826cc5b..c8e82ddc1 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 4cfbbae20..bfede036b 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 8b64af00d..ec5d31c9e 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 99cbd86d6..df1876e82 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 ba4bb2adf..9db91feeb 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 10a7ba16e..583b5dc15 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 14571ee02..a420d6847 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 113c49886..3a95d825c 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 245216a13..7dc2ccc70 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 287d41717..dd24d8ebb 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 cc9c56d76..1fa1eee4a 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 47dd49374..5f3e5e6a9 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 eb7f325cc..03215d91d 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 4da10e2f6..b182931c6 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 527ecaceb..50a068d02 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 f175489e2..2a6b35627 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 2ec630160..6edae81c3 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 ca4074a7f..b14cbe5f2 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 06e4d6449..1c1885153 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 a3e399b31..17d0cb790 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 b75aa07ce..57a854a34 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 ed293d61b..f214d4d15 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 cf749cf3f..f68271efd 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 2700d724e..8425eb4d1 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 8973ae82e..77eab44c3 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 93527d9e4..bacab18fc 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 656dd11dd..f05ed3a49 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 874024ed6..8741d034d 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 65242b685..422884395 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 77ef8a591..a2df6ddfe 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 d1245cb06..c3e10a8cf 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 746e3a4a6..2c8552f21 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 7fb04d654..15afcb0bc 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 7acfd09f6..66645c531 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 2842abd4f..f708a8b27 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 4cbfa5e79..f5bf26e6a 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 2e6b6d1c8..36e5917df 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 0b63309ea..520d6a15b 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 925b23127..6c3444c06 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 b4e41cd4c..d1be8d09f 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 e0518339d..720c271e2 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 5ef8b051e..60f3f6255 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 c1f9e957b..c4ee80ebd 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 a8a895388..1fcca8d29 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 f1e6dd22d..0a99b2523 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 4ff870177..8da399544 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 fd3aa8cf9..c4dc66b37 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 feaf43c93..ec559a611 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 eb5feeadd..b1d886ed2 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 003be0971..3f6d68fbe 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 58f424768..b0c4e866d 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 1514a50ac..657ffbea1 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 d75377eaa..338e6e7db 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 10b24c0eb..112ee05ea 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 3df0f2497..c73d2cc7a 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 852484409..6027d4d07 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 b522cad67..95b02f790 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 c21f4cfc7..af1fcfcd5 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 d68a26f39..aa9f8bbe8 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 c71a384e1..57b13b477 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 0381db88d..dc7c4ef94 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 cc68c6206..cbb307ea6 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 d4e29dc5a..3d26b186a 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 637c9efad..8ec2b02f8 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 296dfd962..0751c4229 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 f58144e1c..35008c5d7 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 d4409f4bf..4ffaacdac 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 ca4811093..37c6e1547 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 730e7937e..0226d0064 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 a33ff1d8a..31bf02a16 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 f23c35572..9571c796a 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 83c002af2..3d230f5f6 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 e3efbaca9..eaf89d4c8 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 a3d5f750e..5eb46fc82 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 688562dd8..26c49fa63 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 c60238582..edae941bb 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 94220fec9..8414b1a60 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 40630f8f0..5ee3ccca6 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 ce75fb905..600523985 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 a0d46ccd3..c3982ed84 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 63a4f9323..270b39aaa 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 5daf071ab..6a1e9fdde 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 df59b4e8c..8dfd4ecf0 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 a2b1de9c9..4a95bae28 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 f9707378b..1d832f050 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 a1faa515a..851fd6d69 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 20707ecf4..f45765747 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 60154dc41..8475a052e 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 bf429e86f..a25730362 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 836bd587d..b2b358767 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 e0cc4134c..2006259ec 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 796a0ef60..d1c8ff187 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 f3b30b724..95fbdc982 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 3d7ad145c..2d3b575fd 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 806e8bf93..30aa35978 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 0230a59d1..f170c43e5 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 43d474b90..39f193fb8 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 55daeb561..ab5e7133e 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 db0ea7556..939ca1a70 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 15e64f553..32ebd4c77 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 cebd38e14..08369e847 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 dcabfa0a1..3604c677b 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 1e0686efb..f4a8c919a 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 86ccb71aa..1fa802360 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 08e9e7576..e2af98b8d 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 89cdaf5d6..7a512231d 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 46520f939..62753be5e 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 982b1e8b7..3ea6479fb 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 5fb7e8014..1f223d9ed 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 7ab54a591..afe2600ba 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 675caa169..db007d525 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 cd07974ee..059234c02 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 a223767e1..137896175 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 2b899667b..512100bf5 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 a8c6086dd..684ec8c46 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 9f58d4f78..0fb64abe9 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 44d9ced84..aeac99915 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 53fc35fb2..bc1b05d9a 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 fd5283f68..e4949cb97 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 2c20b132e..1cfaa4058 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 9a2d85b7d..1a5064f4d 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 80caa01de..2af004ca2 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 22c75de90..ba73d37d0 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 cce1c60b1..4afd70bff 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 fe882f770..8e4a0372d 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 955cced1a..e5c1c6dcf 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 f68596997..88e1f3dbf 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 91bab3de3..d3824431f 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 44510c4b9..98727a340 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 247f43d55..886313010 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 118d51f10..c17724c37 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 b0f4c5b84..ec8439408 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 8b78aba00..109757b7a 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 25ce40990..87653c9f3 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 4c5731685..f3060ee4e 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 0d67810d1..6c294cee8 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 7d1481b29..1f84a3839 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 30dd47d7e..f127827a1 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 6bb1262c2..e4c8e9d81 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 4df23c48b..97173de28 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 189280b3e..92e7065bc 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 4cb9d2b33..77bea15db 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 cac910b21..11f236117 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 4ff5694d5..0dd0fde47 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 76dd88859..38e851b13 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 055db6ca4..6ce627fab 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 466be0a0c..bd648c234 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 fd0923aa9..166c5bf02 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 9e2b9431e..2e981a813 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 738314ed9..e82118b88 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 f7e7722cf..c367ee637 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 5fd43a241..2d7e9b03a 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 a504da8b7..7ec581212 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 212ae9b29..d1f005433 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 25907c54c..bee23f4b5 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 3ff44dedc..6ae99a726 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 20ba7725d..b460a673d 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 9485d6a54..05aad09a0 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 171bc41d7..e1fc31334 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 708680d19..77d8682fe 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 5345c7531..3c1c4f94f 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 27b453487..f2e0fd004 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 1d7e555d4..d8fe56adf 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 7ee4f0d3d..08ff002d4 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 c37c2ef75..505f9ae2d 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 6935fa76e..3396a52d9 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 934cb7a5d..e296b91c8 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 6f3d90646..fc0a0c325 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 4bce96f0b..bee1d9ee0 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 d11218208..add48127e 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 17f261991..ee888cfa6 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 6295bce20..d328522ea 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 efb9537c7..4b46a812f 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 9c44031d7..1907e5878 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 fe9cf48b2..2080ac636 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 4dfaf3c5c..95966d790 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 681b4a943..5134d2dda 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 5d38d2dbd..be656a45a 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 e6e5ec4a0..ea4117065 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 68fac9531..fd27bf84e 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 65a9cbfc4..1f9617d06 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 324bbeb8b..cc0ad8cd5 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 090ec7095..720280dc6 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 7d2c17f74..d63604323 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 09c9285a8..f0150f5d4 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 4646adad1..89a0354ba 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 752a84e3a..b527636c6 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 d15212394..ba825277e 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 8609252d4..8b26a19a7 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 6258852a4..97eacd497 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 16cfd42d8..aa9e5b19b 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 28576c008..a17eb79b7 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 9fefc5b17..9fe6b6ff6 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 acdd192ec..e78136573 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 501aa5992..ef9388fb9 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 c16828bcd..57a8199d2 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 a540ba336..24946553f 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 d95a12720..d245607ee 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 8b25fc27b..a2db24c43 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 8d6146f33..de3291231 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 7144d217a..592bbe521 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 466ab3478..51ccc0b56 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 e653fa873..a9cbd843c 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 2d92b8e75..a34843f67 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 7b56c6d89..dfe4d5486 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 54549dc31..0eafb3f3c 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 900233370..83c6e6590 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 9fd6e97a8..9ce5a8c0a 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 9fee3bb0f..3f52c5ecf 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 3cc31251c..5312d85a9 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 c98100aea..2b6992736 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 bd398f484..ff390e5e4 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 143ec88a7..d6686b264 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 aae8aa941..c8ac40e97 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 c8fdd43b4..ac57bdbef 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 4b06fecc7..0e3c3e977 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 d0ff3f176..544922829 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 506720894..0a61701f0 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 b2ec866fb..9bc795b49 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 06cd307c9..61624c428 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 b7512e05d..f37048750 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 d30074f33..3bf01227f 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 a6a08e67e..3d3f0e4d0 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 1bd8be0b0..357e443ed 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 be28290ce..a39cd09ea 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 e53a8065e..0ee03f0df 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 e456cfe92..dd9cb7303 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 65a3aeeea..202b9515e 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 e40efd74f..b6e94509e 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 85433d15f..76630ee20 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 bba45b274..c38320881 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 4d320f629..4ac35f19e 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 dccf9483f..5ff82f4c5 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 a3ae05bbb..eb77c60d9 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 c0560d4ab..034a230c3 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 5b1fe4071..7dab45779 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 829001aed..74e53be46 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 6c592d5a2..152713faf 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 0e431ef78..64b400659 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 09a8c5b8d..70b81a7fa 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 0e7f024b6..56b5d474f 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 04205de96..eb25df894 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 fd196cf76..27917972c 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 e7c2ae43d..d98d5af32 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 319b2330c..ff1766124 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 f756bc45d..1bb0774b8 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 006e2d970..eac89da6f 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 2fa68c0c4..ea428516b 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 ce8f9b67c..8c0d313d0 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 00e907d66..55d4c3bd1 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 83f8800ec..bf5741d02 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 b0dab6297..bd9af2a90 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 7cb7f342d..e30dbdb25 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 010c17174..c3acf796d 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 bdd0db8b7..db0010aa1 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 2c5f38513..5669a6fca 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 0d66db1c9..a9798a1cd 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 ae3838ec8..ca2a6ccc2 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 f6a3bfa44..51a78fd8b 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 5260b6714..85cb1674f 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 3fff2328e..bef128789 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 f67d5494b..6a60c6575 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 ba2012d17..db134efb3 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 3ed97a9d4..c00263e6c 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 052dacadd..6d571eeed 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 620158df9..2d2253741 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 becef3824..1db1ff9c5 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 2f85914ef..e4056efa1 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 4a7fde61a..d3399cb5d 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 83c25b2d6..2115f3306 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 bb87d5dae..ba74d1ae6 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 0b88d39d2..271382d72 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 16bb76810..7499266d1 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 2dada7a50..aae5234a1 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 10641108d..d4b85c92c 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 7942f915e..cdadedf6a 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 94443b391..6c6802585 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 ad69f264f..fd76fc058 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 894ef0488..26caf9667 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 cfeee3166..1ebc4a646 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 22aa0b14d..1b5981873 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 242022c9c..2479f81ea 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 6d4b2945d..4d1efa68b 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 8528ef454..83c4350ea 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 70e8a7099..814d2ffcf 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 cf63b5d6f..b916e1917 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 7bf5b3097..691bd32a2 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 b0c6512ea..a3b46e329 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 c1c8a3151..4399d1049 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 ebaab18e7..e0dae330b 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 cb0a0e321..0ef55dabf 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 7676d1e44..058d03667 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 4295ebb52..637655884 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 bfa40cc4d..a313c7056 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 d3f425e58..cd0200386 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 bca6534f4..f3c90abc1 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 0d2063668..44fd09733 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 83fa0fc9e..abbe918f2 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 fcaac6f00..aaf6b0c55 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 520f9fc39..2de744642 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 27155e046..567d7bac3 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 6e6ed3b21..967083be7 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 830277792..ab80efb03 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 785fc6b4f..b13597463 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 c30388ed2..1ee839aac 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 b10bae555..db2036c60 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 5ae843efb..9351bf800 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 64b376d2b..5bca661a8 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 6342c7397..ff4292b1e 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 037a12a5b..248128244 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 7e251bd83..4da0b6949 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 a53ea8c59..eb4a38be7 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 499afbd8e..e84a1de90 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 44789cb43..093fcdc37 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 15cc7cdb6..aa17163e0 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 ffc54aefc..82098ecf2 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 b778dceaa..722f80ee2 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 0d06574eb..51cbde5f0 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 bc8c562f3..9d9742d2e 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 54ef39d59..e99a12900 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 82d1708e4..b7faca814 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 0a469ebcf..db1732fe2 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 e0c58b98c..a04236587 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 aa926fea8..9f88cbdae 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 8edafa362..587d45008 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 349cd6e58..314295f20 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 fac743819..d7776dbcf 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 23d894674..84a04ffdb 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 c06300958..8e45f909d 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 e924883cb..ecb9a90c3 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