FileOpAction

FileOpActionclass

actions.t[2119]

Superclass
Tree Subclass
Tree Global
Objects Property
Summary Method
Summary Property
Details Method
Details

A base class for file-oriented actions, such as SCRIPT, RECORD, and REPLAY. We provide common handling that prompts interactively for a filename; subclasses must override a few methods and properties to carry out the specific subclassed operation on the file.

class FileOpAction : SystemAction

Superclass Tree (in declaration order)

FileOpAction
SystemAction
IAction
Action
ReplaceRedirector
Redirector
object

Subclass Tree

(none)

Global Objects

(none)

Summary of Properties

fileDisposition filePromptMsg fileTypeID includeInUndo isRepeatable showCancelMsg

Inherited from SystemAction :
turnsTaken

Inherited from IAction :
againRepeatsParse

Inherited from Action :
actionFailed allowAll extraMessageParams failCheckMsg isImplicit oldRoom parentAction parentAllowAll preCond redirectParent reportImplicitActions scopeList spellingPriority synthParamID unhides verifyObj wasIlluminated

Summary of Methods

execAction performFileOp setUpFileOp

Inherited from SystemAction :
afterAction exec execCycle getInputFile turnSequence

Inherited from IAction :
execResolvedAction resolvedObjectsInScope scoreObjects setResolvedObjects

Inherited from Action :
acknowledgeNotifyStatus addExtraScopeItems addImplicitTime advanceTime announceObject beforeAction buildImplicitActionAnnouncement buildScopeList checkAction checkActionPreconditions commandNotPresent execGroup getAll getAllUnhidden getMessageParam implicitAnnouncement reportAction setMessageParam setMessageParams spPrefix spSuffix synthMessageParam verify verifyObjRole wrapObjectsNP

Inherited from ReplaceRedirector :
redirect

Inherited from Redirector :
doInstead doNested doOtherAction

Properties

fileDisposition actions.t[2124]

the file dialog open/save type

filePromptMsg actions.t[2121]

our file dialog prompt message

fileTypeID actions.t[2127]

the file dialog type ID

includeInUndoOVERRIDDEN actions.t[2198]

we can't include this in undo, as it affects external files

isRepeatableOVERRIDDEN actions.t[2201]

don't allow repeating with AGAIN

showCancelMsg actions.t[2130]

show our cancellation mesage

Methods

execAction (cmd)OVERRIDDEN actions.t[2150]

Each concrete action subclass must override this to carry out our operation. This is called when the user has successfully selected a filename for the operation.

performFileOp (fname, ack, desc, :?) actions.t[2141]

Carry out our file operation.

'desc' is an optional named argument giving a description string entered by the user via the Save Game dialog. Some versions of the Save Game dialog let the user enter this additional information, which can be stored as part of the saved game metadata.

setUpFileOp (ack) actions.t[2161]

ask for a file, and carry out our operation is we get one

Adv3Lite Library Reference Manual
Generated on 28/03/2016 from adv3Lite version 1.5