Orbiter Variables - Revision history

Phenigma at 20:29, 15 September 2014

2014-09-15T20:29:36Z

←Older revision		Revision as of 20:29, 15 September 2014
Line 24:		Line 24:
	===<%=CA:Date%>===		===<%=CA:Date%>===
	Start date of current broadcast?		Start date of current broadcast?
	==Now Playing ~~Informatio~~==		==Now Playing Information==
	===<%=NP%>===		===<%=NP%>===
	Now Playing - Info about the currently playing media		Now Playing - Info about the currently playing media (title)
	===<%=NP_MT%>===		===<%=NP_MT%>===
	Now Playing Media Type - Info about the currently playing media type		Now Playing Media Type - Info about the currently playing media type
	===<%=NP_SEC%>===		===<%=NP_SEC%>===
	Now Playing Section - Info about the currently playing section		Now Playing Section - Info about the currently playing section/chapter/track
	===<%=NP_TIME_SHORT%>===		===<%=NP_TIME_SHORT%>===
	Now Playing ??		Now Playing - Current position in track HH:MM:SS
	===<%=NP_TIME_LONG%>===		===<%=NP_TIME_LONG%>===
	Now Playing ??		Now Playing - as above plus total time of track
	===<%=NP_SPEED%>===		===<%=NP_SPEED%>===
	Now Playing - Current speed		Now Playing - Current speed

Sambuca at 12:34, 16 December 2010

2010-12-16T12:34:35Z

←Older revision		Revision as of 12:34, 16 December 2010
Line 139:		Line 139:
	== V Variables ==		== V Variables ==
	Return the virtual device by the ID following V, i.e. V1234 returns the virtual device 1234 ???		Return the virtual device by the ID following V, i.e. V1234 returns the virtual device 1234 ???
			== DD Variables ==
			Return the device data for the orbiter, i.e. DD100 returns the device data with PK = 100
	== D Variables ==		== D Variables ==
	Return the name of the Device by the ID following D, i.e. D123 returns device 123 description.		Return the name of the Device by the ID following D, i.e. D123 returns device 123 description.

Marie.o: /* <%=U%> */

2010-05-09T19:33:07Z

<%=U%>

←Older revision		Revision as of 19:33, 9 May 2010
Line 103:		Line 103:
	Current Room		Current Room
	===<%=U%>===		===<%=U%>===
	Current PK_Users value assigned to this orbiter (The ~~currnet~~ user using it.)		Current PK_Users value assigned to this orbiter (The current user using it.)

	===<%=UN%>===		===<%=UN%>===
	Current Users Name		Current Users Name

Wierdbeard65 at 15:55, 5 May 2010

2010-05-05T15:55:25Z

←Older revision		Revision as of 15:55, 5 May 2010
Line 1:		Line 1:
			{{versioninfo}}
	[[Category: Programmer's Guide]]		[[Category: Programmer's Guide]]
	[[Category: Orbiters]]		[[Category: Orbiters]]

Tschak909: /* Variable Definition */ slight correction.

2008-10-17T17:00:08Z

Variable Definition: slight correction.

←Older revision		Revision as of 17:00, 17 October 2008
Line 4:		Line 4:

	=Variable Definition=		=Variable Definition=
	Each time text has to be displayed, this text can be substituted by a variable.		Each time text has to be displayed or used in a designobj or command parameter, this text can be substituted by a variable.
	<%= %>		<%= %>
	is the way to define a substitution.		is the way to define a substitution.

	=Defined Variables=		=Defined Variables=
	==Cell Attributes <%=CA:xxxx%>==		==Cell Attributes <%=CA:xxxx%>==

Tschak909: /* <%=!%> */ slight correction.

2008-10-17T15:38:46Z

<%=!%>: slight correction.

←Older revision		Revision as of 15:38, 17 October 2008
Line 57:		Line 57:
	Returns 0 if the variable is 1, otherwise a 1 is returned		Returns 0 if the variable is 1, otherwise a 1 is returned
	===<%=!%>===		===<%=!%>===
	The device # of the ~~onscreen~~ orbiter.		The device # of the orbiter rendering this instance of this screen.

	===<%=E%>===		===<%=E%>===
	Current Entertainment Area		Current Entertainment Area

Tschak909: Corrected and added a few things.

2008-10-13T15:06:34Z

Corrected and added a few things.

←Older revision		Revision as of 15:06, 13 October 2008
Line 36:		Line 36:
	Now Playing - Current speed		Now Playing - Current speed
	===<%=NPD%>===		===<%=NPD%>===
	Now Playing - Device ~~currently playing on?~~		Now Playing - The Current Media Player device referenced by device -106.
			===<%=NPDT%>===
			Now Playing Device Template - The Current Media Player device template referenced by device -106
	===<%=NP_R%>===		===<%=NP_R%>===
	Now Playing - Screen ID of the remote playing media?		Now Playing - Screen ID of the remote playing media?
Line 54:		Line 56:
	===<%=!varname%>===		===<%=!varname%>===
	Returns 0 if the variable is 1, otherwise a 1 is returned		Returns 0 if the variable is 1, otherwise a 1 is returned
			===<%=!%>===
			The device # of the onscreen orbiter.
	===<%=E%>===		===<%=E%>===
	Current Entertainment Area		Current Entertainment Area
Line 96:		Line 100:
	Current Room		Current Room
	===<%=U%>===		===<%=U%>===
	~~Users~~		Current PK_Users value assigned to this orbiter (The currnet user using it.)
	===<%=UN%>===		===<%=UN%>===
	Current Users Name		Current Users Name

Marie.o at 11:43, 10 October 2008

2008-10-10T11:43:30Z

←Older revision		Revision as of 11:43, 10 October 2008
Line 12:		Line 12:

	Variables starting with CAV return a value of that specific variable. Variables starting with CAT return the text of that specific variable.		Variables starting with CAV return a value of that specific variable. Variables starting with CAT return the text of that specific variable.
	===<%CA:Name%>===		===<%=CA:Name%>===
	Name of channel		Name of channel
	===<%CA:Info%>===		===<%=CA:Info%>===
	Title of current broadcast		Title of current broadcast
	===<%CA:Synopsis%>===		===<%=CA:Synopsis%>===
	Long synopsis of current broadcast		Long synopsis of current broadcast
	===<%CA:Time%>===		===<%=CA:Time%>===
	Start time of current broadcast?		Start time of current broadcast?
	===<%CA:Date%>===		===<%=CA:Date%>===
	Start date of current broadcast?		Start date of current broadcast?
	==Now Playing Informatio==		==Now Playing Informatio==
	===<%NP%>===		===<%=NP%>===
	Now Playing - Info about the currently playing media		Now Playing - Info about the currently playing media
	===<%NP_MT%>===		===<%=NP_MT%>===
	Now Playing Media Type - Info about the currently playing media type		Now Playing Media Type - Info about the currently playing media type
	===<%NP_SEC%>===		===<%=NP_SEC%>===
	Now Playing Section - Info about the currently playing section		Now Playing Section - Info about the currently playing section
	===<%NP_TIME_SHORT%>===		===<%=NP_TIME_SHORT%>===
	Now Playing ??		Now Playing ??
	===<%NP_TIME_LONG%>===		===<%=NP_TIME_LONG%>===
	Now Playing ??		Now Playing ??
	===<%NP_SPEED%>===		===<%=NP_SPEED%>===
	Now Playing - Current speed		Now Playing - Current speed
	===<%NPD%>===		===<%=NPD%>===
	Now Playing - Device currently playing on?		Now Playing - Device currently playing on?
	===<%NP_R%>===		===<%=NP_R%>===
	Now Playing - Screen ID of the remote playing media?		Now Playing - Screen ID of the remote playing media?
	===<%NP_PR%>===		===<%=NP_PR%>===
	Now Playing - DesignObj ID of the remote popup?		Now Playing - DesignObj ID of the remote popup?
	===<%NP_RNF%>===		===<%=NP_RNF%>===
	Now Playing - Screen of remote		Now Playing - Screen of remote
	==Other==		==Other==
	===<%LANIP%>===		===<%=LANIP%>===
	Local IP address		Local IP address
	===<%RIP%>===		===<%=RIP%>===
	Router IP address		Router IP address
	===<%RSI%>===		===<%=RSI%>===
	Ripping Status Information		Ripping Status Information
	===<%LUV%>===		===<%=LUV%>===
	Last Update Version		Last Update Version
	===<%!varname%>===		===<%=!varname%>===
	Returns 0 if the variable is 1, otherwise a 1 is returned		Returns 0 if the variable is 1, otherwise a 1 is returned
	===<%E%>===		===<%=E%>===
	Current Entertainment Area		Current Entertainment Area
	===<%MD%>===		===<%=MD%>===
	Location info of current MD		Location info of current MD
	===<%OS%>===		===<%=OS%>===
	Operating System		Operating System
	===<%CLOCK%>===		===<%=CLOCK%>===
	Time - This is not constantly updated but only, when things change		Time - This is not constantly updated but only, when things change
	===<%MT%>===		===<%=MT%>===
	Media Type		Media Type
	===<%MTB%>===		===<%=MTB%>===
	Media Type Browse options		Media Type Browse options
	===<%MB_USERS%>===		===<%=MB_USERS%>===
	Media Browse Private User		Media Browse Private User
	===<%FBO%>===		===<%=FBO%>===
	Media File Browse Options		Media File Browse Options
	==Miscellaneous==		==Miscellaneous==
	===<%B%>===		===<%=B%>===
	return a \t		return a \t
	===<%N%>===		===<%=N%>===
	return a \n		return a \n
	===<%ND%>===		===<%=ND%>===
	Size of selected device		Size of selected device
	===<%DSDR%>===		===<%=DSDR%>===
	Default Storage Device for Ripping		Default Storage Device for Ripping
	===<%DSDRN%>===		===<%=DSDRN%>===
	Default Storage Device for Ripping Name		Default Storage Device for Ripping Name
	===<%SKIN%>===		===<%=SKIN%>===
	Return the current skin		Return the current skin
	===<%SIZE%>===		===<%=SIZE%>===
	Return the current size		Return the current size
	===<%SG%>===		===<%=SG%>===
	Return the time this screen was generated		Return the time this screen was generated
	===<%LS%>===		===<%=LS%>===
	Last selected floorplan object		Last selected floorplan object
	===<%SD%>===		===<%=SD%>===
	All selected floorplan objects		All selected floorplan objects
	===<%STE%>===		===<%=STE%>===
	Selected Telecom Extension		Selected Telecom Extension
	===<%R%>===		===<%=R%>===
	Current Room		Current Room
	===<%U%>===		===<%=U%>===
	Users		Users
	===<%UN%>===		===<%=UN%>===
	Current Users Name		Current Users Name
	===<%X%>===		===<%=X%>===
	Current X coordinate ?!		Current X coordinate ?!
	===<%Y%>===		===<%=Y%>===
	Current Y coordinate ?!		Current Y coordinate ?!
	===<%XS%>===		===<%=XS%>===
	Difference between last X and new X?		Difference between last X and new X?
	===<%YS%>===		===<%=YS%>===
	Difference between last Y and new Y?		Difference between last Y and new Y?
	===<%S%>===		===<%=S%>===
	Last object		Last object
	===<%SID%>===		===<%=SID%>===
	ID of current screen		ID of current screen
	===<%O%===		===<%=O%===
	Current object		Current object

	===<%TS%===		===<%=TS%===
	Current object		Current object

Line 126:		Line 126:
	Variables starting with A return the attributes of the specified attribute????? No idea.		Variables starting with A return the attributes of the specified attribute????? No idea.
	== E Variables ==		== E Variables ==
	If the variable starts with an E it is an extender. i.e. ETIME returns a <%=TIME%>		If the variable starts with an E it is an extender. i.e. ETIME returns a <%==TIME%>
	== T Variables ==		== T Variables ==
	The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234		The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234

Marie.o: fixed syntax - thanks uplink-lmce

2008-10-10T11:39:18Z

fixed syntax - thanks uplink-lmce

←Older revision		Revision as of 11:39, 10 October 2008
Line 5:		Line 5:
	=Variable Definition=		=Variable Definition=
	Each time text has to be displayed, this text can be substituted by a variable.		Each time text has to be displayed, this text can be substituted by a variable.
	<%= =%>		<%= %>
	is the way to define a substitution.		is the way to define a substitution.
	=Defined Variables=		=Defined Variables=
Line 126:		Line 126:
	Variables starting with A return the attributes of the specified attribute????? No idea.		Variables starting with A return the attributes of the specified attribute????? No idea.
	== E Variables ==		== E Variables ==
	If the variable starts with an E it is an extender. i.e. ETIME returns a <%TIME%>		If the variable starts with an E it is an extender. i.e. ETIME returns a <%=TIME%>
	== T Variables ==		== T Variables ==
	The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234		The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234

Marie.o: Added some more variables - Someone better look thru them and fix any description error

2008-10-10T10:33:55Z

Added some more variables - Someone better look thru them and fix any description error

←Older revision		Revision as of 10:33, 10 October 2008
Line 129:		Line 129:
	== T Variables ==		== T Variables ==
	The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234		The text corresponding to the ID following the T. i.e. T1234 returns the Text with PK_Text = 1234
			== V Variables ==
			Return the virtual device by the ID following V, i.e. V1234 returns the virtual device 1234 ???
			== D Variables ==
			Return the name of the Device by the ID following D, i.e. D123 returns device 123 description.
			== B Variables ==
			something with Icons???
			== all other ===
			Returns content of said variable