Methods - vpinball/b2s-backglass GitHub Wiki

B2S Methods Documentation

B2S Method List

  1. B2SSetData

    • Description: Backup method to set data.
    • Parameters:
      • idORname (Object): Identifier or name.
      • value (Object): Value to set.
    • Return Type: Void

  2. B2SPulseData

    • Description: Pulse the set data.
    • Parameters:
      • idORname (Object): Identifier or name.
    • Return Type: Void

  3. B2SSetPos

    • Description: Set position.
    • Parameters:
      • idORname (Object): Identifier or name.
      • xpos (Object): X position.
      • ypos (Object): Y position.
    • Return Type: Void

  4. B2SSetIllumination

    • Description: Method to set illumination.
    • Parameters:
      • name (Object): Name.
      • value (Object): Value to set.
    • Return Type: Void

  5. B2SSetLED

    • Description: Set LED.
    • Parameters:
      • digit (Object): Digit.
      • valueORtext (Object): Value or text.
    • Return Type: Void

  6. B2SSetLEDDisplay

    • Description: Set LED display.
    • Parameters:
      • display (Object): Display.
      • text (Object): Text.
    • Return Type: Void

  7. B2SSetReel

    • Description: Set reel.
    • Parameters:
      • digit (Object): Digit.
      • value (Object): Value to set.
    • Return Type: Void

  8. B2SSetScore

    • Description: Set score (1-24).
    • Parameters:
      • display (Object): Display.
      • value (Object): Value to set.
    • Return Type: Void

  9. B2SSetScorePlayer

    • Description: Set score for a specific player.
    • Parameters:
      • playerno (Object): Player number.
      • score (Object): Score to set.
    • Return Type: Void

  10. B2SSetScorePlayer1

    • Description: Set score for player 1.
    • Parameters:
      • score (Object): Score to set.
    • Return Type: Void

  11. B2SSetScorePlayer2

    • Description: Set score for player 2.
    • Parameters:
      • score (Object): Score to set.
    • Return Type: Void

  12. B2SSetScorePlayer3

    • Description: Set score for player 3.
    • Parameters:
      • score (Object): Score to set.
    • Return Type: Void

  13. B2SSetScorePlayer4

    • Description: Set score for player 4.
    • Parameters:
      • score (Object): Score to set.
    • Return Type: Void

  14. B2SSetScorePlayer5

    • Description: Set score for player 5.
    • Parameters:
      • score (Object): Score to set.
    • Return Type: Void

  15. B2SSetScorePlayer6

    • Description: Set score for player 6.
    • Parameters:
      • score (Object): Score to set.
    • Return Type: Void

  16. B2SSetScoreDigit

    • Description: Set score digit.
    • Parameters:
      • digit (Object): Digit.
      • value (Object): Value to set.
    • Return Type: Void

  17. B2SSetScoreRollover

    • Description: Set score rollover (25-28).
    • Parameters:
      • id (Object): Identifier.
      • value (Object): Value to set.
    • Return Type: Void

  18. B2SSetScoreRolloverPlayer1

    • Description: Set score rollover for player 1.
    • Parameters:
      • value (Object): Value to set.
    • Return Type: Void

  19. B2SSetScoreRolloverPlayer2

    • Description: Set score rollover for player 2.
    • Parameters:
      • value (Object): Value to set.
    • Return Type: Void

  20. B2SSetScoreRolloverPlayer3

    • Description: Set score rollover for player 3.
    • Parameters:
      • value (Object): Value to set.
    • Return Type: Void

  21. B2SSetScoreRolloverPlayer4

    • Description: Set score rollover for player 4.
    • Parameters:
      • value (Object): Value to set.
    • Return Type: Void

  22. B2SSetCredits

    • Description: Set credits (29).
    • Parameters:
      • digitORvalue (Object): Digit or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  23. B2SSetPlayerUp

    • Description: Set player up (30).
    • Parameters:
      • idORvalue (Object): Identifier or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  24. B2SSetCanPlay

    • Description: Set can play (31).
    • Parameters:
      • idORvalue (Object): Identifier or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  25. B2SSetBallInPlay

    • Description: Set ball in play (32).
    • Parameters:
      • idORvalue (Object): Identifier or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  26. B2SSetTilt

    • Description: Set tilt (33).
    • Parameters:
      • idORvalue (Object): Identifier or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  27. B2SSetMatch

    • Description: Set match (34).
    • Parameters:
      • idORvalue (Object): Identifier or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  28. B2SSetGameOver

    • Description: Set game over (35).
    • Parameters:
      • idORvalue (Object): Identifier or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  29. B2SSetShootAgain

    • Description: Set shoot again (36).
    • Parameters:
      • idORvalue (Object): Identifier or value.
      • value (Object, Optional): Value to set.
    • Return Type: Void

  30. B2SStartAnimation

    • Description: Start animation.
    • Parameters:
      • animationname (String): Animation name.
      • playreverse (Boolean, Optional): Play in reverse.
    • Return Type: Void

  31. B2SStartAnimationReverse

    • Description: Start animation in reverse.
    • Parameters:
      • animationname (String): Animation name.
    • Return Type: Void

  32. B2SStopAnimation

    • Description: Stop animation.
    • Parameters:
      • animationname (String): Animation name.
    • Return Type: Void

  33. B2SStopAllAnimations

    • Description: Stop all animations.
    • Parameters: None
    • Return Type: Void

  34. B2SIsAnimationRunning

    • Description: Check if animation is running.
    • Parameters:
      • animationname (String): Animation name.
    • Return Type: Boolean

  35. B2SStartRotation

    • Description: Start rotation.
    • Parameters: None
    • Return Type: Void

  36. B2SStopRotation

    • Description: Stop rotation.
    • Parameters: None
    • Return Type: Void

  37. B2SShowScoreDisplays

    • Description: Show score displays.
    • Parameters: None
    • Return Type: Void

  38. B2SHideScoreDisplays

    • Description: Hide score displays.
    • Parameters: None
    • Return Type: Void

  39. B2SStartSound

    • Description: Start sound.
    • Parameters:
      • soundname (String): Sound name.
    • Return Type: Void

  40. B2SPlaySound

    • Description: Play sound.
    • Parameters:
      • soundname (String): Sound name.
    • Return Type: Void

  41. B2SStopSound

    • Description: Stop sound.
    • Parameters:
      • soundname (String): Sound name.
    • Return Type: Void

  42. B2SMapSound

    • Description: Map sound.
    • Parameters:
      • digit (Object): Digit.
      • soundname (String): Sound name.
    • Return Type: Void