This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.WorldPortal Class

Inherits: Node

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

WorldPortal Class

Properties

float Height#

The current height of the world portal.
set
Sets the height of the world portal.
set value - Height, in units.

float Width#

The current width of the world portal.
set
Sets the width of the world portal.
set value - Width, in units.

int NumWorldSectors#

The number of world sectors connected with the world portal.

Members


static 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 is used instead.
  • float height - Height of the new portal. If a negative value is provided, 0 is used instead.

static WorldPortal Cast ( Node node ) #

Casts a WorldPortal out of the Node instance.

Arguments

  • Node node - Node instance.

Return value

WorldPortal instance.

void SetHeight ( float height ) #

Sets the height of the world portal.

Arguments

  • float height - Height, in units.

void SetWidth ( float width ) #

Sets the width of the world portal.

Arguments

  • float width - Width, in units.

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.

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.

static int type ( ) #

Returns the type of the node.

Return value

World type identifier.
Last update: 2019-08-16
Build: ()