Owning Portal Object Related System Attributes: Difference between revisions
m (New page: == Owning Portal Object Related System Attributes == <onlyinclude> These system attributes enable a subsystem to access its owning portals graphics without having to use a label list. </...) |
m (o) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Owning Portal Object Related System Attributes == | == Owning Portal Object Related System Attributes == | ||
<onlyinclude> | <onlyinclude>These system attributes enable a subsystem to access its owning portals graphics without having to use a label list.</onlyinclude> | ||
These system attributes enable a subsystem to access its owning portals graphics without having to use a label list. | |||
</onlyinclude> | |||
---- | ---- | ||
Name <br> | '''Name '''<br> | ||
Read / Write <br> | Read / Write <br> | ||
Description | Description | ||
| Line 15: | Line 13: | ||
---- | ---- | ||
<br> | <br> | ||
''' | === '''CurrentPanelStatus <br>''' === | ||
R/W <br> | R/W <br> | ||
This is the Current State Value of the Portal Object above the subsystem in which this attribute is set or read | This is the Current State Value of the Portal Object above the subsystem in which this attribute is set or read. | ||
The Portal does not have to be part of the _Model Objects List, but it must have had its States customized. | |||
<br> | |||
=== '''CurrentPortalHeight ''' === | |||
R/W | |||
This attribute will tell you the current height of the Portal Icon (in pixels). | |||
<br> | <br> | ||
''' | === '''CurrentPortalWidth ''' === | ||
R/W | R/W | ||
This attribute will tell you the current width of the Portal Icon (in pixels). | |||
<br> | |||
=== '''CurrentPortalX<br>''' === | |||
R/W | |||
Setting this attribute will move a Portal into a new position along the X axis (i.e. left or right, horizontally). | |||
To make use of this attribute, you have to be inside the actual portal itself. | To make use of this attribute, you have to be inside the actual portal itself. | ||
| Line 45: | Line 51: | ||
Usually you will message or broadcast into the portal to get it move. Its main usefulness is that you can move a portal without having to export its identity into the _Model Objects label list. | Usually you will message or broadcast into the portal to get it move. Its main usefulness is that you can move a portal without having to export its identity into the _Model Objects label list. | ||
There are other mechanisms to do this kind of repositioning also, which may be more appropriate. | |||
<br> | |||
''' | === '''CurrentPortalXScale ''' === | ||
R/W | R/W | ||
This enables a Portal’s icon image to be scaled in the x direction. | |||
They are specified as a percentage - normally 100 - being the native size of the icon image. | |||
Be wary of large values. | |||
<br> | |||
''' | <br> | ||
=== '''CurrentPortalY <br>''' === | |||
R/W | R/W | ||
Setting this attribute will move a Portal into a new position along the Y axis (i.e. up or down, vertically). | |||
They are specified as a percentage | To make use of this attribute, you have to be inside the actual portal itself. | ||
Usually you will message or broadcast into the portal to get it move. Its main usefulness is that you can move a portal without having to export its identity into the _Model Objects label list.<br> | |||
There are other mechanisms to do this kind of repositioning also, which may be more appropriate. | |||
<br> | |||
=== '''CurrentPortalYScale ''' === | |||
R/W | |||
These enable a Portal’s image to be scaled in the y direction. | |||
They are specified as a percentage - normally 100 - being the native size of the icon image. | |||
Be wary of large values. | |||
<br> | |||
=== '''OwningPortalLocation <br>''' === | |||
R <br> | |||
Returns you the index of the first portal above you in the hierarchy that is part of the _Model Objects system Label List (i.e. that has been exported). | |||
<br> | |||
[[Category:Attribute]] | [[Category:Attribute]] [[Category:Object/Portal]] [[Category:Routine]] | ||
[[Category:Object/Portal]] | |||
[[Category:Routine]] | |||
Latest revision as of 21:59, 4 January 2009
Owning Portal Object Related System Attributes
These system attributes enable a subsystem to access its owning portals graphics without having to use a label list.
Name
Read / Write
Description
CurrentPanelStatus
R/W
This is the Current State Value of the Portal Object above the subsystem in which this attribute is set or read.
The Portal does not have to be part of the _Model Objects List, but it must have had its States customized.
CurrentPortalHeight
R/W
This attribute will tell you the current height of the Portal Icon (in pixels).
CurrentPortalWidth
R/W
This attribute will tell you the current width of the Portal Icon (in pixels).
CurrentPortalX
R/W
Setting this attribute will move a Portal into a new position along the X axis (i.e. left or right, horizontally).
To make use of this attribute, you have to be inside the actual portal itself.
Usually you will message or broadcast into the portal to get it move. Its main usefulness is that you can move a portal without having to export its identity into the _Model Objects label list.
There are other mechanisms to do this kind of repositioning also, which may be more appropriate.
CurrentPortalXScale
R/W
This enables a Portal’s icon image to be scaled in the x direction.
They are specified as a percentage - normally 100 - being the native size of the icon image.
Be wary of large values.
CurrentPortalY
R/W
Setting this attribute will move a Portal into a new position along the Y axis (i.e. up or down, vertically).
To make use of this attribute, you have to be inside the actual portal itself.
Usually you will message or broadcast into the portal to get it move. Its main usefulness is that you can move a portal without having to export its identity into the _Model Objects label list.
There are other mechanisms to do this kind of repositioning also, which may be more appropriate.
CurrentPortalYScale
R/W
These enable a Portal’s image to be scaled in the y direction.
They are specified as a percentage - normally 100 - being the native size of the icon image.
Be wary of large values.
OwningPortalLocation
R
Returns you the index of the first portal above you in the hierarchy that is part of the _Model Objects system Label List (i.e. that has been exported).