Editors::EditorRequest class
#include <Spore ModAPI/Spore/Editors/EditorRequest.h>

This class is used to access the editors.

When you create a new instance of this, you have to set the editorID field to the ID of the editor you want to go to. That is the ID of the configuration file in the editor_setup~ folder. There are some additional properties that control features available in the editor By default, new instances of this class have the properties set to:

sporepediaCanSwitch: false
disableNameEdit: false
allowSporepedia: false
hasSaveButton: false
hasCreateNewButton: false
hasExitButton: false
hasPublishButton: false
hasCancelButton: true

Example usage:

auto request = new EditorRequest();
request->editorID = id("CreatureEditorExtraLarge");
request->allowSporepedia = true;
request->hasSaveButton = true;

EditorRequest::Submit(request);

Base classes

class IRefCounted
class IVirtual: A default interface that provides a virtual destructor, it should only be used internally.

Public static functions

static auto Submit(EditorRequest* request) -> bool: When this method is executed, the given request will be processed and open the editor.

Constructors, destructors, conversion operators

EditorRequest()
~EditorRequest() virtual

Public functions

auto AddRef() -> int override
auto Release() -> int override
auto SetDefaultValidation() -> void

Public variables

uint32_t mEditorName: The ID of the editor, such as 'id("CreatureEditorExtraLarge")'.
ResourceKey mModelKey: You can use this field to preload a creation.
uint32_t mCallingGameModeID
bool mbIsFirstTimeInEditor: If true, display the editor model as a nameless creation.
ContentValidation mEditableTests
bool mbSporepediaCanSwitch: If true, the user can change the editor by selecting a different creation type in the Sporepedia.
bool mbDisableNameEdit: If true, the creation name cannot be edited. False by default.
bool mbAllowSporepedia: If true, the user can edit a creation from the Sporepedia.
bool mShowSaveButton: Whether the "Save" button is shown. False by default.
bool mShowNewButton: Whether the "Create new" button is shown. False by default.
bool mShowExitButton: Whether the "Exit to main menu" and "Exit game" buttons are enabled.
bool mShowPublishButton: Whether the "Publish creation" button is shown.
bool mShowCancelButton: Whether the "Cancel" button is shown. True by default.
bool field_3C
bool field_3D
eastl::string16 field_40
eastl::string16 field_50
float field_60
bool field_64
bool mShowPlayButton: Whether the (unused) "Play" button is shown instead of Accept. False by default.
bool field_66
int field_68
bool field_6C: Sets the "save" button enabled from editor entry.
bool field_6D
bool field_6E
bool field_6F
eastl::vector<uint32_t> mConsequenceTraits: IDs of groupID "ConsequenceTraits" in order from cell to space.
int field_84
int field_88
int field_8C
uint32_t field_90
cCollectableItemsPtr mpCollectableItems: Part unlock data, used to show and hide parts in the editor.
EditorRequestPtr mpNext: Next editor to go to. Used to chain a request for creature + outfitter editors.

Protected variables

int mRefCount

Variable documentation

bool Editors::EditorRequest::mbSporepediaCanSwitch

If true, the user can change the editor by selecting a different creation type in the Sporepedia.

False by default.

bool Editors::EditorRequest::mbAllowSporepedia

If true, the user can edit a creation from the Sporepedia.

If false, clicking the Sporepedia button will show all types of creations, but they won't be editable. False by default.

bool Editors::EditorRequest::mShowExitButton

Whether the "Exit to main menu" and "Exit game" buttons are enabled.

True by default.

bool Editors::EditorRequest::mShowPublishButton

Whether the "Publish creation" button is shown.