PluginManager.Plugin, OpenBve C# Class Documentation

Méthode	Description
BeginJump ( InitializationModes mode ) : void	Called before the train jumps to a different location.
DoorChange ( DoorStates oldState, DoorStates newState ) : void	Called when the state of the doors changes.
Elapse ( ElapseData data ) : void	Called every frame to update the plugin. This function should not be called directly. Call UpdatePlugin instead.
EndJump ( ) : void	Called when the train has finished jumping to a different location.
GetHandles ( ) : Handles	Gets the driver handles.
HornBlow ( HornTypes type ) : void	Called when a horn is played or stopped.
KeyDown ( VirtualKeys key ) : void	Called when a virtual key is pressed.
KeyUp ( VirtualKeys key ) : void	Called when a virtual key is released.
Load ( VehicleSpecs specs, InitializationModes mode ) : bool	Called to load and initialize the plugin.
PerformAI ( AIData data ) : void	Called when the AI should be performed. This function should not be called directly. Call UpdateAI instead.
SetBeacon ( BeaconData beacon ) : void	Called when the train passes a beacon. This function should not be called directly. Call UpdateBeacon instead.
SetBrake ( int brakeNotch ) : void	Called to indicate a change of the brake notch. This function should not be called directly. Call UpdateBrake instead.
SetHandles ( Handles handles, bool virtualHandles ) : void	Sets the driver handles or the virtual handles.
SetPower ( int powerNotch ) : void	Called to indicate a change of the power notch. This function should not be called directly. Call UpdatePower instead.
SetReverser ( int reverser ) : void	Called to indicate a change of the reverser. This function should not be called directly. Call UpdateReverser instead.
SetSignal ( SignalData signal ) : void	Is called when the aspect in the current or any of the upcoming sections changes. This function should not be called directly. Call UpdateSignal instead.
Unload ( ) : void	Called to unload the plugin.
UpdateAI ( ) : AIResponse	Updates the AI.
UpdateBeacon ( int type, int sectionIndex, int optional ) : void	Called when the train passes a beacon.
UpdateBrake ( ) : void	Called to update the brake notch. This invokes a call to SetBrake only if a change actually occured.
UpdatePlugin ( ) : void	Called every frame to update the plugin.
UpdatePower ( ) : void	Called to update the power notch. This invokes a call to SetPower only if a change actually occured.
UpdateReverser ( ) : void	Called to update the reverser. This invokes a call to SetReverser only if a change actually occured.
UpdateSignals ( SignalData data ) : void	Called to update the aspects of the section. This invokes a call to SetSignal only if a change in aspect occured or when changing section boundaries.

BeginJump ( InitializationModes mode ) : void

Called before the train jumps to a different location.

DoorChange ( DoorStates oldState, DoorStates newState ) : void

Called when the state of the doors changes.

Elapse ( ElapseData data ) : void

Called every frame to update the plugin.

This function should not be called directly. Call UpdatePlugin instead.

EndJump ( ) : void

Called when the train has finished jumping to a different location.

GetHandles ( ) : Handles

Gets the driver handles.

HornBlow ( HornTypes type ) : void

Called when a horn is played or stopped.

KeyDown ( VirtualKeys key ) : void

Called when a virtual key is pressed.

KeyUp ( VirtualKeys key ) : void

Called when a virtual key is released.

Load ( VehicleSpecs specs, InitializationModes mode ) : bool

Called to load and initialize the plugin.

PerformAI ( AIData data ) : void

Called when the AI should be performed.

This function should not be called directly. Call UpdateAI instead.

SetBeacon ( BeaconData beacon ) : void

Called when the train passes a beacon.

This function should not be called directly. Call UpdateBeacon instead.

SetBrake ( int brakeNotch ) : void

Called to indicate a change of the brake notch.

This function should not be called directly. Call UpdateBrake instead.

SetHandles ( Handles handles, bool virtualHandles ) : void

Sets the driver handles or the virtual handles.

SetPower ( int powerNotch ) : void

Called to indicate a change of the power notch.

This function should not be called directly. Call UpdatePower instead.

SetReverser ( int reverser ) : void

Called to indicate a change of the reverser.

This function should not be called directly. Call UpdateReverser instead.

SetSignal ( SignalData signal ) : void

Is called when the aspect in the current or any of the upcoming sections changes.

This function should not be called directly. Call UpdateSignal instead.

Unload ( ) : void

Called to unload the plugin.

UpdateAI ( ) : AIResponse

Updates the AI.

UpdateBeacon ( int type, int sectionIndex, int optional ) : void

Called when the train passes a beacon.

UpdateBrake ( ) : void

Called to update the brake notch. This invokes a call to SetBrake only if a change actually occured.

UpdatePlugin ( ) : void

Called every frame to update the plugin.

UpdatePower ( ) : void

Called to update the power notch. This invokes a call to SetPower only if a change actually occured.

UpdateReverser ( ) : void

Called to update the reverser. This invokes a call to SetReverser only if a change actually occured.

UpdateSignals ( SignalData data ) : void

Called to update the aspects of the section. This invokes a call to SetSignal only if a change in aspect occured or when changing section boundaries.

C# Class OpenBve.PluginManager.Plugin

Private Methods