FreeSpace Wiki - Recent changes [en]

Ships.tbl

Kestrellius — Wed, 11 Nov 2026 02:53:00 GMT

← Older revision		Revision as of 02:53, 11 November 2026
Line 1:		Line 1:
	{{TableVersionGit\|~~2025~~-08-23\|~~8db0a44~~}}		{{TableVersionGit\|2026-09-11\|996e2fe}}
	{{Tables}}		{{Tables}}
	The '''ships.tbl''' defines all the ship classes used in FSO.		The '''ships.tbl''' defines all the ship classes used in FSO.
Line 1,094:		Line 1,094:
	*'''+Normal Variance:'''		*'''+Normal Variance:'''
	**Default Value: 2.0}}		**Default Value: 2.0}}

			===$Disable Main Fireball:===
			{{Table262\|
			*Whether to avoid spawning the big fireball that normally appears when the ship blows up. Designed for use with $Ship Death Effect, which fills the same role as the fireball.
			*Optional; defaults to False.
			*Syntax: '''''Boolean'''''
			}}

	===$Debris Flame Effect:===		===$Debris Flame Effect:===

Particle Effects

Kestrellius — Wed, 11 Nov 2026 02:42:54 GMT

+Input

← Older revision		Revision as of 02:42, 11 November 2026
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
	{{SCP_table}}		{{SCP_table}}
	{{TableVersionGit\|2025-08-18\|~~0bf632c~~}}		{{TableVersionGit\|2025-10-17\|c0cc43f}}
	{{Tables}}		{{Tables}}

Line 484:		Line 484:
	**'''Age''': The age of the particle in seconds		**'''Age''': The age of the particle in seconds
	**'''Radius''': The radius of the particle (not considering curve modifications)		**'''Radius''': The radius of the particle (not considering curve modifications)
			**'''Apparent Size''': The particle's current size as a fraction of screen width, based on the current viewing position. This does not consider the Radius Mult particle curve output.
	**'''Velocity''': The velocity of the particle (not considering curve modification)		**'''Velocity''': The velocity of the particle (not considering curve modification)
	**'''Post-Curves Velocity''': The velocity of the particle when accounting for curves. Note that when this is queried for the '''Velocity''' output, it will be identical to the unmodified '''Velocity''' input.		**'''Post-Curves Velocity''': The velocity of the particle when accounting for curves. Note that when this is queried for the '''Velocity''' output, it will be identical to the unmodified '''Velocity''' input.
Line 498:		Line 499:
	**'''Parent Ship EMP Intensity''': The intensity of EMP effects currently affecting the parent of this particle. Note that a particle only has a parent if <tt>+Remain local to parent:</tt> is enabled. Only works if the particle is parented to a ship.		**'''Parent Ship EMP Intensity''': The intensity of EMP effects currently affecting the parent of this particle. Note that a particle only has a parent if <tt>+Remain local to parent:</tt> is enabled. Only works if the particle is parented to a ship.
	**'''Parent Ship Time Until Explosion''': The time in seconds until the parent of this particle explodes. Note that a particle only has a parent if <tt>+Remain local to parent:</tt> is enabled. Only works if the particle is parented to a ship, and this ship is in its deathroll.		**'''Parent Ship Time Until Explosion''': The time in seconds until the parent of this particle explodes. Note that a particle only has a parent if <tt>+Remain local to parent:</tt> is enabled. Only works if the particle is parented to a ship, and this ship is in its deathroll.

	===+Output===		===+Output===
	*One of:		*One of:

Lighting Profiles.tbl

Kestrellius — Wed, 11 Nov 2026 02:15:01 GMT

← Older revision		Revision as of 02:15, 11 November 2026
Line 186:		Line 186:
	{{Table224\|		{{Table224\|
	*An [[Lighting_Profiles.tbl#Adjustable values\|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model		*An [[Lighting_Profiles.tbl#Adjustable values\|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
			*Syntax: See [[Lighting_Profiles.tbl#Adjustable values\|Adjustable values]]
			}}

			===$Cockpit light intensity modifier:===
			{{Table250\|
			*An [[Lighting_Profiles.tbl#Adjustable values\|Adjustable value]] applied to the intensity of all lights, only applied when rendering the player ships cockpit and "show ship" model
	*Syntax: See [[Lighting_Profiles.tbl#Adjustable values\|Adjustable values]]		*Syntax: See [[Lighting_Profiles.tbl#Adjustable values\|Adjustable values]]
	}}		}}

Particle Effects

Kestrellius — Wed, 11 Nov 2026 02:03:07 GMT

← Older revision		Revision as of 02:03, 11 November 2026
Line 1:		Line 1:
	{{SCP_table}}		{{SCP_table}}
	{{TableVersionGit\|~~2024~~-08-26\|~~91a673ac586a57e8f7793f08985b6f17a7fd1aa7~~}}		{{TableVersionGit\|2025-08-18\|0bf632c}}
	{{Tables}}		{{Tables}}

Line 528:		Line 528:
	**'''Spawntime Left''': The remaining time this sub-effect will emit particles for.		**'''Spawntime Left''': The remaining time this sub-effect will emit particles for.
	**'''Time Running''': The time this sub-effect has been emit particles for.		**'''Time Running''': The time this sub-effect has been emit particles for.
	**'''~~Apparent Visual~~ Size At Emitter''': The visual size in pixels, based on the current viewing position, that the average particle will have if spawned at the particle source. This does not consider the Radius Mult particle curve output, and does not consider position changes from a Spawn Position Volume.		**'''Pixel Size At Emitter''': The visual size in pixels, based on the current viewing position, that the average particle will have if spawned at the particle source. This does not consider the Radius Mult particle curve output, and does not consider position changes from a Spawn Position Volume.
			**'''Apparent Size At Emitter''': Same a Pixel Size At Emitter, except that it is the particle's size as a fraction of the screen width rather than a number of pixels.
	**'''Total Particle Count''': The total number of particles currently present in the mission.		**'''Total Particle Count''': The total number of particles currently present in the mission.
	**'''Particle Usage Score''': The total number of particles currently present in the mission, divided by the current particle detail setting.		**'''Particle Usage Score''': The total number of particles currently present in the mission, divided by the current particle detail setting.

Asteroid.tbl

Kestrellius — Wed, 11 Nov 2026 01:53:03 GMT

← Older revision		Revision as of 01:53, 11 November 2026
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
	{{~~TableVersion~~\|~~5264~~}}		{{TableVersionGit\|2025-08-23\|1207dfc}}
	{{Tables}}		{{Tables}}
	The '''asteroid.tbl''' is used to define all of the asteroids and debris field pieces in-game.		The '''asteroid.tbl''' is used to define all of the asteroids and debris field pieces in-game.
Line 11:		Line 11:
	{{Table250\|		{{Table250\|
	*'''$Impact Explosion Effect:'''		*'''$Impact Explosion Effect:'''
	*Specifies the [[Particle Effects\|particle effect]] which will be used for impacts of this ~~weapon~~.		*Specifies the [[Particle Effects\|particle effect]] which will be used for weapon impacts against this asteroid.
	*Syntax: '''String''', the particle effect name		*Syntax: '''String''', the particle effect name
	*If this option is specified then ''$Impact Explosion'' and ''$Impact Explosion Radius'' are not valid options!		*If this option is specified then ''$Impact Explosion'' and ''$Impact Explosion Radius'' are not valid options!
	}}		}}
	*'''$Impact Explosion:'''		*'''$Impact Explosion:'''
	**Defines the effect used when weapon strikes at asteroid		**Defines the effect used when a weapon strikes this asteroid
	**Syntax: ''Filename''		**Syntax: ''Filename''
	*'''$Impact Explosion Radius:'''		*'''$Impact Explosion Radius:'''
	**Defines the radius of the effect		**Defines the radius of the effect
	**Syntax: ''Value'', (meters)		**Syntax: ''Value'', (meters)


	==Asteroid and Debris Data==		==Asteroid and Debris Data==
Line 94:		Line 93:
	*Syntax: '''String''', name of the damage type as referenced in [[armor.tbl]]}}		*Syntax: '''String''', name of the damage type as referenced in [[armor.tbl]]}}

			{{Table250\|
			===$Explosion Effect:===
			*Defines the [[Particle Effects\|particle effect]] for this asteroid's explosion.
			*'''If this is specified then $Explosion Animations and $Explosion Radius Mult are not valid!
			*Syntax: '''String''', name of effect
			}}

	===$Explosion Animations:===		===$Explosion Animations:===

Ships.tbl

Kestrellius — Wed, 11 Nov 2026 01:38:40 GMT

← Older revision		Revision as of 01:38, 11 November 2026
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
	{{TableVersionGit\|~~2024~~-11-13\|~~d6b444c~~}}		{{TableVersionGit\|2025-08-23\|8db0a44}}
	{{Tables}}		{{Tables}}
	The '''ships.tbl''' defines all the ship classes used in FSO.		The '''ships.tbl''' defines all the ship classes used in FSO.
Line 915:		Line 915:
	*This sets the multiplier for the ship splitting propagating explosions		*This sets the multiplier for the ship splitting propagating explosions
	*Syntax: '''''Float''''', defaults to 1}}		*Syntax: '''''Float''''', defaults to 1}}
			{{Table250\|
			===$Propagating Explosion Effect:===
			*[[Particle Effects\|Particle effect]] for propagating explosions (the explosions that play while a ship is splitting apart). '''Mutually exclusive with $Propagating Expl Radius Multiplier!'''
			*Vector-type effect host. Host radius is the cross-section of the splitting ship. Orientation is the ship-half's orientation; normal is 'up' within the ship's frame of reference
			*Optional
			*Syntax: '''''String''''', name of effect
			}}


Line 936:		Line 943:
	*Syntax: '''''Float'''''		*Syntax: '''''Float'''''
	**Default: 1}}		**Default: 1}}
			{{Table250\|
			===$Death-Roll Explosion Effect:===
			*[[Particle Effects\|Particle effect]] for death-roll explosions (the small explosions across a ship's surface that happen during the deathroll). '''Mutually exclusive with $Death-Roll Explosion Radius Mult!'''
			*Effect host is the dying ship; normal is the 'outward' vector from the ship's center to the explosion's position
			*Optional
			*Syntax: '''''String''''', name of effect
			}}


Line 950:		Line 964:
	*Syntax: '''''Float'''''		*Syntax: '''''Float'''''
	**Default: 1}}		**Default: 1}}
			{{Table250\|
			===$Death FX Explosion Effect:===
			*[[Particle Effects\|Particle effect]] for death FX explosions (the handful of medium-sized explosions that trigger a moment before the main explosion). '''Mutually exclusive with $Death FX Explosion Radius Mult!'''
			*Effect host is the dying ship; normal is the 'outward' vector from the ship's center to the explosion's position
			*Optional
			*Syntax: '''''String''''', name of effect
			}}

Weapons.tbl

Kestrellius — Wed, 11 Nov 2026 01:10:26 GMT

@@ Line 1: / Line 1: @@
-{{TableVersionGit|2024-12-10|228fd17}}
+{{TableVersionGit|2025-07-12|6921f55}}
 {{Tables}}
 The '''weapons.tbl''' defines all of the weapon classes used in FSO.
@@ Line 1,267: / Line 1,267: @@
 *May be defined any number of times.
 *Currently only works for targets that are ships or weapons. Impacts against weapons are not considered to have a hit angle.
 *All conditional impacts whose requirements are met will play.
 *Non-conditional impact effects, the ones defined above, will only play if no conditional impacts' requirements are met.
 *'''+Armor Type:'''
 **Name of armor type the target must have in order for this impact to play. Shields can have their own armor types. (Subsystems can as well, but at present this system will not detect that.)
 **Syntax: ''''''String'''''', name of armor type in [[armor.tbl]]
 *'''+Min Health Threshold:'''
 **Fraction of target health below which impact will not play. Health is calculated separately for individual shield quadrants and hull.
@@ Line 1,280: / Line 1,296: @@
 **Optional; defaults to 1.0.
 **Syntax: ''''''Float'''''', fraction of health from 0.0 to 1.0
 *'''+Min Angle Threshold:'''
 **Hit angle -- that is, the angle measuring how 'straight on' you're hitting the target surface -- below which impact will not play.
@@ Line 1,288: / Line 1,314: @@
 **Optional; defaults to 180.0.
 **Syntax: ''''''Float'''''', degrees
 *'''+Dinky:'''
 **Whether to play if and only if the weapon is not armed. If false, the impact will not play if the weapon is not armed.
 **Optional; defaults to false.
 **Syntax: ''''''Boolean''''''
 *'''+Effect Name:'''
 **Name of [[Particle Effects|particle effect]] that will play when conditions are met.
 **Syntax: ''''''String'''''', name of effect
 }}

Modular curve

Kestrellius — Wed, 11 Nov 2026 00:22:24 GMT

← Older revision		Revision as of 00:22, 11 November 2026
Line 49:		Line 49:
	*If wraparound is on, an input value exceeding the highest keyframed value will overflow and wrap around so as to remain within the defined range, and likewise, values which are too low will underflow. In essence, the range defined by the keyframes will be treated as repeating endlessly along the X axis.		*If wraparound is on, an input value exceeding the highest keyframed value will overflow and wrap around so as to remain within the defined range, and likewise, values which are too low will underflow. In essence, the range defined by the keyframes will be treated as repeating endlessly along the X axis.
	*Wraparound can sometimes produce very unintuitive behavior. If your modular curve isn't acting the way you expect, check if the problem goes away when wraparound is off!		*Wraparound can sometimes produce very unintuitive behavior. If your modular curve isn't acting the way you expect, check if the problem goes away when wraparound is off!
	*Optional. Defaults to ~~true, God help us~~.		*Optional. Defaults to false.
	*Syntax: '''Boolean''', true or false (or yes or no)		*Syntax: '''Boolean''', true or false (or yes or no)

Template:Table270

MjnMixael — Tue, 10 Nov 2026 17:29:51 GMT

Created page with "<noinclude>Table270</noinclude> <div style="padding: 1px 2px 1px 2px; background-color: #16210A; border: solid 1px #51BE08; padding: 0px 4px; font-size:..."

New page

<noinclude>[[Category:Templates|Table270]]</noinclude>
<div style="padding: 1px 2px 1px 2px; background-color: #16210A; border: solid 1px #51BE08; padding: 0px 4px; font-size: -1; color: #7BE833">'''<font color=#7BE833>FS2 Open, 27.0</font>:''' {{{1}}}</div>

Inferno

Qweqwe321 — Fri, 06 Nov 2026 22:14:46 GMT

Guide to FS mod translations

MjnMixael — Wed, 28 Oct 2026 18:39:36 GMT

← Older revision		Revision as of 18:39, 28 October 2026
Line 63:		Line 63:
	+Extension property is the suffix you will use in all the language-specific files (see the list in the next chapter).		+Extension property is the suffix you will use in all the language-specific files (see the list in the next chapter).

	Note that this step is not required if you translate a mod not using SCPUI with the French, German and Polish languages, as they are already supported by the original game.		Note that this step is not required if you translate a mod not using [https://github.com/MjnMixael/SCPUI/wiki SCPUI] with the French, German and Polish languages, as they are already supported by the original game.

	====In case your language uses special characters not provided by the original fonts====		====In case your language uses special characters not provided by the original fonts====

Briefing Text

MjnMixael — Wed, 28 Oct 2026 18:39:03 GMT

← Older revision		Revision as of 18:39, 28 October 2026
Line 1:		Line 1:
	These tags can be used to manipulate text messages in command and mission briefings, and the fiction viewer. As of r10846, they work in debriefings, too.		These tags can be used to manipulate text messages in command and mission briefings, and the fiction viewer. As of r10846, they work in debriefings, too.

	[[SCPUI]] has its own HTML-based syntax to styling text.		[https://github.com/MjnMixael/SCPUI/wiki SCPUI] has its own HTML-based syntax to styling text.

	==Colors==		==Colors==
Line 51:		Line 51:
	==Styling text in SCPUI==		==Styling text in SCPUI==

	[[SCPUI]] has its own HTML-based approach to styling text. It works everywhere that classic color tags do - briefings (including command, loop, and red alert briefings), debriefings, and the fiction viewer - but also the tech room, campaign descriptions, and nearly everywhere that long-form text is supported. For it to work in briefings, the text must be put in "HTML mode" by putting <code>!html</code> at the start, followed by a space. Everywhere else will work without that tag.		[https://github.com/MjnMixael/SCPUI/wiki SCPUI] has its own HTML-based approach to styling text. It works everywhere that classic color tags do - briefings (including command, loop, and red alert briefings), debriefings, and the fiction viewer - but also the tech room, campaign descriptions, and nearly everywhere that long-form text is supported. For it to work in briefings, the text must be put in "HTML mode" by putting <code>!html</code> at the start, followed by a space. Everywhere else will work without that tag.

	Text in HTML mode may contain HTML markup. Text may be styled using <code><span></code> tags with appropriate classes drawn from common.rcss; inline styles are also supported. FSO and HTML both make use of double quotes and slashes; to minimize conflicts, using single quotes and writing slashes as <code>$slash</code> is recommended. A complete example might look something like this: <code>!html <span class='white'>Pilot attend!<$slashspan> Today, we'll be escorting the <span class='green italic'>GTC Examplar<$slashspan> as she raids <span class='red'>Shivan<$slashspan> positions throughout <span class='yellow'>Gamma Draconis<$slashspan>.</code>		Text in HTML mode may contain HTML markup. Text may be styled using <code><span></code> tags with appropriate classes drawn from common.rcss; inline styles are also supported. FSO and HTML both make use of double quotes and slashes; to minimize conflicts, using single quotes and writing slashes as <code>$slash</code> is recommended. A complete example might look something like this: <code>!html <span class='white'>Pilot attend!<$slashspan> Today, we'll be escorting the <span class='green italic'>GTC Examplar<$slashspan> as she raids <span class='red'>Shivan<$slashspan> positions throughout <span class='yellow'>Gamma Draconis<$slashspan>.</code>

	It is, however, rarely necessary to perform simple styling like this manually: SCPUI's [[Keywords.tbl]] may be used to automate common styling rules.		It is, however, rarely necessary to perform simple styling like this manually: SCPUI's [https://github.com/MjnMixael/SCPUI/wiki/keywords.tbl Keywords.tbl] may be used to automate common styling rules.

	[[Category:FRED Tips]]		[[Category:FRED Tips]]

Game settings.tbl

MjnMixael — Wed, 28 Oct 2026 18:37:51 GMT

← Older revision		Revision as of 18:37, 28 October 2026
Line 198:		Line 198:
	===$Don't initalize built-in languages by default:===		===$Don't initalize built-in languages by default:===
	{{Table240\|		{{Table240\|
	Prevent FSO from initializing the three additional built-in languages (German, French, and Polish). This allows mods which don't support those languages to remove them from the SCPUI language selector.		Prevent FSO from initializing the three additional built-in languages (German, French, and Polish). This allows mods which don't support those languages to remove them from the [https://github.com/MjnMixael/SCPUI/wiki SCPUI] language selector.
	*Syntax: '''''Boolean'''''		*Syntax: '''''Boolean'''''
	*Default Value: '''''NO'''''		*Default Value: '''''NO'''''
Line 820:		Line 820:
	===$SCPUI attempts to load hires animations:===		===$SCPUI attempts to load hires animations:===
	{{Table230\|		{{Table230\|
	*Prevents SCPUI from trying to load anims prefixed with "2_"		*Prevents [https://github.com/MjnMixael/SCPUI/wiki SCPUI] from trying to load anims prefixed with "2_"
	*Syntax: '''''Boolean'''''		*Syntax: '''''Boolean'''''
	*Default Value: true}}		*Default Value: true}}
Line 1,439:		Line 1,439:
	===$Preload briefing icon models:===		===$Preload briefing icon models:===
	{{Table250\|		{{Table250\|
	*If set, this forces preloading of models used for briefing icons. This only loads models used for icons that haven't already been loaded for the mission. This is useful for SCPUI's where hovering over an icon shows the model without having to click on it and the stutter when it loads models not used in mission.		*If set, this forces preloading of models used for briefing icons. This only loads models used for icons that haven't already been loaded for the mission. This is useful for [https://github.com/MjnMixael/SCPUI/wiki SCPUI]'s where hovering over an icon shows the model without having to click on it and the stutter when it loads models not used in mission.
	*Syntax: '''''Boolean'''''		*Syntax: '''''Boolean'''''
	*Default Value: '''''False'''''}}		*Default Value: '''''False'''''}}

RCSS Properties

MjnMixael — Wed, 28 Oct 2026 18:35:13 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Properties}}"

Show changes

RCSS Scrollbars

MjnMixael — Wed, 28 Oct 2026 18:35:04 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Scrollbars}}"

Show changes

RCSS FontEffects

MjnMixael — Wed, 28 Oct 2026 18:34:53 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-FontEffects}}"

← Older revision		Revision as of 18:34, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-FontEffects}}
	Font effects are an extension to CSS for RCSS for applying effects, such as outlining or shadowing, to text. Similarly to decorators, font effects are declared and named in a style sheet like a property, and configured with font-effect-specific properties. Custom font effects can be developed to apply arbitrary effects onto text.

	~~==Properties==~~
	Font effects are declared and configured within style sheets in exactly the same manner as decorators, except they are declared as <name>-font-effect rather that <name>-decorator, including the z-index property to resolve an ambiguous render order. The only exceptions are noted below:

	~~===Color===~~
	~~All font effects have a <name>-color property which is applied multiplicatively over the entire effect~~.

	~~===Inheritance===~~
	~~Unlike decorators, font effects are inherited from parent elements. For example, the following declaration:~~
	~~<pre>~~
	h1
	{
	~~header-font~~-~~effect: outline;~~
	~~header-width: 2px;~~
	~~header-color: black;~~
	}
	~~</pre>~~
	will add an outline effect on the text within all h1 elements and their descendants. To prevent inheritance, override the effect with none. For example, to prevent the h1 outline effect from affecting span elements, you could specify the following:
	~~<pre>~~
	~~h1 span~~
	{
	~~header-font-effect: none;~~
	}
	~~</pre>~~
	~~==Effects==~~
	~~libRocket comes with two built-in font effects:~~

	*shadow effect, for rendering shadows.
	*outline effect, for outlining text.

RCSS Decorators

MjnMixael — Wed, 28 Oct 2026 18:34:42 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Decorators}}"

Show changes

RCSS CursorsDragTab

MjnMixael — Wed, 28 Oct 2026 18:34:31 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-CursorsDragTab}}"

← Older revision		Revision as of 18:34, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-CursorsDragTab}}
	~~==Cursors: the ‘cursor’ property==~~
	*cursor

	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Value:~~
	~~\| <string> \| auto~~
	\|-
	~~\| Initial:~~
	~~\| auto~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~This property defines the cursor to display while the mouse is hovering over the element~~. ~~Values have the following meanings:~~

	*auto
	**The default cursor is used.
	*<string>
	**The RML document loaded as a cursor and with <string> as a title is used as a cursor. If none exists, the default cursor is used.
	~~Cursors can be loaded into libRocket using the Rocket::Core::Context::LoadCursor() function.~~

	~~==Drag & drop: the ‘drag’ property==~~
	The drag property is a new property, not shared by CSS. It controls the generation of events as the mouse cursor begins a drag over an element (ie, clicks the left mouse button and moves the mouse), drags over elements (moves the mouse with the button depressed) and finishes a drag, or ‘drops’, an element over another.

	*drag

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| none \| drag \| drag-drop \| block~~
	\|-
	~~\| Initial:~~
	~~\| none~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| no~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~Values have the following meanings:~~

	*none
	**If the mouse begins a drag over this element, the element is not dragged and does not generate any drag messages. However, it does not prevent an ancestor element from being dragged.
	*drag
	**If the mouse begins a drag over this element, the element will begin spawning drag messages. However, no messages will be directed to other elements relating to the drag or the eventual drop.
	*drag-drop
	**If the mouse begins a drag over this element, the element will begin spawning drag messages. Messages will also be directed to over elements if the dragged element is dragged over them.
	*block
	**If the mouse begins a drag over this element, the element is not dragged and neither is any ancestor element.

	~~==Tab index: the ‘tab-index’ property==~~
	~~The ‘tab-index’ property is introduced for~~ RCSS~~. It controls the generation of a tab order, which is an ordered list of elements within a document that gain input focus in turn as the ‘tab’ key is pressed.~~

	*tab-~~index~~

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| none \| auto~~
	\|-
	~~\| Initial:~~
	~~\| none~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| no~~
	\|-
	~~\| Percentages:~~
	~~\| N/A~~
	\|}
	~~Values have the following meanings:~~

	*none
	**The element is not part of the tabbing order.
	*auto
	**The element inserts itself into the tabbing order in a location relative to its order in the element hierarchy.

RCSS Text

MjnMixael — Wed, 28 Oct 2026 18:34:15 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Text}}"

← Older revision		Revision as of 18:34, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Text}}
	~~==Alignment: the ‘text-align’ property==~~
	*text-align

	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Value:~~
	~~\| left \| right \| center~~
	\|-
	~~\| Initial:~~
	~~\| left~~
	\|-
	~~\| Applies to:~~
	~~\| block-level elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~This property affects how inline boxes within a line box are aligned~~. ~~Values have the following meanings:~~

	*left
	**The row of inline boxes are aligned against the left edge of the line box.
	*right
	**The row of inline boxes are aligned against the right edge of the line box.
	*center
	**The row of inline boxes are aligned in the centre of the line box.
	~~Note that the ‘justify’ value is not yet supported in RCSS.~~

	~~==Decoration==~~
	~~===Underlining: the ‘text-decoration’ property===~~
	*text-decoration

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| none \| underline~~
	\|-
	~~\| Initial:~~
	~~\| none~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~Values have the following meaning:~~

	*none
	**Any text generated by this element has no additional decoration.
	*underline
	**Any text generated by this element has an underline, with a thickness and position specified by the font.
	~~The colour of any decoration is the same as the font colour. Note that overline and line-through is not yet supported in RCSS.~~

	~~===Text shadows: the ‘shadow’ font effect===~~
	Instead of using the CSS-standard text-shadow property, text-shadowing is implemented in libRocket using the more generic font effect system. Below is an example of how to specify a shadow for an element of text.
	~~<pre>~~
	/~~* Specify a grey text shadow on primary headings. *~~/
	h1
	{
	~~darken~~-~~font-effect: shadow;~~
	~~darken-offset: 2px 2px;~~
	~~darken-color: grey;~~
	}
	~~</pre>~~
	~~==Whitespace: the ‘white-space’ property==~~
	*white-space

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| normal \| pre \| nowrap \| pre-wrap \| pre-line~~
	\|-
	~~\| Initial:~~
	~~\| normal~~
	\|-
	~~\| Applies to:~~
	~~\| block-level elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N/A~~
	\|}
	~~This property defines how whitespace (any spaces, end-lines, carriage-returns and tabs) are processed in sections of text. Values have the following meanings:~~

	*normal
	**Sequences of whitespace are collapsed down to single spaces. Lines are broken as necessary to fit line boxes. Line breaks in the source are ignored.
	*pre
	**Sequences of whitespace are preserved. Lines are only broken where line breaks are present in the source.
	*nowrap
	**Sequences of whitespace are collapsed. Lines are not broken.
	*pre-wrap
	**Sequences of whitespace are not collapsed. Lines are broken to fit line boxes or where line breaks are present in the source.
	*pre-line
	**Sequences of whitespace are collapsed. Lines are broken to fit line boxes or where line breaks are present in the source.

RCSS Fonts

MjnMixael — Wed, 28 Oct 2026 18:34:06 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Fonts}}"

← Older revision		Revision as of 18:34, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Fonts}}
	~~RCSS implements a simpler version of the CSS2 font model when dealing with text rendering. This is for two reasons:~~
	*The document renderer is fully under the control of the author, so (for example) a specific font can be assumed to exist.
	*Improved performance.

	~~Fonts are specified in a similar fashion. NOTE: You will need to load all ttf files via the C++ or python interfaces before they can be used in RCSS.~~

	~~==Font specification properties==~~
	~~===Font family: the ‘font-family’ property===~~
	*font-family

	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Value:~~
	~~\| <string>~~
	\|-
	~~\| Initial:~~
	~~\| undefined~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~This property specifies the name of a family of fonts to be used to render sections of text descending from the element~~. ~~Note that, unlike CSS, only a single font family can be specified with this property, not a comma-delimited font set.~~

	~~===Font styling: the ‘font-style’ and ‘font-weight’ properties===~~
	*font-style

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| normal \| italic~~
	\|-
	~~\| Initial:~~
	~~\| normal~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~This property can be used to request normal or italicised versions of a font from within a font-family. Note that RCSS does not yet support oblique font styles.~~

	*font-weight

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| normal \| bold~~
	\|-
	~~\| Initial:~~
	~~\| normal~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~This property can be used to request normal or bolded versions of a font from within a font-family. Note that~~ RCSS ~~only supports bold and non~~-~~bold fonts, and not different strengths of boldness.~~

	~~===Font size: the ‘font-size’ property===~~
	*font-size

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| <number> \| <percentage>~~
	\|-
	~~\| Initial:~~
	~~\| 12px~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N/A~~
	\|}
	~~Values have the following meanings:~~

	*<number>
	**The font size is generated at the point size requested. For font-relative units (such as em ), the font size is relative to the parent element’s font size.
	*<percentage>
	**The font size is generated at the point size of the element’s parent’s font, scaled by the percentage.

	~~===Font charset: the ‘font-charset’ property===~~
	*font-charset

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| <urange>~~
	\|-
	~~\| Initial:~~
	~~\| U+0020-007E~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N/A~~
	\|}
	This property allows elements to request a font that is capable of rendering characters within a range (or ranges). Because fonts are rasterised and rendered to texture before they can be used, this can be quite useful in limiting the size of textures used by the font engine. For example, a large font used for titles could be restricted to only capital letters.

	~~The value of font-charset is a comma-separated list of Unicode ranges, each of which is in one of the forms:~~
	*U+xxxx, to specify a single character (where x is any hexadecimal digit).
	*U+xxxx-yyyy, to specify the range of xxxx through yyyy.
	*U+xx??, to specify the range of xx00 through xxFF. The wildcard ‘?’ can be used to substitute any digits, but must appear in an uninterrupted range at the end of the specifier.
	~~For more information, see the CSS specification of unicode-range.~~

RCSS ColorsBackgrounds

MjnMixael — Wed, 28 Oct 2026 18:33:56 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-ColorsBackgrounds}}"

← Older revision		Revision as of 18:33, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-ColorsBackgrounds}}
	~~==Foreground colour: the ‘color’ property==~~
	*color

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value~~:
	~~\| <colour>~~
	\|-
	~~\| Initial:~~
	~~\| black~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| yes~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~This property sets the colour of rendered text and text decorations~~.

	~~==Background colour==~~
	In RCSS~~, an element’s background can be set as a flat colour but not an image. This functionality (and much more!) instead lies with decorators.~~

	*background-~~color~~

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| <colour>~~
	\|-
	~~\| Initial:~~
	~~\| transparent~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| no~~
	\|-
	~~\| Percentages:~~
	~~\| N/A~~
	\|}
	~~This property sets the color of the element’s generated boxes. The background colour is rendered under a box’s padded area.~~

	*background
	**An alias for background-color.

RCSS VisualEffects

MjnMixael — Wed, 28 Oct 2026 18:33:46 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-VisualEffects}}"

← Older revision		Revision as of 18:33, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-VisualEffects}}
	~~==Overflow and clipping==~~
	~~The contents of a block box may extend beyond the content area of the box itself, for example under the following scenarios:~~
	*The contents of an inline box wider than its containing block box cannot be broken.
	*A block box has a width greater than its containing block box.
	*A block box has an explicit height set, and its contents exceed that height.
	~~When overflow occurs, the overflow-x’ and ‘overflow-y’ properties dictate how the overflow is handled.~~

	~~===Overflow: the ‘overflow’ property===~~
	*overflow-x, overflow-y

	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Value:~~
	~~\| visible \| hidden \| auto \| scroll~~
	\|-
	~~\| Initial:~~
	~~\| visible~~
	\|-
	~~\| Applies to:~~
	~~\| block-level elements~~
	\|-
	~~\| Inherited:~~
	~~\| no~~
	\|-
	~~\| Percentages:~~
	~~\| N~~/A
	\|}
	~~The values have the following meanings:~~

	*visible
	**Overflowing content is visible along this axis.
	*hidden
	**Overflowing content is hidden along this axis.
	*auto
	**If overflow occurs along this axis, overflowing content is hidden and a scrollbar is generated and positioned along the axis so the hidden content can be scrolled into view.
	*scroll
	**A scrollbar is always visible along the axis, allowing hidden content to be scrolled into view. This will eliminate ‘popping’ if content suddenly overflows and a scrollbar appears.
	~~Note that, unlike CSS, if either of overflow-x or overflow-y is set to a value other that ‘visible’, clipping will occur on both axes.~~

	*overflow

	~~Shorthand for overflow-x overflow-y. If two values are specified, the first will be used to specify overflow-x and the second overflow-y. If one value is specified, if will be used to specify both.~~
	~~<pre>~~
	/~~* Hide horizontal overflowing content and generate a scrollbar (if required) along the vertical axis. *~~/
	~~div#content~~
	{
	~~overflow: hidden auto;~~
	}
	</~~pre>~~
	~~===Clipping: the ‘clip’ property===~~
	This property is completely different from the CSS clip property. Instead of defining the clipping region of an element, this property defines how the element interacts with the clipping regions of its ancestors.

	In RCSS~~, the clipping region is always the ‘client area’, which is either the content or padded area (depending on the element).~~

	*clip

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| auto \| none \| <number>~~
	\|-
	~~\| Initial:~~
	~~\| auto~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| no~~
	\|-
	~~\| Percentages:~~
	~~\| N/A~~
	\|}
	~~The values have the following meanings:~~

	*auto
	**The element is subjected to all the clipping regions put in place by its ancestors.
	*none
	**The element is never clipped (except by the context).
	*<number>
	**The element is subjected to the clipping regions of its ancestors, except it skips the closest <number> ancestors that could have put in place a clipping region (ie, those ancestors with an overflow-x or overflow-y other than visible).

	~~===Visibility: the ‘visibility’ property===~~
	*visibility

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~\| Value:~~
	~~\| visible \| hidden~~
	\|-
	~~\| Initial:~~
	~~\| visible~~
	\|-
	~~\| Applies to:~~
	~~\| all elements~~
	\|-
	~~\| Inherited:~~
	~~\| no~~
	\|-
	~~\| Percentages:~~
	~~\| N/A~~
	\|}
	~~Values have the following meanings:~~

	*visible
	**The generated box is visible.
	*hidden
	**The generated box, and all of its descendants, is hidden. Note that the box still has an impact on layout, it is just not rendered.

RCSS VisualModel

MjnMixael — Wed, 28 Oct 2026 18:33:36 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-VisualModel}}"

Show changes

RCSS BoxModel

MjnMixael — Wed, 28 Oct 2026 18:33:27 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-BoxModel}}"

Show changes

RCSS Selectors

MjnMixael — Wed, 28 Oct 2026 18:33:17 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Selectors}}"

← Older revision		Revision as of 18:33, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Selectors}}
	~~Selectors are used to select elements to apply specific rules to. The selector syntax supported in RCSS is as follows:~~

	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Pattern~~
	~~\| Meaning~~
	\|-
	~~\| E~~
	~~\| Matches any element of type E (ie, an element declared in an RML document as <E>)~~.
	\|-
	~~\| E F~~
	~~\| Matches any element of type F that is a descendant of an E element.~~
	\|-
	~~\| E.foo~~
	~~\| Matches any element of type E that has been declared with class foo.~~
	\|-
	~~\| E#foo~~
	~~\| Matches any element of type E that has been declared with an ID of foo.~~
	\|-
	~~\| E:foo~~
	~~\| Matches any element of type E that has the pseudo-class foo currently active.~~
	\|}
	~~Note that attribute selectors, the + selector, and the > selector are currently not supported.~~

	~~The following pseudo-classes are supported natively (this includes the full range of proposed structural selectors from CSS3):~~

	~~{\| border=1 cellpadding=4 style="border-collapse: collapse"~~
	\|-
	~~Pseudo-class~~
	~~\| Meaning~~
	\|-
	~~\| :hover~~
	~~\| Matches an element that is currently under the mouse cursor.~~
	\|-
	~~\| :active~~
	~~\| Matches an element that has been clicked on, only until the button is released.~~
	\|-
	~~\| :focus~~
	~~\| Matches an element that has input focus.~~
	\|-
	~~\| :nth-child(an + b)~~
	~~\| Matches an element that has an + b - 1 siblings before it.~~
	\|-
	~~\| :nth-last-child(an + b)~~
	~~\| Similar to nth-child, but counts backwards.~~
	\|-
	~~\| :nth-of-type(an + b)~~
	~~\| Similar to nth-child, but only counts sibling elements of the same type.~~
	\|-
	~~\| :nth-last-of-type(an + b)~~
	~~\| Similar to nth-of-type, but counts backwards.~~
	\|-
	~~\| :first-child~~
	~~\| Matches an element that is the first child of its parent.~~
	\|-
	~~\| :last-child~~
	~~\| Matches an element that is the last child of its parent.~~
	\|-
	~~\| :first-of-type~~
	~~\| Matches an element that is the first child of its type.~~
	\|-
	~~\| :last-of-type~~
	~~\| Matches an element that is the last child of its type.~~
	\|-
	~~\| :only-child~~
	~~\| Matches an element that has no sibling elements.~~
	\|-
	~~\| :only-of-type~~
	~~\| Matches an element that has no sibling elements of its type.~~
	\|-
	~~\| :empty~~
	~~\| Matches an element that has no child nodes.~~
	\|}
	~~For a much fuller description of the :nth- style selectors, please refer to the respective page of the CSS3 working draft. even and odd are supported in RCSS.~~

	A simple selector is made up of an optional element type followed by zero or more class selectors, ID selectors and pseudo-class selectors. If an element type is not given, any element type will be matched. So, for example, the selector:
	~~<pre>~~
	~~div#level_list:hover~~
	</~~pre>~~
	~~will match any element of type div with an ID of level_list that is currently being hovered by the cursor.~~

	A selector is made up of potentially multiple simple selectors separated by whitespace. For an element to be matched by a selector with multiple simple selectors, it itself must match the last simple selector, and it must have descendants in the RML hierarchy that match, in order, each of the preceding simple selectors. So, for example, the selector:
	~~<pre>~~
	~~div#level_list input.select option:nth-child(even)~~
	</~~pre>~~
	will only match an element of type option that is an even-numbered child of its parent, that has an ancestor of an input element of class select, that itself has an ancestor that is a div element with the ID level_list.

	~~Multiple selectors can be appended with commas, which is equivalent to an OR statement. For example, the following:~~
	~~<pre>~~
	~~div#level_list,~~
	~~div#weapon_list,~~
	~~.colour_list~~
	</~~pre>~~
	~~will match a div element with ID level_list, or ID weapon_list, or any element that has a class of colour_list.~~

	~~See the CSS specifications for more thorough documentation and examples on the use of selectors. Please note that pseudo~~-~~classes (such as :first-letter, :before, etc) are not yet supported in RCSS.~~

RCSS Syntax

MjnMixael — Wed, 28 Oct 2026 18:33:08 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Syntax}}"

← Older revision		Revision as of 18:33, 28 October 2026
Line 1:		Line 1:
	{{~~RCSS}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RCSS-Syntax}}
	~~A style sheet is made up of a number of rules. Each rule has a number of selectors, which define which elements the rule applies to, and properties, which are applied to those elements.~~

	~~The basic syntax of a rule is as follows~~:
	~~<pre>~~
	~~selector1,~~
	~~selector2,~~
	~~selector3~~
	{
	~~property1: value1;~~
	~~property2: value2;~~
	~~property3: value3;~~
	}
	</~~pre>~~
	Selectors are comma-separated, followed by the rule block which is defined by curly braces. Inside the rule block is a list of semi-colon separated property declarations; each property declaration is made up of the property to set, a colon, and a space-separated list of the values to assign to that property. The values accepted by each value, and how many they require, is specific to each value.

	~~==Comments==~~
	Comments can be included in a style sheet using the C-style /* and */ ~~characters.~~

	~~==Values==~~
	Which values each property accepts is given in their definition. Values may be keywords, which are set as specific strings such as auto, left, etc, or generic strings (such as font names or file paths), or one of the types described below.

	~~===Numbers===~~
	~~Specified as in a property's Values list~~. ~~A number can be an integer or real number.~~

	~~<code>z-index: 16;<~~/~~code>~~

	~~===Lengths===~~
	~~Specified as in a property's Values list. A length is a horizontal or vertical measurement consisting of a number and a unit. RCSS recognises the following units:~~

	*px: One px is equivalent to one pixel on the output medium.
	*em: One em is equivalent to the line-height of the current font.
	*ex: One ex is equivalent to the height of the current font’s lower-case x.
	*Note that as RCSS is designed solely for outputting to a computer monitor, it does not recognize the physical measurements in, cm, mm, pt or pc.

	~~<code>width: 125px;<~~/~~code>~~

	~~===Percentages===~~
	Specified as <percentage> in the property’s Values list. A percentage value is evaluated relative to some other value, which is specified in each property that supports a percentage. For example, width can be expressed as a percentage, which is evaluated against the width of the element’s containing block.

	~~<code>min-height: 50%;<~~/~~code>~~

	~~===Colors===~~
	~~Specified as <color> in the property’s Values list. Colors represent a RGBA value, and can be declared in numerous ways:~~

	As the name of one of the 16 colors defined in the HTML 4.0 specification (aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white, and yellow), plus grey (alias for gray), orange and transparent.
	Prefixed with the ‘#’ character, followed by 3, 4, 6 or 8 hexadecimal digits. 3 or 6 digits represent an RGB triplet, and will have 255 attached as the opacity. If only 3 are specified, each digit will be replicated before being read; for example, #FE0 is equivalent to #FFEE00. 4 or 8 digits allow the specification of a translucent color.
	~~In the format rgb(r, g, b) or rgba(r, g, b, a), where each of red, green, blue (and optionally alpha) is specified as a value from 0 to 255. An rgb value has an alpha of 255 attached.~~
	~~In the format rgb(r%, g%, b%) or rgba(r%, g%, b%, a%), where each of red, green, blue (and optionally alpha) is specified as a percentage value from 0 to 100. An rgb value will have full opacity.~~
	~~Important: Note that the declaration of the alpha channel when using the rgba keyword differs from the HTML5 specification.~~

	~~So, for example, the following color declarations are identical:~~
	~~<pre>~~
	~~color: red;~~
	~~color: #F00;~~
	~~color: #FF0000FF;~~
	~~color: rgb(100%, 0%, 0%);~~
	~~color: rgba(100%, 0%, 0%, 100%);~~
	~~color: rgba(255, 0, 0, 255);~~
	</~~pre>~~

	~~==Referencing~~ RCSS ~~from RML==~~
	A style sheet can be either stored in an external file (usually with the extension .rcss) and referenced from an RML file, or declared inline inside an RML file. Referencing an external RCSS file is done using the <link> tag in the following manner:
	~~<pre>~~
	~~<html>~~
	~~<head>~~
	~~<link type="text/css" href="sample.rcss" />~~

	~~...~~
	~~</pre>~~
	~~File paths are relative to the referencing document.~~

	~~Declaring an inline style sheet is done using the <style> tag, also within the <head> tag:~~
	~~<pre>~~
	~~<html>~~
	~~<head>~~
	~~<style>~~
	~~body~~
	{
	~~margin: 0px;~~
	}
	~~</style>~~

	~~...~~
	~~</pre>~~
	Multiple style sheets can be included in a single document and combined with inline style declarations. The ordering of style declarations is important, as they may be used to resolve the precedence conflicting style sheet rules.

	Also, style sheet properties can be declared directly on an element. This is done by inserting semi-colon separated style sheet property declarations into the style attribute of an element. For example, the following RML fragment:
	~~<pre>~~
	~~<div style="width: 25%; min-width: 55px;">~~
	~~</div>~~
	~~</pre>~~
	~~sets the width property to ‘25%’ and the min-width property to ‘55px’ on the div element.~~

RML Events

MjnMixael — Wed, 28 Oct 2026 18:32:56 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RML-Events}}"

Show changes

RML Templates

MjnMixael — Wed, 28 Oct 2026 18:32:47 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RML-Templates}}"

← Older revision		Revision as of 18:32, 28 October 2026
Line 1:		Line 1:
	{{RML}}		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-Templates}}
	~~Templates allow defining a set of RML objects for the Lua to use for creating and styling repeated UI elements.~~

	~~TODO Further explain WTF that means.~~

	~~==<template>==~~
	~~The <template> element has two uses, to define a template and inject a template inline into an existing RML documents.~~

	~~When defining a template, <template> should be used in place of <rml>.~~

	~~===Attributes===~~

	~~====name====~~
	~~The name of the template. Must be unique. Is used by other RML documents to reference the template.~~
	~~====content====~~
	~~The id of the element that the content will be put into.~~
	~~When injecting a template, all elements inside the <template> tag will be placed inside the template’s content element.~~
	~~====src====~~
	~~The name of the template to inject~~

	~~==<body>==~~
	~~The <body> element has a template attribute that is a shorthand for injecting a template around the body tag.~~

	~~===Attributes===~~

	~~====template====~~
	~~The name of the template to use. All child elements under the <body> element will be loaded into the template.~~

RML DataDisplay

MjnMixael — Wed, 28 Oct 2026 18:32:38 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RML-DataDisplay}}"

← Older revision		Revision as of 18:32, 28 October 2026
Line 1:		Line 1:
	{{RML}}		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-DataDisplay}}
	~~Data grids are a kind of table display.~~
	~~==<datagrid>==~~
	~~<datagrid> represents an element capable of fetching, positioning and rendering dynamic tabulated data. For a detailed description see Data grid in the C++ Manual.~~

	~~===Attributes===~~

	~~====source====~~
	~~The name of the data source and table that the rows of the data grid will be fetched from.~~
	~~===<col>===~~
	~~The <col> element represents a column in the datagrid. Each column displays information about each row in the data source in the form of one or more fields.~~

	~~====Attributes====~~

	~~=====fields=====~~
	~~A comma-separated list of fields that this column will fetch from the data source about each row and display.~~
	~~=====formatter=====~~
	~~The name of the data formatter to use to turn the raw field information into RML. If not set (or the formatter can’t be found) then the raw text will be displayed.~~
	~~=====width=====~~
	~~The width (in px or %) of the column.~~

RML Controls

MjnMixael — Wed, 28 Oct 2026 18:32:26 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RML-Controls}}"

← Older revision		Revision as of 18:32, 28 October 2026
Line 1:		Line 1:
	{{~~RML}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-Controls}}
	~~Controls are used to allow dragging are tabbing elements~~.
	~~==<handle>==~~
	~~The <handle> element can be used to move or change the size of elements.~~

	~~===Attributes===~~

	~~====move_target====~~
	~~If specified, the handle will move the element specified by the ID when dragged. Can be #document to reference the parent document.~~
	~~====size_target====~~
	~~If specified, the handle will size the element specified by the ID when dragged. Can be #document to reference the parent document.~~
	~~<pre>~~
	~~<handle move_target="#document">~~
	~~<div id="title">My document<~~/~~div>~~
	</~~handle>~~
	</~~pre>~~
	~~==<tabset>==~~
	~~A <tabset> element contains <tab> elements and <panel> elements.~~

	~~===<tab>===~~
	~~Each <tab> element acts as a button, that when clicked will hide the currently visible panel and show its corresponding panel.~~

	~~===<panel>===~~
	~~A <panel> element is the body of the tabset. The visibility of the panel is controlled by the tab elements in the parent tabset.~~

RML Forms

MjnMixael — Wed, 28 Oct 2026 18:32:16 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RML-Forms}}"

← Older revision		Revision as of 18:32, 28 October 2026
Line 1:		Line 1:
	{{RML}}		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-Forms}}
	~~A form is a collection of input elements inside a <form> element - when the form is “submitted”, the information stored in the each child input element is sent through to the listening process.~~

	~~==<form>==~~
	~~===Attributes===~~
	*onsubmit - The name of the event to trigger when the form is submitted. The values of all form element children are passed to the event as parameters.

	~~===<form> Children===~~
	There are four elements that function as children to a <form> element: the <input>, <textarea>, <select> and <dataselect> elements. These have many common attributes which are listed below. Any specific attributes are listed afterwards under their own headings.

	~~====Attributes====~~
	~~=====name=====~~
	The name of the input element. This is used to look up the element’s value when the form is submitted. For types of radio it is used to group together radio buttons so that only one with the same name can be checked at once.
	~~=====value=====~~
	For types of text, password and range, this is used as the initial value of the element. For the radio and checkbox types this is used as the value that is submitted if the input is checked. For <option> elements, this is the value that is submitted by the parent <select>, if it is the selected option.
	~~=====disabled=====~~
	~~If this attribute is set, then the input element is unable to be changed by user input.~~

	~~==<input>==~~
	~~===Attributes===~~
	~~====type====~~
	~~The type of the input field. Must be one of:~~
	~~====text====~~
	~~A one-line text-entry field.~~
	~~====password====~~
	~~Like text, but replaces the entered text with asterisks.~~
	~~====radio====~~
	~~A radio button.~~
	~~====checkbox====~~
	~~A checkbox.~~
	~~====range====~~
	~~A slider bar.~~
	~~====submit====~~
	~~A button for submitting the form.~~
	~~===Text and Password types===~~
	~~====size====~~
	~~For types of text and password, defines the length (in characters) of the element.~~
	~~====maxlength====~~
	~~For types of text and password, defines the maximum length (in characters) that the element will accept.~~
	~~===Radio and Checkbox types===~~
	~~====checked====~~
	~~For types of radio and checkbox, if this attribute is set then the element is “on”.~~
	~~===Range type===~~
	~~====min====~~
	~~For the range type, defines the value at the lowest (left or top) end of the slider.~~
	~~====max====~~
	~~For the range type, defines the value at the highest (right or bottom) end of the slider.~~
	~~====step====~~
	~~For the range type, defines the increment that the slider will move by.~~
	~~====orientation====~~
	~~For the range type, specifies if it is a vertical or horizontal slider. Values can be horizontal or vertical.~~

	~~==<textarea>==~~
	~~===Attributes===~~
	~~====cols====~~
	~~The width of the visible area of the textarea, as a number of columns of text.~~
	~~====rows====~~
	~~The height of the visible area of the textarea, as a number of text rows.~~
	~~====wrap====~~
	~~If set nowrap, the textarea will not wrap unbroken lines to a new row.~~
	~~====maxlength====~~
	~~The maximum length (in characters) that the element will accept.~~

	~~==<select>==~~
	~~<select> has no additional parameters.~~

	~~==<option>==~~
	~~===Attributes===~~
	~~====selected====~~
	~~If set, then the option is selected when the <select> element is first loaded.~~
	~~====unselectable====~~
	~~If set, then the option is not selectable by the user. Useful for labelling groups of options.~~

	~~==<dataselect>==~~
	~~===Attributes===~~
	~~====source====~~
	~~The data source to read the options from.~~
	~~====fields====~~
	~~A comma-separated list of fields to fetch from the data source and to display for each option (or optionally to be sent through the data formatter)~~
	~~====valuefield====~~
	~~The field from the data source to use as the option’s value. If not set, then the first field in the fields attribute is used.~~
	~~====formatter====~~
	~~The name of the dataformatter to use to process the raw fields information into RML. If not set, then the fields are displayed in raw text.~~

RML StyleSheets

MjnMixael — Wed, 28 Oct 2026 18:32:01 GMT

← Older revision		Revision as of 18:32, 28 October 2026
Line 1:		Line 1:
	{{RML}}		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-StyleSheets}}
	~~Styles can be included in an RML document in three ways: included from an external style sheet, declared in the header, or declared inline inside a specific tag.~~

	~~==External Style Sheets==~~
	~~Style sheets are included from an external source with the <link> tag. See Link [[RML_Elements\|Elements]].~~

	~~==Header Style Information==~~
	~~RCSS can be included directly inside the header, with the <style> tag.~~
	*No attributes

	~~==Inline Style Declaration==~~
	~~RCSS can be declared directly inside an element with the style attribute.~~

	~~===Attributes===~~

	~~====style====~~
	~~This attribute specifies a list of RCSS properties to be applied to the current element.~~

RML Images

MjnMixael — Wed, 28 Oct 2026 18:31:48 GMT

← Older revision		Revision as of 18:31, 28 October 2026
Line 1:		Line 1:
	{{RML}}		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-Images}}
	~~Librocket within FSO support two types of image tags.~~

	~~==<img>==~~
	~~The <img> element is used to include images in the document.~~

	~~==<ani>==~~
	~~The <ani> element is used for animated images and can load APNG, EFF, or ANI files~~

	~~==Attributes==~~
	~~These attributes apply to both types of images.~~
	~~===src===~~
	~~The filename of the img or ani~~
	~~===width===~~
	~~The width to force the element to, in pixels. If this is unspecified, it will default to the width of the image.~~
	~~===height===~~
	~~The height to force the element to, in pixels. If this is unspecified, it will default to the height of the image.~~

RML Elements

MjnMixael — Wed, 28 Oct 2026 18:31:34 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RML-Elements}}"

← Older revision		Revision as of 18:31, 28 October 2026
Line 1:		Line 1:
	{{RML}}		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-Elements}}
	When parsing a tag libRocket will look up custom elements associated with the tag name and fall back to a generic element. Very few custom elements are required as most of the power in libRocket comes from styling elements with RCSS to produce the desired layout.

	The user is encouraged to follow standard HTML guidelines where possible to improve readability across the community. For more information on setting up libRocket to emulate HTML4 see Appendix: HTML4 Style Sheet.

	~~==Global Attributes==~~
	~~Elements have a base set of attributes that are common to across all types, which are:~~

	~~===id===~~
	~~The unique identifier for the element in this document.~~
	~~===class===~~
	Assigns a class name or set of class names to an element. Any number of elements may be assigned the same class name or names. Multiple class names must be separated by white space characters. See RCSS.
	~~===style===~~
	~~Specifies inline style information for the element. See [[Librocket#RCSS\|RCSS]].~~
	~~===on* events===~~
	~~Event bindings. See [[RML_Events\|Events]].~~

	~~==List==~~
	~~The following is a list of elements supported by RML inside FSO:~~

	*<rml>
	*<head>
	*<title>
	*<link>
	*<body>
	*<img>
	*<ani>
	*<handle>
	*<style>
	*<datagrid>
	*<col>
	*<form>
	*<input>
	*<textarea>
	*<select>
	*<option>
	*<dataselect>
	*<tabset>
	*<tab>
	*<panel>

RML Documents

MjnMixael — Wed, 28 Oct 2026 18:31:22 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/RML-Documents}}"

← Older revision		Revision as of 18:31, 28 October 2026
Line 1:		Line 1:
	{{~~RML}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/RML-Documents}}
	~~RML documents have this basic structure.~~
	~~==<rml>==~~
	~~All libRocket documents begin with the <rml> element. The element should contain two children, <head> and <body>.~~
	~~<pre>~~
	~~<rml>~~
	~~<head>~~
	~~...~~
	</~~head>~~
	~~<body>~~
	...
	~~</body>~~
	</~~rml>~~
	</~~pre>~~
	~~===<head>===~~
	~~The <head> element contains information about the current document, such as its title, style and template information is references. No information in the header is rendered.~~

	~~===<title>===~~
	~~The <title> element contains the title of the document. This is often used for the specifying the contents of the title bar of a game window.~~

	~~===<link>===~~
	~~The <link> element is used to specify additional resources the document requires.~~

	~~====Attributes====~~
	~~=====type=====~~
	*Type of link, which should be one of:
	*text/~~rcss - libRocket Style Sheet Specification~~
	*text/~~template~~ - ~~libRocket Template~~
	*text/script - libRocket script
	~~=====href=====~~
	*Specifies the source URI, relative to the document being parsed.

	~~===<body>===~~
	~~The body of a document contains the document’s content. All elements within the <body> tag is laid out and rendered by libRocket based on the active style sheets.~~

Librocket API Event

MjnMixael — Wed, 28 Oct 2026 18:31:08 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Event}}"

← Older revision		Revision as of 18:31, 28 October 2026
Line 1:		Line 1:
	{{~~Librocket_API}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Event}}
	~~When an event is sent to Lua, three global variables are set up in the context of the called function.~~
	*event - The event object
	*document - The document in which the event fired
	*self - The element context in which the event fired

	~~==Event Interface==~~
	~~===Properties===~~
	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Python property~~
	~~\| Brief description~~
	~~\| Equivalent method~~
	\|-
	~~\| current_element~~
	~~\| The current element in the event propagation~~.
	~~\| GetCurrentElement()~~
	\|-
	~~\| target_element~~
	~~\| The element the event was originally targeted at.~~
	~~\| GetTargetElement()~~
	\|-
	~~\| type~~
	~~\| The type of the event.~~
	~~\| GetType()~~
	\|-
	~~\| parameters~~
	~~\| Dictionary style container of all the parameters in the event~~
	~~\| GetParameters()~~
	\|}
	~~===Methods===~~
	~~Events have a single Python method, StopPropagation(), which interrupts the event propagation if allowed by the event (ie, if it is interruptible).~~

Librocket API Element

MjnMixael — Wed, 28 Oct 2026 18:30:55 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Element}}"

Show changes

Librocket API Document

MjnMixael — Wed, 28 Oct 2026 18:30:44 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Document}}"

← Older revision		Revision as of 18:30, 28 October 2026
Line 1:		Line 1:
	{{~~Librocket_API}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Document}}
	~~Documents derive from elements, so inherit their interface. The document-specific interface is similar to the C++ interface; refer there for the full functional documentation.~~

	~~==Properties==~~

	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Lua property~~
	~~\| Brief description~~
	~~\| Equivalent C++ methods~~
	\|-
	~~\| context~~
	~~\| Retrieves the document’s context~~.
	~~\| GetContext()~~
	\|-
	~~\| title~~
	~~\| Gets~~ / ~~sets the document’s title.~~
	~~\| GetTitle(), SetTitle()~~
	\|}

	~~==Methods==~~

	~~{\| border=1 cellpadding=4 style="border~~-~~collapse: collapse"~~
	\|-
	~~\| Lua method~~
	~~\| Brief description~~
	\|-
	~~\| CreateElement()~~
	~~\| Creates an element by tag name.~~
	\|-
	~~\| CreateTextNode()~~
	~~\| Creates a text element.~~
	\|-
	~~\| Close()~~
	~~\| Closes the document and destroys all child elements.~~
	\|-
	~~\| Hide()~~
	~~\| Hides the document.~~
	\|-
	~~\| PullToFront()~~
	~~\| Pulls to the document to the front of others with a similar z-index.~~
	\|-
	~~\| PushToBack()~~
	~~\| Pushes to the document behind others with a similar z-index.~~
	\|-
	~~\| Show(flags = FOCUS)~~
	~~\| Shows the document, optionally with focus flags.~~
	\|}

	~~The flags available for the Show() are referenced in Luaas:~~
	*NONE
	*FOCUS
	*MODAL

Librocket API Context

MjnMixael — Wed, 28 Oct 2026 18:30:31 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Context}}"

← Older revision		Revision as of 18:30, 28 October 2026
Line 1:		Line 1:
	{{~~Librocket_API}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Context}}
	~~==Properties==~~
	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Lua property~~
	~~\| Brief description~~
	~~\| Equivalent functions~~
	\|-
	~~\| dimensions~~
	~~\| Gets~~/~~sets the dimensions of the context~~.
	~~\| GetDimensions(), SetDimensions()~~
	\|-
	~~\| documents~~
	~~\| Retrieves a document within the interface.~~
	~~\| GetDocument(), GetNumDocuments()~~
	\|-
	~~\| focus_element~~
	~~\| Retrieves the context’s focus element.~~
	~~\| GetFocusElement()~~
	\|-
	~~\| hover_element~~
	~~\| Retrieves the element under the context’s cursor.~~
	~~\| GetHoverElement()~~
	\|-
	~~\| root_element~~
	~~\| Retrieves the context’s root element.~~
	~~\| GetRootElement()~~
	\|-
	~~\| name~~
	~~\| Retrieves the context’s name.~~
	~~\| GetName()~~
	\|}

	~~===Retrieving documents===~~
	~~The documents property on the context can be referenced in several ways. For example, as an array:~~
	~~<pre>~~
	~~for document in context.documents:~~
	~~ba.print(document.title)~~
	</~~pre>~~
	~~Or as a dictionary, looking documents up by their ID:~~
	~~<pre>~~
	~~document = context.documents["highscores"]~~
	</~~pre>~~
	~~Or accessing documents as attributes on the documents property itself:~~
	~~<pre>~~
	~~document = context.documents.highscores~~
	</~~pre>~~

	~~==Methods==~~
	~~The following methods are available.~~

	~~{\| border=1 cellpadding=4 style="border~~-~~collapse: collapse"~~
	\|-
	~~\| Luamethod~~
	~~\| Brief description~~
	\|-
	~~\| AddEventListener()~~
	~~\| Attaches an inline event listener to the root of the context.~~
	\|-
	~~\| AddMouseCursor()~~
	~~\| Adds a previously-loaded mouse cursor to the document.~~
	\|-
	~~\| CreateDocument()~~
	~~\| Creates a new document.~~
	\|-
	~~\| LoadDocument()~~
	~~\| Loads a document from an external RML file.~~
	\|-
	~~\| LoadMouseCursor()~~
	~~\| Loads a mouse cursor from an external RML file.~~
	\|-
	~~\| Render()~~
	~~\| Renders the context.~~
	\|-
	~~\| ShowMouseCursor()~~
	~~\| Shows or hides the mouse cursor.~~
	\|-
	~~\| UnloadAllDocuments()~~
	~~\| Unloads all loaded documents within the context.~~
	\|-
	~~\| UnloadAllMouseCursors()~~
	~~\| Unloads all of the context’s mouse cursors.~~
	\|-
	~~\| UnloadDocument()~~
	~~\| Unloads one of the context’s documents.~~
	\|-
	~~\| UnloadMouseCursor()~~
	~~\| Unloads one of the context’s cursors.~~
	\|-
	~~\| Update()~~
	~~\| Updates the context.~~
	\|}

	~~==Creating contexts==~~
	~~Contexts can be created in Python with the CreateContext() function in the libRocket module. This function takes the name of the context as a string and the dimensions as an Vector2i type.~~
	~~<pre>~~
	~~new_context = rocket:CreateContext("hud", rocket.Vector2i(1024, 768))~~
	~~</pre>~~

	~~==Accessing contexts==~~
	~~Existing contexts can be accessed in Lua via the contexts member on the rocket module. They can then be accessed via name or index.~~
	~~<pre>~~
	~~context = rocket.contexts["hud"]~~
	~~</pre>~~
	~~List all contexts~~
	~~<pre>~~
	~~for context in rocket.contexts:~~
	~~print context.name~~
	~~</pre>~~

Librocket API Reference

MjnMixael — Wed, 28 Oct 2026 18:30:19 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Reference}}"

Show changes

Librocket

MjnMixael — Wed, 28 Oct 2026 18:30:02 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/Librocket}}"

← Older revision		Revision as of 18:30, 28 October 2026
Line 1:		Line 1:
	~~Librocket is the UI library that [[~~SCPUI]] uses to layout, draw, and implement the upgraded ui system within FreeSpace Open. It uses the open standards XHTML1.0 and CSS2.0 (while borrowing features from HTML5 and CSS3), and extends them with features suited towards real-time applications.		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/Librocket}}

	~~FSO's version of the library is a bugfixed fork of the original. [~~https://github.com/~~asarium~~/~~libRocketMod The source code is available here.]~~

	~~==Basics==~~
	~~The basic implementation of a librocket UI within FSO contains three files: RML, CSS, and LUA.~~

	~~==Development and Debugging==~~
	~~There are three main things to know when working with the librocket library within FSO.~~

	~~#You can view the librocket debugger by pressing '''''ctrl-shift-d'''''~~
	~~#You can live-reload RML and RCSS files by pressing '''''ctrl-shift-r'''''~~
	**It's worth noting that Librocket will drop the existing elements and lose them in memory. This will cause a warning on game-exit.
	~~#Librocket API warnings and errors are not currently forwarded to FSO's error handling. Because of this, simple bugs in your Lua code that uses the API cause cause FSO to crash.~~

	~~==RML==~~
	RML is based loosely around XHTML 1.0 and HTML 4.01, however element names are (mostly) open-ended in RML and can be used in any way that is logical for your application. All documents follow strict XML1.0 specification and where possible all libRocket elements follow their HTML equivalent.

	RML maintains the core components of HTML4, including CSS and scripting. It provides a number of basic elements including input fields, radio buttons and check boxes as well as more complex enhancements such as templates and datagrids.

	*[[RML_Elements\|Elements]] - The basic RML element.
	*[[RML_Documents\|Documents]] - The HEAD and BODY of a document.
	*[[RML_Images\|Images]] - Referencing images.
	*[[RML_StyleSheets\|Style Sheets]] - Adding style to RML documents.
	*[[RML_Forms\|Forms]] - User-input forms.
	*[[RML_Controls\|Controls]] - Tabsets and window handles.
	*[[RML_DataDisplay\|Data Display]] - Data grids and data selects.
	*[[RML_Templates\|Templates]] - Making all your windows look consistent.
	*[[RML_Events\|Events]] - Mouse clicks, movement, key presses, text entry.

	~~==RCSS==~~
	RCSS is based on the CSS2 specification, with certain elements removed or altered to suit the needs of libRocket. In some cases, elements have been taken from the CSS3 working draft. This document provides an overview of RCSS and the differences between RCSS and CSS, and should be read in conjunction with the CSS2 specification.

	RCSS interacts with RML in an identical fashion to CSS and HTML. Style properties declared in a RCSS are attached selectively to elements defined in RML to affect layout, positioning and other style attributes (such as font, color, text decoration, etc).

	If you are familiar with CSS, a good place to start is the [[RCSS_Properties\|property index]], which outlines the properties and values supported in RCSS and the new functionality included. Next, read up on decorators, the new, flexible way to skin elements.

	~~If you are not, read through this documentation while consulting the CSS2 specification for detailed examples and technical details, or skip all this for now and play around with the samples!~~
	*[[RCSS_Syntax\|Syntax and basic data types]]
	*[[RCSS_Selectors\|Selectors]]
	*[[RCSS_BoxModel\|Box model]]
	*[[RCSS_VisualModel\|Visual formatting model]]
	*[[RCSS_VisualEffects\|Visual effects]]
	*[[RCSS_ColorsBackgrounds\|Colors and backgrounds]]
	*[[RCSS_Fonts\|Fonts]]
	*[[RCSS_Text\|Text]]
	*[[RCSS_CursorsDragTab\|Cursors, Dragging and Tabbing]]
	*[[RCSS_Decorators\|Decorators]]
	*[[RCSS_FontEffects\|Font effects]]
	*[[RCSS_Scrollbars\|Scrollbars and Sliders]]
	*[[RCSS_Properties\|Property Index]]

	~~==LUA API==~~
	The Lua interface to libRocket has been designed to resemble Javascript as closely as possible. It is how the librocket UI will actually interact with the Freespace Open engine. Below is a list of property and API references.

	*[[Librocket_API_Element\|Elements]]
	*[[Librocket_API_Document\|Documents]]
	*[[Librocket_API_Context\|Contexts]]
	*[[Librocket_API_Event\|Events]]
	*[[Librocket_API_Reference\|API Reference]]

	~~===Embedding Script===~~
	Lua code can be embedded into RML files. Inline responses to events are executed as Python code. Functions, structures and variables can be declared or included with the <script> tag, then referenced from the inline code.

	Similarly to Javascript, the lua can be included from a separate file with the src attribute, or otherwise declared inline as loose content within the <script> tag. Any code embedded in this manner will be compiled with the document and will be available to inline event handlers in the RML. See the following examples.
	~~<pre>~~
	~~<rml>~~
	~~<head>~~
	~~<script>~~
	~~def Test():~~
	~~print 'Hello world!'~~
	</~~script>~~
	</~~head>~~
	~~<body>~~
	~~<button onclick="Test()">Continue</button>~~
	~~</body>~~
	~~</rml>~~
	~~</pre>~~
	~~<pre>~~
	~~<rml>~~
	~~<head>~~
	~~<script src="test.py"></script>~~
	~~</head>~~
	~~<body>~~
	~~<button onclick="Test()">Continue</button>~~
	~~</body>~~
	~~</rml>~~
	~~</pre>~~
	~~===Attaching To Events===~~
	~~You can attach to user interface events statically in the RML or dynamically in the lua scripts.~~
	*A list of events available to attach to is in the [[RML_Events\|RML Events]] documentation.

	~~====Statically====~~
	~~With this method you write your code directly into the RML files, using the on* attributes. When the event is fired three global variables are set up, document, event and self.~~
	*[[Librocket_API_Element\|self]] - The element thats currently being processed
	*[[Librocket_API_Document\|document]] - The document the element thats currently being processed belongs to
	*[[Librocket_API_Event\|event]] - The event thats currently being processed
	~~Using the on* attributes you write your code inline~~
	*Example: <code><button onclick="ba.print('Clicked!')"/></code>
	~~LibRocket allows multiple lines of code to be put on one line, separated by a semicolon.~~
	*Example: <code><button onclick="ba.print('Line 1');ba.print('Line 2')"/></code>

	~~====Dynamically====~~
	~~The AddEventListener() method allows you to bind any callable LUA method to an event.~~
	~~<pre>~~
	~~function print(message)~~
	~~ba.print(message)~~
	~~end~~

	~~function createListener()~~
	~~element = document:GetElementById('button')~~
	~~element:AddEventListener('click', function(_, _, _)~~
	~~print("clicked!")~~
	~~end)~~
	~~end~~
	~~</pre>~~

System map.tbl

MjnMixael — Wed, 28 Oct 2026 18:29:50 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/system_map.tbl}} Category:SCPUI Category:Tables"

Show changes

Options.tbl

MjnMixael — Wed, 28 Oct 2026 18:29:38 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/options.tbl}} Category:SCPUI Category:Tables"

Show changes

Nodemap.tbl

MjnMixael — Wed, 28 Oct 2026 18:29:27 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/nodemap.tbl}} Category:SCPUI Category:Tables"

Show changes

Keywords.tbl

MjnMixael — Wed, 28 Oct 2026 18:29:15 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/keywords.tbl}} Category:SCPUI Category:Tables"

Show changes

Journal.tbl

MjnMixael — Wed, 28 Oct 2026 18:29:01 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/journal.tbl}} Category:SCPUI Category:Tables"

Show changes

Achievements.tbl

MjnMixael — Wed, 28 Oct 2026 18:28:50 GMT

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/achievements.tbl}} Category:SCPUI Category:Tables"

← Older revision		Revision as of 18:28, 28 October 2026
Line 1:		Line 1:
	{{~~SCPUI_table}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/achievements.tbl}} [[Category:SCPUI]] [[Category:Tables]]
	~~{{Tables}}~~
	~~Achievements~~.~~tbl is used by the [[~~SCPUI~~]] script system to define the~~ achievements ~~available for a particular mod.~~

	~~Achievements~~.tbl~~, by design, is NOT modular and cannot be extended.~~

	~~==Achievements.tbl==~~
	*Defines what achievements are available and how they are unlocked
	*Begins with #ACHIEVEMENTS and ends with #End

	~~==#ACHIEVEMENTS==~~
	*The list of achievements
	*Can have multiple Achievements starting with $Name

	~~===$Name:===~~
	*The name of the achievement as shown to the player.
	*Cannot exceed 32 characters.
	*Must be unique.
	*Syntax: '''''string'''''

	~~====+Description:====~~
	*A string describing the achievement.
	*Cannot exceed 50 characters.
	*Syntax: '''''string'''''

	~~====+Criteria:====~~
	*Begins parsing the Criteria section
	*Contains no value

	~~=====+Type:=====~~
	*The criteria type. Must be one of "Custom", "Number of Kills", or "Weapons Fired"
	*Syntax: '''''string'''''

	~~=====+Target:=====~~
	*The target of the achievement criteria.
	*If the type is Number of Kills then this should be a ship class. If the type is Weapons Fired this should be a weapon class. For other criteria types this field is discarded.
	*This value is optional. If not provided then all ships or weapons count towards the achievement.
	*Syntax: '''''string'''''

	~~=====+Threshold:=====~~
	*The threshold of the criteria. IE: The number of whatever the player must reach to unlock the achievement.
	*For singular event custom achievements a value of 1 should be used.
	*This value is optional. If not provided, a default width of 1 will be used.
	*Syntax: '''''integer'''''

	~~====+Hidden:====~~
	*Specifies if the achievement should be hidden until unlocked
	*This value is optional. If not provided, a default height of false will be used.
	*Syntax: '''''boolean'''''

	~~====+Color:====~~
	*The color of the text for the achievement in the UI.
	*Use R,G,B,A format. A is optional and defaults to 255.
	*This value is optional. If not provided, the color will be the UI default.
	*Syntax: '''''integer, integer, integer, integer'''''

	~~====+Bar Color:====~~
	*The color of the progress bar for the achievement in the UI.
	*Use R,G,B,A format. A is optional and defaults to 255.
	*This value is optional. If not provided, the color will be the UI default.
	*Syntax: '''''integer, integer, integer, integer'''''


	~~===Example===~~
	~~<pre>~~
	~~#ACHIEVEMENTS~~

	~~$Name: Achievement name (required)~~
	~~+Description: Description text (required)~~
	~~+Criteria:~~
	~~+Type: Number of Kills, Weapons Fired, Custom (required)~~
	~~+Target: Ship class or weapon Class (optional)~~
	~~+Threshold: Number greater than 0 (optional)~~
	~~+Hidden: boolean (optional, default: false)~~
	~~+Color: 128, 128, 128, 255~~
	~~+Bar Color: 255, 0, 0, 255~~

	~~#END~~
	~~</pre>~~
	[[Category:~~Tables~~]]
	[[Category:~~SCPUI~~]]

← Older revision		Revision as of 02:15, 11 November 2026
Line 186:		Line 186:
	{{Table224\|		{{Table224\|
	*An [[Lighting_Profiles.tbl#Adjustable values\|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model		*An [[Lighting_Profiles.tbl#Adjustable values\|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
			*Syntax: See [[Lighting_Profiles.tbl#Adjustable values\|Adjustable values]]
			}}

			===$Cockpit light intensity modifier:===
			{{Table250\|
			*An [[Lighting_Profiles.tbl#Adjustable values\|Adjustable value]] applied to the intensity of all lights, only applied when rendering the player ships cockpit and "show ship" model
	*Syntax: See [[Lighting_Profiles.tbl#Adjustable values\|Adjustable values]]		*Syntax: See [[Lighting_Profiles.tbl#Adjustable values\|Adjustable values]]
	}}		}}

← Older revision		Revision as of 22:14, 6 November 2026
Line 110:		Line 110:
	'''Websites'''		'''Websites'''
	*[http://inferno.hard-light.net/ Official Inferno site \| Hard-Light Productions.net]		*[http://inferno.hard-light.net/ Official Inferno site \| Hard-Light Productions.net]
	*[http://inferno.hard-light.net/SOL Official Inferno: Alliance site \| Hard-Light Productions.net]		*[https://www.moddb.com/games/infscp Inferno page \| ModDB.com]
	*[https://www.moddb.com/games/infscp Inferno~~: Nostos page \| ModDB.com]~~
	*[http://www.moddb.com/games/inferno Inferno: Alliance Reborn page \| ModDB.com]

	'''Forums/Threads'''		'''Forums/Threads'''
	*'''[https://www.hard-light.net/forums/index.php?board=20.0 Main Inferno board \| Hard-Light Productions.net]'''		*'''[https://www.hard-light.net/forums/index.php?board=20.0 Main Inferno board \| Hard-Light Productions.net]'''
	*[https://www.hard-light.net/forums/index.php?topic=~~94800~~.0 Inferno ~~Nostos~~ release thread \| Hard-Light Productions.net]		*[https://www.hard-light.net/forums/index.php?topic=100153.0 Inferno 3 release thread \| Hard-Light Productions.net]
	*[https://www.hard-light.net/forums/index.php?topic=98869.0 INFR1 20th Anniversary Edition release thread \| Hard-Light Productions.net]		*[https://www.hard-light.net/forums/index.php?topic=98869.0 INFR1 20th Anniversary Edition release thread \| Hard-Light Productions.net]

	~~'''Downloads'''~~
	*'''[http://www.freespacemods.net/download.php?view.95 Inferno R1 \| FreeSpaceMods.net]'''
	*'''[http://www.freespacemods.net/download.php?view.353 SCP Patch for Inferno R1 \| FreeSpaceMods.net]'''
	*[http://www.freespacemods.net/download.php?view.94 Inferno: Alliance \| FreeSpaceMods.net]

	~~'''Videos'''~~
	*[http://www.moddb.com/games/inferno/videos Inferno: Alliance Standalone videos \| ModDB.com]

← Older revision		Revision as of 18:30, 28 October 2026
Line 1:		Line 1:
	{{~~Librocket_API}}~~		{{SCPUI moved\|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Document}}
	~~Documents derive from elements, so inherit their interface. The document-specific interface is similar to the C++ interface; refer there for the full functional documentation.~~

	~~==Properties==~~

	{\| ~~border=1 cellpadding=4 style="border-collapse~~: ~~collapse"~~
	\|-
	~~\| Lua property~~
	~~\| Brief description~~
	~~\| Equivalent C++ methods~~
	\|-
	~~\| context~~
	~~\| Retrieves the document’s context~~.
	~~\| GetContext()~~
	\|-
	~~\| title~~
	~~\| Gets~~ / ~~sets the document’s title.~~
	~~\| GetTitle(), SetTitle()~~
	\|}

	~~==Methods==~~

	~~{\| border=1 cellpadding=4 style="border~~-~~collapse: collapse"~~
	\|-
	~~\| Lua method~~
	~~\| Brief description~~
	\|-
	~~\| CreateElement()~~
	~~\| Creates an element by tag name.~~
	\|-
	~~\| CreateTextNode()~~
	~~\| Creates a text element.~~
	\|-
	~~\| Close()~~
	~~\| Closes the document and destroys all child elements.~~
	\|-
	~~\| Hide()~~
	~~\| Hides the document.~~
	\|-
	~~\| PullToFront()~~
	~~\| Pulls to the document to the front of others with a similar z-index.~~
	\|-
	~~\| PushToBack()~~
	~~\| Pushes to the document behind others with a similar z-index.~~
	\|-
	~~\| Show(flags = FOCUS)~~
	~~\| Shows the document, optionally with focus flags.~~
	\|}

	~~The flags available for the Show() are referenced in Luaas:~~
	*NONE
	*FOCUS
	*MODAL