Core - new fn - current_bpm_mode

Add new fn current_bpm_mode which works similarly to current_bpm except when in :link bpm mode returns :link rather than Link's current bpm.

Author: samaaron

app/server/ruby/lib/sonicpi/lang/core.rb

@@ -3898,22 +3898,51 @@ def current_random_source
 puts rand # => 0.10821533203125
 puts rand # => 0.54010009765625
 "]
+      def current_bpm_mode
+        __get_spider_bpm_mode
+      end
+      doc name:          :current_bpm_mode,
+          introduced:    Version.new(4,0,0),
+          summary:       "Get current tempo mode",
+          doc:           "Returns the current tempo mode - either a bpm value or :link.
 
+To know the current BPM value when this thread is in :link mode see `current_bpm`.
 
-      def current_bpm
+This can be set via the fns `use_bpm`, `with_bpm`, `use_sample_bpm` and `with_sample_bpm`.",
+          args:          [],
+          opts:          nil,
+          accepts_block: false,
+          examples:      ["
+  use_bpm 60
+  puts current_bpm_mode    # => 60
+  use_bpm 70
+  puts current_bpm_mode    # => 70
+  use_bpm :link
+  puts current_bpm_mode    # => :link"]
+
+
+
+        def current_bpm
         __get_spider_bpm
       end
       doc name:          :current_bpm,
           introduced:    Version.new(2,0,0),
           summary:       "Get current tempo",
-          doc:           "Returns the current tempo as a bpm value.
+          doc:           "Returns the current tempo as a bpm value. If the thread is in :link bpm mode, this will return the latest bpm value of the shared Link network metronome (note that this value may change after reading if the Link bpm isn't static).
+
+To know if this thread is in :link or standard bpm mode see `current_bpm_mode`.
 
 This can be set via the fns `use_bpm`, `with_bpm`, `use_sample_bpm` and `with_sample_bpm`.",
           args:          [],
           opts:          nil,
           accepts_block: false,
           examples:      ["
-  puts current_bpm # Print out the current bpm"]
+  use_bpm 60
+  puts current_bpm_mode    # => 60
+  use_bpm 70
+  puts current_bpm_mode    # => 70
+  use_bpm :link
+  puts current_bpm_mode    # => 120 (or whatever the current Link BPM value is)"]
 
 
 

app/server/ruby/lib/sonicpi/runtime.rb

@@ -206,6 +206,14 @@ def __get_spider_bpm
       end
     end
 
+    def __get_spider_bpm_mode
+      if __in_link_bpm_mode
+        :link
+      else
+        __get_spider_bpm
+      end
+    end
+
     def __get_spider_beat
       __system_thread_locals.get :sonic_pi_spider_beat
     end