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. </...) |
mNo edit summary |
||
| 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> | ||
'''CurrentScreenStatus <br>''' | '''CurrentScreenStatus <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. In this case, this Portal does not have to be part of the _Model Objects List, but it has to have its States customized. | This is the Current State Value of the Portal Object above the subsystem in which this attribute is set or read. In this case, this Portal does not have to be part of the _Model Objects List, but it has to have its States customized. | ||
<br> | <br> | ||
'''OwningPortalLocation <br>''' | '''OwningPortalLocation <br>''' | ||
R <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). | 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> | <br> | ||
'''CurrentPortalX / CurrentPortalY <br>''' | '''CurrentPortalX / CurrentPortalY <br>''' | ||
R/W | R/W | ||
| Line 45: | Line 43: | ||
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. | ||
<br> | |||
'''CurrentPortalWidth / CurrentPortalHeight ''' | |||
'''CurrentPortalWidth / CurrentPortalHeight ''' | |||
R/W | R/W | ||
| Line 53: | Line 51: | ||
Setting these attributes will tell you the current size of the Portal. | Setting these attributes will tell you the current size of the Portal. | ||
<br> | |||
'''CurrentPortalXScale / CurrentPortalYScale ''' | |||
'''CurrentPortalXScale / CurrentPortalYScale ''' | |||
R/W | R/W | ||
| Line 63: | Line 61: | ||
They are specified as a percentage, normally 100. | They are specified as a percentage, normally 100. | ||
Be wary of large values. | Be wary of large values. | ||
[[Category:Attribute]] | [[Category:Attribute]] [[Category:Object/Portal]] [[Category:Routine]] | ||
[[Category:Object/Portal]] | |||
[[Category:Routine]] | |||
Revision as of 14:20, 14 December 2008
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
CurrentScreenStatus
R/W
This is the Current State Value of the Portal Object above the subsystem in which this attribute is set or read. In this case, this Portal does not have to be part of the _Model Objects List, but it has to have its States customized.
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).
CurrentPortalX / CurrentPortalY
R/W
Setting these attributes will move a Portal into a new position.
There are other mechanisms to do this kind of repositioning also, which may be more appropriate.
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.
CurrentPortalWidth / CurrentPortalHeight
R/W
Setting these attributes will tell you the current size of the Portal.
CurrentPortalXScale / CurrentPortalYScale
R/W
These enable a Portal’s image to be scaled in the x and y direction.
They are specified as a percentage, normally 100.
Be wary of large values.