Portal Define - Revision history

Printz at 05:30, 28 July 2025

2025-07-28T05:30:17Z

← Older revision		Revision as of 01:30, 28 July 2025
Line 1:		Line 1:
	{{DISPLAYTITLE:Portal_Define}}		{{DISPLAYTITLE:Portal_Define}}
	'''Portal_Define''' is a parameterized [[Static linedef specials\|static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special. The special alone doesn't also apply the portal; they are rather placed on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs).		'''Portal_Define''' is a parameterized [[Static linedef specials\|static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special. The special alone doesn't also apply the portal; they are rather placed on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs). Also for DOOM format maps, you can use [[ExtraData]] fields '''portalid''' (for linedefs) and '''portalid.floor''', '''portalid.ceiling''' (for sectors).

	'''NOTE''': for anchored and linked wall portals (which don't involve [[edge portals]]), you may consider [[Line_QuickPortal]] instead. For the classic Doom format, see [[Portal linedef types]].		'''NOTE''': for anchored and linked wall portals (which don't involve [[edge portals]]), you may consider [[Line_QuickPortal]] instead. For the classic Doom format, see [[Portal linedef types]].

Printz: Added quick links

2017-04-13T08:57:58Z

Added quick links

← Older revision		Revision as of 04:57, 13 April 2017
Line 1:		Line 1:
	{{DISPLAYTITLE:Portal_Define}}		{{DISPLAYTITLE:Portal_Define}}
	'''Portal_Define''' is a parameterized [[Static linedef specials\|static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special. The special alone doesn't also apply the portal; they are rather placed on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs).		'''Portal_Define''' is a parameterized [[Static linedef specials\|static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special. The special alone doesn't also apply the portal; they are rather placed on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs).

			'''NOTE''': for anchored and linked wall portals (which don't involve [[edge portals]]), you may consider [[Line_QuickPortal]] instead. For the classic Doom format, see [[Portal linedef types]].

	==Parameters==		==Parameters==

Printz: /* Parameters */

2017-04-12T17:47:15Z

Parameters

← Older revision		Revision as of 13:47, 12 April 2017
Line 6:		Line 6:
	# ''portal ID'': specify the ID (number) of the new portal. This value will be used to identify this portal and will be referenced in '''portalfloor''', '''portalceiling''' and '''portal'''. The value must be non-zero, positive and unique. Eternity will log a warning in the console if you accidentally reuse a portal ID in another '''Portal_Define''' linedef.		# ''portal ID'': specify the ID (number) of the new portal. This value will be used to identify this portal and will be referenced in '''portalfloor''', '''portalceiling''' and '''portal'''. The value must be non-zero, positive and unique. Eternity will log a warning in the console if you accidentally reuse a portal ID in another '''Portal_Define''' linedef.
	# ''portal type'': specify the type of the portal. Only the ''linked'' portal is interactive; the rest are merely visual. The ''two-way'' portals are those which allow the destination area to have a corresponding portal pointing back to the source area. Valid types are:		# ''portal type'': specify the type of the portal. Only the ''linked'' portal is interactive; the rest are merely visual. The ''two-way'' portals are those which allow the destination area to have a corresponding portal pointing back to the source area. Valid types are:
	#* 0: [[plane portal]]		#* 0: [[Portal#Fixed_Plane_Portals\|plane portal]]
	#* 1: [[horizon portal]]		#* 1: [[Portal#Horizon_Plane_Portals\|horizon portal]]
	#* 2: [[skybox portal]]		#* 2: [[Portal#Skybox_Portals\|skybox portal]]
	#* 3: regular purely visual [[anchored portal]]		#* 3: regular purely visual [[Portal#Anchored_Portals\|anchored portal]]
	#* 4: two-way purely visual [[anchored portal]]		#* 4: two-way purely visual [[Portal#Anchored_Portals\|anchored portal]]
	#* 5: two-way [[linked portal]]		#* 5: two-way [[linked portal]]
	# ''anchor line ID'': this only applies and is necessary for portal types 3-5 (anchored and linked) and must be 0 for types 0-2. It is the [[line ID]] of the linedef which acts as an "anchor" for this linedef. The portal you define will have its view offset and rotation (if applicable) calculated by the position difference between the anchor and the current linedef.		# ''anchor line ID'': this only applies and is necessary for portal types 3-5 (anchored and linked) and must be 0 for types 0-2. It is the [[line ID]] of the linedef which acts as an "anchor" for this linedef. The portal you define will have its view offset and rotation (if applicable) calculated by the position difference between the anchor and the current linedef.
	# ''Z parameter'': this parameter has different meanings depending on portal type. If portal type supports it, it can be positive or negative. For types 0-2 it must be zero. For types 3-4 (visual anchored portals), it specifies the visual ''Z offset'': how much the target area is displaced from the source area vertically. For type 5 (linked portals), since Z offsets aren't currently supported, it specifies the ''plane Z'' offset, which changes the position of the linked portal plane Z from its usual position, and is useful for cross-portal elevators. See the details section for more info on this.		# ''Z parameter'': this parameter has different meanings depending on portal type. If portal type supports it, it can be positive or negative. For types 0-2 it must be zero. For types 3-4 (visual anchored portals), it specifies the visual ''Z offset'': how much the target area is displaced from the source area vertically. For type 5 (linked portals), since Z offsets aren't currently supported, it specifies the ''plane Z'' offset, which changes the position of the linked portal plane Z from its usual position, and is useful for cross-portal elevators. See the details section for more info on this.
	# ''flipped'': only applies for types 3-4 (visual anchored portals); for the rest it must be 0. If this parameter is 1, it causes the anchored portal to rotate view by 180 degrees, and is useful if the source and target lines have the same angle but not the same orientation.		# ''flipped'': only applies for types 3-4 (visual anchored portals); for the rest it must be 0. If this parameter is 1, it causes the anchored portal to rotate view by 180 degrees, and is useful if the source and target lines have the same angle but not the same orientation.

	==Usage==		==Usage==
	Set a '''Portal_Define''' special on a linedef next to the area that gives information about the portal. For plane, horizon and skybox portals the front sector must have certain properties -- see the details section. For anchored and linked portals, you must specify a corresponding line ID of the anchor linedef. The anchor linedef ''doesn't need'' its own portal special set on it; it just holds the anchor line ID.		Set a '''Portal_Define''' special on a linedef next to the area that gives information about the portal. For plane, horizon and skybox portals the front sector must have certain properties -- see the details section. For anchored and linked portals, you must specify a corresponding line ID of the anchor linedef. The anchor linedef ''doesn't need'' its own portal special set on it; it just holds the anchor line ID.

Printz: link update

2017-04-09T19:35:03Z

link update

← Older revision		Revision as of 15:35, 9 April 2017
Line 1:		Line 1:
	{{DISPLAYTITLE:Portal_Define}}		{{DISPLAYTITLE:Portal_Define}}
	'''Portal_Define''' is a parameterized [[static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special. The special alone doesn't also apply the portal; they are rather placed on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs).		'''Portal_Define''' is a parameterized [[Static linedef specials\|static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special. The special alone doesn't also apply the portal; they are rather placed on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs).

	==Parameters==		==Parameters==

Printz at 14:09, 9 April 2017

2017-04-09T14:09:09Z

@@ Line 1: / Line 1: @@
-'''Portal_Define''' is a [[static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special, and they are applied on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs).
+{{DISPLAYTITLE:Portal_Define}}
 [[Category:Portals]]
 [[Category:Linedef specials]]
 [[Category:Editing reference]]

Printz: Started stub.

2017-04-09T10:35:07Z

Started stub.

New page

'''Portal_Define''' is a [[static linedef special]] designed for [[UDMF]] which defines a new [[portal]]. All kinds of portals are supported by this special, and they are applied on sector surfaces and linedefs by using the UDMF properties '''portalfloor''', '''portalceiling''' (for sectors) and '''portal''' (for linedefs).

[[Category:Portals]]
[[Category:Linedef specials]]
[[Category:Editing reference]]