BTRON MicroScript Reference Manual

State Names


I Reference Section

.H
Syntax
Function
_____The .H state name is applied to segments, and it can reference the width of a segment (in units of dots).
_____In a case where a symbol variable has not referenced a segment, it becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _ _ _ _
Integer References References References _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.H cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
This state name cannot be applied
The .H state name cannot be applied to procedures.
The setting of a value is not possible in this item
With the .H state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.H cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.H cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.

147

_____
.PID
Syntax
Function
_____This is used in regard to virtual objects segments or symbol variables that reference virtual object segments, and it can reference the process IDs of processes that start up from those virtual object segments.
_____When a process has not started up, it becomes -1. Also, when a symbol variable has not referenced a virtual object segment, it becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _ _ _ _
Integer _ _ References _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.PID cannot be applied to a variable or constant of anything other than a virtual object segment or a symbol variable.
This state name cannot be applied
.PID cannot be applied to a segment other than a virtual object segment or a symbol variable.
The setting of a value is not possible in this item
With the .PID state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
The symbol variable is not referencing a virtual object segment.
Errors Where an Illegal Value Is Returned
Case where a variable is not a virtual object segment or a procedure
The symbol variable is not referencing a virtual object segment.
148

I Reference Section

.S
Syntax
Function
_____In a case where this has been used in a segment, you can reference the display state of that segment. When a segment isn't displayed, 0 is set, and when a segment is displayed, 1 is set.
_____
_____In a case where this has been used in a procedure name or a procedure number expression, we can reference the execution state of that thread. When a procedure hasn't been executed, 0 is set; while it is being executed, 1 is set; and when it is in a waiting state, 2 is set.
_____In a case where we reference the execution state when threads have been started up in multiple from a procedure, any of the thread states of the threads that have started up in multiple can be obtained.
_____
_____When a symbol variable references a procedure or segment, this can be applied even to the symbol variable. When that's not the case, the value becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _ _ _ _
Integer References References References References
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.S cannot be applied to anything other than a segment name, symbol variable, variable segment variable, procedure name, or procedure number expression.
The setting of a value is not possible in this item
With the .S state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.S cannot be applied to anything other than a segment name, symbol variable, variable segment variable, procedure name, or procedure number expression.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment or a procedure
.S cannot be applied to anything other than a segment name, symbol variable, variable segment variable, procedure name, or procedure number expression.

149, 150

I Reference Section

.TBCOL
Syntax
Function
_____When we use .TBCOL, the referencing and setting of character segment background colors are possible.
_____The values are integer values, and they are expressed as numerical values in which the various elements of RGB are lined up in the range of 0x00(0)`0xff(255).
_____As for the values, arbitrary combinations of the 256 individual gradations of RGB are possible, but, in actuality, they will be displayed with the closest color that it is possible to display.
_____In the case of transparent, the value becomes -1 (0xffffffff). When we set a negative value, we can make the background color transparent.
Color expression: 0x00RRGGBB
0xFFFFFFFF Transparent
0x00000000 Black
0x00FFFFFF White
0x00FF0000 Red
0x0000FF00 Green
0x000000FF Blue
____When we carry out the setting of a value when a character segment is in display state, display also is updated.
_____In a case where you have applied this to a segment that isn't a character segment, the referenced value becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _

Sets

_ _
Character _

Sets

_ _
Integer _

References/sets

_ _
Floating point number _

Sets

_ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TBCOL cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
The .TBCOL state name cannot be applied to segments that are not character segments.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TBCOL cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TBCOL cannot be applied to anything other than a segment name or a symbol variable.

151, 152

I Reference Section

.TCGAP
Syntax
Function
_____With .TCGAP, the referencing and setting of character spacing are possible. The value is in number of dots, and the values 0`240 are valid.
____When we carry out the setting of a value when a character segment is in display state, display also is updated.
_____Because the size of the character segment's display region will not change, there will be cases where characters will not be displayed, depending on the values that are specified.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _

Sets

_ _
Character _

Sets

_ _
Integer _

References/sets

_ _
Floating point number _

Sets

_ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TCGAP cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.TCGAP cannot be applied to segments that are not character segments.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TCGAP cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TCGAP cannot be applied to anything other than a segment name or a symbol variable.

153

_____
.TFCOL
Syntax
Function
_____When we use .TFCOL, the referencing and setting of character segment character colors are possible.
_____The values are integer values, and they are expressed as numerical values in which the various elements of RGB are lined up in the range of 0x00(0)`0xff(255). As for the values, arbitrary combinations of the 256 individual gradations of RGB are possible, but, in actuality, they will be displayed with the closest color that is is possible to display. The setting of a negative value will be ignored (the color will not change).
Color expression: 0xRRGGBB
0x000000 Black
0xFFFFFF White
0xFF0000 Red
0x00FF00 Green
0x0000FF Blue
____When we carry out setting of a value when a character segment is in display state, display also is updated.
_____In a case where you have applied this to a segment that isn't a character segment, the referenced value becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _

Sets

_ _
Character _

Sets

_ _
Integer _

References/sets

_ _
Floating point number _

Sets

_ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TFCOL cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.TFCOL cannot be applied to segments that are not character segments.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TFCOL cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TFCOL cannot be applied to anything other than a segment name or a symbol variable.
154, 155

_____
.TL
Syntax
Function
_____The .TL state name is applied to character segments, and it can reference the number of characters in a character segment.
_____In a case where it is not a character segment, it becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _ _ _ _
Integer _
References
_ _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TL cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.TL cannot be applied to segments that are not character segments.
The setting of a value is not possible in this item
With the .TL state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TL cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TL cannot be applied to anything other than a segment name or a symbol variable.
156

I Reference Section

.TLGAP
Syntax
Function
_____With .TLGAP , the referencing and setting of character segment line spacing are possible. Values are in number of dots.
____When we carry out the setting of a value when a character segment is in display state, display also is updated.
_____Because the size of the character segment's display region will not change, there will be cases where characters will not be displayed, depending on the values that are specified.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _

Sets

_ _
Character _

Sets

_ _
Integer _

References/sets

_ _
Floating point number _

Sets

_ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TLGAP cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.TLGAP cannot be applied to segments that are not character segments.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TLGAP cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TLGAP cannot be applied to anything other than a segment name or a symbol variable.

157

_____
.TSIZE
Syntax
Function
_____With .TSIZE , the referencing and setting of character size are possible. Values are in numbers of dots.
_____When we specify 0, it becomes standard character size (16 dot).
_____When you carry out value setting for a character segment in display state, display also will be updated.
_____Because the size of the character segment's display region will not change, there will be cases where it will come about that characters cannot be displayed, depending on the values that are specified.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _

Sets

_ _
Character _

Sets

_ _
Integer _

References/sets

_ _
Floating point number _

Sets

_ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TSIZE cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.TSIZE cannot be applied to segments that are not character segments.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TSIZE cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TSIZE cannot be applied to anything other than a segment name or a symbol variable.
158

I Reference Section

.TSTYL
Syntax
Function
_____By using the .TSTYL state name, the referencing and setting of a character's embellishment state are possible.
_____The meaning of the values is as below.
_____
0: No embellishments (no underline, half-tone dot meshing)
1: Underline
2: Half-tone dot meshing
_____
_____When you carry out value setting for a character segment in display state, display also will be updated.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _

Sets

_ _
Character _

Sets

_ _
Integer _

References/sets

_ _
Floating point number _

Sets

_ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TSTYL cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.TSTYL cannot be applied to segments that are not character segments.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TSTYL cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TSTYL cannot be applied to anything other than a segment name or a symbol variable.

159

_____
.TX
Syntax
Function
_____The .TX state name is applied to character segments, and it can reference the contents (character strings) of a character segment. By making the expression in the manner of .TX [number of elements], we can reference in the same manner as an array variable (see [ : ]). Substitution cannot be done. When you would like to update the contents of a character segment, please use the TEXT statement.
_____In a case where it is not a character segment, it becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character String _
References
_ _
Integer _
_
_ _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.TX cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.TX cannot be applied to segments that are not character segments.
The setting of a value is not possible in this item
With the .TX state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.TX cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.TX cannot be applied to anything other than a segment name or a symbol variable.
160

I Reference Section

.V
Syntax
Function
_____The .V state name is applied to character segments, which become values in which the contents of a segment's character strings have been converted into numerical values.
_____The numerical value conversion is done in order from the beginning of a character segment string up to where it becomes impossible to interpret the contents as a numerical value. In a case where it is impossible to interpret the contents as numerical values from the beginning of a character string, the value becomes 0.
_____In a case where the characters '.' or 'E' are included in a character string, the values become floating point numerical values, and in a case where that's not the case, the values become integers.
_____In a case where the segment is not a character segment, it becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _
_
_ _
Integer _
References
_ _
Floating point number _ References _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.V cannot be applied to anything other than a character segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.V cannot be applied to segments that are not character segments.
The setting of a value is not possible in this item
With the .V state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.V cannot be applied to anything other than a character segment name or a symbol variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.V cannot be applied to anything other than a segment name or a symbol variable.

161

_____
.W
Syntax
Function
_____The .W state name is applied to segments, and it can reference the width of a segment (in units of dots).
_____In a case where a symbol does not reference a segment, it becomes an illegal value.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _
_
_ _
Integer References
References
References _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, .W cannot be specified
.W cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.W cannot be applied to procedures.
The setting of a value is not possible in this item
With the .W state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.W cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.W cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
162

I Reference Section

.X
Syntax
Function
_____The .X state name is applied to segments, and it can reference a segment's upper left X coordinate.
_____You cannot substitute a value in the .X state name and move a location. To move a location, please use the MOVE statement.
_____When the SCENE statement is executed, all segments move so that the upper left of the segment group displayed by the SCENE statement locates in the upper left of the window. By means of this, the X coordinate obtained through the .X state name also receives influence.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _
_
_ _
Integer References
References
References _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.X cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.X cannot be applied to procedures.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.X cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.X cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.

163

_____
.X0
Syntax
Function
_____The .X0 state name is applied to segments, and it can reference the X coordinate of the initial state of a segment.
_____You cannot substitute a value in the .X0 state name and move a location. The initial location cannot be modified.
_____When the SCENE statement is executed, all segments move so that the upper left of the segment group displayed by the SCENE statement locates in the upper left of the window. By means of this, the X coordinate obtained through the .X0 state name also receives influence.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _
_
_ _
Integer References
References
References _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.X0 cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.X0 cannot be applied to procedures.
The setting of a value is not possible in this item
With the .X0 state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.X0 cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.X0 cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
164

I Reference Section

.Y
Syntax
Function
_____The .Y state name is applied to segments, and it can reference a segment's upper left Y coordinate.
_____You cannot substitute a value in the .Y state name and move a location. To move a location, please use the MOVE statement.
_____When the SCENE statement is executed, all segments move so that the upper left of the segment group displayed by the SCENE statement locates in the upper left of the window. By means of this, the Y coordinate obtained through the .Y state name also receives influence.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _
_
_ _
Integer References
References
References _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.Y cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.Y cannot be applied to procedures.
The setting of a value is not possible in this item
With the .Y state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.Y cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.Y cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.

165

_____
.Y0
Syntax
Function
_____The .Y0 state name is applied to segments, and it can reference the Y coordinate of the initial state of a segment.
_____You cannot substitute a value in the .Y0 state name and move a location. The initial location cannot be modified.
_____When the SCENE statement is executed, all segments move so that the upper left of the segment group displayed by the SCENE statement locates in the upper left of the window. By means of this, the Y coordinate obtained through the .Y0 state name also receives influence.
_
Figure Segment
Character Segment
Virtual Object Segment
Procedure Name
Byte _ _ _ _
Character _
_
_ _
Integer References
References
References _
Floating point number _ _ _ _
Symbol _ _ _ _
Segment name _ _ _ _
Variable segment variable _ _ _ _
Array variable _ _ _ _
Illegal value _ _ _ _
Errors that Occur at Startup Time
Because it is not a segment or a procedure, . cannot be specified
.Y0 cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
This state name cannot be applied
.Y0 cannot be applied to procedures.
The setting of a value is not possible in this item
With the .Y0 state name, only referencing is possible; values cannot be set.
Errors that Occur During Execution (only in the case of DEBUG 1; refer to p. 39)
There was an illegal reference to a state name
.Y0 cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
Errors Where an Illegal Value Is Returned
Case where a variable is not a segment
.Y0 cannot be applied to anything other than a segment name, symbol variable, or variable segment variable.
166


The above contents of BTRON MicroScript Reference Manual were translated and loaded onto this Web page with the permission of Personal Media Corporation.

Copyright (c) 1997 Personal Media Corporation

Copyright (c) 2010 Sakamura Laboratory, University Museum, University of Tokyo