Class ShareableBatterySystem

Namespace: mobisim.Battery

A component that manages a shareable portion of the main battery system's energy level.

[RequireComponent(typeof(BatterySystem))]
[DisallowMultipleComponent]
public class ShareableBatterySystem : MonoBehaviour

Inheritance

object→Object→Component→Behaviour→MonoBehaviour→ShareableBatterySystem

Properties

RuntimeLevel

Gets or sets the current shareable battery level. If not previously set, returns m_ShareableAmount.

public float RuntimeLevel { get; set; }

Property Value

float

Remarks

When set, the battery level is broadcast via the configured event channel.

Methods

DrainBattery(float)

Drains both the shareable and main battery systems by the specified amount. The drain amount is clamped to the current shareable level.

public void DrainBattery(float drainAmount)

Parameters

Name	Type	Description
drainAmount	float	Amount to drain from both battery levels.