Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

WorldPortal Class

A portal is an opening between two adjacent sectors, through which one sector can be partially seen if looking from another.

WorldPortal Class

This class inherits from Node

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.

float getHeight ()

Returns the current height of the world portal.

Return value

Current height.

int getNumWorldSectors ()

Returns the number of world sectors connected with the world portal.

Return value

Number of sectors.

float getWidth ()

Returns the current width of the world portal.

Return value

Current width.

WorldSector getWorldSector (int id)

Returns a specified world sector adjacent to the world portal.

Arguments

  • int id - Number of the sector in range from 0 to the total number of world sectors.

Return value

Specified sector.

void setSize (float width, float height)

Updates the current dimensions of the world portal.

Arguments

  • float width - Width of the portal. If a negative value is provided, 0 will be used instead.
  • float height - Height of the portal. If a negative value is provided, 0 will be used instead.
Last update: 2017-07-03