SaveAction class | actions.t[248]

Special "save" action. This command saves the current game state to an external file for later restoration.

`DefineAction(Save, FileOpAction) // original source text`
`class SaveAction : FileOpAction // after macro expansion`

Superclass Tree (in declaration order)

`SaveAction`
`FileOpAction`
`SystemAction`
`IAction`
`Action`
`BasicProd`
`object`

Subclass Tree

`SaveAction`
`predicate(Save)`
`SaveStringAction`
`predicate(SaveString)`

Global Objects

(none)

Summary of Properties

`fileDisposition filePromptMsg fileTypeID includeInUndo isRepeatable`

Inherited from `FileOpAction` :
`showCancelMsg`

Inherited from `SystemAction` :
`actionTime`

``

Inherited from `Action` :
`afterActionMainList beforeAfterObjs defaultForRecursion extraMessageParams implicitMsg isImplicit iterationCanceled originalAction parentAction preCond predicateNounPhrases pronounOverride remappedFrom showDefaultReports synthParamID verbFlags verifiedOkay`

Inherited from `BasicProd` :
`isSpecialResponseMatch`

Summary of Methods

`performFileOp showCancelMsg`

Inherited from `FileOpAction` :
`execSystemAction setUpFileOp`

Inherited from `SystemAction` :
`execAction getInputFile`

Inherited from `IAction` :
`doActionMain resolveNouns`

Inherited from `Action` :
`actionOfKind addBeforeAfterObj afterAction afterActionMain announceActionObject announceAllDefaultObjects announceDefaultObject beforeAction beforeActionMain cacheMultiObjectAnnouncements callAfterActionMain callCatchAllProp callPreConditions callVerifyPreCond callVerifyProp cancelIteration checkAction checkPreConditions checkRemapping combineRemappedVerifyResults createActionFrom createActionInstance createTopicQualifierResolver doAction doActionOnce filterAmbiguousWithVerify filterFacets filterPluralWithVerify finishResolveList getAnaphoricBinding getCurrentObjects getDefaultWithVerify getEnteredVerbPhrase getImplicitPhrase getInfPhrase getMatchForRole getMessageParam getNotifyTable getObjectForRole getObjPreCondDescList getObjPreConditions getObjResponseProd getOriginalAction getOrigTokenList getOtherObjectRole getParticiplePhrase getPreCondDescList getPreCondPropForRole getPredicate getPronounOverride getQuestionInf getRemappedFrom getRemapPropForRole getResolvedObjList getResolveInfo getRoleFromIndex getSimpleSynonymRemap getSortedVerifyResults getVerbPhrase getVerifyPropForRole initTentative isConversational isNestedIn isPartOf isRemapped makeResolveInfo makeResolveInfoList maybeAnnounceDefaultObject maybeAnnounceImplicit maybeAnnounceMultiObject noMatch notifyBeforeAfter objListPronoun preAnnounceActionObject recalcSenseContext repeatAction resetAction resolveAction resolvedObjectsInScope runBeforeNotifiers saveActionForAgain setCurrentObjects setImplicit setMessageParam setMessageParams setNested setObjectMatches setOriginalAction setPronounOverride setRemapped setResolvedObjects spPrefix spSuffix synthMessageParam verifyAction verifyHandlersExist whatObj whatTranslate withVerifyResults zeroActionTime`

Inherited from `BasicProd` :
`canResolveTo getOrigText setOrigTokenList`

Properties

`fileDisposition` OVERRIDDEN | `actions.t[253]`

we're asking for a file to save, or type t3-save

`filePromptMsg` OVERRIDDEN | `actions.t[250]`

the file dialog prompt

`fileTypeID` OVERRIDDEN | `actions.t[254]`

no description available

`includeInUndo` OVERRIDDEN | `actions.t[302]`

Saving has no effect on game state, so it's irrelevant whether or not it's undoable; but it might be confusing to say we undid a "save" command, because the player might think we deleted the saved file. To avoid such confusion, do not include "save" commands in the undo log.

`isRepeatable` OVERRIDDEN | `actions.t[309]`

Don't allow this to be repeated with AGAIN. There's no point in repeating a SAVE immediately, as nothing will have changed in the game state to warrant saving again.

Methods

`performFileOp (fname, ack, desc, :?)`OVERRIDDEN | `actions.t[260]`

perform a save

`showCancelMsg ( )` | `actions.t[257]`

cancel message

TADS 3 Library Manual
Generated on 8/21/2012 from TADS version 3.1.2