Visual Pinbal Objects Settings Guide, Version 5.1

VISUAL PINBALL
OBJECTS SETTINGS
VERSION 5.1

Many thanks to RolandSholz, AngelEyeUK, and Proginoskes

General Information

BALL
BUMPER
COLLECTION
DISPREEL (EMREEL)
DRAGPOINT (CONTROL POINT)
FLIPPER
GATE
IDECAL
ITABLE
KICKER
LIGHT
LIGHTSEQ
PLUNGER
RAMP
SPINNER
TABLE
TEXTBOX
TIMER
TRIGGER
WALL (SURFACE / TARGET)

General Information

Below, all objects in VP6 have been listed, along with properties of these objects, where they can be modified, the events (subroutines that are written by the table designer), and the methods (pre-defined subroutines) that are allowed, and that occur with each object.

For properties, the following are listed, one column at a time: the name of that property, whether it can be changed in the editor (E means yes), whether it can be changed in the script (S means yes), what data type it is, and (sometimes) some clarifyingcomments.

Data Types:

Data Type	Description
Boolean	True or False
Integer	A number without a fraction, between -2³¹and 2³¹
Single	Single-float numbers; these may have a fraction with them
Double	Double-precision numbers; very precise numbers
OLE_Color	Three bytes (integers between 0 and 255), the first giving the intensity of red, the second the intensity of green, the third the intensity of blue
String	A list of bytes, usually alphanumeric characters (letters and numbers)
IFontDisp	A format for displaying fonts
Variant	An object with an arbitrary data type

Other data types usually consist of single bytes, with certain numbers representing certain options. (See "LightState" under BUMPER, for instance.) You can use the descriptive name ("LightStateOn") or the number (1); VP understands both.

If a blinking pattern is specified, 0 represents the light or bumper being off, and 1 represents it being on, for "blink interval". For instance, if BlinkInterval = 500 and BlinkPattern = 1101110, then the light or bumper will be on for 1000 milliseconds, off for 500, on for 1500, and off for 500.

Angles are sometimes used to denote direction. Angles are given in degrees, and match up with the standard locations: 0 degrees is north, 90 is east, 180 is south, and 270 is west.

Now for events. There are certain types of events that recur in the list below, so it is worth while to mention what comes up again and again:

Event	Description	Objects
Init	The script inside this subroutine is executed when the table begins.	most objects
Hit	This script is executed whenever the object has been struck.	most objects
Spin	This script is executed when a spinner is hit. It runs once for each time the spinner completes a revolution.	spinner
Slingshot	Some sides of walls can be programmed to reflect the ball with more energy than it started with. When the ball strikes such a surface of an object, the script inside this Sub is executed.	walls only
Unhit	The script in this subroutine is executed when the ball leaves the area laid out by a trigger.	trigger only
Timer	Every VP object comes with a timer, a device which marks a certain amount of time, once it is enabled. When this time is up, the script inside the Timer subroutine is executed. Note that if the timer is not disabled, the subroutine will run again.	most objects

Since these subroutines belong to different objects, when writing the script, you combine the name of the object with the name of the event. For instance, the instructions in the subroutine DropTarget1_Hit will be executed when DropTarget1 is hit by a ball.

In the case of collections, the event will also receive a variable called the index. This means that the index^th item in the collection has been hit, or unhit, or whatever.

Units:

Property	Units
X, Y, Z	(VP units) The ball is 50 VP units in diameter. The value of X is between 0 (left side of the table) and `{Table}.Width` (right side of the table, where `{Table}` is the name of the table), Y is between 0 (the far side of the table) and `{Table}.Height`, and Z is between 0 (the surface of the table) and `{Table}.GlassHeight` (the top surface of the table, where the glass is on pinball machines).
VelX, VelY, VelZ	(VP units per 100 milliseconds -- yes, you read that right) Used mainly to tell which direction the ball is going. If VelX is positive, it means X is increasing. Thus, if VelY is negative and VelZ is positive, the ball is moving away from you and up towards the glass.
TimerInterval	(milliseconds -- 1/1000 of a second)

Granted, this has been a lot of information, but a good deal of it has not been documented, poorly documented, or documented in several places.

Information that has changed since vpobjectssettings4.txt was written (or is incorrect in that file) is denoted by a *.

ACTIVEBALL (variable)

Property	S?	Data Type
UserValue	S	Variant
VelX	S	Double
VelY	S	Double
VelZ	S	Double
X	S	Double
Y	S	Double
Z	S	Double

BALL (object)

Property	E?	S?	Data Type	Comments
BackDecal	E	S	String	in editor only the default ball can be changed
Color		S	OLE_COLOR
FrontDecal	E	S	String	in editor only the default ball can be changed
Image	E	S	String	in editor only the default ball can be changed

BUMPER (object)

Property	E?	S?	Data Type	Comments
BlinkInterval	E	S	Integer
BlinkPattern	E	S	String	"0"=off, "1"=on
CastsShadow	E		Boolean
Color	E		OLE_Color
Disabled		S	Boolean
FlashWhenHit	E	S	Boolean
Force	E	S	Single
Image	E		String
Overhang	E		Single *
Radius	E		Single *
SideColor	E		OLE_COLOR
State	E	S	LightState	LightStateOff = 0, LightStateOn = 1, LightStateBlinking = 2
Surface	E		String
Threshold	E	S	Single
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UserValue	E	S	Variable
X *	E		Single	x-coord of center of bumper
Y *	E		Single	y-coord of center of bumper

Events: Hit(), Init(), Timer()

COLLECTION (object)

Property	S?	Data Type
_NewEnum	S	UNKNOWN
Count	S	Integer
Item	S	IDispatch

Events: Hit(idx), Init(idx), Slingshot(idx), Spin(idx), Timer(idx), Unhit(idx)

DISPREEL (EMREEL) (object)

Property	E?	S?	Data Type	Comment
BackColor	E	S	OLE_COLOR
Font	E		IFontDisp
FontColor	E		OLE_COLOR
Height	E		Single
Image	E		String
ImagesPerGridRow	E		Integer
IsShading	E		Boolean
IsTransparent	E	S	Boolean
Name	E		String
Range	E		Single	# of images in the reel image
ReelColor	E		OLE_COLOR
Reels	E		Single	# of reels
Sound	E	S	String
Spacing	E		Single
Steps	E	S	Single
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Boolean
Type	E		ReelType	ReelText = 0, ReelImage = 1
UpdateInterval	E	S	Integer
UseImageGrid	E		Boolean
UserValue	E	S	Variant
Width	E		Single
X	E		Single
Y	E		Single

Methods:

Method	Data Type(s)	Description
AddValue x	Integer	x = amount added
ResetToZero
SetValue x	Integer	x = number that the EMReel is set to
SpinReel r, p	Integer, Integer	r = ReelNumber, p = PulseCount

Events: Init, Timer

DRAGPOINT (CONTROL POINT)

Property	E?	Data Type
IsAutoTextureCoordinate	E	Boolean
Smooth	E	Boolean
TextureCoordinate	E	Single
X	E	Single
Y	E	Single

FLIPPER (object)

Property	E?	S?	Data Type	Comments
BaseRadius	E		Single
Color	E		OLE_COLOR
CurrentAngle		S	Single	read only
Elasticity	E	S	Single
EndAngle	E		Single
EndRadius	E		Single
Length	E		Single
Name	E		String
RubberColor *	E		OLE_COLOR
RubberThickness	E		Integer	stored in the .vpt file as a Single
Speed	E	S	Single
StartAngle	E		Single
Strength	E	S	Single
Surface	E		String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UserValue	E	S	Variable
Visible	E*	S*	Boolean
X	E		Single
Y	E		Single

Methods: RotatetoEnd, RotatetoStart

Events: Hit, Init, Timer

GATE (object)

Property	E?	S?	Data Type
Length	E		Single
Name	E		String
Open		S	Boolean
Rotation	E		Single
Surface	E		String
TimerEnabled		S	Boolean
TimerInterval		S	Integer
UserValue	E		String
X	E		Single
Y	E		Single

Events: Hit, Init, Timer

IDECAL (this is an interface; a decal has no name, therefore it can't be accessed in the script)

Property	E?	Data Type	Comments
Font	E	IFontDisp
FontColor	E	OLE_COLOR
HasVerticalText	E	Boolean
Height	E	Single
Image	E	String
Rotation	E	Single
SizingType	E	SizingType	AutoSize = 0, AutoWidth = 1, ManualSize = 2
Surface	E	String
Text	E	String
Type	E	DecalType	DecalText = 0, DecalImage = 1
Width	E	Single
X	E	Single
Y	E	Single

ITABLE (another interface; use the following properties without any object name)

Property	E?	S?	Data Type	Comments
ActiveBall		S	object	See ACTIVEBALL for properties of ActiveBall
AddCreditKey	E	S	Integer
CenterTiltKey	E	S	Integer
GameTime		S	Integer	elapsed time in milliseconds
GetPlayerHWnd		S	Integer	window handle of main table player window
LeftFlipperKey	E	S	Integer
LeftTiltKey	E	S	Integer
PlungerKey	E	S	Integer
RightFlipperKey	E	S	Integer
RightTiltKey	E	S	Integer
StartGameKey	E	S	Integer
UserDirectory		S	String

Methods:

Method	Data Type(s)	Description
EndMusic		stop music
GetTextFile x	String	x = Filename
LoadValue t, n	String, String	t = TableName, n = ValueName loads from VPReg.stg
{name}_MusicDone		procedures to perform when music is done playing
Nudge a, f	Single, Single	a = Angle, f = Force
PlayMusic s	String	s = filename
PlaySound s [,l] [,v]	String, Integer, Single	s = sound name, t = TableName, n = ValueName, v = Value saves to VPReg.stg
StopSound s	String	s = sound name

KICKER (object)

Property	E?	S?	Data Type	Comments
Color	E	S	OLE_COLOR
DrawStyle	E		KickerType	KickerHidden = 0, KickerHole = 1, KickerCup = 2
Enabled	E	S	Boolean
Name	E		String
Surface	E		String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UserValue	E		Variable
X	E		Single
Y	E		Single

Methods:

Method	Data Type(s)	Description
CreateBall		Returns a pointer to the ball created, making expressions like `K1.CreateBall.Color = RGB(0,255,0)` possible
DestroyBall
Kick a, s [,i]	Single, Single, Single	a = Angle, s = Speed, i = (Vertical) Inclination

Events: Hit, Init, Timer

LIGHT (object)

Property	E?	S?	Data Type	Comments
BlinkInterval	E	S	Integer
BlinkPattern	E	S	String	"0"=off, "1"=on
BorderColor	E		OLE_COLOR
BorderWidth	E		Single *
Color	E		OLE_COLOR
Name	E		String
Radius	E		Single
Shape	E		ShapeType	ShapeCircle = 0, ShapeCustom = 1
State	E	S	LightState	LightStateOff = 0, LightStateOn = 1, LightStateBlinking = 2
Surface	E		String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UserValue	E		Variable
X	E		Integer
Y	E		Integer

Events: Init, Timer

LIGHTSEQ (object)

Property	E?	S?	Data Type
CenterX	E		Single
CenterY	E		Single
Collection	E		String
Name	E		String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UpdateInterval	E	S	Integer
UserValue	E	S	Variable

Methods

Method	Data Type(s)	Description
Play a [,t] [,r] [,p]	SequencerState, Integer, Integer, Integer	a = Sequencer State, t = TailLength, r = Repeats (default 1), p = Pause
StopPlay		stops flashing lights in the pattern given by Play

Events: Init, Playdone, Timer

SequencerState can be one of:

SeqUpOn	1
SeqUpOff	2
SeqDownOn	3
SeqDownOff	4
SeqRightOn	5
SeqRightOff	6
SeqLeftOn	7
SeqLeftOff	8
SeqDiagUpRightOn	9
SeqDiagUpRightOff	10
SeqDiagUpLeftOn	11
SeqDiagUpLeftOff	12
SeqDiagDownRightOn	13
SeqDiagDownRightOff	14
SeqDiagDownLeftOn	15
SeqDiagDownLeftOff	16
SeqMiddleOutHorizOn	17
SeqMiddleOutHorizOff	18
SeqMiddleInHorizOn	19
SeqMiddleInHorizOff	20
SeqMiddleOutVertOn	21
SeqMiddleOutVertOff	22
SeqMiddleInVertOn	23
SeqMiddleInVertOff	24
SeqStripe1HorizOn	25
SeqStripe1HorizOff	26
SeqStripe2HorizOn	27
SeqStripe2HorizOff	28
SeqStripe1VertOn	29
SeqStripe1VertOff	30
SeqStripe2VertOn	31
SeqStripe2VertOff	32
SeqHatch1HorizOn	33
SeqHatch1HorizOff	34
SeqHatch2HorizOn	35
SeqHatch2HorizOff	36
SeqHatch1VertOn	37
SeqHatch1VertOff	38
SeqHatch2VertOn	39
SeqHatch2VertOff	40
SeqCircleOutOn	41
SeqCircleOutOff	42
SeqCircleInOn	43
SeqCircleInOff	44

SeqClockRightOn	45
SeqClockRightOff	46
SeqClockLeftOn	47
SeqClockLeftOff	48
SeqRadarRightOn	49
SeqRadarRightOff	50
SeqRadarLeftOn	51
SeqRadarLeftOff	52
SeqWiperRightOn	53
SeqWiperRightOff	54
SeqWiperLeftOn	55
SeqWiperLeftOff	56
SeqFanLeftUpOn	57
SeqFanLeftUpOff	58
SeqFanLeftDownOn	59
SeqFanLeftDownOff	60
SeqFanRightUpOn	61
SeqFanRightUpOff	62
SeqFanRightDownOn	63
SeqFanRightDownOff	64
SeqArcBottomLeftUpOn	65
SeqArcBottomLeftUpOff	66
SeqArcBottomLeftDownOn	67
SeqArcBottomLeftDownOff	68
SeqArcBottomRightUpOn	69
SeqArcBottomRightUpOff	70
SeqArcBottomRightDownOn	71
SeqArcBottomRightDownOff	72
SeqArcTopLeftUpOn	73
SeqArcTopLeftUpOff	74
SeqArcTopLeftDownOn	75
SeqArcTopLeftDownOff	76
SeqArcTopRightUpOn	77
SeqArcTopRightUpOff	78
SeqArcTopRightDownOn	79
SeqArcTopRightDownOff	80
SeqScrewRightOn	81
SeqScrewRightOff	82
SeqScrewLeftOn	83
SeqScrewLeftOff	84
SeqLastDynamic	85
SeqAllOff	1000
SeqAllOn	1001
SeqBlinking	1002
SeqRandom	1003

PLUNGER (object)

Property	E?	S?	Data Type FireSpeed (Editor/Script As Single)
FireSpeed	E	S	Single
Name	E		String
PullSpeed	E	S	Single
Surface	E		String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UserValue	E		Variable
X	E		Single
Y	E		Single

Methods: CreateBall, Fire, PullBack

Events: Init, Timer

RAMP (object)

Property	E?	Data Type	Comments
Color	E	OLE_COLOR
HasWallImage	E	Boolean
HeightBottom	E	Single
HeightTop	E	Single
Image	E	String
ImageAlignment	E	RampImageAlignment	ImageModeWorld = 0, ImageMode Wrap = 1
Name	E	String
Type	E	RampType	RampTypeFlat = 0, RampType4Wire = 1 , RampType2Wire = 2 , RampType3WireLeft = 3, RampType3WireRight = 4.
UserValue	E	Variable
WidthBottom	E	Single
WidthTop	E	Single

Events: Init

SPINNER (object)

Property	E?	S?	Data Type
CastsShadow	E		Boolean
Color	E		OLE_COLOR
Friction	E	S	Single
Height	E		Single
ImageBack	E		String
ImageFront	E		String
Length	E		Single
Name	E		String
Rotation	E		Single
Surface	E		String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
X	E		Single
Y	E		Single

Events: Init, Spin, Timer

TABLE (object)

Property	E?	S?	Data Type
BackdropColor	E		OLE_COLOR
BackdropImage	E		String
BallBackDecal	E		String
BallFontDecal	E		String
BallImage	E		String
DisplayBackdrop	E		Boolean
DisplayGrid	E		Boolean
FieldOfView	E		Single
GlassHeight	E		Single
GridSize	E		Single
Height	E		Single
Image	E		String
Inclination	E		Single
Name	E		String
PlayfieldColor	E		OLE_COLOR
RenderShadows	E		Boolean
Slope	E	S	Single
Width	E		Single
YieldTime		S	Variable

Methods

Method	Data Type(s)	Description
Nudge a, f	Single, Single	a = Angle, f = Force

Events: Exit, Init, KeyDown(keycode), KeyUp(keycode), MusicEnded, UnPaused

TEXTBOX (object)

Property	E?	S?	Data Type	Comments
Alignment	E	S	TextAlignment	TextAlignLeft = 0, TextAlignCenter = 1, TextAlignRight = 2
BackColor	E	S	OLE_COLOR
Font	E		IFontDisp
FontColor	E	S	OLE_COLOR
Height	E		Single
IsTransparent	E	S	Boolean
Name	E		String
Text	E	S	String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UserValue	E	S	Variable
Width	E		Single
X	E		Single
Y	E		Single

Note: Script must refresh Text property if Alignment, BackColor, FontColor, or IsTransparent have been changed. In other words, changing FontColor will not change the color of the text already present, but it will change the color of any new text. To "refresh" the text, you can use the following in your script:

{Name}.Text = {Name}.Text

Events: Init, Timer

TIMER (object)

Property	E?	S?	Data Type
Enabled	E	S	Boolean
Interval	E	S	Integer
Name	E		String
UserValue	E	S	Variant

Events: Init, Timer

TRIGGER (object)

Property	E?	S?	Data Type	Comments
Enabled	E	S	Boolean
Name	E		String
Radius	E		Single
Shape	E		ShapeType *	ShapeCircle = 0, ShapeCustom = 1
Surface	E		String
TimerEnabled	E	S	Boolean
TimerInterval	E	S	Integer
UserValue	E		Variable
Visible	E		Boolean
X	E		Single
Y	E		Single

Events: Hit, Init, Timer, Unhit

WALL (SURFACE/TARGET) (object)

Note: A surface is a wall that cannot be dropped. A target is a wall that can be dropped.

Property	E?	S?	Data Type	Comments
CanDrop	E		Boolean
CastsShadow	E		Boolean
Disabled	E	S	Boolean
DisplayTexture	E		Boolean
Elasticity	E		Single
FaceColor	E		OLE_COLOR
Has HitEvent	E		Boolean
HeightBottom	E		Single
HeightTop	E		Single
Image	E		String
ImageAlignment	E		Boolean
IsDropped		S	Boolean	"CanDrop" must be checked
Name	E		String
SideColor	E		OLE_COLOR
SideImage	E		String
SideVisible	E		Boolean
SlingshotStrength	E		Single
Threshold	E		Single
TimerEnabled	E	S	Boolean
TimerInterval		S	Integer
UserValue	E		Variable
Visible	E		Boolean

Events: Hit, Init, Slingshot, Timer