InstancePortal

From Multiverse

MARS Client Scripting Library
MarsAbility MarsAction MarsClassAbility MarsCommand MarsContainer MarsCursor MarsEvent MarsGroup	MarsQuest MarsSkill MarsTarget MarsTrade MarsTraining MarsUnit MarsVoice
Additional Modules
MarsStandardCommands
Examples
InstancePortal

InstancePortal is an example for the Mars Client Scripting API provided in Sampleworld in the file /Scripts/InstancePortal.py. It provides a property-based mechanism to create portals for entering and leaving instances.

For more information on this example, see World Instancing - Instance portal examples in Sampleworld.

1 Methods
2 Properties
3 Events
4 Messages

[edit]

Methods

The InstancePortal module does not have any external methods.

[edit]

Properties

The InstancePortal module uses the following object properties:

Property	Datatype	Description
instancePortal	string	Any object with this property is treated as an instance portal. The value of the property is used as the mouseover tooltip for the object.
instanceName	string	The name of the instance to enter. This is ignored if instanceFlags is "pop"
locMarker	string	When entering an instance, this property is used as the name of the marker to enter at.
instanceFlags	string	If this is "push" or "pop", the portal manipulates the instance stack.
restoreMarker	string	The name of the marker to use when exiting the instance via a "pop".