Class Radio
A wrapper class for InventorySystem.Items.Radio.RadioItem.
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Exiled.API.Features.Items
Assembly: Exiled.API.dll
Syntax
public class Radio : Item, IWrapper<ItemBase>, IWrapper<RadioItem>
Constructors
| Improve this Doc View SourceRadio(RadioItem)
Initializes a new instance of the Radio class.
Declaration
public Radio(RadioItem itemBase)
Parameters
Type | Name | Description |
---|---|---|
InventorySystem.Items.Radio.RadioItem | itemBase | The base InventorySystem.Items.Radio.RadioItem class. |
Properties
| Improve this Doc View SourceBase
Gets the InventorySystem.Items.Radio.RadioItem that this class is encapsulating.
Declaration
public RadioItem Base { get; }
Property Value
Type | Description |
---|---|
InventorySystem.Items.Radio.RadioItem |
BatteryLevel
Gets or sets the percentage of the radio's battery, between 0-100
.
Declaration
public byte BatteryLevel { get; set; }
Property Value
Type | Description |
---|---|
System.Byte |
IsEnabled
Gets or sets a value indicating whether the radio is enabled or not.
Declaration
public bool IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Range
Gets or sets the current RadioRange.
Declaration
public RadioRange Range { get; set; }
Property Value
Type | Description |
---|---|
RadioRange |
RangeSettings
Gets or sets the RadioRangeSettings for the current Range.
Declaration
public RadioRangeSettings RangeSettings { get; set; }
Property Value
Type | Description |
---|---|
RadioRangeSettings |
Methods
| Improve this Doc View SourceClone()
Clones current Radio object.
Declaration
public override Item Clone()
Returns
Type | Description |
---|---|
Item | New Radio object. |
Overrides
| Improve this Doc View SourceSetRangeSettings(RadioRange, RadioRangeSettings)
Sets the RadioRangeSettings of the given range
.
Declaration
public void SetRangeSettings(RadioRange range, RadioRangeSettings settings)
Parameters
Type | Name | Description |
---|---|---|
RadioRange | range | The RadioRange to modify. |
RadioRangeSettings | settings | The new settings of the specified range. |
ToString()
Returns the Radio in a human readable format.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | A string containing Radio-related data. |