WorldPortal Class
Interface for world portal handling. See also the UnigineScript analog.
To use this class, include the UnigineWorldPortal.h file.
WorldPortal Class
Members
WorldPortal (float width, float height)
Constructor. Creates a new world portal with given dimensions.Arguments
- float width - Width of the new portal. If a negative value is provided, 0 will be used instead.
- float height - Height of the new portal. If a negative value is provided, 0 will be used instead.
void setSize (float width, float height)
Updates the current dimensions of the world portal.Arguments
- float width - World portal width. If a negative value is provided, 0 will be used instead.
- float height - World portal height. If a negative value is provided, 0 will be used instead.
float getHeight ()
Returns the current height of the world portal.Return value
Current height of the portal.Ptr<WorldSector> getWorldSector (int num)
Returns a specified world sector adjacent to the world portal.Arguments
- int num - Number of the sector in range from 0 to the total number of world sectors.
Return value
Specified sector.float getWidth ()
Returns the current width of the world portal.Return value
Current width of the portal.int getNumWorldSectors ()
Returns the number of world sectors connected with the world portal.Return value
Number of sectors.Last update: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)