Edit instance

From HEWIKI
(Difference between revisions)
Jump to: navigation, search
(Created page with "__NOTOC__ An '''Edit Instance''' of an area is always the #0 instance. Any changes made to the Area are persisted to the database as they are made. This saved version becom...")
 
(added permissions section)
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
[[Image:EditInstance.png|right|frame|Bottom righthand corner of the viewport, showing the Area name and the Edit Instance which you are in.]]
 +
 
An '''Edit Instance''' of an [[area]] is always the #0 instance.  Any changes made to the Area are persisted to the database as they are made.  This saved version becomes the template for any future [[Play Instance|Play Instances]] of the Area, because the edits will be saved to the [[Repository]].
 
An '''Edit Instance''' of an [[area]] is always the #0 instance.  Any changes made to the Area are persisted to the database as they are made.  This saved version becomes the template for any future [[Play Instance|Play Instances]] of the Area, because the edits will be saved to the [[Repository]].
  
Line 5: Line 7:
  
 
The Edit Instance's sole purpose is for world-building.  It is not a good idea to do gameplay testing in an Edit Instance, is there is any change that the play might affect anything that would be improper to persist to the database. Gameplay testing ''can'' be done in an Edit Instance, but it is not recommended.
 
The Edit Instance's sole purpose is for world-building.  It is not a good idea to do gameplay testing in an Edit Instance, is there is any change that the play might affect anything that would be improper to persist to the database. Gameplay testing ''can'' be done in an Edit Instance, but it is not recommended.
 
[[Image:Area_Name_Location.jpg|right|thumb|400px|Area Name]]
 
  
 
To tell if you are in an edit instance or not, look at the bottom right-hand corner of the [[HeroBlade]] screen.  Next to the area name, it will either have a number in parentheses, or the word "(EDIT)".   
 
To tell if you are in an edit instance or not, look at the bottom right-hand corner of the [[HeroBlade]] screen.  Next to the area name, it will either have a number in parentheses, or the word "(EDIT)".   
  
To further distinguish, an Edit Instance will always be displayed in a blue box.  Play instances will instead be beige.
+
<br>
<br clear="all">
+
A play instance will have the instance number in parentheses next to it.
{| align="center" width="85%" cellpadding="10"
+
<br>
|-align="center" width="50%" valign="top"
+
[[Image:Playinstance.png]]
|[[Image:Playinstance.gif]]<br>A play instance will be yellow-beige and have the instance number in parentheses next to it.
+
 
|[[Image:Editinstance.gif]]<br>An edit instance will be blue and say (EDIT) next to it.
+
<br>
|}
+
An edit instance will say (EDIT) next to it.
 +
<br>
 +
[[Image:EditInstance.png]]
 +
 
 +
<br>
  
 
==Conflicts==
 
==Conflicts==
Line 30: Line 34:
  
 
Keep in mind that, in general, this affects only your development servers.  Ultimately all editing will be done there, and published to your testing and live servers.  The primary use for play instances on your development servers is for testing and sandbox experimentation.
 
Keep in mind that, in general, this affects only your development servers.  Ultimately all editing will be done there, and published to your testing and live servers.  The primary use for play instances on your development servers is for testing and sandbox experimentation.
 +
 +
<br>
  
 
== Editing Geometry ==
 
== Editing Geometry ==
Line 36: Line 42:
  
 
The [[$EDIT]] [[system node]] processes all of the edits to the area.  It also has methods that the server-side script can call to do area editing.
 
The [[$EDIT]] [[system node]] processes all of the edits to the area.  It also has methods that the server-side script can call to do area editing.
 +
 +
<br>
 +
 +
== Permissions ==
 +
 +
An area can only be edited by a user with the proper permissions granted to them by the [[Account_Management_System|Account Management System]]. For a user to be granted the permission to edit areas they must have the '''Administrator''' and/or '''Developer''' flag enabled. These flags can only be changed on the [[Account_Management_System#Group_Management|Group Management]] page of the [[Account_Management_System|Account Management System]] by an Administrator of the group.
 +
 +
<br>
  
 
==See also==
 
==See also==
Line 41: Line 55:
 
* [[System Areas]]
 
* [[System Areas]]
  
[[Category:Processes]]
 
  
 +
[[Category:Processes]]
 
[[Category:Definitions|Edit Instance]]
 
[[Category:Definitions|Edit Instance]]
 
[[Category:Area server]]
 
[[Category:Area server]]

Latest revision as of 22:13, 2 November 2012

Bottom righthand corner of the viewport, showing the Area name and the Edit Instance which you are in.

An Edit Instance of an area is always the #0 instance. Any changes made to the Area are persisted to the database as they are made. This saved version becomes the template for any future Play Instances of the Area, because the edits will be saved to the Repository.

There is only one Edit Instance of an Area in a given World.

The Edit Instance's sole purpose is for world-building. It is not a good idea to do gameplay testing in an Edit Instance, is there is any change that the play might affect anything that would be improper to persist to the database. Gameplay testing can be done in an Edit Instance, but it is not recommended.

To tell if you are in an edit instance or not, look at the bottom right-hand corner of the HeroBlade screen. Next to the area name, it will either have a number in parentheses, or the word "(EDIT)".


A play instance will have the instance number in parentheses next to it.
Playinstance.png


An edit instance will say (EDIT) next to it.
EditInstance.png


Conflicts

In most cases, an area will not have both play and edit instances open at the same time. However, HeroEngine does allow for this type of development, but it may require some careful scripting to deal with potential conflicts. This is because any changes made to the edit instance will not be propagated to a play instance, until the next time that a player enters that instance, and then the new information will only be available to the newly-entered player, and not to any players that were in the instance prior to the change. This may cause some confusion if not properly handled.

For example:

If your team desires to do this kind of development routinely, one way to handle it is to "force" area updates via HSL. In the above example, a script could be triggered via RemoteCall in all appropriate play instances, to say, "Add a volcano." Then, all players in that area would see it at the same time.

Keep in mind that, in general, this affects only your development servers. Ultimately all editing will be done there, and published to your testing and live servers. The primary use for play instances on your development servers is for testing and sandbox experimentation.


Editing Geometry

The technical description of how the area server stores its representation of the area geometry is found on the Area Node Structure page.

The $EDIT system node processes all of the edits to the area. It also has methods that the server-side script can call to do area editing.


Permissions

An area can only be edited by a user with the proper permissions granted to them by the Account Management System. For a user to be granted the permission to edit areas they must have the Administrator and/or Developer flag enabled. These flags can only be changed on the Group Management page of the Account Management System by an Administrator of the group.


See also

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox