Firefly/ff engine - Revision history

Luxen: Added a few actions

2025-04-06T17:28:32Z

Added a few actions

← Older revision		Revision as of 17:28, 6 April 2025
Line 60:		Line 60:

	== Actions ==		== Actions ==
	* Start Engine
	* Stop Engine		=== Start Engine ===
	* Set Engine Resolution		Start the rendering engine with its current settings.
	* Engine Setup
	** Device Driver		=== Stop Engine ===
	** Anti ~~Aliasing~~		Stop the rendering engine so you can change settings.

			=== Set Engine Resolution ===
			Sets the internal resolution of the rendering engine.
			* This should be set to match the size of the object, or certain rendering functionality may behave incorrectly (example: drawing 3d lines)
			* This action has no effect if the engine is running (verify)

			=== Engine Setup ===
			These options control the rendering pipeline and cannot be used while the engine is running.

			==== Device Driver ====
			Sets the rendering pipeline to be used by the firefly object. If using the 'set' dialog option instead of a predefined selection, index starts at zero. See "Device Driver" properties above (todo: bookmark links to scroll page for user)

			==== Anti Alias ====
			Sets the global anti-aliasing level to be used by the engine. If using the 'set' dialog option instead of a predefined selection, index starts at zero.

	* Set Engine Background Color		* Set Engine Background Color
	* Set Engine Fog Color		* Set Engine Fog Color

Luxen: /* Device Driver */ Added action selection index to table

2025-03-27T00:06:32Z

Device Driver: Added action selection index to table

← Older revision		Revision as of 00:06, 27 March 2025
Line 14:		Line 14:
	Allows you to select the rendering pipeline Firefly will run with. The available options and limitations of each are labeled below:		Allows you to select the rendering pipeline Firefly will run with. The available options and limitations of each are labeled below:
	{\|border="1"		{\|border="1"
	! Driver \|\| Description		! Index
			! Driver
			! Description
	\|-		\|-
	\| Software \|\| A very primitive rendering pipeline on the CPU with no support for shaders, lighting, and does not render any vertices outside of the camera's field of view. Available as a last-available-option renderer.		\| 0 \|\| Software \|\| A very primitive rendering pipeline on the CPU with no support for shaders, lighting, and does not render any vertices outside of the camera's field of view. Available as a last-available-option renderer.
	\|-		\|-
	\| Software2 \|\| A performance-poor rendering pipeline on the CPU with no support for shaders or lighting. Use only if DirectX or OpennGL are not available.		\| 1 \|\| Software2 \|\| A performance-poor rendering pipeline on the CPU with no support for shaders or lighting. Use only if DirectX or OpennGL are not available.
	\|-		\|-
	\| Direct3D8\|\| Does not load at all - possibly because Irrlicht (the 3d engine firefly is based on) dropped support for this pipeline?		\| 2 \|\| Direct3D8\|\| Does not load at all - possibly because Irrlicht (the 3d engine firefly is based on) dropped support for this pipeline?
	\|-		\|-
	\| Direct3D9 \|\| Uses the DirectX standard pipeline for rendering on the GPU. Does not support the engine's lighting, but supports HLSL shaders and has good performance.		\| 3 \|\| Direct3D9 \|\| Uses the DirectX standard pipeline for rendering on the GPU. Does not support the engine's lighting, but supports HLSL shaders and has good performance.
	\|-		\|-
	\| OpenGL \|\| Uses the OpenGL standard pipeline for rendering on the GPU. Shaders do not have correct vertex information (Needs verification) but supports engine lighting and has good performance.		\| 4 \|\| OpenGL \|\| Uses the OpenGL standard pipeline for rendering on the GPU. Shaders do not have correct vertex information (Needs verification) but supports engine lighting and has good performance.
	\|}		\|}

Luxen: /* Properties */ Reformatted page to use subsections instead of lists (can now be navigated), and added additional information present in the outdated clickteam online documentation.

2025-03-27T00:05:13Z

Properties: Reformatted page to use subsections instead of lists (can now be navigated), and added additional information present in the outdated clickteam online documentation.

@@ Line 4: / Line 4: @@
 == Properties ==
-* "Start engine at start": This is a toggle that controls whether the Firefly engine itself will initialize immediately when the frame starts. If you have to configure certain engine settings, or manipulate the engine such as resizing the engine frame, then this should be toggled off, and use an action to trigger the engine to start when you are ready.
+todo:
-* Device Driver: Allows you to select the rendering pipeline FIrefly will run with. The available options and limitations of each are labeled below:
+* show examples to the right or underneath each sub-section as necessary?
 {|border="1"
 ! Driver || Description
 |-
-| Software || A very primitive rendering pipeline with no support for shaders, lighting, and does not render any vertices outside of the camera's field of view. Available as a last-available-option renderer.
+| Software || A very primitive rendering pipeline on the CPU with no support for shaders, lighting, and does not render any vertices outside of the camera's field of view. Available as a last-available-option renderer.
 |-
-| Software2 || A performance-poor rendering pipeline with no support for shaders or lighting. Use only if DirectX or OpennGL are not available.
+| Software2 || A performance-poor rendering pipeline on the CPU with no support for shaders or lighting. Use only if DirectX or OpennGL are not available.
 |-
 | Direct3D8|| Does not load at all - possibly because Irrlicht (the 3d engine firefly is based on) dropped support for this pipeline?
 |-
-| Direct3D9 || Uses the DirectX standard pipeline for rendering. Does not support the engine's lighting, but supports HLSL shaders and has good performance.
+| Direct3D9 || Uses the DirectX standard pipeline for rendering on the GPU. Does not support the engine's lighting, but supports HLSL shaders and has good performance.
 |-
-| OpenGL || Uses the OpenGL standard pipeline for rendering. Shaders do not have correct vertex information (Needs verification) but supports engine lighting and has good performance.
+| OpenGL || Uses the OpenGL standard pipeline for rendering on the GPU. Shaders do not have correct vertex information (Needs verification) but supports engine lighting and has good performance.
 |}
-To do: show examples to the right side of this area? Maybe place these in a table to achieve that effect?
+=== Anti Alias ===
 == Actions ==

Luxen: /* Actions */ Just grabbed a bunch of actions from the clickteam online 'help' document as placeholders

2025-03-26T22:37:54Z

Actions: Just grabbed a bunch of actions from the clickteam online 'help' document as placeholders

@@ Line 33: / Line 33: @@
 == Actions ==
-list - show actions and define their effects, with descriptions for arguments when needed
+* Start Engine
 == Conditions ==

Luxen: /* Properties */ Added the engine properties. might reformat this later.

2025-03-24T01:35:43Z

Properties: Added the engine properties. might reformat this later.

@@ Line 4: / Line 4: @@
 == Properties ==
-list - show properties and explain their behaviors
+* "Start engine at start": This is a toggle that controls whether the Firefly engine itself will initialize immediately when the frame starts. If you have to configure certain engine settings, or manipulate the engine such as resizing the engine frame, then this should be toggled off, and use an action to trigger the engine to start when you are ready.
 == Actions ==

Luxen: /* Firefly engine */ removed 'thumb' notation to fix size

2025-03-23T19:59:37Z

Firefly engine: removed 'thumb' notation to fix size

← Older revision		Revision as of 19:59, 23 March 2025
Line 1:		Line 1:
	= Firefly engine =		= Firefly engine =
	[[image:ff_engine_icon.png~~\|thumb~~\|left\|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.		[[image:ff_engine_icon.png\|left\|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
	<br />		<br />

Luxen: /* Firefly engine */ changed icon file name

2025-03-23T19:58:47Z

Firefly engine: changed icon file name

← Older revision		Revision as of 19:58, 23 March 2025
Line 1:		Line 1:
	= Firefly engine =		= Firefly engine =
	[[image:~~ff_engine~~.~~jpg~~\|thumb\|left\|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.		[[image:ff_engine_icon.png\|thumb\|left\|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
	<br />		<br />

Luxen: Placeholder page for base firefly engine

2025-03-23T19:46:39Z

Placeholder page for base firefly engine

New page

= Firefly engine =
[[image:ff_engine.jpg|thumb|left|Firefly engine]] The Firefly Engine object is the base of the entire Firefly system. It is the object that actually takes all of your various nodes and other Firefly objects and renders the 3d scene to the frame. You must have at least one in your project's frame in order for anything 3d to appear when you run it. The size and placement of the engine within your game's frame determines where in the frame the 3d scene is rendered.
<br />

== Properties ==
list - show properties and explain their behaviors

== Actions ==
list - show actions and define their effects, with descriptions for arguments when needed

== Conditions ==
list - show conditions and define what triggers them

== Expressions ==
list - show expressions and what they define

== Additional notes ==
details on functionality and limitations