---
title: Bumper
slug: bumper
description: This document is a comprehensive guide listing all the essential variables, methods, and events associated with bumpers in VPX. It covers a wide range of variables, including name, materials, size, position, animation, visibility, and many others. The met
docTags: 
createdAt: 2019-11-29T05:17:20.000Z
---

## Variables

*Variables are items in vpx you can set, adjust or call.*

| Call                        | Detail                                                                                                                                                                                                                                                                                                                                                 | Example |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| Name(string)                |                                                                                                                                                                                                                                                                                                                                                        |         |
| CapMaterial(string)         |                                                                                                                                                                                                                                                                                                                                                        |         |
| BaseMaterial(string)        |                                                                                                                                                                                                                                                                                                                                                        |         |
| SkirtMaterial(string)       |                                                                                                                                                                                                                                                                                                                                                        |         |
| Radius(float)               | default=45.0                                                                                                                                                                                                                                                                                                                                           |         |
| HeightScale (float)         | default=90.0                                                                                                                                                                                                                                                                                                                                           |         |
| Orientation(float)          |                                                                                                                                                                                                                                                                                                                                                        |         |
| RingDropOffset(float)       | - An offset to influence the ring animation. The default move down limit is calculated by (HeightScale\*0.5) \* Table\_Scalez.<br /><br />The final move down limit is calculated by RingDropOffset + (HeightScale\*0.5)\* Table\_Scalez.<br /><br />For example: If the ring is moving too far down you have to try to set the RingDropOffset to -10. |         |
| RingSpeed(float)            |                                                                                                                                                                                                                                                                                                                                                        |         |
| X(float)                    | X position                                                                                                                                                                                                                                                                                                                                             |         |
| Y(float)                    | Y position                                                                                                                                                                                                                                                                                                                                             |         |
| Surface(string)             |                                                                                                                                                                                                                                                                                                                                                        |         |
| Force(float)                |                                                                                                                                                                                                                                                                                                                                                        |         |
| Threshold(float)            |                                                                                                                                                                                                                                                                                                                                                        |         |
| Scatter(float)              |                                                                                                                                                                                                                                                                                                                                                        |         |
| TimerEnabled(bool)          |                                                                                                                                                                                                                                                                                                                                                        |         |
| TimerInterval(int)          | set interval for triggering the timer (1 equals 1000 timer calls per second, 1000 equals 1 timer call per second, -1 makes it dependent on the FPS that a user can reach)                                                                                                                                                                              |         |
| UserValue(any)              | can store any user defined value for re-use later-on                                                                                                                                                                                                                                                                                                   |         |
| CapVisible(bool)            | default=true                                                                                                                                                                                                                                                                                                                                           |         |
| BaseVisible(bool)           | default=true                                                                                                                                                                                                                                                                                                                                           |         |
| ReflectionEnabled(bool)     | default=true                                                                                                                                                                                                                                                                                                                                           |         |
| EnableSkirtAnimation(bool)  | default=true, en/disables the skirt animation of a bumper, for example if something external is triggering the bumper (i.e. no ball contact with the skirt)                                                                                                                                                                                            |         |
| HasHitEvent(bool)           |                                                                                                                                                                                                                                                                                                                                                        |         |
| Collidable(bool)            |                                                                                                                                                                                                                                                                                                                                                        |         |

## Methods

*Methods are procedures or actions that you can fire in VPX.*

| Call      | Detail                                                                                    | Example |
| --------- | ----------------------------------------------------------------------------------------- | ------- |
| PlayHit() | if called the bumper will play the hit animation without triggering the actual hit event. |         |

## Events

| Event   | Detail | Example |
| ------- | ------ | ------- |
| \_init  |        |         |
| \_Timer |        |         |
| \_Hit   |        |         |

```javascript
        dispinterface IBumperEvents
        {
        properties:
        methods:
                [id(DISPID_GameEvents_Init)]  void Init();
                [id(DISPID_TimerEvents_Timer)]  void Timer();
                [id(DISPID_HitEvents_Hit)]  void Hit();
        }
```

