Difference between revisions of "PipBoyRadio"

Revision as of 19:09, 30 January 2009

< [[::Category:Functions|Category:Functions]]

A function included in the GECK version 1.1.0.36.

Controls the Pipboy radio. Can switch it on or off and tune into a specific radio station.

PipBoyRadio Command:string RadioStation:ObjectReferenceID

Tune in to Galaxy News Radio:

PipboyRadio tune RadioGalaxyNewsRef02

Turn off the radio:

PipboyRadio 0

Turn on the radio to the last played station:

PipboyRadio 1

The radio station is specified by passing a reference to the talking activator that broadcasts the radio station.
If the radio station is disabled or out of range, it cannot be selected using "tune".
Tuning in to a specific radio station with "Tune" only works if the Pipboy radio is currently active. If it is not active, the station will not change, and PipboyRadio 1 will start playing the last radio station the player was listening to, not the one specified by "Tune".

@@ Line 1: / Line 1: @@
-{{Incomplete}}
 {{Function
 |origin = GECK1
-|summary = Control the Pipboy radio. Enable, Disable, Tune
+|summary = Controls the Pipboy radio. Can switch it on or off and tune into a specific radio station.
 |returnType = void
-|arg1 = int
+|arguments = {{FunctionArgument
-|arg1Type = 0/1/Tune
+    |Name = Command
-|example = PRAD 1
+    |Type = string
+  }}{{FunctionArgument
+    |Name = RadioStation
+    |Type = ObjectReferenceID
+    |Optional = y
+  }}
 }}
+==Examples==
+'''Tune in to Galaxy News Radio:'''
+ PipboyRadio tune RadioGalaxyNewsRef02
+'''Turn off the radio:'''
+ PipboyRadio 0
+'''Turn on the radio to the last played station:'''
+ PipboyRadio 1
+==Notes==
+* The radio station is specified by passing a reference to the talking activator that broadcasts the radio station.
+* If the radio station is disabled or out of range, it cannot be selected using "tune".
+* Tuning in to a specific radio station with "Tune" only works if the Pipboy radio is currently active. If it is not active, the station will not change, and <tt>PipboyRadio 1</tt> will start playing the last radio station the player was listening to, not the one specified by "Tune".
 [[Category:Functions]]
 [[Category:Radio Functions]]