Interface IVehicleEntrance<TDriver, TPassenger, TSteeringHandle, TPassengerHandle>
A vehicle entrance allows passenger to use vehicles in different roles (as driver or co-driver/passenger).
Assembly: SOHDomain.dll
Syntax
public interface IVehicleEntrance<in TDriver, in TPassenger, TSteeringHandle, TPassengerHandle>
where TDriver : ISteeringCapable where TPassenger : IPassengerCapable where TSteeringHandle : ISteeringHandle where TPassengerHandle : IPassengerHandle
Type Parameters
Name |
Description |
TDriver |
|
TPassenger |
|
TSteeringHandle |
|
TPassengerHandle |
|
Methods
NotifyPassengers(PassengerMessage)
Notifies all passengers and the driver.
Declaration
void NotifyPassengers(PassengerMessage passengerMessage)
Parameters
Type |
Name |
Description |
PassengerMessage |
passengerMessage |
Notification message for all passengers. |
TryEnterDriver(TDriver, out TSteeringHandle)
The passenger tries to enter the vehicle in the driver role. On success the driver is able to steer the
vehicle with the given handle.
ATTENTION:This method only affects the vehicle parameters. The broader context (driver was
probably a pedestrian in another environment) has to be taken into consideration and adjusted to the new
modal context.
Declaration
bool TryEnterDriver(TDriver driver, out TSteeringHandle handle)
Parameters
Type |
Name |
Description |
TDriver |
driver |
That will drive the vehicle. |
TSteeringHandle |
handle |
The steering handle that can be used by the driver to control the vehicle. |
Returns
Type |
Description |
System.Boolean |
Whether the driver could enter the vehicle or not. |
TryEnterPassenger(TPassenger, out TPassengerHandle)
The passenger tries to enter the vehicle as co-driver.
ATTENTION:This method only affects the vehicle parameters. The broader context (passenger was
probably a pedestrian in another environment) has to be taken into consideration and adjusted to the new
modal context.
Declaration
bool TryEnterPassenger(TPassenger passenger, out TPassengerHandle handle)
Parameters
Type |
Name |
Description |
TPassenger |
passenger |
That will board the vehicle for transportation. |
TPassengerHandle |
handle |
The passenger handle that provides the possibility to be moved. |
Returns
Type |
Description |
System.Boolean |
Whether the passenger could enter the vehicle or not. |