Class MemoryRecord

The memoryrecord objects are the entries you see in the addresslist.

Class:

Properties

CurrentAddress:
Active Set to true to activate/freeze, false to deactivate/unfreeze.
Address Get/set the interpretable address string.
AddressString Get the address string shown in CE (ReadOnly).
AllowDecrease Allow value decreasing, unfreeze will reset it to false.
AllowIncrease Allow value increasing, unfreeze will reset it to false.
Async Set to true if activating this entry will be asynchronious.
AsyncProcessing True when async is true and it's being processed.
AsyncProcessingTime The time that it has been processing in milliseconds.
Child [ index ] Array to access the child records.
Collapsed Set to true to collapse this record or false to expand it.
Color
Count Number of children.
CustomTypeName If the type is vtCustom this will contain the name of the CustomType.
Description The description of the memory record.
DisplayAsDropDownListItem Self explanatory.
DontSave Don't save this memoryrecord and it's children.
DropDownCount Equivalent to DropDownList.Count
DropDownDescription [ index ] Array to access Descriptions in DropDownList (ReadOnly).
DropDownDescriptionOnly Self explanatory.
DropDownLinked If dropdown list refers to list of another memory record eg.
DropDownLinkedMemrec Description of linked memrec or emptystring if not linked.
DropDownList List of "value:description" lines, lists are still separate objects when linked, read-write.
DropDownReadOnly true if 'Disallow manual user input' is set.
DropDownValue
FIXME [ index ] Same as Child
Hotkey [] Array to index the hotkeys.
HotkeyCount Number of hotkeys attached to this memory record.
ID Unique ID.
Index The index ID for this record.
IsGroupHeader Set to true if the record was created as a Group Header with no address or value info.
IsReadable Set to false if record contains an unreadable address.
Offset [] Array to access each offset.
OffsetCount The number of offsets.
OffsetText [] Array to access each offset using the interpretable text style.
OnActivate The function to call when the memoryrecord will change (or changed) Active to true.
OnDeactivate The function to call when the memoryrecord will change (or changed) Active to false.
OnDestroy Called when the memoryrecord is destroyed.
OnGetDisplayValue This function gets called when rendering the value of a memory record.
Options A string enclosed by square brackets filled with the options seperated by a comma.
Parent Self explanatory.
Script If the type is vtAutoAssembler this will contain the auto assembler script.
ShowAsHex Self explanatory.
ShowAsSigned Self explanatory.
Value The value in stringform.
VarType The variable type of this record.
Selected:
Type: The variable type of this record.

Methods

appendToEntry ( memrec ) Appends the current memory record to the given memory record.
createHotkey ( keys, action, value ) Returns a hotkey object.
disableWithoutExecute () Sets the entry to disabled without executing the disable section.
getAddress () Returns the interpretable addressstring of this record.
getCurrentAddress () Returns the current address as an integer.
getDescription ()
getHotkey ( index ) Returns the hotkey from the hotkey array.
getHotkeyByID ( id ) Returns the hotkey with the given id.
getOffset ( index ) Gets the offset at the given index.
getOffsetCount () Returns the number of offsets for this memoryrecord.
reinterpret ()
setAddress ( address ) Sets the interpretable address string, and if offsets are provided make it a pointer.
setDescription ()
setOffset ( index, value ) Sets the offset at the given index.
setOffsetCount ( count ) Lets you set the number of offsets.


Properties

CurrentAddress:
integer - The address the memoryrecord points to
Active
Set to true to activate/freeze, false to deactivate/unfreeze.

Type:

    boolean
Address
Get/set the interpretable address string. Useful for simple address settings.

Type:

AddressString
Get the address string shown in CE (ReadOnly).

Type:

AllowDecrease
Allow value decreasing, unfreeze will reset it to false.

Type:

    boolean
AllowIncrease
Allow value increasing, unfreeze will reset it to false.

Type:

    boolean
Async
Set to true if activating this entry will be asynchronious.

(only for AA/Lua scripts)

Type:

    boolean
AsyncProcessing
True when async is true and it's being processed.

Type:

    boolean
AsyncProcessingTime
The time that it has been processing in milliseconds.

Type:

    qword
Child [ index ]
Array to access the child records.

Type:

    array
Collapsed
Set to true to collapse this record or false to expand it. Use expand/collapse methods for recursive operations.

Type:

    boolean
Color

Type:

    integer
Count
Number of children.

Type:

    integer
CustomTypeName
If the type is vtCustom this will contain the name of the CustomType.

Type:

Description
The description of the memory record.

Type:

DisplayAsDropDownListItem
Self explanatory.

Type:

    boolean
DontSave
Don't save this memoryrecord and it's children.

Type:

    boolean
DropDownCount
Equivalent to DropDownList.Count

Type:

    integer
DropDownDescription [ index ]
Array to access Descriptions in DropDownList (ReadOnly).

Type:

    array
DropDownDescriptionOnly
Self explanatory.

Type:

    boolean
DropDownLinked
If dropdown list refers to list of another memory record eg. (memrec name).

Type:

    boolean
DropDownLinkedMemrec
Description of linked memrec or emptystring if not linked.

Type:

DropDownList
List of "value:description" lines, lists are still separate objects when linked, read-write.

Type:

DropDownReadOnly
true if 'Disallow manual user input' is set.

Type:

    boolean
DropDownValue
[index] : Array to access values in DropDownList (ReadOnly)
FIXME [ index ]
Same as Child

Type:

    array
Hotkey []
Array to index the hotkeys.

Type:

    array
HotkeyCount
Number of hotkeys attached to this memory record.

Type:

    integer
ID
Unique ID.

Type:

    integer
Index
The index ID for this record. 0 is top. (ReadOnly)

Type:

    integer
IsGroupHeader
Set to true if the record was created as a Group Header with no address or value info. (ReadOnly)

Type:

    boolean
IsReadable
Set to false if record contains an unreadable address. (ReadOnly)

NOTE: This property will not be set until the value property is accessed at least once.

Type:

    boolean
Offset []
Array to access each offset.

Type:

    array
OffsetCount
The number of offsets. Set to 0 for a normal address.

Type:

    integer
OffsetText []
Array to access each offset using the interpretable text style.

Type:

    array
OnActivate
The function to call when the memoryrecord will change (or changed) Active to true. If before is true, not returning true will cause the activation to stop.

Type:

    function

Usage:

    MemoryRecord.OnActivate = function(memoryrecord, before, currentstate)
OnDeactivate
The function to call when the memoryrecord will change (or changed) Active to false. If before is true, not returning true will cause the deactivation to stop.

Type:

    function

Usage:

    MemoryRecord.OnDeactivate = function(memoryrecord, before, currentstate)
OnDestroy
Called when the memoryrecord is destroyed.

Type:

    function

Usage:

    MemoryRecord.OnDestroy = function()
OnGetDisplayValue
This function gets called when rendering the value of a memory record. Return true and a new string to override the value shown

Type:

    function

Usage:

    MemoryRecord.OnGetDisplayValue = function(memoryrecord, valuestring)
Options
A string enclosed by square brackets filled with the options seperated by a comma. Valid options are: moHideChildren, moActivateChildrenAsWell, moDeactivateChildrenAsWell, moRecursiveSetValue, moAllowManualCollapseAndExpand, moManualExpandCollapse.

Type:

    String set
Parent
Self explanatory.

Type:

Script
If the type is vtAutoAssembler this will contain the auto assembler script.

Type:

ShowAsHex
Self explanatory.

Type:

    boolean
ShowAsSigned
Self explanatory.

Type:

    boolean
Value
The value in stringform.

Type:

VarType
The variable type of this record.

See vtByte to vtCustom.

Type:

    ValueType (string)
Selected:
boolean - Set to true if selected (ReadOnly)
Type:
The variable type of this record.

See vtByte to vtCustom.

If the type is vtString then the following properties are available:
 String.Size: Number of characters in the string
 String.Unicode: boolean
 String.Codepage: boolean

If the type is vtBinary then the following properties are available
  Binary.Startbit: First bit to start reading from
  Binary.Size : Number of bits

If the type is vtByteArray then the following properties are available
  Aob.Size : Number of bytes

ValueType (number)

Methods

appendToEntry ( memrec )
Appends the current memory record to the given memory record.

Parameters:

createHotkey ( keys, action, value )
Returns a hotkey object.

Parameters:

  • keys table
  • action
  • value (optional)

Returns:

    MemoryRecordHotkey
disableWithoutExecute ()
Sets the entry to disabled without executing the disable section.
getAddress ()
Returns the interpretable addressstring of this record. If it is a pointer, it returns a second result as a table filled with the offsets.

Returns:

  1. string
  2. table
getCurrentAddress ()
Returns the current address as an integer.

(the final result of the interpretable address and pointer offsets)

Returns:

    integer
getDescription ()

Returns:

    string
getHotkey ( index )
Returns the hotkey from the hotkey array.

Parameters:

  • index integer

Returns:

    MemoryRecordHotkey
getHotkeyByID ( id )
Returns the hotkey with the given id.

Parameters:

  • id integer

Returns:

    MemoryRecordHotkey
getOffset ( index )
Gets the offset at the given index.

Parameters:

  • index integer
getOffsetCount ()
Returns the number of offsets for this memoryrecord.

Returns:

    integer
reinterpret ()
setAddress ( address )
Sets the interpretable address string, and if offsets are provided make it a pointer.

Parameters:

setDescription ()
setOffset ( index, value )
Sets the offset at the given index.

Parameters:

  • index integer
  • value
setOffsetCount ( count )
Lets you set the number of offsets.

Parameters:

  • count integer
generated by LDoc 1.4.6-antum-dev-1 Last updated 2019-02-27 23:30:35