Owning Portal Object Related System Attributes

From Planimate Knowledge Base
Jump to: navigation, search

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).