OBJECTS REFERENCE (FULL EDITION ONLY,
WINDOWS ONLY)
List of all the objects that are available from VBScript by
default
Object |
Description |
Hotspot(INDEX) |
"ImageBox"
controls that correspond to the hotspots that are created when you hold down the left
mouse button in the "Frame Editor" window of Adventure Maker. Replace INDEX with
the number that identifies the hotspot. |
Text(INDEX) |
"Label"
controls that correspond to the text objects that are created when you right-click on the
background of the "Frame Editor" window of
Adventure Maker. Replace INDEX with the number that identifies the text object. |
LoopingVideo(INDEX) |
"MediaPlayer"
controls that correspond to the looping videos that are created when you select
"Looping Video" from the "General" tab of the "Hotspot
Properties" of a hotspot. Replace INDEX with the number that identifies the hotspot. |
EXAMPLES:
To disable the hotspot
number 1, use the following code:
Hotspot(1).Enabled = False
To disable all the
hotspots, use the following code:
For Each X in Hotspot
X.Enabled = False
Next
To make all the hotspots
become transparent, use the following code:
For Each X in Hotspot
Set X.Picture = Nothing
Next
To change the cursor that
is associated to the hotspot number 5, use the following code (where FILENAME is an icon
or cursor that is located inside the "Areas" subfolder of the project folder):
Hotspot(5).MouseIcon =
LoadGraphicFile("FILENAME")
Hotspot(5).MousePointer = 99
To change the contents of
the text object number 1, use the following code:
Text(1).Caption =
"ENTER_NEW_TEXT_HERE"
To move the text object
number 3 to the position (100,200) in pixels, use the following code (notice that you must
multiply the coordinates by 15 in order to get the coordinated in twips instead of
pixels):
Text(3).Move 100*15,200*15
:
To hide all the text objects, use the following code:
For Each X in Text
X.Visible = False
Next
To stop the looping video
number 1, use the following code:
LoopingVideo(1).Pause
To resume playback of the
looping video number 1, use the following code:
LoopingVideo(1).Play
To change the playback
speed of all the looping videos, use the following code (where you must replace NEW_SPEED
with a value):
For Each X in LoopingVideo
X.Rate = NEW_SPEED
Next
Object |
Most
interesting properties (VB6) |
CheckBoxObject(INDEX) |
.Value (default=false)
.Caption |
LineObject(INDEX) |
.X1
.X2
.Y1
.Y2
.BorderColor |
ShapeObject(INDEX) |
.Shape (0 to
5)
.BorderColor
.BorderStyle (0 to 6)
.BackColor
.BackStyle (0 or 1) |
TextBoxObject(INDEX) |
.Text |
PictureBoxObject(INDEX) |
.Picture
.Image
.BackColor (default=VbWhite)
.AutoRedraw (default=true)
.AutoSize (default=false) |
ListBoxObject(INDEX) |
.List(INDEX2)
.ListIndex
.ListCount |
ImageBoxObject(INDEX) |
.Picture
.Stretch (default=false) |
FileBoxObject(INDEX) |
.Path
.Pattern (default="*.*")
.FileName
.List(INDEX2)
.ListIndex
.ListCount |
DirBoxObject(INDEX) |
.Path |
DriveBoxObject(INDEX) |
.Drive |
MediaPlayerObject(INDEX) |
.AutoRewind
(default=true)
.Autosize (default=false)
.Autostart (default=false)
.ClickToPlay (default=false)
.CurrentPosition
.FileName
.Mute (default=false)
.PlayCount (default=0)
.Rate (default=1)
.Volume (default= -1080) |
The following properties are available for most of the controls listed above:
.Visible
.Enabled
.Left
.Top
.Width
.Height
.MouseIcon
.MousePointer
.Tag
To create a new control, use the following code (where you must replace CONTROLNAME with
the name of the control and INDEX with any integer of your choice greater than 1):
LoadControl CONTROLNAME(INDEX)
To remove a control, use
the following code:
UnloadControl CONTROLNAME(INDEX)
To be sure that the index
of the new control is not being used by another piece of code (like another procedure or
even a plugin), use the following code (where you must replace CONTROLNAME with the name
of the control):
Dim i
Do Until LoadControl(CONTROLNAME(i))=True
i=i+1
Loop
EXAMPLES:
To create a new checkbox,
use the following code:
LoadControl CheckBoxObject(1)
To remove the checkbox,
use the following code:
UnloadControl CheckBoxObject(1)
If you are not sure
whether the CheckBox number 1 already exists, use the following code to find a free index
and create a new checkbox with that index:
Dim i
Do Until LoadControl(CheckBoxObject(i)) = True
i=i+1
Loop
To make the checkbox
number 1 become visible, use the following code:
CheckBoxObject(1).Visible = True
To change the text that
is on the checkbox, use the following code:
CheckBoxObject(1).Caption =
"ENTER_SOME_TEXT_HERE"
To create a new
PictureBox and display it, use the following code:
LoadControl PictureBoxObject(1)
To move and resize the
PictureBox, use the following code (where you must replace LEFT, TOP, WIDTH and HEIGHT
with the values in pixels):
PictureBoxObject(1).Move
LEFT*15,TOP*15,WIDTH*15,HEIGHT*15
To create and show a new
TextBox, use the following code:
LoadControl TextBoxObject(1)
TextBoxObject(1).Visible = True
To display in a popup
message the text that the user has entered in the TextBox, use the following code:
MsgBox TextBoxObject(1).Text
To compare the text that
the user has entered in the TextBox with the secret password "dog", use the
following code:
If TextBoxObject(1).Text <>
"dog" Then
MsgBox "Wrong Password!"
Else
MsgBox "Password Correct!"
End If
Object |
VB6
equivalent |
Main
properties |
ScreenObject |
VB.Screen |
.FontCount
.Fonts(INDEX)
.Height
.Width
.MouseIcon
.MousePointer
.TwipsPerPixelX
.TwipsPerPixelY |
AppObject |
VB.App |
.EXEName
.HelpFile
.hInstance
.Path
.PrevInstance
.ThreadID
.Title |
PrinterObject |
VB.Printer |
.CurrentX
.CurrentY
.DeviceName
.Orientation |
PrintersCollection |
VB.Printers |
.Count
.Item(INDEX) |
ClipboardObject |
VB.Clipboard |
|
EXAMPLES:
To change the cursor to
the hourglass, use the following code:
ScreenObject.MousePointer = 11
To remove the hourglass
cursor, use the following code:
ScreenObject.MousePointer = 0
To display the screen
resolution in pixels, use the following code:
MsgBox (ScreenObject.Width/15)
& "*" & (ScreenObject.Height/15)
To change the title of
the application, use the following code:
AppObject.Title =
"ENTER_TITLE_HERE"
To know whether another
instance of the application is already running, use the following code:
MsgBox AppObject.PrevInstance
To list of all the
available printers, use the following code:
Dim x
For Each x In PrintersCollection
MsgBox x.DeviceName
Next
To print the contents of
the current frame (including all the hotspots, text objects, and custom controls), use the
following code:
LoadControl
PictureBoxObject(1)
PictureBoxObject(1).Move 0,0,GetProjectWidth*15,GetProjectHeight*15
CaptureFrame(PictureBoxObject(1))
Set PictureBoxObject(1).Picture=PictureBoxObject(1).Image
PrinterObject.PaintPicture PictureBoxObject(1).Picture,1000,1000
PrinterObject.EndDoc
Object |
Type (VB6) |
TimedEventObject(i) |
Timer |
TimerObject(i) |
Timer |
MessageTimerObject |
Timer |
MessageObject |
Label |
MessageCanvasObject |
Frame |
DialogueObject(i) |
Label |
DialogueCanvasObject |
Label |
BackgroundObject |
PictureBox |
BackgroundHotspotObject |
Image |
AudioPlayerObject(i) |
MediaPlayer |
InventoryItemObject(i) |
Image |
InventoryButtonObject |
Image |
InventoryCanvasObject |
PictureBox |
InventoryBackgroundObject |
Image |
InventoryTimerObject |
Timer |
FramesHistoryObject |
ListBox |
RipplingWaterObject |
PictureBox |
AnimatedGifObject(i) |
Gif89a control |
AnimatedGifCanvasObject(i) |
Frame |
ScriptControlObject |
ScriptControl |
ScriptControl2Object |
ScriptControl |
WindowObject |
Form |
ExitMenuObject |
Menu |
SaveMenuObject |
Menu |
LoadMenuObject |
Menu |
OptionsMenuObject |
Menu |
DebugMenuObject |
Menu |
DisableEffectsMenuObject |
Menu |
TransitionsMenuObject |
Menu |
EXAMPLES:
To change to "Times
New Roman" the font of the messages that appear at the bottom of the screen, use the
following code:
MessageObject.FontName = "Times New Roman"
To change the size of the
text displayed at the bottom of the screen, use the following code:
MessageObject.FontSize = 20
To change the color of
the text displayed at the bottom of the screen, use the following code:
MessageObject.ForeColor = RGB(0,0,255)
To change what it is
written on the "Exit" button of the menu that appears when you press
"Esc" during the game, use the following code:
ExitMenuObject.Caption =
"ENTER_SOME_TEXT_HERE"
To change the font of the
questions that appear in the conversations created with the Dialogue Wizard, use the
following code:
For Each X in DialogueObject
X.FontName = "Times New Roman"
X.FontSize = 20
X.FontUnderline = True
Next
|