VPX Documentation

Kicker

4min
variables variables are items in vpx you can set, adjust or call call detail example name(string) x(float) y(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) enabled(bool) drawstyle(kickertype) 0=hidden, 1=hole, 2=cup, 3=invisible color(ole color) surface(string) surface this kicker is attached to uservalue(any) can store any user defined value for re use later on scatter(float) fall through(bool) if checked the ball will fall through the surface assigned to the kicker can be used to fake holes in the pf if not using the primitive playfields in 10 6+ legacy(bool) if checked the kicker will behave as an old vp9 kicker that means no distraction of the ball if it doesn't hit straight the kicker center hitaccuracy(float) defines the accuracy how fast the ball gets caught when rolling over the kicker center (0 0 1 0) hitheight(float) orientation(float) radius(float) lastcapturedball returns an instance to the last captured ball or the current captured ball if no ball was captured before or was destroyed before an error message will be displayed methods methods are procedures or actions that you can fire in vpx call detail example createball() createsizedball(float radius) createsizedballwithmass(float radius, float mass) kick(float angle, float speed, float inclination) kickxyz(float angle, float speed, float inclination, float x, float y, float z) kickz(float angle, float speed, float inclination, float heightz) ballcntover(int) events event detail example init timer hit unhit dispinterface ikickerevents { properties methods \[id(dispid gameevents init)] void init(); \[id(dispid timerevents timer)] void timer(); \[id(dispid hitevents hit)] void hit(); \[id(dispid hitevents unhit)] void unhit(); }