Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- /*!
- @brief A collection of properties that determine control behavior and rendering.
- @ingroup GuiCore
- */
- class GuiControlProfile : public SimObject {
- public:
- virtual int getStringWidth(( pString )) {}
- /*! @name Behavior
- @{ */
- /*! */
- /*!
- */
- bool tab;
- /*!
- Whether the control can have the keyboard focus.
- */
- bool canKeyFocus;
- /*!
- */
- bool mouseOverSelected;
- /*!
- */
- bool modal;
- /// @}
- /*! @name Appearance
- @{ */
- /*! */
- /*!
- */
- bool opaque;
- /*!
- */
- ColorI fillColor;
- /*!
- */
- ColorI fillColorHL;
- /*!
- */
- ColorI fillColorNA;
- /*!
- */
- ColorI fillColorSEL;
- /*!
- Border type (0=no border).
- */
- int border;
- /*!
- Thickness of border in pixels.
- */
- int borderThickness;
- /*!
- Color to draw border with.
- */
- ColorI borderColor;
- /*!
- */
- ColorI borderColorHL;
- /*!
- */
- ColorI borderColorNA;
- /*!
- */
- ColorI bevelColorHL;
- /*!
- */
- ColorI bevelColorLL;
- /// @}
- /*! @name Text
- @{ */
- /*! */
- /*!
- Name of font family and typeface (e.g. "Arial Bold").
- */
- string fontType;
- /*!
- Font size in points.
- */
- int fontSize;
- /*!
- */
- GuiFontCharset fontCharset;
- /*!
- Font colors to use for different text types/states.
- */
- ColorI fontColors;
- /*!
- Font color for normal text (same as fontColors[0]).
- */
- ColorI FontColor;
- /*!
- Font color for highlighted text (same as fontColors[1]).
- */
- ColorI fontColorHL;
- /*!
- Font color when control is not active/disabled (same as fontColors[2]).
- */
- ColorI fontColorNA;
- /*!
- Font color for selected text (same as fontColors[3]).
- */
- ColorI fontColorSEL;
- /*!
- Font color for links in text (same as fontColors[4]).
- */
- ColorI fontColorLink;
- /*!
- Font color for highlighted links in text (same as fontColors[5]).
- */
- ColorI fontColorLinkHL;
- /*!
- Horizontal alignment for text.
- */
- GuiAlignmentType justify;
- /*!
- */
- Point2I textOffset;
- /*!
- Automatically adjust width of control to fit contents.
- */
- bool autoSizeWidth;
- /*!
- Automatically adjust height of control to fit contents.
- */
- bool autoSizeHeight;
- /*!
- Whether to add automatic tab event when return is pressed so focus moves on to next control (GuiTextEditCtrl).
- */
- bool returnTab;
- /*!
- Whether control should only accept numerical data (GuiTextEditCtrl).
- */
- bool numbersOnly;
- /*!
- Color to use for the text cursor.
- */
- ColorI cursorColor;
- /*!
- Shadow color
- */
- ColorI shadowColor;
- /*!
- Text have shadow
- */
- bool shadowText;
- /// @}
- /*! @name Misc
- @{ */
- /*! */
- /*!
- Texture to use for rendering control.
- */
- filename bitmap;
- /*!
- If true, 'bitmap' is an array of images.
- */
- bool hasBitmapArray;
- /*!
- Sound to play when mouse has been pressed on control.
- */
- SFXTrack soundButtonDown;
- /*!
- Sound to play when mouse is hovering over control.
- */
- SFXTrack soundButtonOver;
- /*!
- */
- string profileForChildren;
- /// @}
- /*!
- Category under which the profile will appear in the editor.
- */
- string category;
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Checkbox32EulaProfile : public GuiControlProfile {
- public:
- };
- /*!
- @brief A control that displays a value between its minimal and maximal bounds using a slider placed on a vertical or horizontal axis.
- A slider displays a value and allows that value to be changed by dragging a thumb control along the axis of the slider. In this way, the value is changed between its allowed minimum and maximum.
- To hook up script code to the value changes of a slider, use the #command and #altCommand properties. #command is executed once the thumb is released by the user whereas #altCommand is called any time the slider value changes. When changing the slider value from script, however, trigger of #altCommand is suppressed by default.
- The orientation of a slider is automatically determined from the ratio of its width to its height. If a slider is taller than it is wide, it will be rendered with a vertical orientation. If it is wider than it is tall, it will be rendered with a horizontal orientation.
- The rendering of a slider depends on the bitmap in the slider's profile. This bitmap must be a bitmap array comprised of at least five bitmap rectangles. The rectangles are used such that:
- - Rectangle #1: Left edge of slider
- - Rectangle #2: Center piece of slider; this is stretched between the left and right edge
- - Rectangle #3: Right edge of slider
- - Rectangle #4: Thumb button in normal state
- - Rectangle #5: Thumb button in highlighted (mouse-over) state
- @tsexample
- // Create a sound source and a slider that changes the volume of the source.
- %source = sfxPlayOnce( "art/sound/testing", AudioLoop2D );
- new GuiSlider()
- {
- // Update the sound source volume when the slider is being dragged and released.
- command = %source @ ".setVolume( $ThisControl.value );";
- // Limit the range to 0..1 since that is the allowable range for sound volumes.
- range = "0 1";
- };
- @endtsexample
- @see GuiTextEditSliderCtrl
- @see GuiTextEditSliderBitmapCtrl
- */
- class GuiIntSliderCtrl : public GuiControl {
- public:
- /*! Called when the left mouse button is dragged across the slider. */
- void onMouseDragged();
- /*! Called when value changed */
- void onValueChanged();
- /*! Get the current value of the slider based on the position of the thumb.
- @return Slider position (from range.x to range.y). */
- virtual int getValue(()) {}
- /*! Set position of the thumb on the slider.
- @param pos New slider position (from range.x to range.y)
- @param doCallback If true, the altCommand callback will be invoked
- */
- virtual void setValue(( int pos, bool doCallback=false )) {}
- virtual void setRange(( Point2F range )) {}
- /*! Returns true if the thumb is currently being dragged by the user. This method is mainly useful for scrubbing type sliders where the slider position is sync'd to a changing value. When the user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. */
- virtual bool isThumbBeingDragged(()) {}
- /*! @name Slider
- @{ */
- /*! */
- /*!
- Min and max values corresponding to left and right slider position.
- */
- Point2F range;
- /*!
- Spacing between tick marks in pixels. 0=off.
- */
- int ticks;
- /*!
- Whether to snap the slider to tick marks.
- */
- bool snap;
- /*!
- The value corresponding to the current slider position.
- */
- int value;
- /*!
- Allow to override default step value
- */
- int step;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class CmGuiArrowSliderCtrl : public GuiIntSliderCtrl {
- public:
- /*! @name Slider
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class ProductCountSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /*!
- @brief GUI control object this displays a single line of text, without TorqueML.
- @tsexample
- new GuiTextCtrl()
- {
- text = "Hello World";
- textID = ""STR_HELLO"";
- maxlength = "1024";
- //Properties not specific to this control have been omitted from this example.
- };
- @endtsexample
- @see GuiControl
- @see Localization
- @ingroup GuiCore
- */
- class GuiTextCtrl : public GuiContainer {
- public:
- /*! @brief Sets the text in the control.
- @param text Text to display in the control.
- @tsexample
- // Set the text to show in the control
- %text = "Gideon - Destroyer of World";
- // Inform the GuiTextCtrl control to change its text to the defined value
- %thisGuiTextCtrl.setText(%text);
- @endtsexample
- @see GuiControl */
- virtual void setText(( string text )) {}
- /*! @brief Maps the text ctrl to a variable used in localization, rather than raw text.
- @param textID Name of variable text should be mapped to
- @tsexample
- // Inform the GuiTextCtrl control of the textID to use
- %thisGuiTextCtrl.setTextID("STR_QUIT");
- @endtsexample
- @see GuiControl@see Localization */
- virtual void setTextID(( string textID )) {}
- /*! @brief Maps the text ctrl to a variable used in localization, rather than raw text.
- @param textID Name of variable text should be mapped to
- @tsexample
- // Inform the GuiTextCtrl control of the textID to use
- %thisGuiTextCtrl.setTextID("STR_QUIT");
- @endtsexample
- @see GuiControl@see Localization */
- virtual void setTextXMLID(( string textID )) {}
- /*!
- The text to show on the control.
- */
- caseString text;
- /*!
- Maps the text of this control to a variable used in localization, rather than raw text.
- */
- string textID;
- /*!
- Maps the text of this control to a variable used in localization, rather than raw text.
- */
- int textXMLID;
- /*!
- Defines the maximum length of the text. The default is 1024.
- */
- int maxLength;
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /*!
- @brief A component that places a text entry box on the screen.
- Fonts and sizes are changed using profiles. The text value can be set or entered by a user.
- @tsexample
- new GuiTextEditCtrl(MessageHud_Edit)
- {
- text = "Hello World";
- validate = "validateCommand();"
- escapeCommand = "escapeCommand();";
- historySize = "5";
- tabComplete = "true";
- deniedSound = "DeniedSoundProfile";
- sinkAllKeyEvents = "true";
- password = "true";
- passwordMask = "*";
- //Properties not specific to this control have been omitted from this example.
- };
- @endtsexample
- @see GuiTextCtrl
- @see GuiControl
- @ingroup GuiControls
- */
- class GuiTextEditCtrl : public GuiTextCtrl {
- public:
- /*! @brief Called if tabComplete is true, and the 'tab' key is pressed.
- @param val Input to mimick the '1' sent by the actual tab key button press.
- @tsexample
- // Tab key has been pressed, causing the callback to occur.
- GuiTextEditCtrl::onTabComplete(%this,%val)
- {
- //Code to run when the onTabComplete callback occurs
- }
- @endtsexample
- @see GuiTextCtrl
- @see GuiControl
- */
- void onTabComplete( string val );
- /*! @brief Called when the 'Return' or 'Enter' key is pressed.
- @tsexample
- // Return or Enter key was pressed, causing the callback to occur.
- GuiTextEditCtrl::onReturn(%this)
- {
- // Code to run when the onReturn callback occurs
- }
- @endtsexample
- @see GuiTextCtrl
- @see GuiControl
- */
- void onReturn();
- /*! @brief Called whenever the control is validated.
- @tsexample
- // The control gets validated, causing the callback to occur
- GuiTextEditCtrl::onValidated(%this)
- {
- // Code to run when the control is validated
- }
- @endtsexample
- @see GuiTextCtrl
- @see GuiControl
- */
- void onValidate();
- /*! @brief Acquires the current text displayed in this control.
- @tsexample
- // Acquire the value of the text control.
- %text = %thisGuiTextEditCtrl.getText();
- @endtsexample
- @return The current text within the control.
- @see GuiControl */
- virtual string getText(()) {}
- /*! @brief Sets the text in the control.
- @param text Text to place in the control.
- @tsexample
- // Define the text to display
- %text = "Text!"
- // Inform the GuiTextEditCtrl to display the defined text
- %thisGuiTextEditCtrl.setText(%text);
- @endtsexample
- @see GuiControl */
- virtual void setText(( string text )) {}
- /*! @brief Returns the current position of the text cursor in the control.
- @tsexample
- // Acquire the cursor position in the control
- %position = %thisGuiTextEditCtrl.getCursorPost();
- @endtsexample
- @return Text cursor position within the control.
- @see GuiControl */
- virtual int getCursorPos(()) {}
- /*! @brief Sets the text cursor at the defined position within the control.
- @param position Text position to set the text cursor.
- @tsexample
- // Define the cursor position
- %position = "12";
- // Inform the GuiTextEditCtrl control to place the text cursor at the defined position
- %thisGuiTextEditCtrl.setCursorPos(%position);
- @endtsexample
- @see GuiControl */
- virtual void setCursorPos(( int position )) {}
- /*! @brief Checks to see if all text in the control has been selected.
- @tsexample
- // Check to see if all text has been selected or not.
- %allSelected = %thisGuiTextEditCtrl.isAllTextSelected();
- @endtsexample
- @return True if all text in the control is selected, otherwise false.
- @see GuiControl */
- virtual bool isAllTextSelected(()) {}
- /*! @brief Selects all text within the control.
- @tsexample
- // Inform the control to select all of its text.
- %thisGuiTextEditCtrl.selectAllText();
- @endtsexample
- @see GuiControl */
- virtual void selectAllText(()) {}
- /*! @brief Unselects all selected text in the control.
- @tsexample
- // Inform the control to unselect all of its selected text
- %thisGuiTextEditCtrl.clearSelectedText();
- @endtsexample
- @see GuiControl */
- virtual void clearSelectedText(()) {}
- /*! @brief Force a validation to occur.
- @tsexample
- // Inform the control to force a validation of its text.
- %thisGuiTextEditCtrl.forceValidateText();
- @endtsexample
- @see GuiControl */
- virtual void forceValidateText(()) {}
- /*! @name Text Input
- @{ */
- /*! */
- /*!
- Script command to be called when the first validater is lost.
- */
- string validate;
- /*!
- Script command to be called when the Escape key is pressed.
- */
- string escapeCommand;
- /*!
- How large of a history buffer to maintain.
- */
- int historySize;
- /*!
- If true, when the 'tab' key is pressed, it will act as if the Enter key was pressed on the control.
- */
- bool tabComplete;
- /*!
- If the attempted text cannot be entered, this sound effect will be played.
- */
- SFXTrack deniedSound;
- /*!
- If true, every key event will act as if the Enter key was pressed.
- */
- bool sinkAllKeyEvents;
- /*!
- If true, all characters entered will be stored in the control, however will display as the character stored in passwordMask.
- */
- bool password;
- /*!
- If 'password' is true, this is the character that will be used to mask the characters in the control.
- */
- string passwordMask;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /*!
- @brief GUI Control which displays a numerical value which can be increased or decreased using a pair of arrows.
- @tsexample
- new GuiTextEditSliderCtrl()
- {
- format = "%3.2f";
- range = "-1e+03 1e+03";
- increment = "0.1";
- focusOnMouseWheel = "0";
- //Properties not specific to this control have been omitted from this example.
- };
- @endtsexample
- @see GuiTextEditCtrl
- @ingroup GuiCore
- */
- class GuiTextEditSliderCtrl : public GuiTextEditCtrl {
- public:
- /*! Called when value changed */
- void onValueChanged();
- /*!
- Character format type to place in the control.
- */
- string format;
- /*!
- Maximum vertical and horizontal range to allow in the control.
- */
- Point2F range;
- /*!
- How far to increment the slider on each step.
- */
- float increment;
- /*!
- If true, the control will accept giving focus to the user when the mouse wheel is used.
- */
- bool focusOnMouseWheel;
- /*!
- If true, the control will render arrows
- */
- bool renderArrow;
- /*! @name Text Input
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class ProductCountNumber : public GuiTextEditSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /*!
- @brief A gui control that is used to display an image.
- The image is stretched to the constraints of the control by default. However, the control can also
- tile the image as well.
- The image itself is stored inside the GuiBitmapCtrl::bitmap field. The boolean value that decides
- whether the image is stretched or tiled is stored inside the GuiBitmapCtrl::wrap field.
- @tsexample
- // Create a tiling GuiBitmapCtrl that displays "myImage.png"
- %bitmapCtrl = new GuiBitmapCtrl()
- {
- bitmap = "myImage.png";
- wrap = "true";
- };
- @endtsexample
- */
- class GuiBitmapCtrl : public GuiControl {
- public:
- /*! Set the offset of the bitmap within the control.
- @param x The x-axis offset of the image.
- @param y The y-axis offset of the image.
- */
- virtual void setValue(( int x, int y )) {}
- /*! Assign an image to the control.
- @hide */
- virtual void setBitmap(( String filename | String filename, bool resize )) {}
- /*! @name Bitmap
- @{ */
- /*! */
- /*!
- The bitmap file to display in the control.
- */
- filename bitmap;
- /*!
- If true, the bitmap is tiled inside the control rather than stretched to fit.
- */
- bool wrap;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ProductImageCtrl : public GuiBitmapCtrl {
- public:
- };
- class CraftworkBrewingTankOptionsDlg : public GuiControl {
- public:
- virtual Script OnOkButtonClick(( string this )) {}
- virtual Script ProductCountSliderOnValueChanged(( string this )) {}
- virtual Script ProductCountNumberOnValueChanged(( string this )) {}
- virtual Script init(( string this, string maxProductCount, string bitmap )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CraftOptions2Text : public GuiMLTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CraftOptions2Dlg : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiAwesomiumProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CraftOptionsText : public GuiMLTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CraftOptionsDlg : public GuiControl {
- public:
- };
- class GuiSlideButton : public GuiBitmapButtonCtrl {
- public:
- /*!
- Special type of special button
- */
- string slideType;
- /*! @name Bitmap
- @{ */
- /*! */
- /// @}
- /*! @name Button
- @{ */
- /*! */
- /// @}
- /*! @name Button
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegePositionBtnR : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegePositionBtnZ : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegePositionBtnY : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegePositionBtnX : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegePositionDlgWnd : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegePositionDlg : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DropPositionBtnR : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DropPositionBtnZ : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DropPositionBtnY : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DropPositionBtnX : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DropPositionDlgWnd : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DropPositionDlg : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ObservePositionDlgWnd : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ObservePositionDlg : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BuildPositionBtnR : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BuildPositionBtnZ : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BuildPositionBtnY : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BuildPositionBtnX : public GuiSlideButton {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BuildPositionDlgWnd : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BuildPositionDlg : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectionListDlgBtn2 : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectionListDlgBtn : public GuiButtonCtrl {
- public:
- };
- /*!
- @brief A container that arranges children into a grid.
- This container maintains a 2D grid of GUI controls. If one is added, deleted, or resized, then the grid is updated. The insertion order into the grid is determined by the internal order of the children (ie. the order of addition).<br>Children are added to the grid by row or column until they fill the assocated GuiDynamicCtrlArrayControl extent (width or height). For example, a GuiDynamicCtrlArrayControl with 15 children, and <i>fillRowFirst</i> set to true may be arranged as follows:
- <pre>
- 1 2 3 4 5 6
- 7 8 9 10 11 12
- 13 14 15
- </pre>
- If <i>dynamicSize</i> were set to true in this case, the GuiDynamicCtrlArrayControl height would be calculated to fit the 3 rows of child controls.
- @tsexample
- new GuiDynamicCtrlArrayControl()
- {
- colSize = "128";
- rowSize = "18";
- colSpacing = "2";
- rowSpacing = "2";
- frozen = "0";
- autoCellSize = "1";
- fillRowFirst = "1";
- dynamicSize = "1";
- padding = "0 0 0 0";
- //Properties not specific to this control have been omitted from this example.
- };
- @endtsexample
- */
- class GuiDynamicCtrlArrayControl : public GuiControl {
- public:
- /*! Recalculates the position and size of this control and all its children. */
- virtual void refresh(()) {}
- /*!
- Number of columns the child controls have been arranged into. This value is calculated automatically when children are added, removed or resized; writing it directly has no effect.
- */
- int colCount;
- /*!
- Width of each column. If <i>autoCellSize</i> is set, this will be calculated automatically from the widest child control
- */
- int colSize;
- /*!
- Number of rows the child controls have been arranged into. This value is calculated automatically when children are added, removed or resized; writing it directly has no effect.
- */
- int rowCount;
- /*!
- Height of each row. If <i>autoCellSize</i> is set, this will be calculated automatically from the tallest child control
- */
- int rowSize;
- /*!
- Spacing between rows
- */
- int rowSpacing;
- /*!
- Spacing between columns
- */
- int colSpacing;
- /*!
- When true, the array will not update when new children are added or in response to child resize events. This is useful to prevent unnecessary resizing when adding, removing or resizing a number of child controls.
- */
- bool frozen;
- /*!
- When true, the cell size is set to the widest/tallest child control.
- */
- bool autoCellSize;
- /*!
- Controls whether rows or columns are filled first.
- If true, controls are added to the grid left-to-right (to fill a row); then rows are added top-to-bottom as shown below:
- <pre>1 2 3 4
- 5 6 7 8</pre>
- If false, controls are added to the grid top-to-bottom (to fill a column); then columns are added left-to-right as shown below:
- <pre>1 3 5 7
- 2 4 6 8</pre>
- */
- bool fillRowFirst;
- /*!
- If true, the width or height of this control will be automatically calculated based on the number of child controls (width if <i>fillRowFirst</i> is false, height if <i>fillRowFirst</i> is true).
- */
- bool dynamicSize;
- /*!
- Padding around the top, bottom, left, and right of this control. This reduces the area available for child controls.
- */
- RectSpacingI padding;
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class GuiListItemsControl : public GuiDynamicCtrlArrayControl {
- public:
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectionListArray : public GuiListItemsControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectionListDlgScrl : public GuiScrollCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectionListDlgWnd : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectionListDlg : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_TextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ScrollProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_Border1 : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ButtonH28leftProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ButtonH28RedProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ButtonH28BlueProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ButtonH28YellowProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ButtonH28Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ButtonH238Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SC_ButtonH32Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectCraftProfile : public GuiControlProfile {
- public:
- };
- class prospectingRadiusSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- class prospectingRadiusValueEdit : public GuiTextEditSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class prospectingRadiusLabel : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class prospectingIcon : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class prospectingRadiusWindowCtrl : public GuiWindowCtrl {
- public:
- };
- class ProspectingRadiusDialog : public GuiControl {
- public:
- virtual Script changeValue(( string this, string val )) {}
- virtual Script onClose(( string this )) {}
- virtual Script btnClose(( string this )) {}
- virtual Script btnOK(( string this )) {}
- virtual Script toggle(( string this )) {}
- virtual Script init(( string this, string minRadius, string maxRadius, string caption, string label, string bitmap )) {}
- };
- class SliderCount : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bmpRight : public GuiBitmapCtrl {
- public:
- };
- class sbRight : public GuiTextEditSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- class sbLeft : public GuiTextEditSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bmpLeft : public GuiBitmapCtrl {
- public:
- };
- class SplitStackItem : public GuiControl {
- public:
- virtual Script SliderCountOnValueChanged(( string this )) {}
- virtual Script sbRightOnValueChanged(( string this )) {}
- virtual Script sbLeftOnValueChanged(( string this )) {}
- virtual Script toggle(( string this )) {}
- virtual Script btnOK(( string this )) {}
- virtual Script init(( string this, string root_id1, string container_id1, string item_id1, string quantity1, string max_stack_size1, string root_id2, string container_id2, string item_id2, string quantity2, string max_stack_size2, string bitmap )) {}
- };
- /*!
- @brief A button based around the radio concept.
- GuiRadioCtrl's functionality is based around GuiButtonBaseCtrl's ButtonTypeRadio type.
- A button control with a radio box and a text label.
- This control is used in groups where multiple radio buttons
- present a range of options out of which one can be chosen.
- A radio button automatically signals its siblings when it is
- toggled on.
- @tsexample
- // Create a GuiCheckBoxCtrl that calls randomFunction with its current value when clicked.
- %radio = new GuiRadioCtrl()
- {
- profile = "GuiRadioProfile";
- };
- @endtsexample
- */
- class GuiRadioCtrl : public GuiCheckBoxCtrl {
- public:
- /*! @name CheckBox
- @{ */
- /*! */
- /// @}
- /*! @name Button
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HotBarRadio10x1 : public GuiRadioCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HotBarRadio5x2 : public GuiRadioCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HotBarRadio2x5 : public GuiRadioCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HotBarRadio1x10 : public GuiRadioCtrl {
- public:
- };
- class HotBarSettingsOpacityText : public GuiTextEditCtrl {
- public:
- virtual Script updateText(()) {}
- };
- /*!
- @brief A control that displays a value between its minimal and maximal bounds using a slider placed on a vertical or horizontal axis.
- A slider displays a value and allows that value to be changed by dragging a thumb control along the axis of the slider. In this way, the value is changed between its allowed minimum and maximum.
- To hook up script code to the value changes of a slider, use the #command and #altCommand properties. #command is executed once the thumb is released by the user whereas #altCommand is called any time the slider value changes. When changing the slider value from script, however, trigger of #altCommand is suppressed by default.
- The orientation of a slider is automatically determined from the ratio of its width to its height. If a slider is taller than it is wide, it will be rendered with a vertical orientation. If it is wider than it is tall, it will be rendered with a horizontal orientation.
- The rendering of a slider depends on the bitmap in the slider's profile. This bitmap must be a bitmap array comprised of at least five bitmap rectangles. The rectangles are used such that:
- - Rectangle #1: Left edge of slider
- - Rectangle #2: Center piece of slider; this is stretched between the left and right edge
- - Rectangle #3: Right edge of slider
- - Rectangle #4: Thumb button in normal state
- - Rectangle #5: Thumb button in highlighted (mouse-over) state
- @tsexample
- // Create a sound source and a slider that changes the volume of the source.
- %source = sfxPlayOnce( "art/sound/testing", AudioLoop2D );
- new GuiSlider()
- {
- // Update the sound source volume when the slider is being dragged and released.
- command = %source @ ".setVolume( $ThisControl.value );";
- // Limit the range to 0..1 since that is the allowable range for sound volumes.
- range = "0 1";
- };
- @endtsexample
- @see GuiTextEditSliderCtrl
- @see GuiTextEditSliderBitmapCtrl
- */
- class GuiSliderCtrl : public GuiControl {
- public:
- /*! Called when the left mouse button is dragged across the slider. */
- void onMouseDragged();
- /*! Get the current value of the slider based on the position of the thumb.
- @return Slider position (from range.x to range.y). */
- virtual float getValue(()) {}
- /*! Set position of the thumb on the slider.
- @param pos New slider position (from range.x to range.y)
- @param doCallback If true, the altCommand callback will be invoked
- */
- virtual void setValue(( float pos, bool doCallback=false )) {}
- virtual void setRange(( Point2F range )) {}
- /*! Returns true if the thumb is currently being dragged by the user. This method is mainly useful for scrubbing type sliders where the slider position is sync'd to a changing value. When the user is dragging the thumb, however, the sync'ing should pause and not get in the way of the user. */
- virtual bool isThumbBeingDragged(()) {}
- /*! @name Slider
- @{ */
- /*! */
- /*!
- Min and max values corresponding to left and right slider position.
- */
- Point2F range;
- /*!
- Spacing between tick marks in pixels. 0=off.
- */
- int ticks;
- /*!
- Whether to snap the slider to tick marks.
- */
- bool snap;
- /*!
- The value corresponding to the current slider position.
- */
- float value;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class HotBarSettingsOpacity : public GuiSliderCtrl {
- public:
- virtual Script updateValue(()) {}
- };
- class HotBarSettingsDialog : public GuiControl {
- public:
- virtual Script updateWindowSettings(( string obj, string window )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class RadioButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HotBarTabBookProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HotBarCellTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HotBarCellButtonProfile : public GuiControlProfile {
- public:
- };
- class CmWindowCtrlSettingsOpacityText : public GuiTextEditCtrl {
- public:
- virtual Script updateText(()) {}
- };
- class CmWindowCtrlSettingsOpacity : public GuiSliderCtrl {
- public:
- virtual Script updateValue(()) {}
- };
- class CmWindowCtrlSettingsDialog : public GuiControl {
- public:
- virtual Script onClose(()) {}
- virtual Script SaveXml(()) {}
- virtual Script updateWindowSettings(( string obj, string window )) {}
- };
- class CmBarSettingsShowNumber : public GuiCheckBoxCtrl {
- public:
- virtual Script UpdateCheck(()) {}
- };
- class CmBarSettingsTextSizeText : public GuiTextEditCtrl {
- public:
- virtual Script updateText(()) {}
- };
- class CmBarSettingsTextSize : public GuiSliderCtrl {
- public:
- virtual Script updateValue(()) {}
- };
- class CmBarSettingsOpacityText : public GuiTextEditCtrl {
- public:
- virtual Script updateText(()) {}
- };
- class CmBarSettingsOpacity : public GuiSliderCtrl {
- public:
- virtual Script updateValue(()) {}
- };
- class CmBarSettingsDialog : public GuiControl {
- public:
- virtual Script onClose(()) {}
- virtual Script updateWindowSettings(( string obj, string bar_window )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmChatSettingsShowTimestamps : public GuiCheckBoxCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmChatSettingsOpacityText : public GuiTextEditCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmChatSettingsOpacity : public GuiSliderCtrl {
- public:
- };
- class CmChatSettingsDialog : public GuiControl {
- public:
- virtual Script updateEnableLog(()) {}
- virtual Script updateWindowSettings(()) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBRenameEnterText : public GuiTextEditCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBRenameConfirmText : public GuiMLTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBRenameCancelBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBRenameOKBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBRenameFrame : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MessageBoxRenameDlg : public GuiControl {
- public:
- };
- /*!
- @brief A GUI control which renders a black square over a bitmap image. The black square will fade out, then fade back in after a determined time.
- This control is especially useful for transitions and splash screens.
- @tsexample
- new GuiFadeinBitmapCtrl()
- {
- fadeinTime = "1000";
- waitTime = "2000";
- fadeoutTime = "1000";
- done = "1";
- // Additional GUI properties that are not specific to GuiFadeinBitmapCtrl have been omitted from this example.
- };
- @endtsexample
- @see GuiBitmapCtrl
- @ingroup GuiCore
- */
- class GuiFadeinBitmapCtrl : public GuiBitmapCtrl {
- public:
- /*! @brief Informs the script level that this object received a Click event from the cursor or keyboard.
- @tsexample
- GuiFadeInBitmapCtrl::click(%this)
- {
- // Code to run when click occurs
- }
- @endtsexample
- @see GuiCore
- */
- void click();
- /*! @brief Informs the script level that this object has completed is fade cycle.
- @tsexample
- GuiFadeInBitmapCtrl::onDone(%this)
- {
- // Code to run when the fade cycle completes
- }
- @endtsexample
- @see GuiCore
- */
- void onDone();
- /*! @name Fading
- @{ */
- /*! */
- /*!
- Color to fade in from and fade out to.
- */
- ColorF fadeColor;
- /*!
- Milliseconds for the bitmap to fade in.
- */
- int fadeInTime;
- /*!
- Milliseconds to wait after fading in before fading out the bitmap.
- */
- int waitTime;
- /*!
- Milliseconds for the bitmap to fade out.
- */
- int fadeOutTime;
- /*!
- Easing curve for fade-in.
- */
- EaseF fadeInEase;
- /*!
- Easing curve for fade-out.
- */
- EaseF fadeOutEase;
- /*!
- Whether the fade cycle has finished running.
- */
- bool done;
- /// @}
- /*! @name Bitmap
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BlankGui : public GuiFadeinBitmapCtrl {
- public:
- };
- class StartupGui : public GuiFadeinBitmapCtrl {
- public:
- virtual Script onDone(( string this )) {}
- virtual Script next(( string this )) {}
- virtual Script click(( string this )) {}
- };
- /*!
- @brief Abstract base class for controls that store and display multiple elements in a single view.
- You cannot actually instantiate this class. Instead you can use its childre:
- - GuiConsole
- - GuiTextListCtrl
- - GuiTreeViewCtrl
- - DbgFileView
- - CreatorTree
- This base class is primarily used by other internal classes or those dedicated to editors.
- @ingroup GuiCore
- */
- class GuiArrayCtrl : public GuiControl {
- public:
- /*! Call when a cell in the array is selected (clicked).
- @param @cell Coordinates of the cell */
- void onCellSelected( Point2I cell );
- /*! Call when a cell in the array is highlighted (moused over).
- @param @cell Coordinates of the cell */
- void onCellHighlighted( Point2I cell );
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /*!
- @brief GUI control that displays a list of text. Text items in the list can be individually selected.
- @tsexample
- new GuiTextListCtrl(EndGameGuiList)
- {
- columns = "0 256";
- fitParentWidth = "1";
- clipColumnText = "0";
- //Properties not specific to this control have been omitted from this example.
- };
- @endtsexample
- @see Reference
- @ingroup GuiControls
- */
- class GuiTextListCtrl : public GuiArrayCtrl {
- public:
- /*! @brief Called whenever an item in the list is selected.
- @param cellid The ID of the cell that was selected
- @param text The text in the selected cel
- @tsexample
- // A cel in the control was selected, causing the callback to occur
- GuiTextListCtrl::onSelect(%this,%callid,%text)
- {
- // Code to run when a cel item is selected
- }
- @endtsexample
- @see GuiControl
- */
- void onSelect( string cellid, string text );
- /*! @brief Called when the delete key has been pressed.
- @param id Id of the selected item in the list
- @tsexample
- // The delete key was pressed while the GuiTextListCtrl was in focus, causing the callback to occur.
- GuiTextListCtrl::onDeleteKey(%this,%id)
- {
- // Code to run when the delete key is pressed
- }
- @endtsexample
- @see GuiControl
- */
- void onDeleteKey( string id );
- /*! @brief Get the ID of the currently selected item.
- @tsexample
- // Acquire the ID of the selected item in the list.
- %id = %thisGuiTextListCtrl.getSelectedId();
- @endtsexample
- @return The id of the selected item in the list.
- @see GuiControl */
- virtual int getSelectedId(()) {}
- /*! @brief Finds the specified entry by id, then marks its row as selected.
- @param id Entry within the text list to make selected.
- @tsexample
- // Define the id
- %id = "5";
- // Inform the GuiTextListCtrl control to set the defined id entry as selected
- %thisGuiTextListCtrl.setSelectedById(%id);
- @endtsexample
- @see GuiControl */
- virtual void setSelectedById(( int id )) {}
- /*! @briefSelects the specified row.
- @param rowNum Row number to set selected.
- @tsexample
- // Define the row number to set selected
- %rowNum = "4";
- %guiTextListCtrl.setSelectedRow(%rowNum);
- @endtsexample
- @see GuiControl */
- virtual void setSelectedRow(( int rowNum )) {}
- /*! @brief Returns the selected row index (not the row ID).
- @tsexample
- // Acquire the selected row index
- %rowIndex = %thisGuiTextListCtrl.getSelectedRow();
- @endtsexample
- @return Index of the selected row
- @see GuiControl */
- virtual int getSelectedRow(()) {}
- /*! @brief Set the selection to nothing.
- @tsexample
- // Deselect anything that is currently selected
- %thisGuiTextListCtrl.clearSelection();
- @endtsexample
- @see GuiControl */
- virtual void clearSelection(()) {}
- /*! @brief Adds a new row at end of the list with the defined id and text.
- If index is used, then the new row is inserted at the row location of 'index'.
- @param id Id of the new row.
- @param text Text to display at the new row.
- @param index Index to insert the new row at. If not used, new row will be placed at the end of the list.
- @tsexample
- // Define the id
- %id = "4";
- // Define the text to display
- %text = "Display Text"
- // Define the index (optional)
- %index = "2"
- // Inform the GuiTextListCtrl control to add the new row with the defined information.
- %rowIndex = %thisGuiTextListCtrl.addRow(%id,%text,%index);
- @endtsexample
- @return Returns the row index of the new row. If 'index' was defined, then this just returns the number of rows in the list.
- @see References */
- virtual int addRow(( int id=0, string text="", int index=-1 )) {}
- /*! @brief Sets the text at the defined id.
- @param id Id to change.
- @param text Text to use at the Id.
- @tsexample
- // Define the id
- %id = "4";
- // Define the text
- %text = "Text To Display";
- // Inform the GuiTextListCtrl control to display the defined text at the defined id
- %thisGuiTextListCtrl.setRowById(%id,%text);
- @endtsexample
- @see GuiControl */
- virtual void setRowById(( int id, string text )) {}
- /*! @brief Performs a standard (alphabetical) sort on the values in the specified column.
- @param columnId Column ID to perform the sort on.
- @param increasing If false, sort will be performed in reverse.
- @tsexample
- // Define the columnId
- %id = "1";
- // Define if we are increasing or not
- %increasing = "false";
- // Inform the GuiTextListCtrl to perform the sort operation
- %thisGuiTextListCtrl.sort(%id,%increasing);
- @endtsexample
- @see GuiControl */
- virtual void sort(( int columnId, bool increasing=true )) {}
- /*! @brief Perform a numerical sort on the values in the specified column.
- Detailed description
- @param columnId Column ID to perform the sort on.
- @param increasing If false, sort will be performed in reverse.
- @tsexample
- // Define the columnId
- %id = "1";
- // Define if we are increasing or not
- %increasing = "false";
- // Inform the GuiTextListCtrl to perform the sort operation
- %thisGuiTextListCtrl.sortNumerical(%id,%increasing);
- @endtsexample
- @see GuiControl */
- virtual void sortNumerical(( int columnID, bool increasing=true )) {}
- /*! @brief Clear the list.
- @tsexample
- // Inform the GuiTextListCtrl control to clear its contents
- %thisGuiTextListCtrl.clear();
- @endtsexample
- @see GuiControl */
- virtual void clear(()) {}
- /*! @brief Get the number of rows.
- @tsexample
- // Get the number of rows in the list
- %rowCount = %thisGuiTextListCtrl.rowCount();
- @endtsexample
- @return Number of rows in the list.
- @see GuiControl */
- virtual int rowCount(()) {}
- /*! @brief Get the row ID for an index.
- @param index Index to get the RowID at
- @tsexample
- // Define the index
- %index = "3";
- // Request the row ID at the defined index
- %rowId = %thisGuiTextListCtrl.getRowId(%index);
- @endtsexample
- @return RowId at the defined index.
- @see GuiControl */
- virtual int getRowId(( int index )) {}
- /*! @brief Get the text of a row with the specified id.
- @tsexample
- // Define the id
- %id = "4";
- // Inform the GuiTextListCtrl control to return the text at the defined row id
- %rowText = %thisGuiTextListCtrl.getRowTextById(%id);
- @endtsexample
- @return Row text at the requested row id.
- @see GuiControl */
- virtual string getRowTextById(( int id )) {}
- /*! @brief Get the row number for a specified id.
- @param id Id to get the row number at
- @tsexample
- // Define the id
- %id = "4";
- // Request the row number from the GuiTextListCtrl control at the defined id.
- %rowNumber = %thisGuiTextListCtrl.getRowNumById(%id);
- @endtsexample
- @see GuiControl */
- virtual int getRowNumById(( int id )) {}
- /*! @brief Get the text of the row with the specified index.
- @param index Row index to acquire the text at.
- @tsexample
- // Define the row index
- %index = "5";
- // Request the text from the row at the defined index
- %rowText = %thisGuiTextListCtrl.getRowText(%index);
- @endtsexample
- @return Text at the defined row index.
- @see GuiControl */
- virtual string getRowText(( int index )) {}
- /*! @brief Remove row with the specified id.
- @param id Id to remove the row entry at
- @tsexample
- // Define the id
- %id = "4";
- // Inform the GuiTextListCtrl control to remove the row at the defined id
- %thisGuiTextListCtrl.removeRowById(%id);
- @endtsexample
- @see GuiControl */
- virtual void removeRowById(( int id )) {}
- /*! @brief Remove a row from the table, based on its index.
- @param index Row index to remove from the list.
- @tsexample
- // Define the row index
- %index = "4";
- // Inform the GuiTextListCtrl control to remove the row at the defined row index
- %thisGuiTextListCtrl.removeRow(%index);
- @endtsexample
- @see GuiControl */
- virtual void removeRow(( int index )) {}
- /*! @brief Scroll so the specified row is visible
- @param rowNum Row number to make visible
- @tsexample
- // Define the row number to make visible
- %rowNum = "4";
- // Inform the GuiTextListCtrl control to scroll the list so the defined rowNum is visible.
- %thisGuiTextListCtrl.scrollVisible(%rowNum);
- @endtsexample
- @see GuiControl */
- virtual void scrollVisible(( int rowNum )) {}
- /*! @brief Find needle in the list, and return the row number it was found in.
- @param needle Text to find in the list.
- @tsexample
- // Define the text to find in the list
- %needle = "Text To Find";
- // Request the row number that contains the defined text to find
- %rowNumber = %thisGuiTextListCtrl.findTextIndex(%needle);
- @endtsexample
- @return Row number that the defined text was found in,
- @see GuiControl */
- virtual int findTextIndex(( string needle )) {}
- /*! @brief Mark a specified row as active/not.
- @param rowNum Row number to change the active state.
- @param active Boolean active state to set the row number.
- @tsexample
- // Define the row number
- %rowNum = "4";
- // Define the boolean active state
- %active = "true";
- // Informthe GuiTextListCtrl control to set the defined active state at the defined row number.
- %thisGuiTextListCtrl.setRowActive(%rowNum,%active);
- @endtsexample
- @see GuiControl */
- virtual void setRowActive(( int rowNum, bool active )) {}
- /*! @brief Check if the specified row is currently active or not.
- @param rowNum Row number to check the active state.
- @tsexample
- // Define the row number
- %rowNum = "5";
- // Request the active state of the defined row number from the GuiTextListCtrl control.
- %rowActiveState = %thisGuiTextListCtrl.isRowActive(%rowNum);
- @endtsexample
- @return Active state of the defined row number.
- @see GuiControl */
- virtual bool isRowActive(( int rowNum )) {}
- /*!
- A vector of column offsets. The number of values determines the number of columns in the table.
- */
- intList columns;
- /*!
- If true, the width of this control will match the width of its parent.
- */
- bool fitParentWidth;
- /*!
- If true, text exceeding a column's given width will get clipped.
- */
- bool clipColumnText;
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class EndGameGuiList : public GuiTextListCtrl {
- public:
- };
- /*!
- @brief This is a control that will render a specified bitmap or a bitmap specified in a referenced variable.
- This control allows you to either set a bitmap with the "bitmap" field or with the setBitmap method. You can also choose to reference a variable in the "variable" field such as "$image" and then set "useVariable" to true. This will cause it to synchronize the variable with the bitmap displayed (if the variable holds a valid image). You can then change the variable and effectively changed the displayed image.
- @tsexample
- $image = "anotherbackground.png";
- new GuiChunkedBitmapCtrl(ChunkedBitmap)
- {
- bitmap = "background.png";
- variable = "$image";
- useVariable = false;
- }
- // This will result in the control rendering "background.png"
- // If we now set the useVariable to true it will now render "anotherbackground.png"
- ChunkedBitmap.useVariable = true;
- @endtsexample
- @see GuiControl::variable
- @ingroup GuiImages
- */
- class GuiChunkedBitmapCtrl : public GuiControl {
- public:
- /*! @brief Set the image rendered in this control.
- @param filename The image name you want to set
- @tsexample
- ChunkedBitmap.setBitmap("images/background.png");@endtsexample
- */
- virtual void setBitmap(( string filename )) {}
- /*! @name GuiChunkedBitmapCtrl
- @{ */
- /*! */
- /*!
- This is the bitmap to render to the control.
- */
- filename bitmap;
- /*!
- This decides whether to use the "bitmap" file or a bitmap stored in "variable"
- */
- bool useVariable;
- /*!
- This is no longer in use
- */
- bool tile;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class EndGameGui : public GuiChunkedBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_status : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_statusText : public GuiTextCtrl {
- public:
- };
- /*!
- @brief GUI Control which displays a horizontal bar which increases as the progress value of 0.0 - 1.0 increases.
- @tsexample
- new GuiProgressCtrl(JS_statusBar)
- {
- //Properties not specific to this control have been omitted from this example.
- };
- // Define the value to set the progress bar%value = "0.5f"
- // Set the value of the progress bar, from 0.0 - 1.0
- %thisGuiProgressCtrl.setValue(%value);
- // Get the value of the progress bar.
- %progress = %thisGuiProgressCtrl.getValue();
- @endtsexample
- @see GuiTextCtrl
- @see GuiControl
- @ingroup GuiValues
- */
- class GuiProgressCtrl : public GuiTextCtrl {
- public:
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_statusBar : public GuiProgressCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_cancelQuery : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_queryStatus : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_serverList : public GuiTextListCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_joinServer : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_refreshServer : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_queryLan : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JS_queryMaster : public GuiButtonCtrl {
- public:
- };
- class JoinServerDlg : public GuiControl {
- public:
- virtual Script update(( string this )) {}
- virtual Script Exit(( string this )) {}
- virtual Script refreshSelectedServer(( string this )) {}
- virtual Script refresh(( string this )) {}
- virtual Script join(( string this )) {}
- virtual Script cancel(( string this )) {}
- virtual Script queryLan(( string this )) {}
- virtual Script query(( string this )) {}
- virtual Script onWake(()) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDCPasswordText : public GuiTextEditCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDCPasswordDescrText : public GuiMLTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDCServerAddressText : public GuiTextEditCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBServerDescrText : public GuiMLTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDCCancelButton : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDCOKButton : public GuiButtonCtrl {
- public:
- };
- class MessageBoxDirectConnectDlg : public GuiControl {
- public:
- virtual Script showCharacters(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBPasswordEnterText : public GuiTextEditCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBPasswordCancelButton : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBPasswordOKButton : public GuiButtonCtrl {
- public:
- };
- class MessageBoxPasswordDlg : public GuiControl {
- public:
- virtual Script showCharacters(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDelcharEnterText : public GuiTextEditCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDelcharConfirmText : public GuiMLTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDelcharCancelBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDelcharOKBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MBDelcharFrame : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MessageBoxDelcharDlg : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ExitBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CreatePlayerBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectCharacterScroll : public GuiScrollCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharslotsPanel : public GuiControl {
- public:
- };
- class selectCharacterDlg : public GuiChunkedBitmapCtrl {
- public:
- virtual Script onCreatePlayerButClick(()) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SelectScrollProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Checkbox32Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ButtonPictureProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ButtonH60Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ButtonH32LeftProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ButtonH32Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharselectPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharSelectProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterDescriptionText : public GuiMLTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterDescriptionFrame : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingMaxText : public GuiTextCtrl {
- public:
- };
- class ThrowingSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TwohandedMaxText : public GuiTextCtrl {
- public:
- };
- class TwohandedSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TwohandedMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TwohandedText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BladesmasteryMaxText : public GuiTextCtrl {
- public:
- };
- class BladesmasterySlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BladesmasteryMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BladesmasteryText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MilitiaserviceMaxText : public GuiTextCtrl {
- public:
- };
- class MilitiaserviceSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MilitiaserviceMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MilitiaserviceText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WarhorsehandlingMaxText : public GuiTextCtrl {
- public:
- };
- class WarhorsehandlingSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WarhorsehandlingMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WarhorsehandlingText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FarmingMaxText : public GuiTextCtrl {
- public:
- };
- class FarmingSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FarmingMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FarmingText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TerraformingMaxText : public GuiTextCtrl {
- public:
- };
- class TerraformingSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TerraformingMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TerraformingText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NatureloreMaxText : public GuiTextCtrl {
- public:
- };
- class NatureloreSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NatureloreMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NatureloreText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ForestryMaxText : public GuiTextCtrl {
- public:
- };
- class ForestrySlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ForestryMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ForestryText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ProspectingMaxText : public GuiTextCtrl {
- public:
- };
- class ProspectingSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ProspectingMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ProspectingText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class IntelligenceMaxText : public GuiTextCtrl {
- public:
- };
- class IntelligenceGuiSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class IntelligenceMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class IntelligenceGuiTextCtrl : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WillpowerMaxText : public GuiTextCtrl {
- public:
- };
- class WillpowerGuiSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WillpowerMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WillpowerGuiTextCtrl : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ConstitutionMaxText : public GuiTextCtrl {
- public:
- };
- class ConstitutionGuiSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ConstitutionMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ConstitutionGuiTextCtrl : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AgilityMaxText : public GuiTextCtrl {
- public:
- };
- class AgilityGuiSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AgilityMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AgilityGuiTextCtrl : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StrenghtMaxText : public GuiTextCtrl {
- public:
- };
- class StrenghtGuiSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StrenghtMinText : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StrenghtGuiTextCtrl : public GuiTextCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterRandomBut : public GuiButtonCtrl {
- public:
- };
- class GuiColorViewControl : public GuiControl {
- public:
- virtual void setColor(( ColorI c )) {}
- /*!
- Color
- */
- ColorI color;
- /*!
- Bitmap
- */
- filename bitmap;
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SkinToneColorViewControl : public GuiColorViewControl {
- public:
- };
- class SkinToneGuiSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterSkinToneText : public GuiTextCtrl {
- public:
- };
- class BodyFeaturesSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HairToneColorViewControl : public GuiColorViewControl {
- public:
- };
- class HairColorSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterHairColorText : public GuiTextCtrl {
- public:
- };
- /*!
- @brief A control that allows to select a value from a drop-down list.
- This is essentially a GuiPopUpMenuCtrl, but with quite a few more features.
- @tsexample
- new GuiPopUpMenuCtrlEx()
- {
- maxPopupHeight = "200";
- sbUsesNAColor = "0";
- reverseTextList = "0";
- bitmapBounds = "16 16";
- hotTrackCallback = "0";
- extent = "64 64";
- profile = "GuiDefaultProfile";
- tooltipProfile = "GuiToolTipProfile";
- };
- @endtsexample
- @see GuiPopUpMenuCtrl
- @ingroup GuiControls
- */
- class GuiPopUpMenuCtrlEx : public GuiTextCtrl {
- public:
- virtual void add((string name, int idNum, int scheme=0)) {}
- /*! @brief Add a category to the list.
- Acts as a separator between entries, allowing for sub-lists
- @param text Name of the new category
- */
- virtual void addCategory(( string text )) {}
- /*! @brief Create a new scheme and add it to the list of choices for when a new text entry is added.
- @param id Numerical id associated with this scheme
- @param fontColor The base text font color. Formatted as "Red Green Blue", each a numerical between 0 and 255.
- @param fontColorHL Color of text when being highlighted. Formatted as "Red Green Blue", each a numerical between 0 and 255.
- @param fontColorSel Color of text when being selected. Formatted as "Red Green Blue", each a numerical between 0 and 255.
- */
- virtual void addScheme(( int id, ColorI fontColor, ColorI fontColorHL, ColorI fontColorSEL )) {}
- /*! @brief Set the current text to a specified value.
- @param text String containing new text to set
- */
- virtual void setText(( string text )) {}
- /*! @brief Get the.
- Detailed description
- @param param Description
- @tsexample
- // Comment
- code();
- @endtsexample
- @return Returns current text in string format */
- virtual string getText(()) {}
- /*! @brief Clear the popup list.
- */
- virtual void clear(()) {}
- /*! @brief Sort the list alphabetically.
- */
- virtual void sort(( bool flgReId=true )) {}
- /*! @brief Sort the list by ID.
- */
- virtual void sortID(()) {}
- /*! @brief Manually for the onAction function, which updates everything in this control.
- */
- virtual void forceOnAction(()) {}
- /*! @brief Manually force this control to collapse and close.
- */
- virtual void forceClose(()) {}
- /*! @brief Get the current selection of the menu.
- @return Returns the ID of the currently selected entry */
- virtual int getSelected(()) {}
- /*! @hide */
- virtual void setSelected((int id, [scriptCallback=true])) {}
- /*! @hide */
- virtual void setFirstSelected(([scriptCallback=true])) {}
- /*! @brief Clears selection in the menu.
- */
- virtual void setNoneSelected(( int param )) {}
- /*! @brief Get the text of an entry based on an ID.
- @param id The ID assigned to the entry being queried
- @return String contained by the specified entry, NULL if empty or bad ID */
- virtual string getTextById(( int id )) {}
- /*! @brief Get color of an entry's box
- @param id ID number of entry to query
- @return ColorI in the format of "Red Green Blue Alpha", each of with is a value between 0 - 255 */
- virtual string getColorById() {}
- /*! @brief This fills the popup with a classrep's field enumeration type info.
- More of a helper function than anything. If console access to the field list is added, at least for the enumerated types, then this should go away.
- @param class Name of the class containing the enum
- @param enum Name of the enum value to acces
- */
- virtual void setEnumContent() {}
- /*! Returns the id of the first entry containing the specified text or -1 if not found.@param text String value used for the query
- @return Numerical ID of entry containing the text. */
- virtual int findText((string text)) {}
- /*! @brief Get the size of the menu
- @return Number of entries in the menu
- */
- virtual int size() {}
- /*! @brief Flag that causes each new text addition to replace the current entry
- @param True to turn on replacing, false to disable it */
- virtual void replaceText() {}
- virtual void clearEntry((S32 entry)) {}
- /*!
- Length of menu when it extends
- */
- int maxPopupHeight;
- /*!
- Deprecated@internal
- */
- bool sbUsesNAColor;
- /*!
- Reverses text list if popup extends up, instead of down
- */
- bool reverseTextList;
- /*!
- File name of bitmap to use
- */
- filename bitmap;
- /*!
- Boundaries of bitmap displayed
- */
- Point2I bitmapBounds;
- /*!
- Whether to provide a 'onHotTrackItem' callback when a list item is hovered over
- */
- bool hotTrackCallback;
- /*!
- Added pixel popup width
- */
- int addedPopupWidth;
- /*!
- Added pixel cell width
- */
- int addedCellWidth;
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class GuiInventoryDropDown : public GuiPopUpMenuCtrlEx {
- public:
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class createCharacterFacialHairPopUpMenu : public GuiInventoryDropDown {
- public:
- virtual Script onSelect(( string this, string id, string text )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterFacialHairText : public GuiTextCtrl {
- public:
- };
- class createCharacterHaircutPopUpMenu : public GuiInventoryDropDown {
- public:
- virtual Script onSelect(( string this, string id, string text )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterHaircutText : public GuiTextCtrl {
- public:
- };
- class FacialFeaturesSliderCtrl : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterFacialFeaturesText : public GuiTextCtrl {
- public:
- };
- class createCharacterHeadSlider : public CmGuiArrowSliderCtrl {
- public:
- virtual Script onValueChanged(( string this )) {}
- };
- class createCharacterMonBut : public GuiButtonCtrl {
- public:
- virtual Script onStateChanged(( string this, string state )) {}
- };
- class createCharacterVikBut : public GuiButtonCtrl {
- public:
- virtual Script onStateChanged(( string this, string state )) {}
- };
- class createCharacterEurBut : public GuiButtonCtrl {
- public:
- virtual Script onStateChanged(( string this, string state )) {}
- };
- class createCharacterVoicePopUpMenu : public GuiInventoryDropDown {
- public:
- virtual Script onSelect(( string this, string id, string text )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterVoiceText : public GuiTextCtrl {
- public:
- };
- class createCharacterFemaleBut : public GuiButtonCtrl {
- public:
- virtual Script onStateChanged(( string this, string state )) {}
- };
- class createCharacterMaleBut : public GuiButtonCtrl {
- public:
- virtual Script onStateChanged(( string this, string state )) {}
- };
- class createCharacterEnteredFamily : public GuiTextEditCtrl {
- public:
- virtual Script onTabComplete(( string this, string val )) {}
- };
- class createCharacterEnteredName : public GuiTextEditCtrl {
- public:
- virtual Script onTabComplete(( string this, string val )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterMinusBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterPlusBut : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CC_PlusMinus : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CC_DoneCancel : public GuiControl {
- public:
- };
- /*!
- @brief Abstract base class for controls that render 3D scenes.
- GuiTSCtrl is the base class for controls that render 3D camera views in Torque. The class itself does not implement a concrete scene rendering. Use GuiObjectView to display invidiual shapes in the Gui and GameTSCtrl to render full scenes.
- @see GameTSCtrl
- @see GuiObjectView
- @ingroup Gui3D
- */
- class GuiTSCtrl : public GuiContainer {
- public:
- /*! Transform 3D screen-space coordinates (x, y, depth) to world space.
- This method can be, for example, used to find the world-space position relating to the current mouse cursor position.
- @param screenPosition The x/y position on the screen plus the depth from the screen-plane outwards.
- @return The world-space position corresponding to the given screen-space coordinates. */
- virtual string unproject(( Point3F screenPosition )) {}
- /*! Transform world-space coordinates to screen-space (x, y, depth) coordinates.
- @param worldPosition The world-space position to transform to screen-space.
- @return The */
- virtual string project(( Point3F worldPosition )) {}
- /*! Get the ratio between world-space units and pixels.
- @return The amount of world-space units covered by the extent of a single pixel. */
- virtual string getWorldToScreenScale(()) {}
- /*! Given the camera's current FOV, get the distance from the camera's viewpoint at which the given radius will fit in the render area.
- @param radius Radius in world-space units which should fit in the view.
- @return The distance from the viewpoint at which the given radius would be fully visible. */
- virtual float calculateViewDistance(( float radius )) {}
- /*! @name Camera
- @{ */
- /*! */
- /*!
- Z rotation angle of camera.
- */
- float cameraZRot;
- /*!
- The vertical field of view in degrees or zero to use the normal camera FOV.
- */
- float forceFOV;
- /// @}
- /*! @name Rendering
- @{ */
- /*! */
- /*!
- The share of the per-frame reflection update work this control's rendering should run.
- The reflect update priorities of all visible GuiTSCtrls are added together and each control is assigned a share of the per-frame reflection update time according to its percentage of the total priority value.
- */
- float reflectPriority;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /*!
- @brief GUI control which displays a 3D model.
- Model displayed in the control can have other objects mounted onto it, and the light settings can be adjusted.
- @tsexample
- new GuiCharacterView(ObjectPreview)
- {
- shapeFile = "art/shapes/items/kit/healthkit.dts";
- mountedNode = "mount0";
- lightColor = "1 1 1 1";
- lightAmbient = "0.5 0.5 0.5 1";
- lightDirection = "0 0.707 -0.707";
- orbitDiststance = "2";
- minOrbitDiststance = "0.917688";
- maxOrbitDiststance = "5";
- cameraSpeed = "0.01";
- cameraZRot = "0";
- forceFOV = "0";
- reflectPriority = "0";
- };
- @endtsexample
- @see GuiControl
- @ingroup Gui3D
- */
- class GuiCharacterView : public GuiTSCtrl {
- public:
- /*! @brief Called whenever the mouse enters the control.
- @tsexample
- // The mouse has entered the control, causing the callback to occur
- GuiCharacterView::onMouseEnter(%this)
- {
- // Code to run when the mouse enters this control
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseEnter();
- /*! @brief Called whenever the mouse leaves the control.
- @tsexample
- // The mouse has left the control, causing the callback to occur
- GuiCharacterView::onMouseLeave(%this)
- {
- // Code to run when the mouse leaves this control
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseLeave();
- /*! @brief Return the model displayed in this view.
- @tsexample
- // Request the displayed model name from the GuiCharacterView object.
- %modelName = %thisGuiCharacterView.getModel();
- @endtsexample
- @return Name of the displayed model.
- @see GuiControl */
- virtual string getModel(()) {}
- /*! @brief Sets the model to be displayed in this control.
- @param shapeName Name of the model to display.
- @tsexample
- // Define the model we want to display
- %shapeName = "gideon.dts";
- // Tell the GuiCharacterView object to display the defined model
- %thisGuiCharacterView.setModel(%shapeName);
- @endtsexample
- @see GuiControl */
- virtual void setModel(( string shapeName )) {}
- /*! @brief Return the name of the mounted model.
- @tsexample
- // Request the name of the mounted model from the GuiCharacterView object
- %mountedModelName = %thisGuiCharacterView.getMountedModel();
- @endtsexample
- @return Name of the mounted model.
- @see GuiControl */
- virtual string getMountedModel(()) {}
- /*! @brief Sets the model to be mounted on the primary model.
- @param shapeName Name of the model to mount.
- @tsexample
- // Define the model name to mount
- %modelToMount = "GideonGlasses.dts";
- // Inform the GuiCharacterView object to mount the defined model to the existing model in the control
- %thisGuiCharacterView.setMountedModel(%modelToMount);
- @endtsexample
- @see GuiControl */
- virtual void setMountedModel(( string shapeName )) {}
- /*! @brief Return the name of skin used on the primary model.
- @tsexample
- // Request the name of the skin used on the primary model in the control
- %skinName = %thisGuiCharacterView.getSkin();
- @endtsexample
- @return Name of the skin used on the primary model.
- @see GuiControl */
- virtual string getSkin(()) {}
- /*! @brief Sets the skin to use on the model being displayed.
- @param skinName Name of the skin to use.
- @tsexample
- // Define the skin we want to apply to the main model in the control
- %skinName = "disco_gideon";
- // Inform the GuiCharacterView control to update the skin the to defined skin
- %thisGuiCharacterView.setSkin(%skinName);
- @endtsexample
- @see GuiControl */
- virtual void setSkin(( string skinName )) {}
- /*! @brief Return the name of skin used on the mounted model.
- @tsexample
- // Request the skin name from the model mounted on to the main model in the control
- %mountModelSkin = %thisGuiCharacterView.getMountSkin();
- @endtsexample
- @return Name of the skin used on the mounted model.
- @see GuiControl */
- virtual string getMountSkin(( int param1, int param2 )) {}
- /*! @brief Sets the skin to use on the mounted model.
- @param skinName Name of the skin to set on the model mounted to the main model in the control
- @tsexample
- // Define the name of the skin
- %skinName = "BronzeGlasses";
- // Inform the GuiCharacterView Control of the skin to use on the mounted model
- %thisGuiCharacterViewCtrl.setMountSkin(%skinName);
- @endtsexample
- @see GuiControl */
- virtual void setMountSkin(( string skinName )) {}
- /*! @brief Sets the animation to play for the viewed object.
- @param indexOrName The index or name of the animation to play.
- @tsexample
- // Set the animation index value, or animation sequence name.
- %indexVal = "3";
- //OR:
- %indexVal = "idle";
- // Inform the GuiCharacterView object to set the animation sequence of the object in the control.
- %thisGuiObjectVew.setSeq(%indexVal);
- @endtsexample
- @see GuiControl */
- virtual void setSeq(( string indexOrName )) {}
- /*! @brief Mounts the given model to the specified mount point of the primary model displayed in this control.
- Detailed description
- @param shapeName Name of the model to mount.
- @param mountNodeIndexOrName Index or name of the mount point to be mounted to. If index, corresponds to "mountN" in your shape where N is the number passed here.
- @tsexample
- // Set the shapeName to mount
- %shapeName = "GideonGlasses.dts"
- // Set the mount node of the primary model in the control to mount the new shape at
- %mountNodeIndexOrName = "3";
- //OR:
- %mountNodeIndexOrName = "Face";
- // Inform the GuiCharacterView object to mount the shape at the specified node.
- %thisGuiCharacterView.setMount(%shapeName,%mountNodeIndexOrName);
- @endtsexample
- @see GuiControl */
- virtual void setMount(( string shapeName, string mountNodeIndexOrName, string mountObjNodeIndexOrName="mountPoint" )) {}
- /*! @brief Return the current distance at which the camera orbits the object.
- @tsexample
- // Request the current orbit distance
- %orbitDistance = %thisGuiCharacterView.getOrbitDistance();
- @endtsexample
- @return The distance at which the camera orbits the object.
- @see GuiControl */
- virtual float getOrbitDistance(()) {}
- /*! @brief Sets the distance at which the camera orbits the object. Clamped to the acceptable range defined in the class by min and max orbit distances.
- Detailed description
- @param distance The distance to set the orbit to (will be clamped).
- @tsexample
- // Define the orbit distance value
- %orbitDistance = "1.5";
- // Inform the GuiCharacterView object to set the orbit distance to the defined value
- %thisGuiCharacterView.setOrbitDistance(%orbitDistance);
- @endtsexample
- @see GuiControl */
- virtual void setOrbitDistance(( float distance )) {}
- virtual void setOrbitZPos(( float pos )) {}
- /*! @brief Return the current multiplier for camera zooming and rotation.
- @tsexample
- // Request the current camera zooming and rotation multiplier value
- %multiplier = %thisGuiCharacterView.getCameraSpeed();
- @endtsexample
- @return Camera zooming / rotation multiplier value.
- @see GuiControl */
- virtual float getCameraSpeed(()) {}
- /*! @brief Sets the multiplier for the camera rotation and zoom speed.
- @param factor Multiplier for camera rotation and zoom speed.
- @tsexample
- // Set the factor value
- %factor = "0.75";
- // Inform the GuiCharacterView object to set the camera speed.
- %thisGuiCharacterView.setCameraSpeed(%factor);
- @endtsexample
- @see GuiControl */
- virtual void setCameraSpeed(( float factor )) {}
- /*! @brief Set the light color on the sun object used to render the model.
- @param color Color of sunlight.
- @tsexample
- // Set the color value for the sun
- %color = "1.0 0.4 0.5";
- // Inform the GuiCharacterView object to change the sun color to the defined value
- %thisGuiCharacterView.setLightColor(%color);
- @endtsexample
- @see GuiControl */
- virtual void setLightColor(( ColorF color )) {}
- /*! @brief Set the light ambient color on the sun object used to render the model.
- @param color Ambient color of sunlight.
- @tsexample
- // Define the sun ambient color value
- %color = "1.0 0.4 0.6";
- // Inform the GuiCharacterView object to set the sun ambient color to the requested value
- %thisGuiCharacterView.setLightAmbient(%color);
- @endtsexample
- @see GuiControl */
- virtual void setLightAmbient(( ColorF color )) {}
- /*! @brief Set the light direction from which to light the model.
- @param direction XYZ direction from which the light will shine on the model
- @tsexample
- // Set the light direction
- %direction = "1.0 0.2 0.4"
- // Inform the GuiCharacterView object to change the light direction to the defined value
- %thisGuiCharacterView.setLightDirection(%direction);
- @endtsexample
- @see GuiControl */
- virtual void setLightDirection(( Point3F direction )) {}
- /*! @name Model
- @{ */
- /*! */
- /*!
- The object model shape file to show in the view.
- */
- filename shapeFile;
- /*!
- The skin to use on the object model.
- */
- string skin;
- /*!
- Initial model rotation.
- */
- Point3F modelRotation;
- /// @}
- /*! @name Animation
- @{ */
- /*! */
- /*!
- The animation sequence to play on the model.
- */
- string animSequence;
- /// @}
- /*! @name Mounting
- @{ */
- /*! */
- /*!
- Optional shape file to mount on the primary model (e.g. weapon).
- */
- filename mountedShapeFile;
- /*!
- Skin name used on mounted shape file.
- */
- string mountedSkin;
- /*!
- Name of node on primary model to which to mount the secondary shape.
- */
- string mountedNode;
- /*!
- */
- string mountObjectMountNode;
- /// @}
- /*!
- */
- LightType lightType;
- /*!
- Diffuse color of the sunlight used to render the model.
- */
- ColorF lightColor;
- /*!
- Ambient color of the sunlight used to render the model.
- */
- ColorF lightAmbient;
- /*!
- Direction from which the model is illuminated.
- */
- Point3F lightDirection;
- /*! @name Camera
- @{ */
- /*! */
- /*!
- Distance from which to render the model.
- */
- float orbitDiststance;
- /*!
- Maxiumum distance to which the camera can be zoomed out.
- */
- float minOrbitDiststance;
- /*!
- Minimum distance below which the camera will not zoom in further.
- */
- float maxOrbitDiststance;
- /*!
- Multiplier for mouse camera operations.
- */
- float cameraSpeed;
- /// @}
- /*! @name Camera
- @{ */
- /*! */
- /// @}
- /*! @name Rendering
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class createCharacterModel : public GuiCharacterView {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CC_ModelPanel : public GuiControl {
- public:
- };
- class createCharacterWindow : public GuiChunkedBitmapCtrl {
- public:
- virtual Script OnRandomAppearance(( string this, string state )) {}
- virtual Script OnMinusBtn(()) {}
- virtual Script OnPlusBtn(()) {}
- virtual Script OnNextBtn(()) {}
- virtual Script OnCancelBtn(()) {}
- virtual Script InitSkinColors(()) {}
- virtual Script InitHairColors(()) {}
- virtual Script InitBeards(()) {}
- virtual Script InitHaircuts(()) {}
- virtual Script InitVoices(()) {}
- virtual Script onWake(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BorderPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharPopUpMenuDefault : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharPopUpMenuEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmGuiCharTextEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiCharDescProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharPanelColorProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharAttributValTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharAttributTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharTextProfileDisabled : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharComboStackProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmComboStackSettingButtonDef : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharSettingPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmComboStackAttributButtonDef : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmComboStackButtonDef : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharAttributPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CharPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiJoinWorldWindowProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ScrollCharPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsVideoScroll : public GuiScrollCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsVideoDlgBg : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class VideoOKProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class VideoCancelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class VideoApplyProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class VideoTextEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiCheckBoxVideoProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class VideoPopUpMenuEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class VideoPopUpMenuDefault : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmGuiVideoSliderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiTextVideoDlgSmallProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiTextVideoCommentProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiTextVideoDlgProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiTextVideoProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsAudioDlgBg : public GuiBitmapCtrl {
- public:
- };
- class OptionsControlsHotBarTextCtrl {
- public:
- virtual Script onDoubleClick(( string this )) {}
- };
- class OptionsControlsHUDTextCtrl {
- public:
- virtual Script onDoubleClick(( string this )) {}
- };
- /*!
- @brief Used to overlaps a 'hot region' where you want to catch inputs with and have specific events occur based on individual callbacks.
- Mouse event callbacks supported by this control are: onMouseUp, onMouseDown, onMouseMove, onMouseDragged, onMouseEnter, onMouseLeave,
- onRightMouseDown, onRightMouseUp and onRightMouseDragged.
- @tsexample
- new GuiMouseEventCtrl()
- {
- lockMouse = "0";
- //Properties not specific to this control have been omitted from this example.
- };
- @endtsexample
- @see GuiControl
- @ingroup GuiCore
- */
- class GuiMouseEventCtrl : public GuiControl {
- public:
- /*! @brief Callback that occurs whenever the mouse is pressed down while in this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Mouse was pressed down in this control, causing the callback
- GuiMouseEventCtrl::onMouseDown(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseDown( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the mouse is released while in this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Mouse was released in this control, causing the callback
- GuiMouseEventCtrl::onMouseUp(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseUp( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the mouse is moved (without dragging) while in this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Mouse was moved in this control, causing the callback
- GuiMouseEventCtrl::onMouseMove(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseMove( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the mouse is dragged while in this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Mouse was dragged in this control, causing the callback
- GuiMouseEventCtrl::onMouseDragged(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseDragged( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the mouse enters this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Mouse entered this control, causing the callback
- GuiMouseEventCtrl::onMouseEnter(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseEnter( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the mouse leaves this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Mouse left this control, causing the callback
- GuiMouseEventCtrl::onMouseLeave(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onMouseLeave( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the right mouse button is pressed while in this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Right mouse button was pressed in this control, causing the callback
- GuiMouseEventCtrl::onRightMouseDown(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onRightMouseDown( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the right mouse button is released while in this control.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Right mouse button was released in this control, causing the callback
- GuiMouseEventCtrl::onRightMouseUp(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onRightMouseUp( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @brief Callback that occurs whenever the mouse is dragged in this control while the right mouse button is pressed.
- @param modifier Key that was pressed during this callback. Values are:
- $EventModifier::RSHIFT
- $EventModifier::SHIFT
- $EventModifier::LCTRL
- $EventModifier::RCTRL
- $EventModifier::CTRL
- $EventModifier::CTRL
- $EventModifier::RALT
- $EventModifier::ALT
- @param mousePoint X/Y location of the mouse point
- @param mouseClickCount How many mouse clicks have occured for this event
- @tsexample
- // Right mouse button was dragged in this control, causing the callback
- GuiMouseEventCtrl::onRightMouseDragged(%this,%modifier,%mousePoint,%mouseClickCount)
- {
- // Code to call when a mouse event occurs.
- }
- @endtsexample
- @see GuiControl
- */
- void onRightMouseDragged( U8 modifier, Point2I mousePoint, U8 mouseClickCount );
- /*! @name Input
- @{ */
- /*! */
- /*!
- Whether the control should lock the mouse between up and down button events.
- */
- bool lockMouse;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /*!
- @brief A control that locks the mouse and reports all keyboard input events to script.
- This is useful for implementing custom keyboard handling code, and most commonly used in Torque for a menu that allows a user to remap their in-game controls
- @tsexample
- new GuiInputCtrl(OptRemapInputCtrl)
- {
- lockMouse = "0";
- position = "0 0";
- extent = "64 64";
- minExtent = "8 8";
- horizSizing = "center";
- vertSizing = "bottom";
- profile = "GuiInputCtrlProfile";
- visible = "1";
- active = "1";
- tooltipProfile = "GuiToolTipProfile";
- hovertime = "1000";
- isContainer = "0";
- canSave = "1";
- canSaveDynamicFields = "0";
- };
- @endtsexample
- @see GuiMouseEventCtrl
- @ingroup GuiUtil
- */
- class GuiInputCtrl : public GuiMouseEventCtrl {
- public:
- /*! @brief Callback that occurs when an input is triggered on this control
- @param device The device type triggering the input, such as keyboard, mouse, etc
- @param action The actual event occuring, such as a key or button
- @param state True if the action is being pressed, false if it is being release
- */
- void onInputEvent( string device, string action, bool state );
- /*! @name Input
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class optionsBindInputCtrl : public GuiInputCtrl {
- public:
- virtual Script onInputEvent(( string this, string device, string action )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class optionsBindDlg : public GuiControl {
- public:
- };
- class GuiComboPanel : public GuiControl {
- public:
- /*!
- AddButton
- */
- bool AddButton;
- /*!
- Text label.
- */
- caseString caption;
- /*!
- AutoResize
- */
- bool AutoResize;
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsHotBarPresetsPanel : public GuiComboPanel {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsHUDPresetsPanel : public GuiComboPanel {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsHotbarPanel : public GuiComboPanel {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsVehiclePanel : public GuiComboPanel {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsViewPanel : public GuiComboPanel {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsInterfacePanel : public GuiComboPanel {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsInteractionPanel : public GuiComboPanel {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsMovementPanel : public GuiComboPanel {
- public:
- };
- /*!
- @brief A container that stacks its children horizontally or vertically.
- This container maintains a horizontal or vertical stack of GUI controls. If one is added, deleted, or resized, then the stack is resized to fit. The order of the stack is determined by the internal order of the children (ie. the order of addition).<br>@tsexample
- new GuiStackControl()
- {
- stackingType = "Dynamic";
- horizStacking = "Left to Right";
- vertStacking = "Top to Bottom";
- padding = "4";
- dynamicSize = "1";
- dynamicNonStackExtent = "0";
- dynamicPos = "0";
- changeChildSizeToFit = "1";
- changeChildPosition = "1";
- //Properties not specific to this control have been omitted from this example.
- };
- @endtsexample
- */
- class GuiStackControl : public GuiControl {
- public:
- /*! Return whether or not this control is frozen */
- virtual bool isFrozen(()) {}
- /*! Prevents control from restacking - useful when adding or removing child controls
- @param freeze True to freeze the control, false to unfreeze it
- @tsexample
- %stackCtrl.freeze(true);
- // add controls to stack
- %stackCtrl.freeze(false);
- @endtsexample
- */
- virtual void freeze(( bool freeze )) {}
- /*! Restack the child controls.
- */
- virtual void updateStack(()) {}
- /*! @name Stacking
- @{ */
- /*! */
- /*!
- Determines the method used to position the child controls.
- */
- GuiStackingType stackingType;
- /*!
- Controls the type of horizontal stacking to use (<i>Left to Right</i> or <i>Right to Left</i>)
- */
- GuiHorizontalStackingType horizStacking;
- /*!
- Controls the type of vertical stacking to use (<i>Top to Bottom</i> or <i>Bottom to Top</i>)
- */
- GuiVerticalStackingType vertStacking;
- /*!
- Distance (in pixels) between stacked child controls.
- */
- int padding;
- /*!
- Determines whether to resize the stack control along the stack axis (change width for horizontal stacking, change height for vertical stacking).
- If true, the stack width/height will be resized to the sum of the child control widths/heights. If false, the stack will not be resized.
- */
- bool dynamicSize;
- /*!
- Determines whether to resize the stack control along the non-stack axis (change height for horizontal stacking, change width for vertical stacking). No effect if dynamicSize is false.
- If true, the stack will be resized to the maximum of the child control widths/heights. If false, the stack will not be resized.
- */
- bool dynamicNonStackExtent;
- /*!
- Determines whether to reposition the stack along the stack axis when it is auto-resized. No effect if dynamicSize is false.
- If true, the stack will grow left for horizontal stacking, and grow up for vertical stacking.
- If false, the stack will grow right for horizontal stacking, and grow down for vertical stacking.
- */
- bool dynamicPos;
- /*!
- Determines whether to resize child controls.
- If true, horizontally stacked children keep their width, but have their height set to the stack control height. Vertically stacked children keep their height, but have their width set to the stack control width. If false, child controls are not resized.
- */
- bool changeChildSizeToFit;
- /*!
- Determines whether to reposition child controls.
- If true, horizontally stacked children are aligned along the top edge of the stack control. Vertically stacked children are aligned along the left edge of the stack control. If false, horizontally stacked children retain their Y position, and vertically stacked children retain their X position.
- */
- bool changeChildPosition;
- /*!
- */
- int RightIndent;
- /*!
- */
- int LeftIndent;
- /*!
- */
- int TopIndent;
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class GuiComboStackControl : public GuiStackControl {
- public:
- /*!
- Text label.
- */
- caseString caption;
- /*!
- Radio button toggle group number. The default group is -1.
- */
- int groupNum;
- /*! @name Stacking
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsStackControl : public GuiComboStackControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsControlsScrollControl : public GuiScrollCtrl {
- public:
- };
- class OptionsControlsDlg : public GuiControl {
- public:
- virtual Script onSleep(( string this )) {}
- virtual Script onWake(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsPanelStackButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsSliderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsCheckboxProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsHeaderTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class OptionsMainTextProfile : public GuiControlProfile {
- public:
- };
- class HelpDlgText : public GuiMLTextCtrl {
- public:
- virtual Script onURL(( string this, string url )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HelpDlgScrl : public GuiScrollCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HelpDlgWnd : public GuiWindowCtrl {
- public:
- };
- class HelpDlg : public GuiControl {
- public:
- virtual Script onSleep(( string this )) {}
- virtual Script onWake(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HelpButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HelpScrollProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MainMenuGuiExitBtn : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MainMenuGuiHelpBtn : public GuiButtonCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MainMenuGuiBg : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MainMenuGui : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class EmptyGui : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityButtonArrowProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityDefaultDelimeterProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityDelimeterProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilitySkillButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityDefaultButtonSignProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityDefaultButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityWidgetBorderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AbilityWidgetProfile : public GuiControlProfile {
- public:
- };
- /*!
- @brief The main 3D viewport for a Torque 3D game.
- @ingroup Gui3D
- */
- class GameTSCtrl : public GuiTSCtrl {
- public:
- /*! @name Camera
- @{ */
- /*! */
- /// @}
- /*! @name Rendering
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class HudlessPlayGui : public GameTSCtrl {
- public:
- virtual Script toggle(( string this )) {}
- virtual Script onSleep(( string this )) {}
- virtual Script onWake(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class voiceChatBitmap : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class gmBar : public GuiTextCtrl {
- public:
- };
- class GuiMiniCharWindow : public GuiWindowCtrl {
- public:
- virtual void onClose(()) {}
- /*! @name Window
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MiniCharWindow : public GuiMiniCharWindow {
- public:
- };
- class CmCombosWindow : public GuiWindowCtrl {
- public:
- /*! @name Window
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CombosBar : public CmCombosWindow {
- public:
- };
- class GuiTextColorfulCtrl : public GuiControl {
- public:
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TargetBarText3 : public GuiTextColorfulCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TargetBarText2 : public GuiTextColorfulCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TargetBarText1 : public GuiTextColorfulCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TargetBarText0 : public GuiTextColorfulCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TargetBar : public GuiWindowCtrl {
- public:
- };
- class cmEffectsBarWindow : public GuiWindowCtrl {
- public:
- /*! @name Window
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class EffectsBar : public cmEffectsBarWindow {
- public:
- };
- class cmMiddleBarWindow : public GuiWindowCtrl {
- public:
- virtual Script onSettings(( string obj )) {}
- virtual void setFirstValue(( int new_value )) {}
- virtual void setShowNumber(( bool new_value )) {}
- virtual bool getShowNumber(()) {}
- virtual void setFontSize(( int size )) {}
- virtual int getFontSize(()) {}
- virtual void onClose(()) {}
- /*!
- Bar image path.
- */
- string barImage;
- /*!
- First value color
- */
- ColorI firstColor;
- /*!
- Shadow color
- */
- ColorI shadowColor;
- /*! @name Window
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AlignmentBar : public cmMiddleBarWindow {
- public:
- };
- class cmDoubleBarWindow : public GuiWindowCtrl {
- public:
- virtual Script onSettings(( string obj )) {}
- virtual void setFirstValue(( int new_value )) {}
- virtual void setSecondValue(( int new_value )) {}
- virtual void setShowNumber(( bool new_value )) {}
- virtual bool getShowNumber(()) {}
- virtual void setFontSize(( int size )) {}
- virtual int getFontSize(()) {}
- virtual void onClose(()) {}
- /*!
- Bar image path.
- */
- string barImage;
- /*!
- First value color
- */
- ColorI firstColor;
- /*!
- Second value color
- */
- ColorI secondColor;
- /*!
- Shadow color
- */
- ColorI shadowColor;
- /*!
- Shadow color
- */
- bool is_show_second_number_value;
- /*! @name Window
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HungerBar : public cmDoubleBarWindow {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StaminaBar : public cmDoubleBarWindow {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HealthBar : public cmDoubleBarWindow {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseSpeedNeeded : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseSpeedBackward : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseSpeedForward : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseSpeedBar : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseSpeedWindow : public GuiWindowCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseStaminaBar : public cmDoubleBarWindow {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseHealthBar : public cmDoubleBarWindow {
- public:
- };
- class GuiHitIndicator : public GuiBitmapCtrl {
- public:
- virtual void addHit(( VectorF direction )) {}
- /*! @name Bitmap
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- /*!
- */
- float hitDuration;
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HitIndicator : public GuiHitIndicator {
- public:
- };
- class GuiCrossHairHud : public GuiControl {
- public:
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Reticle : public GuiCrossHairHud {
- public:
- };
- class TerrainSelection : public GuiTSCtrl {
- public:
- /*! @name Camera
- @{ */
- /*! */
- /// @}
- /*! @name Rendering
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class terSelection : public TerrainSelection {
- public:
- };
- /*!
- @brief A horizontal progress bar rendered from a repeating image.
- This class is used give progress feedback to the user. Unlike GuiProgressCtrl which simply renders a filled rectangle, GuiProgressBitmapCtrl renders the bar using a bitmap.
- This bitmap can either be simple, plain image which is then stretched into the current extents of the bar as it fills up or it can be a bitmap array with three entries. In the case of a bitmap array, the first entry in the array is used to render the left cap of the bar and the third entry in the array is used to render the right cap of the bar. The second entry is streched in-between the two caps.
- @tsexample
- // This example shows one way to break down a long-running computation into phases
- // and incrementally update a progress bar between the phases.
- new GuiProgressBitmapCtrl( Progress )
- {
- bitmap = "core/art/gui/images/loading";
- extent = "300 50";
- position = "100 100";
- };
- // Put the control on the canvas.
- %wrapper = new GuiControl();
- %wrapper.addObject( Progress );
- Canvas.pushDialog( %wrapper );
- // Start the computation.
- schedule( 1, 0, "phase1" );
- function phase1()
- {
- Progress.setValue( 0 );
- // Perform some computation.
- //...
- // Update progress.
- Progress.setValue( 0.25 );
- // Schedule next phase. Don't call directly so engine gets a change to run refresh.
- schedule( 1, 0, "phase2" );
- }
- function phase2()
- {
- // Perform some computation.
- //...
- // Update progress.
- Progress.setValue( 0.7 );
- // Schedule next phase. Don't call directly so engine gets a change to run refresh.
- schedule( 1, 0, "phase3" );
- }
- function phase3()
- {
- // Perform some computation.
- //...
- // Update progress.
- Progress.setValue( 0.9 );
- // Schedule next phase. Don't call directly so engine gets a change to run refresh.
- schedule( 1, 0, "phase4" );
- }
- function phase4()
- {
- // Perform some computation.
- //...
- // Final update of progress.
- Progress.setValue( 1.0 );
- }
- @endtsexample
- @see GuiProgressCtrl
- */
- class GuiProgressBitmapCtrl : public GuiTextCtrl {
- public:
- /*! Set the bitmap to use for rendering the progress bar.
- @param filename ~Path to the bitmap file.
- @note Directly assign to #bitmap rather than using this method.
- @see GuiProgressBitmapCtrl::setBitmap */
- virtual void setBitmap(( string filename )) {}
- /*!
- ~Path to the bitmap file to use for rendering the progress bar.
- If the profile assigned to the control already has a bitmap assigned, this property need not be set in which case the bitmap from the profile is used.
- */
- filename bitmap;
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class cmProgressBar : public GuiProgressBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class cmProgressBarBackground : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class cmProgressBarHud : public GuiControl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LagIcon : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bottomPrintDlg : public GuiBitmapCtrl {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class centerPrintDlg : public GuiBitmapCtrl {
- public:
- };
- class GuiBlinkBitmapCtrl : public GuiBitmapCtrl {
- public:
- virtual void startBlink() {}
- virtual void finishBlink() {}
- /*! @name Bitmap
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- /*!
- */
- float alpha;
- /*!
- */
- float maxAlpha;
- /*!
- */
- float blinkSpeed;
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StreamingIcon : public GuiBlinkBitmapCtrl {
- public:
- };
- /*!
- @brief A customized variation of GameTSCtrl.
- @ingroup afxGUI
- @ingroup AFX
- */
- class afxTSCtrl : public GuiTSCtrl {
- public:
- /*! Associate a spellbook with an afxTSCtrl.
- @ingroup AFX */
- virtual void setSpellBook(( afxSpellBook spellbook )) {}
- /*! Push a new targeting-mode onto a statck of modes.
- @ingroup AFX */
- virtual void pushTargetingMode(( unsigned int mode, unsigned int checkMethod=arcaneFX::TARGET_CHECK_POLL )) {}
- /*! Pop the targeting-mode off a statck of modes.
- @ingroup AFX */
- virtual void popTargetingMode(()) {}
- /*! Get the current targeting-mode.
- @ingroup AFX */
- virtual int getTargetingMode(()) {}
- /*! Get the 3D direction vector for the mouse cursor.
- @ingroup AFX */
- virtual string getMouse3DVec(()) {}
- /*! Get the 3D position of the mouse cursor.
- @ingroup AFX */
- virtual string getMouse3DPos(()) {}
- /*! @name Camera
- @{ */
- /*! */
- /// @}
- /*! @name Rendering
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Layout
- @{ */
- /*! */
- /// @}
- /*! @name Control
- @{ */
- /*! */
- /// @}
- /*! @name ToolTip
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Localization
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class PlayGui : public afxTSCtrl {
- public:
- virtual Script disableVoiceChat(( string this )) {}
- virtual Script enableVoiceChat(( string this )) {}
- virtual Script clearHud(( string this )) {}
- virtual Script onSleep(( string this )) {}
- virtual Script onWake(( string this )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GMTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class VersionTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ComboTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TrebuchetSliderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TrebuchetTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiTrebuchetButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CreateServerDeleteButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CreateWorldButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CreatedServerButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmCreateWorldPAssNumericTextEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmCreateWorldPAssTextEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmCreateWorldNameTextEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerBorderPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerConnectButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerPanelProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerCaptionProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TableItemrProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TableHeaderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TabButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CreateServerInfoItemValProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CreateServerInfoItemText2Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CreateServerInfoItemText1Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerInfoItemValProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerInfoItemText2Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerInfoItemText1Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerValTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerTextSmallProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoinServerTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MixerRightText2Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MixerRightText1Profile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MixerLeftTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmBackPnlforPopUpMenuProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PersonWndTitulScrollProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PersonWndTitulPopUpProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PersonWndTitulPopUpMenu : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiWinButtonProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonHungProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonSumStatProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonLuckProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonIntProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonWillProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonConProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonAgiProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonStrProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonSoftStamProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonHardStamProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonSoftHitProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonHardHitProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiDoubleValPersonWndProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PersonWndTitulTextEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PersonWndNameTextEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonAligProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiPersonFoodProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmGuiTextEditNotBorderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SplitStackItemIconProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmGuiSliderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmGuiNumericTextEditSliderBitmapProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmLineTextEditBitmapProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class EnoughCountItemProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class InventoryDescriptionProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmScrollForPopUpMenuProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmPopUpMenuEditProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmPopUpMenuDefault : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class InventoryPopupMenuItemBorder : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GuiCmProgressBitmapProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ObjInventoryNameProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class InvItemGui : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class InvGui : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class InvScroll : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class InvList : public GuiControlProfile {
- public:
- };
- /*!
- @brief This class contains behavior and rendering properties used by the Gizmo class
- Not intended for game development, for editors or internal use only.
- */
- class GizmoProfile : public SimObject {
- public:
- /*!
- */
- GizmoAlignment alignment;
- /*!
- */
- GizmoMode mode;
- /*!
- */
- bool snapToGrid;
- /*!
- */
- bool allowSnapRotations;
- /*!
- */
- float rotationSnap;
- /*!
- */
- bool allowSnapScale;
- /*!
- */
- float scaleSnap;
- /*!
- */
- bool renderWhenUsed;
- /*!
- */
- bool renderInfoText;
- /*!
- */
- bool renderPlane;
- /*!
- */
- bool renderPlaneHashes;
- /*!
- */
- bool renderSolid;
- /*!
- */
- bool renderMoveGrid;
- /*!
- */
- ColorI gridColor;
- /*!
- */
- float planeDim;
- /*!
- */
- Point3F gridSize;
- /*!
- */
- int screenLength;
- /*!
- */
- float rotateScalar;
- /*!
- */
- float scaleScalar;
- /*!
- */
- int flags;
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CmObjGizmoProfile : public GizmoProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NumericHealthProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HudTextBoldProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HudTextItalicProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HudTextNormalProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ChatHudBorderProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HudTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HudScrollProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CMDefaultScrollProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ChatHudMessageProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ChatHudTextProfile : public GuiControlProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ChatHudEditProfile : public GuiControlProfile {
- public:
- };
- class substance : public SimObject {
- public:
- /*!
- */
- char ter2_id;
- /*!
- */
- float quantity_k;
- /*!
- */
- float maxHeightDiffBeforeFall;
- /*!
- */
- bool canBeDigged;
- /*!
- */
- bool canBeShaped;
- /*!
- */
- string terrainMaterialName;
- /*!
- */
- string tunnelFloorMaterialName;
- /*!
- */
- string tunnelCeilingMaterialName;
- /*!
- */
- string tunnelWallMaterialName;
- /*!
- */
- char footstepsType;
- /*!
- */
- float SpeedMultiplier;
- /*!
- */
- int droppedObjectID;
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StoneRoad : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertilePotatoBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertilePotatoBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertilePotatoNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertilePotatoNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertilePotatoSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertilePotatoSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileGrapeBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileGrapeBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileGrapeNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileGrapeNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileGrapeSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileGrapeSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileFlaxBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileFlaxBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileFlaxNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileFlaxNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileFlaxSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileFlaxSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileCarrotBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileCarrotBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileCarrotNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileCarrotNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileCarrotSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileCarrotSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileOnionBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileOnionBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileOnionNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileOnionNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileOnionSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileOnionSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileCabbageBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileCabbageBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileCabbageNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileCabbageNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileCabbageSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileCabbageSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertilePeaBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertilePeaBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertilePeaNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertilePeaNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertilePeaSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertilePeaSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileWheatBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileWheatBig : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileWheatNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileWheatNormal : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NonFertileWheatSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FertileWheatSmall : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class RiverRock : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Swamp : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Snow : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Clay : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Sand : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CopperOre : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CopperVein : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SilverOre : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SilverVein : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class IronOreLoose : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class IronOre : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GoldOreloose : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GoldOre : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class slatefrag : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Slate : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class marblefrag : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Marble : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class granitefrag : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Granite : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class rockfrag : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class rockbare : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class loosensteppesoil : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class steppesoil : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class loosenforestsoil : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class forestsoil : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LoosenSoil : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Soil : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class air : public substance {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SubstancesGroup : public SimGroup {
- public:
- };
- /*!
- @brief Represents geometry to be mounted to a ShapeBase object.
- @ingroup gameObjects
- */
- class ShapeBaseImageData : public GameBaseData {
- public:
- virtual void onRangedImagePrefire((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onRangedImageFire((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onRangedImageFireCancel((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onRangedImageReady((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onRangedImageInactive((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onThrowingWeaponFire((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onThrowingWeaponPostfire((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onImagePrefire((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onImageFire((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onImageFireCancel((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onImageReady((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- virtual void onImageInactive((ShapeBase obj, S32 slot, F32 dt, F32 pctT)) {}
- /*! @brief Called when the Image is first mounted to the object.
- @param obj object that this Image has been mounted to
- @param slot Image mount slot on the object
- @param dt time remaining in this Image update
- */
- void onMount( ShapeBase obj, int slot, float dt );
- /*! @brief Called when the Image is unmounted from the object.
- @param obj object that this Image has been unmounted from
- @param slot Image mount slot on the object
- @param dt time remaining in this Image update
- */
- void onUnmount( ShapeBase obj, int slot, float dt );
- /*!
- @brief The DTS or DAE model to use for this Image.
- */
- filename shapeFile;
- /*!
- @brief Mount node # to mount this Image to.
- This should correspond to a mount# node on the ShapeBase derived object we are mounting to.
- */
- int mountPoint;
- /*!
- @brief "X Y Z" translation offset from this Image's <i>mountPoint</i> node to attach to.
- Defaults to "0 0 0". ie. attach this Image's <i>mountPoint</i> node to the ShapeBase model's mount# node without any offset.
- @see rotation
- */
- MatrixPosition offset;
- /*!
- @brief "X Y Z ANGLE" rotation offset from this Image's <i>mountPoint</i> node to attach to.
- Defaults to "0 0 0". ie. attach this Image's <i>mountPoint</i> node to the ShapeBase model's mount# node without any additional rotation.
- @see offset
- */
- MatrixRotation rotation;
- /*!
- @brief "X Y Z" translation offset from the ShapeBase model's eye node.
- When in first person view, this is the offset from the eye node to place the gun. This gives the gun a fixed point in space, typical of a lot of FPS games.
- @see eyeRotation
- */
- MatrixPosition eyeOffset;
- /*!
- @brief "X Y Z ANGLE" rotation offset from the ShapeBase model's eye node.
- When in first person view, this is the rotation from the eye node to place the gun.
- @see eyeOffset
- */
- MatrixRotation eyeRotation;
- /*!
- @brief Flag to adjust the aiming vector to the eye's LOS point.
- @see ShapeBase::getMuzzleVector()
- */
- bool correctMuzzleVector;
- /*!
- @brief This flag must be set for the adjusted LOS muzzle vector to be computed.
- @see ShapeBase::getMuzzleVector()
- */
- bool firstPerson;
- /*!
- @brief Mass of this Image.
- This is added to the total mass of the ShapeBase object.
- */
- float mass;
- /*!
- @brief The type of light this Image emits.
- @see ShapeBaseImageLightType
- */
- ShapeBaseImageLightType lightType;
- /*!
- @brief The color of light this Image emits.
- @see lightType
- */
- ColorF lightColor;
- /*!
- @brief Duration in SimTime of Pulsing and WeaponFire type lights.
- @see lightType
- */
- int lightDuration;
- /*!
- @brief Radius of the light this Image emits.
- @see lightType
- */
- float lightRadius;
- /*!
- @brief Brightness of the light this Image emits.
- Only valid for WeaponFireLight.@see lightType
- */
- float lightBrightness;
- /*!
- @brief Node of Image where light is mount.
- @see lightType
- */
- string lightImageNode;
- /*!
- @brief light parameters from lightprototype
- */
- string lightPrototype;
- /*!
- @brief Flag indicating whether the camera should shake when this Image fires.
- @note Camera shake only works properly if the player is in control of the one and only shapeBase object in the scene which fires an Image that uses camera shake.
- */
- bool shakeCamera;
- /*!
- @brief Frequency of the camera shaking effect.
- @see shakeCamera
- */
- Point3F camShakeFreq;
- /*!
- @brief Amplitude of the camera shaking effect.
- @see shakeCamera
- */
- Point3F camShakeAmp;
- /*!
- @brief Permanent emitter to generate particles.
- @see permanentEmitter
- */
- ParticleEmitterData permanentEmitter;
- /*!
- @brief Name of the node to emit particles from.
- @see permanentEmitter
- */
- string permanentEmitterNode;
- /*!
- permanent sound to play.
- */
- SFXTrack permanentSound;
- /*!
- Name of this state.
- */
- caseString stateName;
- /*!
- Name of the state to transition to when the loaded state of the Image changes to 'Loaded'.
- */
- string stateTransitionOnLoaded;
- /*!
- Name of the state to transition to when the loaded state of the Image changes to 'Empty'.
- */
- string stateTransitionOnNotLoaded;
- /*!
- Name of the state to transition to when the ammo state of the Image changes to true.
- */
- string stateTransitionOnAmmo;
- /*!
- Name of the state to transition to when the ammo state of the Image changes to false.
- */
- string stateTransitionOnNoAmmo;
- /*!
- Name of the state to transition to when the Image gains a target.
- */
- string stateTransitionOnTarget;
- /*!
- Name of the state to transition to when the Image loses a target.
- */
- string stateTransitionOnNoTarget;
- /*!
- Name of the state to transition to when the Image enters the water.
- */
- string stateTransitionOnWet;
- /*!
- Name of the state to transition to when the Image exits the water.
- */
- string stateTransitionOnNotWet;
- /*!
- Name of the state to transition to when the trigger state of the Image changes to true (fire button down).
- */
- string stateTransitionOnTriggerUp;
- /*!
- Name of the state to transition to when the trigger state of the Image changes to false (fire button released).
- */
- string stateTransitionOnTriggerDown;
- /*!
- Name of the state to transition to when the alt trigger state of the Image changes to true (alt fire button down).
- */
- string stateTransitionOnAltTriggerUp;
- /*!
- Name of the state to transition to when the alt trigger state of the Image changes to false (alt fire button up).
- */
- string stateTransitionOnAltTriggerDown;
- /*!
- Name of the state to transition to when we have been in this state for stateTimeoutValue seconds.
- */
- string stateTransitionOnTimeout;
- /*!
- Time in seconds to wait before transitioning to stateTransitionOnTimeout.
- */
- float stateTimeoutValue;
- /*!
- If false, this state ignores stateTimeoutValue and transitions immediately if other transition conditions are met.
- */
- bool stateWaitForTimeout;
- /*!
- The first state with this set to true is the state entered by the client when it receives the 'fire' event.
- */
- bool stateFire;
- /*!
- If true, this state will be checking prerequisites for transition
- */
- bool stateCheckTransition;
- /*!
- @brief If false, other Images will temporarily be blocked from mounting while the state machine is executing the tasks in this state.
- For instance, if we have a rocket launcher, the player shouldn't be able to switch out <i>while</i> firing. So, you'd set stateAllowImageChange to false in firing states, and true the rest of the time.
- */
- bool stateAllowImageChange;
- /*!
- @brief Direction of the animation to play in this state.
- True is forward, false is backward.
- */
- bool stateDirection;
- /*!
- @brief Don't play animation, stop it.
- */
- bool stateFreezeAnimation;
- /*!
- @brief Set the loaded state of the Image.
- <ul><li>IgnoreLoaded: Don't change Image loaded state.</li><li>Loaded: Set Image loaded state to true.</li><li>NotLoaded: Set Image loaded state to false.</li></ul>
- @see ShapeBaseImageLoadedState
- */
- ShapeBaseImageLoadedState stateLoadedFlag;
- /*!
- @brief Controls how fast the 'spin' animation sequence will be played in this state.
- <ul><li>Ignore: No change to the spin sequence.</li><li>Stop: Stops the spin sequence at its current position.</li><li>SpinUp: Increase spin sequence timeScale from 0 (on state entry) to 1 (after stateTimeoutValue seconds).</li><li>SpinDown: Decrease spin sequence timeScale from 1 (on state entry) to 0 (after stateTimeoutValue seconds).</li><li>FullSpeed: Resume the spin sequence playback at its current position with timeScale=1.</li></ul>
- @see ShapeBaseImageSpinState
- */
- ShapeBaseImageSpinState stateSpinThread;
- /*!
- Name of the sequence to play on entry to this state.
- */
- string stateSequence;
- /*!
- @brief If true, a random frame from the muzzle flash sequence will be displayed each frame.
- The name of the muzzle flash sequence is the same as stateSequence, with "_vis" at the end.
- */
- bool stateSequenceRandomFlash;
- /*!
- If true, the timeScale of the stateSequence animation will be adjusted such that the sequence plays for stateTimeoutValue seconds.
- */
- bool stateScaleAnimation;
- /*!
- @brief Method to execute on entering this state.
- Scoped to this image class name, then ShapeBaseImageData. The script callback function takes the same arguments as the onMount callback.
- @see onMount() for the same arguments as this callback.
- */
- caseString stateScript;
- /*!
- Sound to play on entry to this state.
- */
- SFXTrack stateSound;
- /*!
- @brief Emitter to generate particles in this state (from muzzle point or specified node).
- @see stateEmitterNode
- */
- ParticleEmitterData stateEmitter0;
- /*!
- @brief Name of the node to emit particles from.
- @see stateEmitter
- */
- string stateEmitterNode0;
- /*!
- @brief Emitter to generate particles in this state (from muzzle point or specified node).
- @see stateEmitterNode
- */
- ParticleEmitterData stateEmitter1;
- /*!
- @brief Name of the node to emit particles from.
- @see stateEmitter
- */
- string stateEmitterNode1;
- /*!
- @brief Emitter to generate particles in this state (from muzzle point or specified node).
- @see stateEmitterNode
- */
- ParticleEmitterData stateEmitter2;
- /*!
- @brief Name of the node to emit particles from.
- @see stateEmitter
- */
- string stateEmitterNode2;
- /*!
- @brief If set to true, and both ready and loaded transitions are true, the ready transition will be taken instead of the loaded transition.
- A state is 'ready' if pressing the fire trigger in that state would transition to the fire state.
- */
- bool stateIgnoreLoadedForReady;
- /*!
- @brief Define which sub-state of fire state we describe here.
- */
- ShapeBaseImageFireSubState stateFireSubState;
- /*!
- @brief Maximum number of sounds this Image can play at a time.
- Any value <= 0 indicates that it can play an infinite number of sounds.
- */
- int maxConcurrentSounds;
- /*!
- @brief If true, allow multiple timeout transitions to occur within a single tick (useful if states have a very small timeout).
- */
- bool useRemainderDT;
- /*!
- */
- ShapeBaseImageHitNodeType hitGroupType;
- /*!
- */
- intList hitDirection;
- /*!
- */
- ShapeBaseImageAttackTypes attackType;
- /*!
- */
- ShapeBaseImageWeaponTypes weaponType;
- /*!
- */
- int Object_typeID;
- /*!
- */
- float WoundMultiplier;
- /*!
- */
- float FractureMultiplier;
- /*!
- */
- float StunMultiplier;
- /*!
- for Transportation mount images.
- */
- float wheelRadius;
- /*!
- */
- float BasePrefireAnimTime;
- /*!
- */
- float BaseFireAnimTime;
- /*!
- */
- float BaseRecoilAnimTime;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MountedTrader_cart : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MountedCart : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MountedWheelbarrow : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MountedPlough : public ShapeBaseImageData {
- public:
- };
- /*!
- @brief A datablock that describes an ambient sound space.
- Each ambience datablock captures the properties of a unique ambient sound space. A sound space is comprised of:
- - an ambient audio track that is played when the listener is inside the space,
- - a reverb environment that is active inside the space, and
- - a number of SFXStates that are activated when entering the space and deactivated when exiting it.
- Each of these properties is optional.
- An important characteristic of ambient audio spaces is that their unique nature is not determined by their location in space but rather by their SFXAmbience datablock. This means that the same SFXAmbience datablock assigned to multiple locations in a level represents the same unique audio space to the sound system.
- This is an important distinction for the ambient sound mixer which will activate a given ambient audio space only once at any one time regardless of how many intersecting audio spaces with the same SFXAmbience datablock assigned the listener may currently be in.
- All SFXAmbience instances are automatically added to the global @c SFXAmbienceSet.
- At the moment, transitions between reverb environments are not blended and different reverb environments from multiple active SFXAmbiences will not be blended together. This will be added in a future version.
- @tsexample
- singleton SFXAmbience( Underwater )
- {
- environment = AudioEnvUnderwater;
- soundTrack = ScubaSoundList;
- states[ 0 ] = AudioLocationUnderwater;
- };
- @endtsexample
- @see SFXEnvironment
- @see SFXTrack
- @see SFXState
- @see LevelInfo::soundAmbience
- @see Zone::soundAmbience
- @ref Datablock_Networking
- @ingroup SFX
- @ingroup Datablocks
- */
- class SFXAmbience : public SimDataBlock {
- public:
- /*! @name Sound
- @{ */
- /*! */
- /*!
- Reverb environment active in the ambience zone.
- @ref SFX_reverb
- */
- SFXEnvironment environment;
- /*!
- Sound track to play in the ambience zone.
- */
- SFXTrack soundTrack;
- /*!
- The rolloff factor to apply to distance-based volume attenuation in this space.
- Defaults to 1.0.
- @note This applies to the logarithmic distance model only.
- @ref SFXSource_volume
- */
- float rolloffFactor;
- /*!
- The factor to apply to the doppler affect in this space.
- Defaults to 0.5.
- @ref SFXSource_doppler
- */
- float dopplerFactor;
- /*!
- States to activate when the ambient zone is entered.
- When the ambient sound state is entered, all states associated with the state will be activated (given that they are not disabled) and deactivated when the space is exited again.
- */
- SFXState states;
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AudioAmbienceOutside : public SFXAmbience {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AudioStateExclusive : public SFXState {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AudioLocationOutside : public AudioStateExclusive {
- public:
- };
- /*!
- @brief Defines properties for a ShapeBase object.
- @see ShapeBase
- @ingroup gameObjects
- */
- class ShapeBaseData : public GameBaseData {
- public:
- /*! @brief Called when the object damage state changes to Enabled.
- @param obj The ShapeBase object
- @param lastState The previous damage state
- */
- void onEnabled( ShapeBase obj, string lastState );
- /*! @brief Called when the object damage state changes to Disabled.
- @param obj The ShapeBase object
- @param lastState The previous damage state
- */
- void onDisabled( ShapeBase obj, string lastState );
- /*! @brief Called when the object damage state changes to Destroyed.
- @param obj The ShapeBase object
- @param lastState The previous damage state
- */
- void onDestroyed( ShapeBase obj, string lastState );
- /*! @brief Called when we collide with another object beyond some impact speed.
- The Player class makes use of this callback when a collision speed is more than PlayerData::minImpactSpeed.
- @param obj The ShapeBase object
- @param collObj The object we collided with
- @param vec Collision impact vector
- @param len Length of the impact vector
- */
- void onImpact( ShapeBase obj, SceneObject collObj, VectorF vec, float len );
- /*! @brief Called when we collide with another object.
- @param obj The ShapeBase object
- @param collObj The object we collided with
- @param vec Collision impact vector
- @param len Length of the impact vector
- */
- void onCollision( ShapeBase obj, SceneObject collObj, VectorF vec, float len );
- /*! @brief Called when the object is damaged.
- @param obj The ShapeBase object
- @param obj The ShapeBase object
- @param delta The amount of damage received. */
- void onDamage( ShapeBase obj, float delta );
- /*! @brief Called when a thread playing a non-cyclic sequence reaches the end of the sequence.
- @param obj The ShapeBase object
- @param slot Thread slot that finished playing
- */
- void onEndSequence( ShapeBase obj, int slot );
- /*! @brief Called when the object is forced to uncloak.
- @param obj The ShapeBase object
- @param reason String describing why the object was uncloaked
- */
- void onForceUncloak( ShapeBase obj, string reason );
- /*! @brief Helper method to get a transform from a position and vector (suitable for use with setTransform).
- @param pos Desired transform position
- @param normal Vector of desired direction
- @return The deploy transform
- */
- virtual string getDeployTransform(( Point3F pos, Point3F normal )) {}
- /*! @name Shadows
- @{ */
- /*! */
- /*!
- Enable shadows for this shape (currently unused, shadows are always enabled).
- */
- bool shadowEnable;
- /*!
- Size of the projected shadow texture (must be power of 2).
- */
- int shadowSize;
- /*!
- Maximum distance at which shadow is visible (currently unused).
- */
- float shadowMaxVisibleDistance;
- /*!
- Maximum height above ground to project shadow. If the object is higher than this no shadow will be rendered.
- */
- float shadowProjectionDistance;
- /*!
- Scalar applied to the radius of spot shadows (initial radius is based on the shape bounds but can be adjusted with this field).
- */
- float shadowSphereAdjust;
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /*!
- The DTS or DAE model to use for this object.
- */
- filename shapeFile;
- /*!
- */
- Point3F imageScale;
- /*!
- */
- Point3F horseScale;
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /*!
- %Explosion to generate when this shape is blown up.
- */
- ExplosionData Explosion;
- /*!
- %Explosion to generate when this shape is blown up underwater.
- */
- ExplosionData underwaterExplosion;
- /*!
- %Debris to generate when this shape is blown up.
- */
- DebrisData Debris;
- /*!
- Whether to render the shape when it is in the "Destroyed" damage state.
- */
- bool renderWhenDestroyed;
- /*!
- The DTS or DAE model to use for auto-generated breakups. @note may not be functional.
- */
- filename debrisShapeName;
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /*!
- Shape mass.
- Used in simulation of moving objects.
- */
- float mass;
- /*!
- Drag factor.
- Reduces velocity of moving objects.
- */
- float drag;
- /*!
- Shape density.
- Used when computing buoyancy when in water.
- */
- float density;
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /*!
- Maximum damage level for this object.
- */
- float maxDamage;
- /*!
- Damage level above which the object is destroyed.
- When the damage level increases above this value, the object damage state is set to "Destroyed".
- */
- float destroyedLevel;
- /*!
- Rate at which damage is repaired in damage units/tick.
- This value is subtracted from the damage level until it reaches 0.
- */
- float repairRate;
- /*!
- Invincible flag; when invincible, the object cannot be damaged or repaired.
- */
- bool isInvincible;
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /*!
- The maximum distance from the camera to the object.
- Used when computing a custom camera transform for this object.
- @see observeThroughObject
- */
- float cameraMaxDist;
- /*!
- The minimum distance from the camera to the object.
- Used when computing a custom camera transform for this object.
- @see observeThroughObject
- */
- float cameraMinDist;
- /*!
- The default camera vertical FOV in degrees.
- */
- float cameraDefaultFov;
- /*!
- The minimum camera vertical FOV allowed in degrees.
- */
- float cameraMinFov;
- /*!
- The maximum camera vertical FOV allowed in degrees.
- */
- float cameraMaxFov;
- /*!
- Flag controlling whether the view from this object is first person only.
- */
- bool firstPersonOnly;
- /*!
- Flag controlling whether the client uses this object's eye point to view from.
- */
- bool useEyePoint;
- /*!
- Observe this object through its camera transform and default fov.
- If true, when this object is the camera it can provide a custom camera transform and FOV (instead of the default eye transform).
- */
- bool observeThroughObject;
- /// @}
- /*!
- */
- string remapTextureTags;
- /*!
- */
- bool silentBBoxValidation;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /*!
- @brief The most basic ShapeBaseData derrived shape datablock available in Torque 3D.
- When it comes to placing 3D objects in the scene, you effectively have two options:
- 1. TSStatic objects
- 2. ShapeBase derived objects
- Since ShapeBase and ShapeBaseData are not meant to be instantiated in script, you will use one of its child classes instead. Several game related objects are derived from ShapeBase: Player, Vehicle, Item, and so on.
- When you need a 3D object with datablock capabilities, you will use an object derived from ShapeBase. When you need an object with extremely low overhead, and with no other purpose than to be a 3D object in the scene, you will use TSStatic.
- The most basic child of ShapeBase is StaticShape. It does not introduce any of the additional functionality you see in Player, Item, Vehicle or the other game play heavy classes. At its core, it is comparable to a TSStatic, but with a datbalock. Having a datablock provides a location for common variables as well as having access to various ShapeBaseData, GameBaseData and SimDataBlock callbacks.
- @tsexample
- // Create a StaticShape using a datablock
- datablock StaticShapeData(BasicShapeData)
- {
- shapeFile = "art/shapes/items/kit/healthkit.dts";
- testVar = "Simple string, not a stock variable";
- };
- new StaticShape()
- {
- dataBlock = "BasicShapeData";
- position = "0.0 0.0 0.0";
- rotation = "1 0 0 0";
- scale = "1 1 1";
- };
- @endtsexample
- @see StaticShape
- @see ShapeBaseData
- @see TSStatic
- @ingroup gameObjects
- */
- class StaticShapeData : public ShapeBaseData {
- public:
- /*! @name Shadows
- @{ */
- /*! */
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TreeLogData : public StaticShapeData {
- public:
- };
- /*!
- @brief Defines properties for a Player object.
- @see Player
- @ingroup gameObjects
- */
- class PlayerData : public ShapeBaseData {
- public:
- /*! @brief Called when the player starts swimming.
- @param obj The Player object
- */
- void onStartSwim( Player obj );
- /*! @brief Called when the player stops swimming.
- @param obj The Player object
- */
- void onStopSwim( Player obj );
- /*! @brief Called when attempting to dismount the player from a vehicle.
- It is up to the doDismount() method to actually perform the dismount. Often there are some conditions that prevent this, such as the vehicle moving too fast.
- @param obj The Player object
- */
- void doDismount( Player obj );
- /*! @brief Called when the player enters a liquid.
- @param obj The Player object
- @param coverage Percentage of the player's bounding box covered by the liquid
- @param type The type of liquid the player has entered
- */
- void onEnterLiquid( Player obj, float coverage, string type );
- /*! @brief Called when the player leaves a liquid.
- @param obj The Player object
- @param type The type of liquid the player has left
- */
- void onLeaveLiquid( Player obj, string type );
- /*! @brief Called on the server when a scripted animation completes.
- @param obj The Player object
- @see Player::setActionThread() for setting a scripted animation and its 'hold' parameter to determine if this callback is used.
- */
- void animationDone( Player obj );
- /*! @brief Called when the player enters the mission area.
- @param obj The Player object
- @see MissionArea
- */
- void onEnterMissionArea( Player obj );
- /*! @brief Called when the player leaves the mission area.
- @param obj The Player object
- @see MissionArea
- */
- void onLeaveMissionArea( Player obj );
- /*!
- @brief Maximum time scale for action animations.
- If an action animation has a defined ground frame, it is automatically scaled to match the player's ground velocity. This field limits the maximum time scale used even if the player's velocity exceeds it.
- */
- float maxTimeScale;
- /*! @name Camera
- @{ */
- /*! */
- /*!
- @brief Flag controlling whether to render the player shape in first person view.
- */
- bool renderFirstPerson;
- /*!
- @brief Lowest angle (in radians) the player can look.
- @note An angle of zero is straight ahead, with positive up and negative down.
- */
- float minLookAngle;
- /*!
- @brief Highest angle (in radians) the player can look.
- @note An angle of zero is straight ahead, with positive up and negative down.
- */
- float maxLookAngle;
- /*!
- @brief Defines the maximum left and right angles (in radians) the player can look in freelook mode.
- */
- float maxFreelookAngle;
- /*!
- The maximum distance from the camera to the object in building mode.
- */
- float buildCameraMaxDist;
- /*!
- The maximum distance from the camera to the object in building mode.
- */
- float buildCameraMinDist;
- /// @}
- /*! @name Movement
- @{ */
- /*! */
- /*!
- @brief Maximum height the player can step up.
- The player will automatically step onto changes in ground height less than maxStepHeight. The player will collide with ground height changes greater than this.
- */
- float maxStepHeight;
- /*!
- @brief Force used to accelerate the player when running.
- */
- float runForce;
- /*!
- @brief Maximum forward speed when walking.
- */
- float maxForwardSpeed;
- /*!
- @brief Maximum backward speed when walking.
- */
- float maxBackwardSpeed;
- /*!
- @brief Maximum sideways speed when walking.
- */
- float maxSideSpeed;
- /*!
- @brief Maximum forward speed when running.
- */
- float maxRuningSpeed;
- /*!
- @brief Maximum forward speed when walking.
- */
- float maxWarForwardSpeed;
- /*!
- @brief Maximum backward speed when walking.
- */
- float maxWarBackwardSpeed;
- /*!
- @brief Maximum sideways speed when walking.
- */
- float maxWarSideSpeed;
- /*!
- @brief Maximum forward speed when running.
- */
- float maxWarRuningSpeed;
- /*!
- @brief Maximum angle from vertical (in degrees) the player can run up.
- */
- float runSurfaceAngle;
- /*!
- @brief Minimum impact speed to apply falling damage.
- This field also sets the minimum speed for the onImpact callback to be invoked.
- @see ShapeBaseData::onImpact()
- */
- float minImpactSpeed;
- /*!
- @brief Maximum horizontal speed.
- @note This limit is only enforced if the player's horizontal speed exceeds horizResistSpeed.
- @see horizResistSpeed
- @see horizResistFactor
- */
- float horizMaxSpeed;
- /*!
- @brief Horizontal speed at which resistence will take place.
- @see horizMaxSpeed
- @see horizResistFactor
- */
- float horizResistSpeed;
- /*!
- @brief Factor of resistence once horizResistSpeed has been reached.
- @see horizMaxSpeed
- @see horizResistSpeed
- */
- float horizResistFactor;
- /*!
- @brief Maximum upwards speed.
- @note This limit is only enforced if the player's upward speed exceeds upResistSpeed.
- @see upResistSpeed
- @see upResistFactor
- */
- float upMaxSpeed;
- /*!
- @brief Upwards speed at which resistence will take place.
- @see upMaxSpeed
- @see upResistFactor
- */
- float upResistSpeed;
- /*!
- @brief Factor of resistence once upResistSpeed has been reached.
- @see upMaxSpeed
- @see upResistSpeed
- */
- float upResistFactor;
- /// @}
- /*! @name Movement: Jumping
- @{ */
- /*! */
- /*!
- @brief Force used to accelerate the player when a jump is initiated.
- */
- float jumpForce;
- /*!
- @brief Force used to accelerate the player when a jump on shield is initiated.
- */
- float pounceForce;
- /*!
- @brief Minimum speed needed to jump.
- If the player's own z velocity is greater than this, then it is used to scale the jump speed, up to maxJumpSpeed.
- @see maxJumpSpeed
- */
- float minJumpSpeed;
- /*!
- @brief Maximum vertical speed before the player can no longer jump.
- */
- float maxJumpSpeed;
- /*!
- @brief Angle from vertical (in degrees) where the player can jump.
- */
- float jumpSurfaceAngle;
- /*!
- @brief Delay time in number of ticks ticks between jumps.
- */
- int jumpDelay;
- /*!
- @brief Amount of movement control the player has when in the air.
- This is applied as a multiplier to the player's x and y motion.
- */
- float airControl;
- /*!
- @brief Controls the direction of the jump impulse.
- When false, jumps are always in the vertical (+Z) direction. When true jumps are in the direction of the ground normal so long as the player is not directly facing the surface. If the player is directly facing the surface, then they will jump straight up.
- */
- bool jumpTowardsNormal;
- /// @}
- /*! @name Movement: Swimming
- @{ */
- /*! */
- /*!
- @brief Force used to accelerate the player when swimming.
- */
- float swimForce;
- /*!
- @brief Maximum forward speed when underwater.
- */
- float maxUnderwaterForwardSpeed;
- /*!
- @brief Maximum backward speed when underwater.
- */
- float maxUnderwaterBackwardSpeed;
- /*!
- @brief Maximum sideways speed when underwater.
- */
- float maxUnderwaterSideSpeed;
- /// @}
- /*! @name Falling
- @{ */
- /*! */
- /*!
- @brief Number of ticks for the player to recover from falling.
- */
- int recoverDelay;
- /*!
- @brief Scale factor applied to runForce while in the recover state.
- This can be used to temporarily slow the player's movement after a fall, or prevent the player from moving at all if set to zero.
- */
- float recoverRunForceScale;
- /*!
- lookupdown_animation_angle_min (radians)
- */
- float lookupdown_animation_angle_min;
- /*!
- lookupdown_animation_angle_max (radians)
- */
- float lookupdown_animation_angle_max;
- /// @}
- /*! @name Collision
- @{ */
- /*! */
- /*!
- @brief Size of the bounding box used by the player for collision.
- Dimensions are given as "width depth height".
- */
- Point3F boundingBox;
- /*!
- @brief Collision bounding box used when the player is swimming.
- @see boundingBox
- */
- Point3F swimBoundingBox;
- /*!
- Standard collision (raycasting only, no physics) bounding box.
- @see boundingBox
- */
- Point3F standardRaycastBox;
- /*!
- Collision (raycasting only, no physics) bounding box used when the player is mounted.
- @see boundingBox
- */
- Point3F mountingRaycastBox;
- /// @}
- /*! @name Interaction: Footsteps
- @{ */
- /*! */
- /*!
- @brief Particle emitter used to generate footpuffs (particles created as the player walks along the ground).
- @note The generation of foot puffs requires the appropriate triggeres to be defined in the player's animation sequences. Without these, no foot puffs will be generated.
- */
- ParticleEmitterData footPuffEmitter;
- /*!
- @brief Number of footpuff particles to generate each step.
- Each foot puff is randomly placed within the defined foot puff radius. This includes having footPuffNumParts set to one.
- @see footPuffRadius
- */
- int footPuffNumParts;
- /*!
- @brief Particle creation radius for footpuff particles.
- This is applied to each foot puff particle, even if footPuffNumParts is set to one. So set this value to zero if you want a single foot puff placed at exactly the same location under the player each time.
- */
- float footPuffRadius;
- /*!
- @brief Emitter used to generate dust particles.
- @note Currently unused.
- */
- ParticleEmitterData dustEmitter;
- /*!
- @brief Decal to place on the ground for player footsteps.
- */
- DecalData DecalData;
- /*!
- @brief Distance from the center of the model to the right foot.
- While this defines the distance to the right foot, it is also used to place the left foot decal as well. Just on the opposite side of the player.
- */
- float decalOffset;
- /*!
- */
- string footNodeName1;
- /*!
- */
- string footNodeName2;
- /// @}
- /*! @name Interaction: Sounds
- @{ */
- /*! */
- /*!
- */
- string stepSoundsDir;
- /*!
- */
- string stepSoundsGeneralName;
- /*!
- */
- int stepSoundsStartingId;
- /*!
- */
- string stepSoundsDescription;
- /*!
- */
- string moveSoundsDir;
- /*!
- */
- string moveSoundsGeneralName;
- /*!
- */
- int moveSoundsStartingId;
- /*!
- */
- string moveSoundsDescription;
- /// @}
- /*! @name Interaction: Splashes
- @{ */
- /*! */
- /*!
- @brief SplashData datablock used to create splashes when the player moves through water.
- */
- SplashData Splash;
- /*!
- @brief Minimum velocity when moving through water to generate splashes.
- */
- float splashVelocity;
- /*!
- @brief Maximum angle (in degrees) from pure vertical movement in water to generate splashes.
- */
- float splashAngle;
- /*!
- @brief Multipled by speed to determine the number of splash particles to generate.
- */
- float splashFreqMod;
- /*!
- @brief Minimum speed to generate splash particles.
- */
- float splashVelEpsilon;
- /*!
- @brief Time in seconds to generate bubble particles after entering the water.
- */
- float bubbleEmitTime;
- /*!
- @brief Particle emitters used to generate splash particles.
- */
- ParticleEmitterData splashEmitter;
- /*!
- @brief Water coverage level to choose between FootShallowSound and FootWadingSound.
- @see FootShallowSound
- @see FootWadingSound
- */
- float footstepSplashHeight;
- /*!
- @brief Minimum velocity when entering the water for choosing between the impactWaterEasy and impactWaterMedium sounds to play.
- @see impactWaterEasy
- @see impactWaterMedium
- */
- float mediumSplashSoundVelocity;
- /*!
- @brief Minimum velocity when entering the water for choosing between the impactWaterMedium and impactWaterHard sound to play.
- @see impactWaterMedium
- @see impactWaterHard
- */
- float hardSplashSoundVelocity;
- /*!
- @brief Minimum velocity when leaving the water for the exitingWater sound to play.
- @see exitingWater
- */
- float exitSplashSoundVelocity;
- /// @}
- /*! @name Interaction: Ground Impact
- @{ */
- /*! */
- /*!
- @brief Minimum falling impact speed to apply damage and initiate the camera shaking effect.
- */
- float groundImpactMinSpeed;
- /*!
- @brief Frequency of the camera shake effect after falling.
- This is how fast to shake the camera.
- */
- Point3F groundImpactShakeFreq;
- /*!
- @brief Amplitude of the camera shake effect after falling.
- This is how much to shake the camera.
- */
- Point3F groundImpactShakeAmp;
- /*!
- @brief Duration (in seconds) of the camera shake effect after falling.
- This is how long to shake the camera.
- */
- float groundImpactShakeDuration;
- /*!
- @brief Falloff factor of the camera shake effect after falling.
- This is how to fade the camera shake over the duration.
- */
- float groundImpactShakeFalloff;
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /*!
- @brief Specifies the type of physics used by the player.
- This depends on the physics module used. An example is 'Capsule'.
- @note Not current used.
- */
- string physicsPlayerType;
- /// @}
- /*!
- @brief Frequency of the camera shake effect after falling.
- This is how fast to shake the camera.
- */
- string bloodEmitterTypeName;
- /*!
- @brief Falloff factor of the camera shake effect after falling.
- This is how to fade the camera shake over the duration.
- */
- float bloodEmitterDuration;
- /*! @name Shadows
- @{ */
- /*! */
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /*!
- @brief Defines properties for a AI_Animal object.
- @see AI_Animal
- @ingroup gameObjects
- */
- class AI_AnimalData : public PlayerData {
- public:
- /*!
- @brief animal_breed_object_id
- */
- int animal_breed_object_id;
- /*!
- @brief is_two_capsules_physical_body
- */
- bool is_two_capsules_physical_body;
- /*!
- @brief animal_breed_name
- */
- string animal_breed_name;
- /*!
- @brief
- */
- float base_hp;
- /*!
- @brief
- */
- HitDistance fast_hit_distances;
- /*!
- @brief
- */
- float fast_hit_damaging_sector;
- /*!
- @brief
- */
- DamageRandomValue fast_hit_base_speed;
- /*!
- @brief
- */
- HitDistance power_hit_distances;
- /*!
- @brief
- */
- float power_hit_damaging_sector;
- /*!
- @brief
- */
- DamageRandomValue power_hit_base_speed;
- /*!
- @brief
- */
- float power_attack_probability;
- /*!
- @brief
- */
- float walk_animation_speed;
- /*!
- @brief
- */
- float run_animation_speed;
- /*!
- @brief
- */
- float walk_speed;
- /*!
- @brief
- */
- float run_speed;
- /*!
- @brief
- */
- float body_radius;
- /*!
- @brief alertness_range
- */
- EnemyObservingDistance alertness_range;
- /*!
- @brief aggression_range
- */
- EnemyObservingDistance aggression_range;
- /*!
- @brief max_threat
- */
- float alertness_range_max_threat;
- /*!
- @brief memory_duration
- */
- float alertness_range_memory_duration;
- /*!
- @brief max_threat
- */
- float aggression_range_max_threat;
- /*!
- @brief memory_duration
- */
- float aggression_range_memory_duration;
- /*!
- @brief threat_from_damage_per_hit_point
- */
- float threat_from_damage_per_hit_point;
- /*!
- @brief become_alerted_threshold
- */
- TwoValuesThreshold become_alerted_threshold;
- /*!
- @brief become_aggressive_threshold
- */
- TwoValuesThreshold become_aggressive_threshold;
- /*!
- @brief sleep_probab
- */
- float sleep_probab;
- /*!
- @brief eat_probab
- */
- float eat_probab;
- /*!
- @brief stand_probab
- */
- float stand_probab;
- /*!
- @brief walk_probab
- */
- float walk_probab;
- /*!
- @brief run_probab
- */
- float run_probab;
- /*!
- @brief sleep_duration_min
- */
- int sleep_duration_min;
- /*!
- @brief sleep_duration_max
- */
- int sleep_duration_max;
- /*!
- @brief non_sleep_action_duration_max
- */
- int non_sleep_action_duration_max;
- /*!
- @brief traveling_distance_min
- */
- float traveling_distance_min;
- /*!
- @brief traveling_distance_max
- */
- float traveling_distance_max;
- /*!
- @brief
- */
- float flee_mode__distance_to_enemy_min;
- /*!
- @brief
- */
- DistanceRandomValue flee_order__distance;
- /*!
- @brief
- */
- float flee_mode__threat_afteraction_duration;
- /*!
- @brief
- */
- string sound_files_prefix;
- /*! @name Camera
- @{ */
- /*! */
- /// @}
- /*! @name Movement
- @{ */
- /*! */
- /// @}
- /*! @name Movement: Jumping
- @{ */
- /*! */
- /// @}
- /*! @name Movement: Swimming
- @{ */
- /*! */
- /// @}
- /*! @name Falling
- @{ */
- /*! */
- /// @}
- /*! @name Collision
- @{ */
- /*! */
- /// @}
- /*! @name Interaction: Footsteps
- @{ */
- /*! */
- /// @}
- /*! @name Interaction: Sounds
- @{ */
- /*! */
- /// @}
- /*! @name Interaction: Splashes
- @{ */
- /*! */
- /// @}
- /*! @name Interaction: Ground Impact
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Shadows
- @{ */
- /*! */
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AurochsCowData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class mutton_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MuttonData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class moose_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MooseData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wolf_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WolfData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HindData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class hare_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class hare_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class hare_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class hare_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HareData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class grouse_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class grouse_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class grouse_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class grouse_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GrouseData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class wildhorse_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WildHorseData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SowData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class boar_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BoarData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class bear_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BearData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class aurochs_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AurochsBullData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_sleep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_threatened : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_roar : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_death : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_stagger : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_attackfast : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_attackpower : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_run : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class deer_walk : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DeerMaleData : public AI_AnimalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Audio_bear_attackfast : public SFXDescription {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Audio_animal_default_looped : public SFXDescription {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Audio_animal_default : public SFXDescription {
- public:
- };
- /*!
- @brief Base properties shared by all Vehicles (FlyingVehicle, HoverVehicle, WheeledVehicle.
- This datablock defines properties shared by all Vehicle types, but should not be instantiated directly. Instead, set the desired properties in the FlyingVehicleData, HoverVehicleData or WheeledVehicleData datablock.
- @ingroup Vehicles
- */
- class VehicleData : public ShapeBaseData {
- public:
- /*! Called when the vehicle enters liquid.
- @param obj the Vehicle object
- @param coverage percentage of the vehicle's bounding box covered by the liquid
- @param type type of liquid the vehicle has entered
- */
- void onEnterLiquid( Vehicle obj, float coverage, string type );
- /*! Called when the vehicle leaves liquid.
- @param obj the Vehicle object
- @param type type of liquid the vehicle has left
- */
- void onLeaveLiquid( Vehicle obj, string type );
- /*!
- Defines the vehicle's center of mass (offset from the origin of the model).
- */
- Point3F massCenter;
- /*!
- Define the box used to estimate the vehicle's moment of inertia.
- Currently only used by WheeledVehicle, other vehicle types use a unit sphere to compute inertia.
- */
- Point3F massBox;
- /*!
- Collision 'bounciness'.
- Normally in the range 0 (not bouncy at all) to 1 (100% bounciness).
- */
- float bodyRestitution;
- /*!
- Collision friction coefficient.
- How well this object will slide against objects it collides with.
- */
- float bodyFriction;
- /*!
- Sound to play on a 'soft' impact.
- This sound is played if the impact speed is < hardImpactSpeed and >= softImpactSpeed.
- @see softImpactSpeed
- */
- SFXProfile softImpactSound;
- /*!
- Sound to play on a 'hard' impact.
- This sound is played if the impact speed >= hardImpactSpeed.
- @see hardImpactSpeed
- */
- SFXProfile hardImpactSound;
- /*!
- Minimum collision speed for the onImpact callback to be invoked.
- */
- float minImpactSpeed;
- /*!
- Minimum collision speed for the softImpactSound to be played.
- */
- float softImpactSpeed;
- /*!
- Minimum collision speed for the hardImpactSound to be played.
- */
- float hardImpactSpeed;
- /*!
- Maximum yaw (horizontal) and pitch (vertical) steering angle in radians.
- */
- float maxSteeringAngle;
- /*!
- Maximum height to step up.
- */
- float maxStepHeight;
- /*!
- */
- float jumpSurfaceAngle;
- /*!
- */
- float runSurfaceAngle;
- /*!
- Number of integration steps per tick.
- Increase this to improve simulation stability (also increases simulation processing time).
- */
- int integration;
- /*!
- Minimum distance between objects for them to be considered as colliding.
- */
- float collisionTol;
- /*!
- Maximum relative velocity between objects for collisions to be resolved as contacts.
- Velocities greater than this are handled as collisions.
- */
- float contactTol;
- /*!
- If true, the camera will roll with the vehicle. If false, the camera will always have the positive Z axis as up.
- */
- bool cameraRoll;
- /*!
- How much the camera lags behind the vehicle depending on vehicle speed.
- Increasing this value will make the camera fall further behind the vehicle as it accelerates away.
- @see cameraDecay.
- */
- float cameraLag;
- /*!
- How quickly the camera moves back towards the vehicle when stopped.
- @see cameraLag.
- */
- float cameraDecay;
- /*!
- Vertical (Z axis) height of the camera above the vehicle.
- */
- float cameraOffset;
- /*!
- Dust particle emitter.
- @see triggerDustHeight
- @see dustHeight
- */
- ParticleEmitterData dustEmitter;
- /*!
- Maximum height above surface to emit dust particles.
- If the vehicle is less than triggerDustHeight above a static surface with a material that has 'showDust' set to true, the vehicle will emit particles from the dustEmitter.
- */
- float triggerDustHeight;
- /*!
- Height above ground at which to emit particles from the dustEmitter.
- */
- float dustHeight;
- /*!
- Array of particle emitters used to generate damage (dust, smoke etc) effects.
- @see damageEmitterOffset
- */
- ParticleEmitterData damageEmitter;
- /*!
- "x y z" offsets used to emit particles for each of the active damageEmitters.
- @tsexample
- // damage levels
- damageLevelTolerance[0] = 0.5;
- damageEmitter[0] = SmokeEmitter;
- // emit offsets (used for all active damage level emitters
- damageEmitterOffset[0] = "0.5 3 1";
- damageEmitterOffset[1] = "-0.5 3 1";
- numDmgEmitterAreas = 2;
- @endtsexample
- */
- Point3F damageEmitterOffset;
- /*!
- Damage level (as a percentage of maxDamage) above which to begin emitting particles from the associated damageEmitter.
- @see damageEmitterOffset
- */
- float damageLevelTolerance;
- /*!
- Number of damageEmitterOffset values to use for each damageEmitter.
- @see damageEmitterOffset
- */
- float numDmgEmitterAreas;
- /*!
- Array of particle emitters used to generate splash effects.
- */
- ParticleEmitterData splashEmitter;
- /*!
- Number of splash particles to generate based on vehicle speed.
- This value is multiplied by the current speed to determine how many particles to generate each frame.
- */
- float splashFreqMod;
- /*!
- Minimum speed when moving through water to generate splash particles.
- */
- float splashVelEpsilon;
- /*!
- Minimum velocity when leaving the water for the exitingWater sound to play.
- */
- float exitSplashSoundVelocity;
- /*!
- Minimum velocity when entering the water for the imapactWaterEasy sound to play.
- @see impactWaterEasy
- */
- float softSplashSoundVelocity;
- /*!
- Minimum velocity when entering the water for the imapactWaterMedium sound to play.
- @see impactWaterMedium
- */
- float mediumSplashSoundVelocity;
- /*!
- Minimum velocity when entering the water for the imapactWaterHard sound to play.
- @see impactWaterHard
- */
- float hardSplashSoundVelocity;
- /*!
- Sound to play when exiting the water.
- */
- SFXProfile exitingWater;
- /*!
- Sound to play when entering the water with speed >= softSplashSoundVelocity and < mediumSplashSoundVelocity.
- */
- SFXProfile impactWaterEasy;
- /*!
- Sound to play when entering the water with speed >= mediumSplashSoundVelocity and < hardSplashSoundVelocity.
- */
- SFXProfile impactWaterMedium;
- /*!
- Sound to play when entering the water with speed >= hardSplashSoundVelocity.
- */
- SFXProfile impactWaterHard;
- /*!
- Looping sound to play while moving through the water.
- */
- SFXProfile waterWakeSound;
- /*!
- */
- Point3F physicsBoxSize;
- /*! @name Shadows
- @{ */
- /*! */
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- class HorseData : public VehicleData {
- public:
- /*! @name Shadows
- @{ */
- /*! */
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- /*! @name Basic horse
- @{ */
- /*! */
- /*!
- */
- int objectTypeId;
- /*!
- */
- float pickupRadius;
- /*!
- */
- Point3F boundingBox;
- /*!
- */
- float velocityNeededRelaxForce;
- /*!
- */
- int jumpDelay;
- /*!
- */
- float jumpEnergyDrain;
- /*!
- */
- float minJumpSpeed;
- /*!
- */
- float maxJumpSpeed;
- /*!
- */
- float jumpForce;
- /*!
- */
- float runBackForce;
- /// @}
- /*! @name LiF Additions
- @{ */
- /*! */
- /*!
- */
- float minSpeed;
- /*!
- */
- float maxSpeed;
- /*!
- */
- float maxAcceleration;
- /*!
- */
- float angleSpeed;
- /*!
- */
- float walk2trot;
- /*!
- */
- float trot2walk;
- /*!
- */
- float trot2gallop;
- /*!
- */
- float gallop2trot;
- /*!
- */
- float carryWeight;
- /*!
- */
- float HP;
- /*!
- */
- float HPRegen;
- /*!
- */
- float stamina;
- /*!
- */
- float staminaRegen;
- /*!
- */
- float collisionStopSpeed;
- /*!
- */
- float collisionHindLegsSpeed;
- /*!
- */
- float skillTravelDistance;
- /*!
- */
- int skillIdTraveller;
- /*!
- */
- char speedLevelCount;
- /*!
- */
- float speedLevels;
- /// @}
- /*!
- */
- float maxSideSpeed;
- /*!
- */
- float maxDownSpeed;
- /*!
- */
- float maxUnderwaterForwardSpeed;
- /*!
- */
- float maxUnderwaterBackwardSpeed;
- /*!
- */
- float maxUnderwaterSideSpeed;
- /*!
- */
- float velocityForwardLossCoef;
- /*!
- */
- float velocitySideLossCoef;
- /*!
- */
- float velocityUpLossCoef;
- /*!
- */
- float velocityAngleLossCoef;
- /*!
- */
- float steeringForceKoef;
- /*!
- */
- float steeringForce;
- /*!
- */
- float steeringDamping;
- /*!
- */
- float horizMaxSpeed;
- /*!
- */
- float horizResistSpeed;
- /*!
- */
- float horizResistFactor;
- /*!
- */
- float mUpMaxSpeed;
- /*!
- */
- float mUpResistSpeed;
- /*!
- */
- float mUpResistFactor;
- /*!
- */
- float toPlayerMinDamageVelocity;
- /*!
- */
- float toPlayerDamageCoef;
- /*!
- */
- float toPlayerKickCoef;
- /*!
- */
- float toPlayerKickUp;
- /*!
- */
- string visibleMesh;
- /*!
- */
- string allowedSkins;
- /*!
- */
- float criticalWaterCoverage;
- /*!
- */
- float hindlegsWaterCoverage;
- /*!
- */
- int hindlegsWaterCoverageTimeout;
- /*!
- */
- int minimalLevel;
- /*!
- */
- string stepSoundsDir;
- /*!
- */
- string stepSoundsGeneralName;
- /*!
- */
- int stepSoundsStartingId;
- /*!
- */
- string stepSoundsDescription;
- /*!
- */
- DecalData DecalData;
- /*!
- */
- string footNodeName;
- /*!
- */
- string sounds;
- /*!
- */
- ParticleEmitterData footPuffEmitter;
- /*!
- */
- int footPuffNumParts;
- /*!
- */
- float footPuffRadius;
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Steed : public HorseData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseHeavyWarhorse : public Steed {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseSpiritedWarhorse : public Steed {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseHardyWarhorse : public Steed {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseSimpleWarhorse : public Steed {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseRidingFemale : public Steed {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_water04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_water03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_water02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_water01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_soil01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_snow04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_snow03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_snow02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_snow01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_sand01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_gallop_rock01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_water04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_water03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_water02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_water01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_soil01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_snow04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_snow03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_snow02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_snow01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_sand01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_trot_rock01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_water04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_water03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_water02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_water01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_soil01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_snow04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_snow03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_snow02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_snow01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_sand01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock08 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock07 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock06 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock05 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_horse_walk_rock01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseRiding : public Steed {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseFootprint : public DecalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseAudioLoop : public SFXDescription {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HorseAudio : public SFXDescription {
- public:
- };
- /*!
- @brief A datablock that describes a camera.
- @tsexample
- datablock CameraData(Observer)
- {
- mode = "Observer";
- };
- @endtsexample
- @see Camera
- @ref Datablock_Networking
- @ingroup BaseCamera
- @ingroup Datablocks
- */
- class CameraData : public ShapeBaseData {
- public:
- /*! @name Shadows
- @{ */
- /*! */
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Observer : public CameraData {
- public:
- };
- class Armor : public PlayerData {
- public:
- virtual Script onDamage(( string this, string obj, string delta )) {}
- virtual Script onDisabled(( string this, string obj, string state )) {}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerFemaleData : public Armor {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerMaleData : public Armor {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_building04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_building03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_building02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_building01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_water04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_water03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_water02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_water01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_soil04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_soil03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_soil02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_soil01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_snow02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_snow01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_sand04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_sand03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_sand02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_sand01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_rock04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_rock03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_rock02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class footstep_human_rock01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_heavyarmoured_run02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_heavyarmoured_run01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_armoured_run02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_armoured_run01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_naked_run02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_naked_run01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_heavyarmoured_walk04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_heavyarmoured_walk03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_heavyarmoured_walk02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_heavyarmoured_walk01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_armoured_walk04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_armoured_walk03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_armoured_walk02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_armoured_walk01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_naked_walk04 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_naked_walk03 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_naked_walk02 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Player_naked_walk01 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DefaultPlayerData : public Armor {
- public:
- };
- /*!
- @brief Stores properties for an individual debris type.
- DebrisData defines the base properties for a Debris object. Typically you'll want a Debris object to consist of a shape and possibly up to two particle emitters. The DebrisData datablock provides the definition for these items, along with physical properties and how a Debris object will react to other game objects, such as water and terrain.
- @tsexample
- datablock DebrisData(GrenadeDebris)
- {
- shapeFile = "art/shapes/weapons/ramrifle/debris.dts";
- emitters[0] = GrenadeDebrisFireEmitter;
- elasticity = 0.4;
- friction = 0.25;
- numBounces = 3;
- bounceVariance = 1;
- explodeOnMaxBounce = false;
- staticOnMaxBounce = false;
- snapOnMaxBounce = false;
- minSpinSpeed = 200;
- maxSpinSpeed = 600;
- lifetime = 4;
- lifetimeVariance = 1.5;
- velocity = 15;
- velocityVariance = 5;
- fade = true;
- useRadiusMass = true;
- baseRadius = 0.3;
- gravModifier = 1.0;
- terminalVelocity = 20;
- ignoreWater = false;
- };
- @endtsexample
- @see Debris
- @ingroup FX
- */
- class DebrisData : public GameBaseData {
- public:
- /*! @name Display
- @{ */
- /*! */
- /*!
- @brief Texture imagemap to use for this debris object.
- Not used any more.
- */
- string texture;
- /*!
- @brief Object model to use for this debris object.
- This shape is optional. You could have Debris made up of only particles.
- */
- filename shapeFile;
- /// @}
- /*! @name Datablocks
- @{ */
- /*! */
- /*!
- @brief List of particle emitters to spawn along with this debris object.
- These are optional. You could have Debris made up of only a shape.
- */
- ParticleEmitterData emitters;
- /*!
- @brief ExplosionData to spawn along with this debris object.
- This is optional as not all Debris explode.
- */
- ExplosionData Explosion;
- /// @}
- /*! @name Physical Properties
- @{ */
- /*! */
- /*!
- @brief A floating-point value specifying how 'bouncy' this object is.
- Must be in the range of -10 to 10.
- */
- float elasticity;
- /*!
- @brief A floating-point value specifying how much velocity is lost to impact and sliding friction.
- Must be in the range of -10 to 10.
- */
- float friction;
- /*!
- @brief How many times to allow this debris object to bounce until it either explodes, becomes static or snaps (defined in explodeOnMaxBounce, staticOnMaxBounce, snapOnMaxBounce).
- Must be within the range of 0 to 10000.
- @see bounceVariance
- */
- int numBounces;
- /*!
- @brief Allowed variance in the value of numBounces.
- Must be less than numBounces.
- @see numBounces
- */
- int bounceVariance;
- /*!
- @brief Minimum speed that this debris object will rotate.
- Must be in the range of -10000 to 1000, and must be less than maxSpinSpeed.
- @see maxSpinSpeed
- */
- float minSpinSpeed;
- /*!
- @brief Maximum speed that this debris object will rotate.
- Must be in the range of -10000 to 10000.
- @see minSpinSpeed
- */
- float maxSpinSpeed;
- /*!
- How much gravity affects debris.
- */
- float gravModifier;
- /*!
- Max velocity magnitude.
- */
- float terminalVelocity;
- /*!
- @brief Speed at which this debris object will move.
- @see velocityVariance
- */
- float velocity;
- /*!
- @brief Allowed variance in the value of velocity
- Must be less than velocity.
- @see velocity
- */
- float velocityVariance;
- /*!
- @brief Amount of time until this debris object is destroyed.
- Must be in the range of 0 to 1000.
- @see lifetimeVariance
- */
- float lifetime;
- /*!
- @brief Allowed variance in the value of lifetime.
- Must be less than lifetime.
- @see lifetime
- */
- float lifetimeVariance;
- /*!
- @brief Use mass calculations based on radius.
- Allows for the adjustment of elasticity and friction based on the Debris size.
- @see baseRadius
- */
- bool useRadiusMass;
- /*!
- @brief Radius at which the standard elasticity and friction apply.
- Only used when useRaduisMass is true.
- @see useRadiusMass.
- */
- float baseRadius;
- /// @}
- /*! @name Behavior
- @{ */
- /*! */
- /*!
- @brief If true, this debris object will explode after it has bounced max times.
- Be sure to provide an ExplosionData datablock for this to take effect.
- @see explosion
- */
- bool explodeOnMaxBounce;
- /*!
- If true, this debris object becomes static after it has bounced max times.
- */
- bool staticOnMaxBounce;
- /*!
- If true, this debris object will snap into a resting position on the last bounce.
- */
- bool snapOnMaxBounce;
- /*!
- @brief If true, this debris object will fade out when destroyed.
- This fade occurs over the last second of the Debris' lifetime.
- */
- bool fade;
- /*!
- If true, this debris object will not collide with water, acting as if the water is not there.
- */
- bool ignoreWater;
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerDebris : public DebrisData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DecalDataSet : public SimSet {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerFootprint : public DecalData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LiftoffDustEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LiftoffDust : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LightPuffEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LightPuff : public ParticleData {
- public:
- };
- /*!
- @brief Acts as the physical point in space in white a Splash is created from.
- @ingroup FX
- */
- class SplashData : public GameBaseData {
- public:
- /*!
- SFXProfile effect to play.
- */
- SFXProfile soundProfile;
- /*!
- The scale of this splashing effect, defined as the F32 points X, Y, Z.
- */
- Point3F scale;
- /*!
- List of particle emitters to create at the point of this Splash effect.
- */
- ParticleEmitterData emitter;
- /*!
- Time to delay, in milliseconds, before actually starting this effect.
- */
- int delayMS;
- /*!
- Time variance for delayMS.
- */
- int delayVariance;
- /*!
- Lifetime for this effect, in milliseconds.
- */
- int lifetimeMS;
- /*!
- Time variance for lifetimeMS.
- */
- int lifetimeVariance;
- /*!
- Width for the X and Y coordinates to create this effect within.
- */
- float width;
- /*!
- Number of ejection points in the splash ring.
- */
- int numSegments;
- /*!
- Velocity for the splash effect to travel.
- */
- float velocity;
- /*!
- Height for the splash to reach.
- */
- float height;
- /*!
- Constant acceleration value to place upon the splash effect.
- */
- float acceleration;
- /*!
- Times to transition through the splash effect. Up to 4 allowed. Values are 0.0 - 1.0, and corrispond to the life of the particle where 0 is first created and 1 is end of lifespace.
- */
- float times;
- /*!
- Color values to set the splash effect, rgba. Up to 4 allowed. Will transition through colors based on values set in the times value. Example: colors[0] = "0.6 1.0 1.0 0.5".
- */
- ColorF colors;
- /*!
- Imagemap file to use as the texture for the splash effect.
- */
- filename texture;
- /*!
- Amount to wrap the texture around the splash ring, 0.0f - 1.0f.
- */
- float texWrap;
- /*!
- Factor in which to apply the texture to the splash ring, 0.0f - 1.0f.
- */
- float texFactor;
- /*!
- Frequency in which to emit splash rings.
- */
- float ejectionFreq;
- /*!
- Rotational angle to create a splash ring.
- */
- float ejectionAngle;
- /*!
- Lifetime, in milliseconds, for a splash ring.
- */
- float ringLifetime;
- /*!
- Starting radius size of a splash ring.
- */
- float startRadius;
- /*!
- ExplosionData object to create at the creation position of this splash effect.
- */
- ExplosionData Explosion;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerSplash : public SplashData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerSplashEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerSplashParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerWakeEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerWakeParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerFoamDropletsEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerFoamDropletsParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerFoamEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerFoamParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerBubbleEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerBubbleParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerSplashMistEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PlayerSplashMist : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HumanAudio : public SFXDescription {
- public:
- };
- class ArrowData : public ShapeBaseImageData {
- public:
- /*!
- */
- float upForce;
- /*!
- */
- float friction;
- /*!
- */
- ShapeBaseImageData loadedAmmo;
- /*!
- */
- ExplosionProjectileData ExplosionData;
- /*!
- */
- int stuckArrowLifeTime;
- /*!
- */
- filename projectileShape;
- /*!
- */
- SFXTrack sound;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BarrelAmmo : public ArrowData {
- public:
- };
- class ExplosionProjectileData : public ShapeBaseImageData {
- public:
- /*!
- */
- int rayNum;
- /*!
- */
- float radius;
- /*!
- */
- float damage;
- /*!
- */
- string emitters;
- /*!
- */
- SFXTrack sound;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BarrelExplosion : public ExplosionProjectileData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BarrelAmmoLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegeStoneAmmo : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegeStoneAmmoLoaded : public ShapeBaseImageData {
- public:
- };
- class SiegeWeaponStaticShapeData : public StaticShapeData {
- public:
- /*! @name Shadows
- @{ */
- /*! */
- /// @}
- /*! @name Render
- @{ */
- /*! */
- /// @}
- /*! @name Destruction
- Parameters related to the destruction effects of this object.
- @{ */
- /*! */
- /// @}
- /*! @name Physics
- @{ */
- /*! */
- /// @}
- /*! @name Damage/Energy
- @{ */
- /*! */
- /// @}
- /*! @name Camera
- The settings used by the shape when it is the camera.
- @{ */
- /*! */
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- /*!
- */
- int Object_typeID;
- /*!
- */
- float MaxAccuracy;
- /*!
- */
- float Emax;
- /*!
- */
- float BasePrefireAnimTime;
- /*!
- */
- float BaseRecoilAnimTime;
- /*!
- */
- float IntNeed;
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TrebuchetData : public SiegeWeaponStaticShapeData {
- public:
- };
- class ThrowingWeaponData : public ShapeBaseImageData {
- public:
- /*!
- */
- float upForce;
- /*!
- */
- float friction;
- /*!
- */
- ArrowData projectileData;
- /*!
- */
- int stuckArrowLifeTime;
- /*!
- */
- filename projectileShape;
- /*!
- */
- SFXTrack sound;
- /*!
- */
- float AgilityNeed;
- /*!
- */
- float MaxAccuracy;
- /*!
- */
- float StrengthNeed;
- /*!
- */
- float Emax;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingPot : public ThrowingWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingPotProjectile : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PotExplosion : public ExplosionProjectileData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingAxe : public ThrowingWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingAxeProjectile : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingJavelin : public ThrowingWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingJavelinProjectile : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingKnife : public ThrowingWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingKnifeProjectile : public ArrowData {
- public:
- };
- class RangedWeaponData : public ShapeBaseImageData {
- public:
- /*!
- */
- float AgilityNeed;
- /*!
- */
- float MaxAccuracy;
- /*!
- */
- intList allowedAmmoIDs;
- /*!
- */
- float StrengthNeed;
- /*!
- */
- float Emax;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Sling : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HeavyCrossbow : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Arbalest : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LightCrossbow : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LongBow : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ShortBow : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SimpleBow : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CompositeBow : public RangedWeaponData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SlingStone : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SlingStoneLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DullBolt : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DullBoltLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StandBolt : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StandBoltLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HeavyBolt : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HeavyBoltLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DullArrow : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DullArrowLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StandArrow : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class StandArrowLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BroadheadArrow : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BroadheadLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BodkinArrow : public ArrowData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BodkinArrowLoaded : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WeaponImage : public ShapeBaseImageData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HandOfIlyas : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HandOfBoris : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Torch : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_Fishing_Pole : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Cow_Horns : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Bull_Horns : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Mutton_Horns : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Sow_Tusk : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Boar_Tusk : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Moose_Hoof : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Wolf_Fang : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Hind_Hoof : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Deer_Hoof : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Wild_Horse_Hoof : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Bear_Paw : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Glassblower_toolkit : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Skinning_knife : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Knife : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_Knife : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Cooking_Pot : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_Cooking_Pot : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HeavyTarge : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Sickle : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_Sickle : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class CrucibleandTongs : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_CrucibleandStick : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Saw : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_Saw : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Hatchet : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_Axe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Fishing_Pole : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Mallet : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Smiths_Hammer : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_hammer : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Hardened_steel_pickaxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Pickaxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_pickaxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitive_shovel : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Shovel : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Pavise : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Towershield : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Kiteshield : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Heatershield : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Bucklershield : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Primitiveshield : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Targeshield : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class JoustingLance : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Lance : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LongPike : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MediumPike : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ShortPike : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BecdeCorbin : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AwlPike : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BoarSpear : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Spear : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Staff : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Partisan : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Pitchfork : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WarScythe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Guisarme : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Glaive : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PracticeMaul : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Maul : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SledgeHammer : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BroadAxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Bardiche : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Pollaxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PracticeGreataxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Flamberge : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Zweihaender : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Claymore : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PracticeLongsword : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WarPick : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Cudgel : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FlangedMace : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MorningStar : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NordicAxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BattleAxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WarAxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PracticeAxe : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GrossMesser : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BigFalchion : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BastardSword : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Estoc : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PracticeBastard : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Falchion : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Scimitar : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LightSaber : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class KnightSword : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NordicSword : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class PracticeSword : public WeaponImage {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Dust_from_building_construction : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Dust_from_building_construction_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Building_destruction_element : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Building_destruction_element_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Building_destruction_dust2 : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Building_destruction_dust2_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Building_destruction_dust1 : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Building_destruction_dust1_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_smoke_small : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_fire_small : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_elements_of_dirt_small : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_fire : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_smoke : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_elements_of_dirt : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_smoke_small_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_fire_small_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_elements_of_dirt_small_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_fire_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_smoke_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class Explosion_elements_of_dirt_particle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SparksOfTorchEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SmokeOfTorchEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireOfTorchEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SparksOfTorchParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SmokeOfTorchParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireOfTorchParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TerFallEmitterLiF : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TerFallParticleLiF : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SparksEmitter : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FootstepPoofEmitterLiF2Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FootstepPoofEmitterLiF1Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodEmitterLiF4Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodEmitterLiF3Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodEmitterLiF2Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodEmitterLiF1Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SmokeEmitterLiF1Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SmokeEmitterLiF2Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireEmitterLiF5Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireEmitterLiF3Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireEmitterLiF2Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireEmitterLiF1Z : public ParticleEmitterData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SparksParticle : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FootstepPoofParticleLiF2Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FootstepPoofParticleLiF1Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DustParticleLiF5Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF15Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF14Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF13Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF12Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF11Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF10Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF9Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF8Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF7Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF6Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF5Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF4Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF3Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF2Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BloodParticleLiF1Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TorchFireParticleLiF4Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TorchFireParticleLiF3Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TorchFireParticleLiF2Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TorchFireParticleLiF1Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireParticleLiF5Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireParticleLiF4Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireParticleLiF3Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireParticleLiF2Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class FireParticleLiF1Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SmokeParticleLiF1Z : public ParticleData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SmokeParticleLiF2Z : public ParticleData {
- public:
- };
- /*!
- @brief Contains the timeMuliplier information to be assigned to a ParticleEmitterNode.
- The time multiplayer value for the ParticleEmitterNodeData can be set with %nodeData.timeMultiple = %value;
- @ingroup FX
- */
- class ParticleEmitterNodeData : public GameBaseData {
- public:
- /*!
- Time multiplier for particle emitter nodes.
- */
- float timeMultiple;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LiFEmitterNodeData : public ParticleEmitterNodeData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TorchFireSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WagonSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WheelSound : public SFXDescription {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_smithing : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_smelting : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_pray : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_perform : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_treecut : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_fishing : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_eat : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_drink : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_mine : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_nail : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_mow : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_plow : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_saw : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_build : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_dig : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_equip : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class player_cooking : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_wine_press : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_windmill : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_watermill : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_water_wave : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_water_hum : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_water_bird : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_warehouse_large : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_warehouse : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_underground_tap : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_underground_rumble : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_underground_loop : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_underground_fire : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_thunder : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_tanning_tub : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_swamp_water_loop : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_swamp_water : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_swamp_insect : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_swamp_toad : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_swamp_frog : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_swamp_bubble : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_swamp_bird : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_noise : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_wind : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_breeze : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_lark : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_crow : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_grass_rustle : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_cricket : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_bird_fly : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_bee : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_grasshopper : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_steppe_insect : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_stable_horse : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_stable_small : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_stable : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_spinning_wheel : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_snowfall : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_snow_wind : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_snow_crackle : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_snow_bird : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_ruins : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_rainfall : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_outdoor_loop_night : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_outdoor_loop_day : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_mountains_wind : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_mountains_debris2 : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_mountains_debris : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_mountains_bird : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_indoor_noise : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_indoor_loop_night : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_indoor_loop_day : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_fountain : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_forge : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_forest_rustle : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_forest_insect : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_forest_creak : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_forest_pecker : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_forest_owl : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_forest_bird : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_fire_small : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_fire_oven : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_fire_medium : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_fire : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_desert_wind : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_desert_noise : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_desert_sand_debris : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_coop_cock : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_coop : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_cauldron : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_bloomery : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_beehive : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_barn_sheep : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_barn_cow : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class env_barn : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class EnvFireSmallSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HareDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class GrouseDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class AurochsDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MuttonDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BoarDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class MooseDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WolfDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DeerDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class WildHorseDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BearDeathSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TerFallSound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class horse_move_gallop_armoured : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class horse_move_gallop_naked : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class horse_move_trot_armoured : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class horse_move_trot_naked : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class horse_move_walk_armoured : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class horse_move_walk_naked : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class TrebuchetShot : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BigGrenadeExplosion : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SmallGrenadeExplosion : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SiegeFlySound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThrowingFlySound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class BoltFlySound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ArrowFlySound : public SFXProfile {
- public:
- };
- /*!
- @brief Defines shared properties for Trigger objects.
- The primary focus of the TriggerData datablock is the callbacks it provides when an object is within or leaves the Trigger bounds.
- @see Trigger.
- @ingroup gameObjects
- @ingroup Datablocks
- */
- class TriggerData : public GameBaseData {
- public:
- /*! @brief Called when an object enters the volume of the Trigger instance using this TriggerData.
- @param trigger the Trigger instance whose volume the object entered
- @param obj the object that entered the volume of the Trigger instance
- */
- void onEnterTrigger( Trigger trigger, GameBase obj );
- /*! @brief Called every tickPeriodMS number of milliseconds (as specified in the TriggerData) whenever one or more objects are inside the volume of the trigger.
- The Trigger has methods to retrieve the objects that are within the Trigger's bounds if you want to do something with them in this callback.
- @param trigger the Trigger instance whose volume the object is inside
- @see tickPeriodMS
- @see Trigger::getNumObjects()
- @see Trigger::getObject()
- */
- void onTickTrigger( Trigger trigger );
- /*! @brief Called when an object leaves the volume of the Trigger instance using this TriggerData.
- @param trigger the Trigger instance whose volume the object left
- @param obj the object that left the volume of the Trigger instance
- */
- void onLeaveTrigger( Trigger trigger, GameBase obj );
- /*! @name Callbacks
- @{ */
- /*! */
- /*!
- @brief Time in milliseconds between calls to onTickTrigger() while at least one object is within a Trigger's bounds.
- @see onTickTrigger()
- */
- int tickPeriodMS;
- /*!
- Forces Trigger callbacks to only be called on clients.
- */
- bool clientSide;
- /// @}
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ClientTrigger : public TriggerData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class DefaultTrigger : public TriggerData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThunderCrash4Sound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThunderCrash3Sound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThunderCrash2Sound : public SFXProfile {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class ThunderCrash1Sound : public SFXProfile {
- public:
- };
- /*!
- @brief Defines the droplets used in a storm (IE: raindrops, snowflakes, etc.).
- @tsexample
- datablock PrecipitationData(HeavyRain)
- {
- soundProfile = "HeavyRainSound";
- dropTexture = "art/environment/precipitation/rain";
- splashTexture = "art/environment/precipitation/water_splash";
- dropSize = 0.35;
- splashSize = 0.1;
- useTrueBillboards = false;
- splashMS = 500;
- };
- @endtsexample
- @ingroup FX
- */
- class PrecipitationData : public GameBaseData {
- public:
- /*!
- SFXProfile effect to play.
- */
- SFXTrack soundProfile;
- /*!
- Texture filename for drop particles.
- */
- filename dropTexture;
- /*!
- The name of the shader used for raindrops.
- */
- string dropShader;
- /*!
- Texture filename for splash particles.
- */
- filename splashTexture;
- /*!
- The name of the shader used for raindrops.
- */
- string splashShader;
- /*!
- How many drops are on a side of the raindrop texture.
- */
- int dropsPerSide;
- /*!
- How many splash are on a side of the splash texture.
- */
- int splashesPerSide;
- /*! @name Scripting
- @{ */
- /*! */
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HeavyRain : public PrecipitationData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class HeavyRainSound : public SFXProfile {
- public:
- };
- /*!
- @brief Defines a light flare effect usable by scene lights.
- %LightFlareData is a datablock which defines a type of flare effect. This may then be referenced by other classes which support the rendering of a flare: Sun, ScatterSky, LightBase.
- A flare contains one or more elements defined in the element* named fields of %LightFlareData, with a maximum of ten elements. Each element is rendered as a 2D sprite in screenspace.
- @tsexample
- // example from Full Template, core/art/datablocks/lights.cs
- datablock LightFlareData( LightFlareExample0 )
- {
- overallScale = 2.0;
- flareEnabled = true;
- renderReflectPass = true;
- flareTexture = "./../special/lensFlareSheet1";
- occlusionRadius = 0.25;
- elementRect[0] = "0 512 512 512";
- elementDist[0] = 0.0;
- elementScale[0] = 0.5;
- elementTint[0] = "1.0 1.0 1.0";
- elementRotate[0] = false;
- elementUseLightColor[0] = false;
- elementRect[1] = "512 0 512 512";
- elementDist[1] = 0.0;
- elementScale[1] = 2.0;
- elementTint[1] = "0.5 0.5 0.5";
- elementRotate[1] = false;
- elementUseLightColor[1] = false;
- };
- @endtsexample
- The elementDist field defines where along the flare's beam the element appears. A distance of 0.0 is directly over the light source, a distance of 1.0 is at the screen center, and a distance of 2.0 is at the position of the light source mirrored across the screen center.
- @image html images/lightFlareData_diagram.png
- */
- class LightFlareData : public SimDataBlock {
- public:
- /*! Intended as a helper to developers and editor scripts.
- Force trigger an inspectPostApply */
- virtual void apply(()) {}
- /*! @name LightFlareData
- @{ */
- /*! */
- /*!
- Size scale applied to all elements of the flare.
- */
- float overallScale;
- /*!
- If positive an occlusion query is used to test flare visibility, else it uses simple raycasts.
- */
- float occlusionRadius;
- /*!
- If false the flare does not render in reflections, else only non-zero distance elements are rendered.
- */
- bool renderReflectPass;
- /// @}
- /*! @name FlareElements
- @{ */
- /*! */
- /*!
- Allows the user to disable this flare globally for any lights referencing it.
- */
- bool flareEnabled;
- /*!
- The texture / sprite sheet for this flare.
- */
- filename flareTexture;
- /*!
- A rectangle specified in pixels of the flareTexture image.
- */
- RectF elementRect;
- /*!
- Where this element appears along the flare beam.
- */
- float elementDist;
- /*!
- Size scale applied to this element.
- */
- float elementScale;
- /*!
- Used to modulate this element's color if elementUseLightColor is false.
- @see elementUseLightColor
- */
- ColorF elementTint;
- /*!
- Defines if this element orients to point along the flare beam or if it is always upright.
- */
- bool elementRotate;
- /*!
- If true this element's color is modulated by the light color. If false, elementTint will be used.
- @see elementTint
- */
- bool elementUseLightColor;
- /// @}
- /*! @name Ungrouped
- @{ */
- /*! */
- /// @}
- /*! @name Object
- @{ */
- /*! */
- /// @}
- /*! @name Editing
- @{ */
- /*! */
- /// @}
- /*! @name Persistence
- @{ */
- /*! */
- /// @}
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LightFlareExample2 : public LightFlareData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LightFlareExample1 : public LightFlareData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class LightFlareExample0 : public LightFlareData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SunFlarePacificIsland : public LightFlareData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SunFlareExample3 : public LightFlareData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SunFlareExample2 : public LightFlareData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class SunFlareExample : public LightFlareData {
- public:
- };
- /// Stub class
- ///
- /// @note This is a stub class to ensure a proper class hierarchy. No
- /// information was available for this class.
- class NullLightFlare : public LightFlareData {
- public:
- };
Add Comment
Please, Sign In to add comment