diff --git a/docs/api/README.md b/docs/api/README.md index c2aa308..b0bd01b 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,12 +1,12 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [@tybys/wz](./wz.md) | MapleStory WZ reader. | - + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [@tybys/wz](./wz.md) | MapleStory WZ reader. | + diff --git a/docs/api/index.md b/docs/api/index.md index c2aa308..b0bd01b 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,12 +1,12 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [@tybys/wz](./wz.md) | MapleStory WZ reader. | - + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [@tybys/wz](./wz.md) | MapleStory WZ reader. | + diff --git a/docs/api/wz.baseerror._constructor_.md b/docs/api/wz.baseerror._constructor_.md index 82df3d8..8209c82 100644 --- a/docs/api/wz.baseerror._constructor_.md +++ b/docs/api/wz.baseerror._constructor_.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [BaseError](./wz.baseerror.md) > [(constructor)](./wz.baseerror._constructor_.md) - -## BaseError.(constructor) - -Constructs a new instance of the `BaseError` class - -Signature: - -```typescript -constructor(message?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| message | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [BaseError](./wz.baseerror.md) > [(constructor)](./wz.baseerror._constructor_.md) + +## BaseError.(constructor) + +Constructs a new instance of the `BaseError` class + +**Signature:** + +```typescript +constructor(message?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| message | string | _(Optional)_ | + diff --git a/docs/api/wz.baseerror.md b/docs/api/wz.baseerror.md index 80d4996..c8bc14e 100644 --- a/docs/api/wz.baseerror.md +++ b/docs/api/wz.baseerror.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [BaseError](./wz.baseerror.md) - -## BaseError class - - -Signature: - -```typescript -export declare class BaseError extends Error -``` -Extends: Error - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(message)](./wz.baseerror._constructor_.md) | | Constructs a new instance of the BaseError class | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [BaseError](./wz.baseerror.md) + +## BaseError class + + +**Signature:** + +```typescript +export declare class BaseError extends Error +``` +**Extends:** Error + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(message)](./wz.baseerror._constructor_.md) | | Constructs a new instance of the BaseError class | + diff --git a/docs/api/wz.canvas._constructor_.md b/docs/api/wz.canvas._constructor_.md index b4da809..440b312 100644 --- a/docs/api/wz.canvas._constructor_.md +++ b/docs/api/wz.canvas._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [(constructor)](./wz.canvas._constructor_.md) - -## Canvas.(constructor) - -Constructs a new instance of the `Canvas` class - -Signature: - -```typescript -constructor(width: number, height: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| width | number | | -| height | number | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [(constructor)](./wz.canvas._constructor_.md) + +## Canvas.(constructor) + +Constructs a new instance of the `Canvas` class + +**Signature:** + +```typescript +constructor(width: number, height: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| width | number | | +| height | number | | + diff --git a/docs/api/wz.canvas.dispose.md b/docs/api/wz.canvas.dispose.md index 17c2a33..6439ade 100644 --- a/docs/api/wz.canvas.dispose.md +++ b/docs/api/wz.canvas.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [dispose](./wz.canvas.dispose.md) - -## Canvas.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [dispose](./wz.canvas.dispose.md) + +## Canvas.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.canvas.getbufferasync.md b/docs/api/wz.canvas.getbufferasync.md index 819a306..b15a01f 100644 --- a/docs/api/wz.canvas.getbufferasync.md +++ b/docs/api/wz.canvas.getbufferasync.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [getBufferAsync](./wz.canvas.getbufferasync.md) - -## Canvas.getBufferAsync() method - -Signature: - -```typescript -getBufferAsync(mime: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| mime | string | | - -Returns: - -Promise<Uint8Array> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [getBufferAsync](./wz.canvas.getbufferasync.md) + +## Canvas.getBufferAsync() method + +**Signature:** + +```typescript +getBufferAsync(mime: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| mime | string | | + +**Returns:** + +Promise<Uint8Array> + diff --git a/docs/api/wz.canvas.getcanvas.md b/docs/api/wz.canvas.getcanvas.md new file mode 100644 index 0000000..f3ea0ce --- /dev/null +++ b/docs/api/wz.canvas.getcanvas.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [getCanvas](./wz.canvas.getcanvas.md) + +## Canvas.getCanvas() method + +**Signature:** + +```typescript +getCanvas(): HTMLCanvasElement | InstanceType; +``` +**Returns:** + +HTMLCanvasElement \| InstanceType<typeof Jimp> + diff --git a/docs/api/wz.canvas.getwidth.md b/docs/api/wz.canvas.getwidth.md index 850933c..8dedb8d 100644 --- a/docs/api/wz.canvas.getwidth.md +++ b/docs/api/wz.canvas.getwidth.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [getWidth](./wz.canvas.getwidth.md) - -## Canvas.getWidth() method - -Signature: - -```typescript -getWidth(): number; -``` -Returns: - -number - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [getWidth](./wz.canvas.getwidth.md) + +## Canvas.getWidth() method + +**Signature:** + +```typescript +getWidth(): number; +``` +**Returns:** + +number + diff --git a/docs/api/wz.canvas.md b/docs/api/wz.canvas.md index 248f393..173cc86 100644 --- a/docs/api/wz.canvas.md +++ b/docs/api/wz.canvas.md @@ -1,30 +1,31 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) - -## Canvas class - - -Signature: - -```typescript -export declare class Canvas -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(width, height)](./wz.canvas._constructor_.md) | | Constructs a new instance of the Canvas class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.canvas.dispose.md) | | | -| [getBufferAsync(mime)](./wz.canvas.getbufferasync.md) | | | -| [getWidth()](./wz.canvas.getwidth.md) | | | -| [rgbaToInt(r, g, b, a)](./wz.canvas.rgbatoint.md) | static | | -| [setPixelColor(rgba, x, y)](./wz.canvas.setpixelcolor.md) | | | -| [writeAsync(file)](./wz.canvas.writeasync.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) + +## Canvas class + + +**Signature:** + +```typescript +export declare class Canvas +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(width, height)](./wz.canvas._constructor_.md) | | Constructs a new instance of the Canvas class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.canvas.dispose.md) | | | +| [getBufferAsync(mime)](./wz.canvas.getbufferasync.md) | | | +| [getCanvas()](./wz.canvas.getcanvas.md) | | | +| [getWidth()](./wz.canvas.getwidth.md) | | | +| [rgbaToInt(r, g, b, a)](./wz.canvas.rgbatoint.md) | static | | +| [setPixelColor(rgba, x, y)](./wz.canvas.setpixelcolor.md) | | | +| [writeAsync(file)](./wz.canvas.writeasync.md) | | | + diff --git a/docs/api/wz.canvas.rgbatoint.md b/docs/api/wz.canvas.rgbatoint.md index 4adfa37..a6282e0 100644 --- a/docs/api/wz.canvas.rgbatoint.md +++ b/docs/api/wz.canvas.rgbatoint.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [rgbaToInt](./wz.canvas.rgbatoint.md) - -## Canvas.rgbaToInt() method - -Signature: - -```typescript -static rgbaToInt(r: number, g: number, b: number, a: number): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| r | number | | -| g | number | | -| b | number | | -| a | number | | - -Returns: - -number - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [rgbaToInt](./wz.canvas.rgbatoint.md) + +## Canvas.rgbaToInt() method + +**Signature:** + +```typescript +static rgbaToInt(r: number, g: number, b: number, a: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| r | number | | +| g | number | | +| b | number | | +| a | number | | + +**Returns:** + +number + diff --git a/docs/api/wz.canvas.setpixelcolor.md b/docs/api/wz.canvas.setpixelcolor.md index b2e887a..f31222c 100644 --- a/docs/api/wz.canvas.setpixelcolor.md +++ b/docs/api/wz.canvas.setpixelcolor.md @@ -1,24 +1,24 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [setPixelColor](./wz.canvas.setpixelcolor.md) - -## Canvas.setPixelColor() method - -Signature: - -```typescript -setPixelColor(rgba: number, x: number, y: number): Canvas; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| rgba | number | | -| x | number | | -| y | number | | - -Returns: - -[Canvas](./wz.canvas.md) - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [setPixelColor](./wz.canvas.setpixelcolor.md) + +## Canvas.setPixelColor() method + +**Signature:** + +```typescript +setPixelColor(rgba: number, x: number, y: number): Canvas; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| rgba | number | | +| x | number | | +| y | number | | + +**Returns:** + +[Canvas](./wz.canvas.md) + diff --git a/docs/api/wz.canvas.writeasync.md b/docs/api/wz.canvas.writeasync.md index 1763b2e..5955d8e 100644 --- a/docs/api/wz.canvas.writeasync.md +++ b/docs/api/wz.canvas.writeasync.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [writeAsync](./wz.canvas.writeasync.md) - -## Canvas.writeAsync() method - -Signature: - -```typescript -writeAsync(file: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| file | string | | - -Returns: - -Promise<[Canvas](./wz.canvas.md)> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [Canvas](./wz.canvas.md) > [writeAsync](./wz.canvas.writeasync.md) + +## Canvas.writeAsync() method + +**Signature:** + +```typescript +writeAsync(file: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| file | string | | + +**Returns:** + +Promise<[Canvas](./wz.canvas.md)> + diff --git a/docs/api/wz.errorlevel.md b/docs/api/wz.errorlevel.md index dd25f0f..ed55234 100644 --- a/docs/api/wz.errorlevel.md +++ b/docs/api/wz.errorlevel.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLevel](./wz.errorlevel.md) - -## ErrorLevel enum - - -Signature: - -```typescript -export declare enum ErrorLevel -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Crash | 3 | | -| Critical | 2 | | -| IncorrectStructure | 1 | | -| MissingFeature | 0 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLevel](./wz.errorlevel.md) + +## ErrorLevel enum + + +**Signature:** + +```typescript +export declare enum ErrorLevel +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Crash | 3 | | +| Critical | 2 | | +| IncorrectStructure | 1 | | +| MissingFeature | 0 | | + diff --git a/docs/api/wz.errorlogger.clearerrors.md b/docs/api/wz.errorlogger.clearerrors.md index 6b52863..b25d924 100644 --- a/docs/api/wz.errorlogger.clearerrors.md +++ b/docs/api/wz.errorlogger.clearerrors.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [clearErrors](./wz.errorlogger.clearerrors.md) - -## ErrorLogger.clearErrors() method - -Signature: - -```typescript -static clearErrors(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [clearErrors](./wz.errorlogger.clearerrors.md) + +## ErrorLogger.clearErrors() method + +**Signature:** + +```typescript +static clearErrors(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.errorlogger.errorspresent.md b/docs/api/wz.errorlogger.errorspresent.md index aa93e19..5e9e659 100644 --- a/docs/api/wz.errorlogger.errorspresent.md +++ b/docs/api/wz.errorlogger.errorspresent.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [errorsPresent](./wz.errorlogger.errorspresent.md) - -## ErrorLogger.errorsPresent() method - -Signature: - -```typescript -static errorsPresent(): boolean; -``` -Returns: - -boolean - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [errorsPresent](./wz.errorlogger.errorspresent.md) + +## ErrorLogger.errorsPresent() method + +**Signature:** + +```typescript +static errorsPresent(): boolean; +``` +**Returns:** + +boolean + diff --git a/docs/api/wz.errorlogger.log.md b/docs/api/wz.errorlogger.log.md index 9da2031..03d99c0 100644 --- a/docs/api/wz.errorlogger.log.md +++ b/docs/api/wz.errorlogger.log.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [log](./wz.errorlogger.log.md) - -## ErrorLogger.log() method - -Signature: - -```typescript -static log(level: ErrorLevel, message: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| level | [ErrorLevel](./wz.errorlevel.md) | | -| message | string | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [log](./wz.errorlogger.log.md) + +## ErrorLogger.log() method + +**Signature:** + +```typescript +static log(level: ErrorLevel, message: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| level | [ErrorLevel](./wz.errorlevel.md) | | +| message | string | | + +**Returns:** + +void + diff --git a/docs/api/wz.errorlogger.md b/docs/api/wz.errorlogger.md index 7ae3001..352c2e6 100644 --- a/docs/api/wz.errorlogger.md +++ b/docs/api/wz.errorlogger.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) - -## ErrorLogger class - - -Signature: - -```typescript -export declare class ErrorLogger -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [clearErrors()](./wz.errorlogger.clearerrors.md) | static | | -| [errorsPresent()](./wz.errorlogger.errorspresent.md) | static | | -| [log(level, message)](./wz.errorlogger.log.md) | static | | -| [numberOfErrorsPresent()](./wz.errorlogger.numberoferrorspresent.md) | static | | -| [saveToFile(file)](./wz.errorlogger.savetofile.md) | static | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) + +## ErrorLogger class + + +**Signature:** + +```typescript +export declare class ErrorLogger +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [clearErrors()](./wz.errorlogger.clearerrors.md) | static | | +| [errorsPresent()](./wz.errorlogger.errorspresent.md) | static | | +| [log(level, message)](./wz.errorlogger.log.md) | static | | +| [numberOfErrorsPresent()](./wz.errorlogger.numberoferrorspresent.md) | static | | +| [saveToFile(file)](./wz.errorlogger.savetofile.md) | static | | + diff --git a/docs/api/wz.errorlogger.numberoferrorspresent.md b/docs/api/wz.errorlogger.numberoferrorspresent.md index 4804f20..584bba8 100644 --- a/docs/api/wz.errorlogger.numberoferrorspresent.md +++ b/docs/api/wz.errorlogger.numberoferrorspresent.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [numberOfErrorsPresent](./wz.errorlogger.numberoferrorspresent.md) - -## ErrorLogger.numberOfErrorsPresent() method - -Signature: - -```typescript -static numberOfErrorsPresent(): number; -``` -Returns: - -number - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [numberOfErrorsPresent](./wz.errorlogger.numberoferrorspresent.md) + +## ErrorLogger.numberOfErrorsPresent() method + +**Signature:** + +```typescript +static numberOfErrorsPresent(): number; +``` +**Returns:** + +number + diff --git a/docs/api/wz.errorlogger.savetofile.md b/docs/api/wz.errorlogger.savetofile.md index b668124..de1370a 100644 --- a/docs/api/wz.errorlogger.savetofile.md +++ b/docs/api/wz.errorlogger.savetofile.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [saveToFile](./wz.errorlogger.savetofile.md) - -## ErrorLogger.saveToFile() method - -Signature: - -```typescript -static saveToFile(file: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| file | string | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [ErrorLogger](./wz.errorlogger.md) > [saveToFile](./wz.errorlogger.savetofile.md) + +## ErrorLogger.saveToFile() method + +**Signature:** + +```typescript +static saveToFile(file: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| file | string | | + +**Returns:** + +void + diff --git a/docs/api/wz.geterrordescription.md b/docs/api/wz.geterrordescription.md index 412d5ae..0026706 100644 --- a/docs/api/wz.geterrordescription.md +++ b/docs/api/wz.geterrordescription.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [getErrorDescription](./wz.geterrordescription.md) - -## getErrorDescription() function - - -Signature: - -```typescript -export declare function getErrorDescription(status: WzFileParseStatus): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| status | [WzFileParseStatus](./wz.wzfileparsestatus.md) | | - -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [getErrorDescription](./wz.geterrordescription.md) + +## getErrorDescription() function + + +**Signature:** + +```typescript +export declare function getErrorDescription(status: WzFileParseStatus): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| status | [WzFileParseStatus](./wz.wzfileparsestatus.md) | | + +**Returns:** + +string + diff --git a/docs/api/wz.idisposable.dispose.md b/docs/api/wz.idisposable.dispose.md index 08ae9d8..cbceb13 100644 --- a/docs/api/wz.idisposable.dispose.md +++ b/docs/api/wz.idisposable.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IDisposable](./wz.idisposable.md) > [dispose](./wz.idisposable.dispose.md) - -## IDisposable.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IDisposable](./wz.idisposable.md) > [dispose](./wz.idisposable.dispose.md) + +## IDisposable.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.idisposable.md b/docs/api/wz.idisposable.md index f9ea566..62a37f5 100644 --- a/docs/api/wz.idisposable.md +++ b/docs/api/wz.idisposable.md @@ -1,19 +1,19 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IDisposable](./wz.idisposable.md) - -## IDisposable interface - - -Signature: - -```typescript -export interface IDisposable -``` - -## Methods - -| Method | Description | -| --- | --- | -| [dispose()](./wz.idisposable.dispose.md) | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IDisposable](./wz.idisposable.md) + +## IDisposable interface + + +**Signature:** + +```typescript +export interface IDisposable +``` + +## Methods + +| Method | Description | +| --- | --- | +| [dispose()](./wz.idisposable.dispose.md) | | + diff --git a/docs/api/wz.init.md b/docs/api/wz.init.md index 22a3f9a..999e8d6 100644 --- a/docs/api/wz.init.md +++ b/docs/api/wz.init.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [init](./wz.init.md) - -## init() function - - -Signature: - -```typescript -export declare function init(moduleOverrides?: Partial): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| moduleOverrides | Partial<EmscriptenModule> | (Optional) | - -Returns: - -Promise<void> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [init](./wz.init.md) + +## init() function + + +**Signature:** + +```typescript +export declare function init(moduleOverrides?: Partial): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| moduleOverrides | Partial<EmscriptenModule> | _(Optional)_ | + +**Returns:** + +Promise<void> + diff --git a/docs/api/wz.ipropertycontainer.addproperties.md b/docs/api/wz.ipropertycontainer.addproperties.md index 4d2955e..ab94537 100644 --- a/docs/api/wz.ipropertycontainer.addproperties.md +++ b/docs/api/wz.ipropertycontainer.addproperties.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [addProperties](./wz.ipropertycontainer.addproperties.md) - -## IPropertyContainer.addProperties() method - -Signature: - -```typescript -addProperties(props: Set): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [addProperties](./wz.ipropertycontainer.addproperties.md) + +## IPropertyContainer.addProperties() method + +**Signature:** + +```typescript +addProperties(props: Set): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +**Returns:** + +void + diff --git a/docs/api/wz.ipropertycontainer.addproperty.md b/docs/api/wz.ipropertycontainer.addproperty.md index d2ce38e..f67c048 100644 --- a/docs/api/wz.ipropertycontainer.addproperty.md +++ b/docs/api/wz.ipropertycontainer.addproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [addProperty](./wz.ipropertycontainer.addproperty.md) - -## IPropertyContainer.addProperty() method - -Signature: - -```typescript -addProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [addProperty](./wz.ipropertycontainer.addproperty.md) + +## IPropertyContainer.addProperty() method + +**Signature:** + +```typescript +addProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.ipropertycontainer.at.md b/docs/api/wz.ipropertycontainer.at.md index 1485321..544958a 100644 --- a/docs/api/wz.ipropertycontainer.at.md +++ b/docs/api/wz.ipropertycontainer.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [at](./wz.ipropertycontainer.at.md) - -## IPropertyContainer.at() method - -Signature: - -```typescript -at(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [at](./wz.ipropertycontainer.at.md) + +## IPropertyContainer.at() method + +**Signature:** + +```typescript +at(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.ipropertycontainer.clearproperties.md b/docs/api/wz.ipropertycontainer.clearproperties.md index ade24be..1fdadb7 100644 --- a/docs/api/wz.ipropertycontainer.clearproperties.md +++ b/docs/api/wz.ipropertycontainer.clearproperties.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [clearProperties](./wz.ipropertycontainer.clearproperties.md) - -## IPropertyContainer.clearProperties() method - -Signature: - -```typescript -clearProperties(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [clearProperties](./wz.ipropertycontainer.clearproperties.md) + +## IPropertyContainer.clearProperties() method + +**Signature:** + +```typescript +clearProperties(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.ipropertycontainer.md b/docs/api/wz.ipropertycontainer.md index 397f6de..96f60a0 100644 --- a/docs/api/wz.ipropertycontainer.md +++ b/docs/api/wz.ipropertycontainer.md @@ -1,30 +1,30 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) - -## IPropertyContainer interface - - -Signature: - -```typescript -export interface IPropertyContainer -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [wzProperties](./wz.ipropertycontainer.wzproperties.md) | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -## Methods - -| Method | Description | -| --- | --- | -| [addProperties(props)](./wz.ipropertycontainer.addproperties.md) | | -| [addProperty(prop)](./wz.ipropertycontainer.addproperty.md) | | -| [at(name)](./wz.ipropertycontainer.at.md) | | -| [clearProperties()](./wz.ipropertycontainer.clearproperties.md) | | -| [removeProperty(prop)](./wz.ipropertycontainer.removeproperty.md) | | -| [set(name, value)](./wz.ipropertycontainer.set.md) | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) + +## IPropertyContainer interface + + +**Signature:** + +```typescript +export interface IPropertyContainer +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [wzProperties](./wz.ipropertycontainer.wzproperties.md) | readonly | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +## Methods + +| Method | Description | +| --- | --- | +| [addProperties(props)](./wz.ipropertycontainer.addproperties.md) | | +| [addProperty(prop)](./wz.ipropertycontainer.addproperty.md) | | +| [at(name)](./wz.ipropertycontainer.at.md) | | +| [clearProperties()](./wz.ipropertycontainer.clearproperties.md) | | +| [removeProperty(prop)](./wz.ipropertycontainer.removeproperty.md) | | +| [set(name, value)](./wz.ipropertycontainer.set.md) | | + diff --git a/docs/api/wz.ipropertycontainer.removeproperty.md b/docs/api/wz.ipropertycontainer.removeproperty.md index d4eeb15..239b248 100644 --- a/docs/api/wz.ipropertycontainer.removeproperty.md +++ b/docs/api/wz.ipropertycontainer.removeproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [removeProperty](./wz.ipropertycontainer.removeproperty.md) - -## IPropertyContainer.removeProperty() method - -Signature: - -```typescript -removeProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [removeProperty](./wz.ipropertycontainer.removeproperty.md) + +## IPropertyContainer.removeProperty() method + +**Signature:** + +```typescript +removeProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.ipropertycontainer.set.md b/docs/api/wz.ipropertycontainer.set.md index e55b091..c395a98 100644 --- a/docs/api/wz.ipropertycontainer.set.md +++ b/docs/api/wz.ipropertycontainer.set.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [set](./wz.ipropertycontainer.set.md) - -## IPropertyContainer.set() method - -Signature: - -```typescript -set(name: string, value: T): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| value | T | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [set](./wz.ipropertycontainer.set.md) + +## IPropertyContainer.set() method + +**Signature:** + +```typescript +set(name: string, value: T): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| value | T | | + +**Returns:** + +void + diff --git a/docs/api/wz.ipropertycontainer.wzproperties.md b/docs/api/wz.ipropertycontainer.wzproperties.md index dd85018..7733d35 100644 --- a/docs/api/wz.ipropertycontainer.wzproperties.md +++ b/docs/api/wz.ipropertycontainer.wzproperties.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [wzProperties](./wz.ipropertycontainer.wzproperties.md) - -## IPropertyContainer.wzProperties property - -Signature: - -```typescript -readonly wzProperties: Set; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IPropertyContainer](./wz.ipropertycontainer.md) > [wzProperties](./wz.ipropertycontainer.wzproperties.md) + +## IPropertyContainer.wzProperties property + +**Signature:** + +```typescript +readonly wzProperties: Set; +``` diff --git a/docs/api/wz.iwzparseresult.md b/docs/api/wz.iwzparseresult.md index 48e0398..bdd7d9d 100644 --- a/docs/api/wz.iwzparseresult.md +++ b/docs/api/wz.iwzparseresult.md @@ -1,19 +1,19 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IWzParseResult](./wz.iwzparseresult.md) - -## IWzParseResult interface - - -Signature: - -```typescript -export interface IWzParseResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [message](./wz.iwzparseresult.message.md) | string | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IWzParseResult](./wz.iwzparseresult.md) + +## IWzParseResult interface + + +**Signature:** + +```typescript +export interface IWzParseResult +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [message](./wz.iwzparseresult.message.md) | | string | | + diff --git a/docs/api/wz.iwzparseresult.message.md b/docs/api/wz.iwzparseresult.message.md index 2b28602..36e03cf 100644 --- a/docs/api/wz.iwzparseresult.message.md +++ b/docs/api/wz.iwzparseresult.message.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [IWzParseResult](./wz.iwzparseresult.md) > [message](./wz.iwzparseresult.message.md) - -## IWzParseResult.message property - -Signature: - -```typescript -message: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [IWzParseResult](./wz.iwzparseresult.md) > [message](./wz.iwzparseresult.message.md) + +## IWzParseResult.message property + +**Signature:** + +```typescript +message: string; +``` diff --git a/docs/api/wz.maplestorylocalisation.md b/docs/api/wz.maplestorylocalisation.md index e0c65f4..7e7600a 100644 --- a/docs/api/wz.maplestorylocalisation.md +++ b/docs/api/wz.maplestorylocalisation.md @@ -1,28 +1,28 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [MapleStoryLocalisation](./wz.maplestorylocalisation.md) - -## MapleStoryLocalisation enum - - -Signature: - -```typescript -export declare enum MapleStoryLocalisation -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| MapleStoryEurope | 9 | | -| MapleStoryGlobal | 8 | | -| MapleStoryKorea | 1 | | -| MapleStoryKoreaTespia | 2 | | -| MapleStorySEA | 7 | | -| MapleStoryTespia | 5 | | -| Not\_Known | 999 | | -| Unknown3 | 3 | | -| Unknown4 | 4 | | -| Unknown6 | 6 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [MapleStoryLocalisation](./wz.maplestorylocalisation.md) + +## MapleStoryLocalisation enum + + +**Signature:** + +```typescript +export declare enum MapleStoryLocalisation +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| MapleStoryEurope | 9 | | +| MapleStoryGlobal | 8 | | +| MapleStoryKorea | 1 | | +| MapleStoryKoreaTespia | 2 | | +| MapleStorySEA | 7 | | +| MapleStoryTespia | 5 | | +| Not\_Known | 999 | | +| Unknown3 | 3 | | +| Unknown4 | 4 | | +| Unknown6 | 6 | | + diff --git a/docs/api/wz.md b/docs/api/wz.md index 02192c4..0f81325 100644 --- a/docs/api/wz.md +++ b/docs/api/wz.md @@ -1,74 +1,79 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) - -## wz package - -MapleStory WZ reader. - -## Classes - -| Class | Description | -| --- | --- | -| [BaseError](./wz.baseerror.md) | | -| [Canvas](./wz.canvas.md) | | -| [ErrorLogger](./wz.errorlogger.md) | | -| [NotImplementedError](./wz.notimplementederror.md) | | -| [WzBinaryProperty](./wz.wzbinaryproperty.md) | | -| [WzBinaryReader](./wz.wzbinaryreader.md) | | -| [WzCanvasProperty](./wz.wzcanvasproperty.md) | | -| [WzConvexProperty](./wz.wzconvexproperty.md) | | -| [WzDirectory](./wz.wzdirectory.md) | | -| [WzDoubleProperty](./wz.wzdoubleproperty.md) | | -| [WzError](./wz.wzerror.md) | | -| [WzExtended](./wz.wzextended.md) | | -| [WzFile](./wz.wzfile.md) | | -| [WzFloatProperty](./wz.wzfloatproperty.md) | | -| [WzHeader](./wz.wzheader.md) | | -| [WzImage](./wz.wzimage.md) | | -| [WzImageProperty](./wz.wzimageproperty.md) | | -| [WzIntProperty](./wz.wzintproperty.md) | | -| [WzLongProperty](./wz.wzlongproperty.md) | | -| [WzLuaProperty](./wz.wzluaproperty.md) | | -| [WzMainDirectory](./wz.wzmaindirectory.md) | | -| [WzMutableKey](./wz.wzmutablekey.md) | | -| [WzNullProperty](./wz.wznullproperty.md) | | -| [WzObject](./wz.wzobject.md) | | -| [WzPngProperty](./wz.wzpngproperty.md) | | -| [WzShortProperty](./wz.wzshortproperty.md) | | -| [WzStringProperty](./wz.wzstringproperty.md) | | -| [WzSubProperty](./wz.wzsubproperty.md) | | -| [WzUOLProperty](./wz.wzuolproperty.md) | | -| [WzVectorProperty](./wz.wzvectorproperty.md) | | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [ErrorLevel](./wz.errorlevel.md) | | -| [MapleStoryLocalisation](./wz.maplestorylocalisation.md) | | -| [WzBinaryPropertyType](./wz.wzbinarypropertytype.md) | | -| [WzDirectoryType](./wz.wzdirectorytype.md) | | -| [WzFileParseStatus](./wz.wzfileparsestatus.md) | | -| [WzMapleVersion](./wz.wzmapleversion.md) | | -| [WzObjectType](./wz.wzobjecttype.md) | | -| [WzPropertyType](./wz.wzpropertytype.md) | | - -## Functions - -| Function | Description | -| --- | --- | -| [getErrorDescription(status)](./wz.geterrordescription.md) | | -| [init(moduleOverrides)](./wz.init.md) | | -| [walkDirectory(dir, callback)](./wz.walkdirectory.md) | | -| [walkPropertyContainer(container, callback)](./wz.walkpropertycontainer.md) | | -| [walkWzFileAsync(filepath, mapleVersion, callback)](./wz.walkwzfileasync.md) | | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [IDisposable](./wz.idisposable.md) | | -| [IPropertyContainer](./wz.ipropertycontainer.md) | | -| [IWzParseResult](./wz.iwzparseresult.md) | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) + +## wz package + +MapleStory WZ reader. + +## Classes + +| Class | Description | +| --- | --- | +| [BaseError](./wz.baseerror.md) | | +| [Canvas](./wz.canvas.md) | | +| [ErrorLogger](./wz.errorlogger.md) | | +| [NotImplementedError](./wz.notimplementederror.md) | | +| [WzBinaryProperty](./wz.wzbinaryproperty.md) | | +| [WzBinaryReader](./wz.wzbinaryreader.md) | | +| [WzCanvasProperty](./wz.wzcanvasproperty.md) | | +| [WzConvexProperty](./wz.wzconvexproperty.md) | | +| [WzDirectory](./wz.wzdirectory.md) | | +| [WzDoubleProperty](./wz.wzdoubleproperty.md) | | +| [WzError](./wz.wzerror.md) | | +| [WzFile](./wz.wzfile.md) | | +| [WzFloatProperty](./wz.wzfloatproperty.md) | | +| [WzHeader](./wz.wzheader.md) | | +| [WzImage](./wz.wzimage.md) | | +| [WzIntProperty](./wz.wzintproperty.md) | | +| [WzLongProperty](./wz.wzlongproperty.md) | | +| [WzLuaProperty](./wz.wzluaproperty.md) | | +| [WzMainDirectory](./wz.wzmaindirectory.md) | | +| [WzMutableKey](./wz.wzmutablekey.md) | | +| [WzNullProperty](./wz.wznullproperty.md) | | +| [WzPngProperty](./wz.wzpngproperty.md) | | +| [WzShortProperty](./wz.wzshortproperty.md) | | +| [WzStringProperty](./wz.wzstringproperty.md) | | +| [WzSubProperty](./wz.wzsubproperty.md) | | +| [WzUOLProperty](./wz.wzuolproperty.md) | | +| [WzVectorProperty](./wz.wzvectorproperty.md) | | + +## Abstract Classes + +| Abstract Class | Description | +| --- | --- | +| [WzExtended](./wz.wzextended.md) | | +| [WzImageProperty](./wz.wzimageproperty.md) | | +| [WzObject](./wz.wzobject.md) | | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [ErrorLevel](./wz.errorlevel.md) | | +| [MapleStoryLocalisation](./wz.maplestorylocalisation.md) | | +| [WzBinaryPropertyType](./wz.wzbinarypropertytype.md) | | +| [WzDirectoryType](./wz.wzdirectorytype.md) | | +| [WzFileParseStatus](./wz.wzfileparsestatus.md) | | +| [WzMapleVersion](./wz.wzmapleversion.md) | | +| [WzObjectType](./wz.wzobjecttype.md) | | +| [WzPropertyType](./wz.wzpropertytype.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [getErrorDescription(status)](./wz.geterrordescription.md) | | +| [init(moduleOverrides)](./wz.init.md) | | +| [walkDirectory(dir, callback)](./wz.walkdirectory.md) | | +| [walkPropertyContainer(container, callback)](./wz.walkpropertycontainer.md) | | +| [walkWzFileAsync(filepath, mapleVersion, callback)](./wz.walkwzfileasync.md) | | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [IDisposable](./wz.idisposable.md) | | +| [IPropertyContainer](./wz.ipropertycontainer.md) | | +| [IWzParseResult](./wz.iwzparseresult.md) | | + diff --git a/docs/api/wz.notimplementederror._constructor_.md b/docs/api/wz.notimplementederror._constructor_.md index a24642c..e71e2bf 100644 --- a/docs/api/wz.notimplementederror._constructor_.md +++ b/docs/api/wz.notimplementederror._constructor_.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [NotImplementedError](./wz.notimplementederror.md) > [(constructor)](./wz.notimplementederror._constructor_.md) - -## NotImplementedError.(constructor) - -Constructs a new instance of the `NotImplementedError` class - -Signature: - -```typescript -constructor(where?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| where | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [NotImplementedError](./wz.notimplementederror.md) > [(constructor)](./wz.notimplementederror._constructor_.md) + +## NotImplementedError.(constructor) + +Constructs a new instance of the `NotImplementedError` class + +**Signature:** + +```typescript +constructor(where?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| where | string | _(Optional)_ | + diff --git a/docs/api/wz.notimplementederror.md b/docs/api/wz.notimplementederror.md index 7c45432..059beb9 100644 --- a/docs/api/wz.notimplementederror.md +++ b/docs/api/wz.notimplementederror.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [NotImplementedError](./wz.notimplementederror.md) - -## NotImplementedError class - - -Signature: - -```typescript -export declare class NotImplementedError extends BaseError -``` -Extends: [BaseError](./wz.baseerror.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(where)](./wz.notimplementederror._constructor_.md) | | Constructs a new instance of the NotImplementedError class | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [NotImplementedError](./wz.notimplementederror.md) + +## NotImplementedError class + + +**Signature:** + +```typescript +export declare class NotImplementedError extends BaseError +``` +**Extends:** [BaseError](./wz.baseerror.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(where)](./wz.notimplementederror._constructor_.md) | | Constructs a new instance of the NotImplementedError class | + diff --git a/docs/api/wz.walkdirectory.md b/docs/api/wz.walkdirectory.md index 9e4014e..e35ac54 100644 --- a/docs/api/wz.walkdirectory.md +++ b/docs/api/wz.walkdirectory.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [walkDirectory](./wz.walkdirectory.md) - -## walkDirectory() function - -Signature: - -```typescript -export declare function walkDirectory(dir: WzDirectory, callback: (obj: T) => boolean | undefined | Promise): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| dir | [WzDirectory](./wz.wzdirectory.md) | | -| callback | <T extends [WzObject](./wz.wzobject.md)>(obj: T) => boolean \| undefined \| Promise<boolean \| undefined> | | - -Returns: - -Promise<boolean> - -`true` if stop manually - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [walkDirectory](./wz.walkdirectory.md) + +## walkDirectory() function + +**Signature:** + +```typescript +export declare function walkDirectory(dir: WzDirectory, callback: (obj: T) => boolean | undefined | Promise): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dir | [WzDirectory](./wz.wzdirectory.md) | | +| callback | <T extends [WzObject](./wz.wzobject.md)>(obj: T) => boolean \| undefined \| Promise<boolean \| undefined> | | + +**Returns:** + +Promise<boolean> + +`true` if stop manually + diff --git a/docs/api/wz.walkpropertycontainer.md b/docs/api/wz.walkpropertycontainer.md index 98a39bb..98a12f0 100644 --- a/docs/api/wz.walkpropertycontainer.md +++ b/docs/api/wz.walkpropertycontainer.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [walkPropertyContainer](./wz.walkpropertycontainer.md) - -## walkPropertyContainer() function - -Signature: - -```typescript -export declare function walkPropertyContainer(container: WzImageProperty | WzImage, callback: (obj: T) => boolean | undefined | Promise): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| container | [WzImageProperty](./wz.wzimageproperty.md) \| [WzImage](./wz.wzimage.md) | | -| callback | <T extends [WzObject](./wz.wzobject.md)>(obj: T) => boolean \| undefined \| Promise<boolean \| undefined> | | - -Returns: - -Promise<boolean> - -`true` if stop manually - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [walkPropertyContainer](./wz.walkpropertycontainer.md) + +## walkPropertyContainer() function + +**Signature:** + +```typescript +export declare function walkPropertyContainer(container: WzImageProperty | WzImage, callback: (obj: T) => boolean | undefined | Promise): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| container | [WzImageProperty](./wz.wzimageproperty.md) \| [WzImage](./wz.wzimage.md) | | +| callback | <T extends [WzObject](./wz.wzobject.md)>(obj: T) => boolean \| undefined \| Promise<boolean \| undefined> | | + +**Returns:** + +Promise<boolean> + +`true` if stop manually + diff --git a/docs/api/wz.walkwzfileasync.md b/docs/api/wz.walkwzfileasync.md index 0a1df5c..4f0089d 100644 --- a/docs/api/wz.walkwzfileasync.md +++ b/docs/api/wz.walkwzfileasync.md @@ -1,26 +1,26 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [walkWzFileAsync](./wz.walkwzfileasync.md) - -## walkWzFileAsync() function - -Signature: - -```typescript -export declare function walkWzFileAsync(filepath: string | File, mapleVersion: WzMapleVersion, callback: (obj: T) => boolean | undefined | Promise): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filepath | string \| File | | -| mapleVersion | [WzMapleVersion](./wz.wzmapleversion.md) | | -| callback | <T extends [WzObject](./wz.wzobject.md)>(obj: T) => boolean \| undefined \| Promise<boolean \| undefined> | | - -Returns: - -Promise<boolean> - -`true` if stop manually - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [walkWzFileAsync](./wz.walkwzfileasync.md) + +## walkWzFileAsync() function + +**Signature:** + +```typescript +export declare function walkWzFileAsync(filepath: string | File, mapleVersion: WzMapleVersion, callback: (obj: T) => boolean | undefined | Promise): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filepath | string \| File | | +| mapleVersion | [WzMapleVersion](./wz.wzmapleversion.md) | | +| callback | <T extends [WzObject](./wz.wzobject.md)>(obj: T) => boolean \| undefined \| Promise<boolean \| undefined> | | + +**Returns:** + +Promise<boolean> + +`true` if stop manually + diff --git a/docs/api/wz.wzbinaryproperty.create.md b/docs/api/wz.wzbinaryproperty.create.md index 69775e5..a71e69e 100644 --- a/docs/api/wz.wzbinaryproperty.create.md +++ b/docs/api/wz.wzbinaryproperty.create.md @@ -1,24 +1,24 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [create](./wz.wzbinaryproperty.create.md) - -## WzBinaryProperty.create() method - -Signature: - -```typescript -static create(name: string, reader: WzBinaryReader, parseNow: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| parseNow | boolean | | - -Returns: - -Promise<[WzBinaryProperty](./wz.wzbinaryproperty.md)> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [create](./wz.wzbinaryproperty.create.md) + +## WzBinaryProperty.create() method + +**Signature:** + +```typescript +static create(name: string, reader: WzBinaryReader, parseNow: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| parseNow | boolean | | + +**Returns:** + +Promise<[WzBinaryProperty](./wz.wzbinaryproperty.md)> + diff --git a/docs/api/wz.wzbinaryproperty.dispose.md b/docs/api/wz.wzbinaryproperty.dispose.md index 432ebdc..3d8809e 100644 --- a/docs/api/wz.wzbinaryproperty.dispose.md +++ b/docs/api/wz.wzbinaryproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [dispose](./wz.wzbinaryproperty.dispose.md) - -## WzBinaryProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [dispose](./wz.wzbinaryproperty.dispose.md) + +## WzBinaryProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzbinaryproperty.getbytes.md b/docs/api/wz.wzbinaryproperty.getbytes.md index 79bc094..0405d36 100644 --- a/docs/api/wz.wzbinaryproperty.getbytes.md +++ b/docs/api/wz.wzbinaryproperty.getbytes.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [getBytes](./wz.wzbinaryproperty.getbytes.md) - -## WzBinaryProperty.getBytes() method - -Signature: - -```typescript -getBytes(saveInMemory?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| saveInMemory | boolean | (Optional) | - -Returns: - -Promise<Uint8Array> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [getBytes](./wz.wzbinaryproperty.getbytes.md) + +## WzBinaryProperty.getBytes() method + +**Signature:** + +```typescript +getBytes(saveInMemory?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| saveInMemory | boolean | _(Optional)_ | + +**Returns:** + +Promise<Uint8Array> + diff --git a/docs/api/wz.wzbinaryproperty.header.md b/docs/api/wz.wzbinaryproperty.header.md index 650c5b7..1922eeb 100644 --- a/docs/api/wz.wzbinaryproperty.header.md +++ b/docs/api/wz.wzbinaryproperty.header.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [header](./wz.wzbinaryproperty.header.md) - -## WzBinaryProperty.header property - -Signature: - -```typescript -header: Uint8Array; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [header](./wz.wzbinaryproperty.header.md) + +## WzBinaryProperty.header property + +**Signature:** + +```typescript +header: Uint8Array; +``` diff --git a/docs/api/wz.wzbinaryproperty.length.md b/docs/api/wz.wzbinaryproperty.length.md index 3229bc8..2ed757a 100644 --- a/docs/api/wz.wzbinaryproperty.length.md +++ b/docs/api/wz.wzbinaryproperty.length.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [length](./wz.wzbinaryproperty.length.md) - -## WzBinaryProperty.length property - -Signature: - -```typescript -length: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [length](./wz.wzbinaryproperty.length.md) + +## WzBinaryProperty.length property + +**Signature:** + +```typescript +length: number; +``` diff --git a/docs/api/wz.wzbinaryproperty.md b/docs/api/wz.wzbinaryproperty.md index a516c06..502beb2 100644 --- a/docs/api/wz.wzbinaryproperty.md +++ b/docs/api/wz.wzbinaryproperty.md @@ -1,36 +1,36 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) - -## WzBinaryProperty class - - -Signature: - -```typescript -export declare class WzBinaryProperty extends WzExtended -``` -Extends: [WzExtended](./wz.wzextended.md) - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [header](./wz.wzbinaryproperty.header.md) | | Uint8Array | | -| [length](./wz.wzbinaryproperty.length.md) | | number | | -| [name](./wz.wzbinaryproperty.name.md) | | string | | -| [parent](./wz.wzbinaryproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzbinaryproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [soundHeader](./wz.wzbinaryproperty.soundheader.md) | static | number\[\] | | -| [wzValue](./wz.wzbinaryproperty.wzvalue.md) | | Promise<Uint8Array> | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [create(name, reader, parseNow)](./wz.wzbinaryproperty.create.md) | static | | -| [dispose()](./wz.wzbinaryproperty.dispose.md) | | | -| [getBytes(saveInMemory)](./wz.wzbinaryproperty.getbytes.md) | | | -| [saveToFile(file)](./wz.wzbinaryproperty.savetofile.md) | | | -| [setValue(\_value)](./wz.wzbinaryproperty.setvalue.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) + +## WzBinaryProperty class + + +**Signature:** + +```typescript +export declare class WzBinaryProperty extends WzExtended +``` +**Extends:** [WzExtended](./wz.wzextended.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [header](./wz.wzbinaryproperty.header.md) | | Uint8Array | | +| [length](./wz.wzbinaryproperty.length.md) | | number | | +| [name](./wz.wzbinaryproperty.name.md) | | string | | +| [parent](./wz.wzbinaryproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzbinaryproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [soundHeader](./wz.wzbinaryproperty.soundheader.md) | static | number\[\] | | +| [wzValue](./wz.wzbinaryproperty.wzvalue.md) | readonly | Promise<Uint8Array> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [create(name, reader, parseNow)](./wz.wzbinaryproperty.create.md) | static | | +| [dispose()](./wz.wzbinaryproperty.dispose.md) | | | +| [getBytes(saveInMemory)](./wz.wzbinaryproperty.getbytes.md) | | | +| [saveToFile(file)](./wz.wzbinaryproperty.savetofile.md) | | | +| [setValue(\_value)](./wz.wzbinaryproperty.setvalue.md) | | | + diff --git a/docs/api/wz.wzbinaryproperty.name.md b/docs/api/wz.wzbinaryproperty.name.md index 8d96642..665654b 100644 --- a/docs/api/wz.wzbinaryproperty.name.md +++ b/docs/api/wz.wzbinaryproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [name](./wz.wzbinaryproperty.name.md) - -## WzBinaryProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [name](./wz.wzbinaryproperty.name.md) + +## WzBinaryProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzbinaryproperty.parent.md b/docs/api/wz.wzbinaryproperty.parent.md index c590db6..e966544 100644 --- a/docs/api/wz.wzbinaryproperty.parent.md +++ b/docs/api/wz.wzbinaryproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [parent](./wz.wzbinaryproperty.parent.md) - -## WzBinaryProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [parent](./wz.wzbinaryproperty.parent.md) + +## WzBinaryProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzbinaryproperty.propertytype.md b/docs/api/wz.wzbinaryproperty.propertytype.md index 6fde111..f07a489 100644 --- a/docs/api/wz.wzbinaryproperty.propertytype.md +++ b/docs/api/wz.wzbinaryproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [propertyType](./wz.wzbinaryproperty.propertytype.md) - -## WzBinaryProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [propertyType](./wz.wzbinaryproperty.propertytype.md) + +## WzBinaryProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzbinaryproperty.savetofile.md b/docs/api/wz.wzbinaryproperty.savetofile.md index e9ab8fa..785a21c 100644 --- a/docs/api/wz.wzbinaryproperty.savetofile.md +++ b/docs/api/wz.wzbinaryproperty.savetofile.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [saveToFile](./wz.wzbinaryproperty.savetofile.md) - -## WzBinaryProperty.saveToFile() method - -Signature: - -```typescript -saveToFile(file: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| file | string | | - -Returns: - -Promise<void> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [saveToFile](./wz.wzbinaryproperty.savetofile.md) + +## WzBinaryProperty.saveToFile() method + +**Signature:** + +```typescript +saveToFile(file: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| file | string | | + +**Returns:** + +Promise<void> + diff --git a/docs/api/wz.wzbinaryproperty.setvalue.md b/docs/api/wz.wzbinaryproperty.setvalue.md index 813c721..8b19792 100644 --- a/docs/api/wz.wzbinaryproperty.setvalue.md +++ b/docs/api/wz.wzbinaryproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [setValue](./wz.wzbinaryproperty.setvalue.md) - -## WzBinaryProperty.setValue() method - -Signature: - -```typescript -setValue(_value: unknown): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_value | unknown | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [setValue](./wz.wzbinaryproperty.setvalue.md) + +## WzBinaryProperty.setValue() method + +**Signature:** + +```typescript +setValue(_value: unknown): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_value | unknown | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzbinaryproperty.soundheader.md b/docs/api/wz.wzbinaryproperty.soundheader.md index 87ba77b..038bd7b 100644 --- a/docs/api/wz.wzbinaryproperty.soundheader.md +++ b/docs/api/wz.wzbinaryproperty.soundheader.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [soundHeader](./wz.wzbinaryproperty.soundheader.md) - -## WzBinaryProperty.soundHeader property - -Signature: - -```typescript -static soundHeader: number[]; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [soundHeader](./wz.wzbinaryproperty.soundheader.md) + +## WzBinaryProperty.soundHeader property + +**Signature:** + +```typescript +static soundHeader: number[]; +``` diff --git a/docs/api/wz.wzbinaryproperty.wzvalue.md b/docs/api/wz.wzbinaryproperty.wzvalue.md index 4bb67ea..77c934c 100644 --- a/docs/api/wz.wzbinaryproperty.wzvalue.md +++ b/docs/api/wz.wzbinaryproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [wzValue](./wz.wzbinaryproperty.wzvalue.md) - -## WzBinaryProperty.wzValue property - -Signature: - -```typescript -get wzValue(): Promise; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryProperty](./wz.wzbinaryproperty.md) > [wzValue](./wz.wzbinaryproperty.wzvalue.md) + +## WzBinaryProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): Promise; +``` diff --git a/docs/api/wz.wzbinarypropertytype.md b/docs/api/wz.wzbinarypropertytype.md index 822778d..4bfea42 100644 --- a/docs/api/wz.wzbinarypropertytype.md +++ b/docs/api/wz.wzbinarypropertytype.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryPropertyType](./wz.wzbinarypropertytype.md) - -## WzBinaryPropertyType enum - - -Signature: - -```typescript -export declare enum WzBinaryPropertyType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| MP3 | 1 | | -| Raw | 0 | | -| WAV | 2 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryPropertyType](./wz.wzbinarypropertytype.md) + +## WzBinaryPropertyType enum + + +**Signature:** + +```typescript +export declare enum WzBinaryPropertyType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| MP3 | 1 | | +| Raw | 0 | | +| WAV | 2 | | + diff --git a/docs/api/wz.wzbinaryreader._constructor_.md b/docs/api/wz.wzbinaryreader._constructor_.md index fd84202..0bb9450 100644 --- a/docs/api/wz.wzbinaryreader._constructor_.md +++ b/docs/api/wz.wzbinaryreader._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [(constructor)](./wz.wzbinaryreader._constructor_.md) - -## WzBinaryReader.(constructor) - -Constructs a new instance of the `WzBinaryReader` class - -Signature: - -```typescript -constructor(filePath: string | File, wzIv: Uint8Array); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filePath | string \| File | | -| wzIv | Uint8Array | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [(constructor)](./wz.wzbinaryreader._constructor_.md) + +## WzBinaryReader.(constructor) + +Constructs a new instance of the `WzBinaryReader` class + +**Signature:** + +```typescript +constructor(filePath: string | File, wzIv: Uint8Array); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string \| File | | +| wzIv | Uint8Array | | + diff --git a/docs/api/wz.wzbinaryreader.available.md b/docs/api/wz.wzbinaryreader.available.md index 366c19a..640b945 100644 --- a/docs/api/wz.wzbinaryreader.available.md +++ b/docs/api/wz.wzbinaryreader.available.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [available](./wz.wzbinaryreader.available.md) - -## WzBinaryReader.available() method - -Signature: - -```typescript -available(): number; -``` -Returns: - -number - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [available](./wz.wzbinaryreader.available.md) + +## WzBinaryReader.available() method + +**Signature:** + +```typescript +available(): number; +``` +**Returns:** + +number + diff --git a/docs/api/wz.wzbinaryreader.decryptnonunicodestring.md b/docs/api/wz.wzbinaryreader.decryptnonunicodestring.md index 42df21a..3fac696 100644 --- a/docs/api/wz.wzbinaryreader.decryptnonunicodestring.md +++ b/docs/api/wz.wzbinaryreader.decryptnonunicodestring.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [decryptNonUnicodeString](./wz.wzbinaryreader.decryptnonunicodestring.md) - -## WzBinaryReader.decryptNonUnicodeString() method - -Signature: - -```typescript -decryptNonUnicodeString(stringToDecrypt: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| stringToDecrypt | string | | - -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [decryptNonUnicodeString](./wz.wzbinaryreader.decryptnonunicodestring.md) + +## WzBinaryReader.decryptNonUnicodeString() method + +**Signature:** + +```typescript +decryptNonUnicodeString(stringToDecrypt: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stringToDecrypt | string | | + +**Returns:** + +string + diff --git a/docs/api/wz.wzbinaryreader.decryptstring.md b/docs/api/wz.wzbinaryreader.decryptstring.md index 59d53b7..0534f76 100644 --- a/docs/api/wz.wzbinaryreader.decryptstring.md +++ b/docs/api/wz.wzbinaryreader.decryptstring.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [decryptString](./wz.wzbinaryreader.decryptstring.md) - -## WzBinaryReader.decryptString() method - -Signature: - -```typescript -decryptString(stringToDecrypt: string): string; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| stringToDecrypt | string | | - -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [decryptString](./wz.wzbinaryreader.decryptstring.md) + +## WzBinaryReader.decryptString() method + +**Signature:** + +```typescript +decryptString(stringToDecrypt: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stringToDecrypt | string | | + +**Returns:** + +string + diff --git a/docs/api/wz.wzbinaryreader.hash.md b/docs/api/wz.wzbinaryreader.hash.md index 3921e8a..4d7f0af 100644 --- a/docs/api/wz.wzbinaryreader.hash.md +++ b/docs/api/wz.wzbinaryreader.hash.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [hash](./wz.wzbinaryreader.hash.md) - -## WzBinaryReader.hash property - -Signature: - -```typescript -hash: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [hash](./wz.wzbinaryreader.hash.md) + +## WzBinaryReader.hash property + +**Signature:** + +```typescript +hash: number; +``` diff --git a/docs/api/wz.wzbinaryreader.header.md b/docs/api/wz.wzbinaryreader.header.md index 2a76b61..50256be 100644 --- a/docs/api/wz.wzbinaryreader.header.md +++ b/docs/api/wz.wzbinaryreader.header.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [header](./wz.wzbinaryreader.header.md) - -## WzBinaryReader.header property - -Signature: - -```typescript -header: WzHeader; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [header](./wz.wzbinaryreader.header.md) + +## WzBinaryReader.header property + +**Signature:** + +```typescript +header: WzHeader; +``` diff --git a/docs/api/wz.wzbinaryreader.md b/docs/api/wz.wzbinaryreader.md index 399db30..4e4ed1c 100644 --- a/docs/api/wz.wzbinaryreader.md +++ b/docs/api/wz.wzbinaryreader.md @@ -1,46 +1,46 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) - -## WzBinaryReader class - - -Signature: - -```typescript -export declare class WzBinaryReader extends AsyncBinaryReader implements IDisposable -``` -Extends: AsyncBinaryReader - -Implements: [IDisposable](./wz.idisposable.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(filePath, wzIv)](./wz.wzbinaryreader._constructor_.md) | | Constructs a new instance of the WzBinaryReader class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [hash](./wz.wzbinaryreader.hash.md) | | number | | -| [header](./wz.wzbinaryreader.header.md) | | [WzHeader](./wz.wzheader.md) | | -| [size](./wz.wzbinaryreader.size.md) | | number | | -| [wzKey](./wz.wzbinaryreader.wzkey.md) | | [WzMutableKey](./wz.wzmutablekey.md) | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [available()](./wz.wzbinaryreader.available.md) | | | -| [decryptNonUnicodeString(stringToDecrypt)](./wz.wzbinaryreader.decryptnonunicodestring.md) | | | -| [decryptString(stringToDecrypt)](./wz.wzbinaryreader.decryptstring.md) | | | -| [readNullTerminatedString()](./wz.wzbinaryreader.readnullterminatedstring.md) | | | -| [readStringBlock(offset)](./wz.wzbinaryreader.readstringblock.md) | | | -| [readWzInt()](./wz.wzbinaryreader.readwzint.md) | | | -| [readWzLong()](./wz.wzbinaryreader.readwzlong.md) | | | -| [readWzOffset()](./wz.wzbinaryreader.readwzoffset.md) | | | -| [readWzString()](./wz.wzbinaryreader.readwzstring.md) | | | -| [readWzStringAtOffset(offset, readByte)](./wz.wzbinaryreader.readwzstringatoffset.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) + +## WzBinaryReader class + + +**Signature:** + +```typescript +export declare class WzBinaryReader extends AsyncBinaryReader implements IDisposable +``` +**Extends:** AsyncBinaryReader + +**Implements:** [IDisposable](./wz.idisposable.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(filePath, wzIv)](./wz.wzbinaryreader._constructor_.md) | | Constructs a new instance of the WzBinaryReader class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [hash](./wz.wzbinaryreader.hash.md) | | number | | +| [header](./wz.wzbinaryreader.header.md) | | [WzHeader](./wz.wzheader.md) | | +| [size](./wz.wzbinaryreader.size.md) | readonly | number | | +| [wzKey](./wz.wzbinaryreader.wzkey.md) | | [WzMutableKey](./wz.wzmutablekey.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [available()](./wz.wzbinaryreader.available.md) | | | +| [decryptNonUnicodeString(stringToDecrypt)](./wz.wzbinaryreader.decryptnonunicodestring.md) | | | +| [decryptString(stringToDecrypt)](./wz.wzbinaryreader.decryptstring.md) | | | +| [readNullTerminatedString()](./wz.wzbinaryreader.readnullterminatedstring.md) | | | +| [readStringBlock(offset)](./wz.wzbinaryreader.readstringblock.md) | | | +| [readWzInt()](./wz.wzbinaryreader.readwzint.md) | | | +| [readWzLong()](./wz.wzbinaryreader.readwzlong.md) | | | +| [readWzOffset()](./wz.wzbinaryreader.readwzoffset.md) | | | +| [readWzString()](./wz.wzbinaryreader.readwzstring.md) | | | +| [readWzStringAtOffset(offset, readByte)](./wz.wzbinaryreader.readwzstringatoffset.md) | | | + diff --git a/docs/api/wz.wzbinaryreader.readnullterminatedstring.md b/docs/api/wz.wzbinaryreader.readnullterminatedstring.md index d4a8e0a..41eaf86 100644 --- a/docs/api/wz.wzbinaryreader.readnullterminatedstring.md +++ b/docs/api/wz.wzbinaryreader.readnullterminatedstring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readNullTerminatedString](./wz.wzbinaryreader.readnullterminatedstring.md) - -## WzBinaryReader.readNullTerminatedString() method - -Signature: - -```typescript -readNullTerminatedString(): Promise; -``` -Returns: - -Promise<string> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readNullTerminatedString](./wz.wzbinaryreader.readnullterminatedstring.md) + +## WzBinaryReader.readNullTerminatedString() method + +**Signature:** + +```typescript +readNullTerminatedString(): Promise; +``` +**Returns:** + +Promise<string> + diff --git a/docs/api/wz.wzbinaryreader.readstringblock.md b/docs/api/wz.wzbinaryreader.readstringblock.md index a6c5c7d..4836886 100644 --- a/docs/api/wz.wzbinaryreader.readstringblock.md +++ b/docs/api/wz.wzbinaryreader.readstringblock.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readStringBlock](./wz.wzbinaryreader.readstringblock.md) - -## WzBinaryReader.readStringBlock() method - -Signature: - -```typescript -readStringBlock(offset: number): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| offset | number | | - -Returns: - -Promise<string> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readStringBlock](./wz.wzbinaryreader.readstringblock.md) + +## WzBinaryReader.readStringBlock() method + +**Signature:** + +```typescript +readStringBlock(offset: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| offset | number | | + +**Returns:** + +Promise<string> + diff --git a/docs/api/wz.wzbinaryreader.readwzint.md b/docs/api/wz.wzbinaryreader.readwzint.md index 818c27c..6625703 100644 --- a/docs/api/wz.wzbinaryreader.readwzint.md +++ b/docs/api/wz.wzbinaryreader.readwzint.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzInt](./wz.wzbinaryreader.readwzint.md) - -## WzBinaryReader.readWzInt() method - -Signature: - -```typescript -readWzInt(): Promise; -``` -Returns: - -Promise<number> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzInt](./wz.wzbinaryreader.readwzint.md) + +## WzBinaryReader.readWzInt() method + +**Signature:** + +```typescript +readWzInt(): Promise; +``` +**Returns:** + +Promise<number> + diff --git a/docs/api/wz.wzbinaryreader.readwzlong.md b/docs/api/wz.wzbinaryreader.readwzlong.md index 15af0c3..8ce4a19 100644 --- a/docs/api/wz.wzbinaryreader.readwzlong.md +++ b/docs/api/wz.wzbinaryreader.readwzlong.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzLong](./wz.wzbinaryreader.readwzlong.md) - -## WzBinaryReader.readWzLong() method - -Signature: - -```typescript -readWzLong(): Promise; -``` -Returns: - -Promise<bigint> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzLong](./wz.wzbinaryreader.readwzlong.md) + +## WzBinaryReader.readWzLong() method + +**Signature:** + +```typescript +readWzLong(): Promise; +``` +**Returns:** + +Promise<bigint> + diff --git a/docs/api/wz.wzbinaryreader.readwzoffset.md b/docs/api/wz.wzbinaryreader.readwzoffset.md index b9b3028..fe8a3b8 100644 --- a/docs/api/wz.wzbinaryreader.readwzoffset.md +++ b/docs/api/wz.wzbinaryreader.readwzoffset.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzOffset](./wz.wzbinaryreader.readwzoffset.md) - -## WzBinaryReader.readWzOffset() method - -Signature: - -```typescript -readWzOffset(): Promise; -``` -Returns: - -Promise<number> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzOffset](./wz.wzbinaryreader.readwzoffset.md) + +## WzBinaryReader.readWzOffset() method + +**Signature:** + +```typescript +readWzOffset(): Promise; +``` +**Returns:** + +Promise<number> + diff --git a/docs/api/wz.wzbinaryreader.readwzstring.md b/docs/api/wz.wzbinaryreader.readwzstring.md index 19bce4a..5ef9e4f 100644 --- a/docs/api/wz.wzbinaryreader.readwzstring.md +++ b/docs/api/wz.wzbinaryreader.readwzstring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzString](./wz.wzbinaryreader.readwzstring.md) - -## WzBinaryReader.readWzString() method - -Signature: - -```typescript -readWzString(): Promise; -``` -Returns: - -Promise<string> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzString](./wz.wzbinaryreader.readwzstring.md) + +## WzBinaryReader.readWzString() method + +**Signature:** + +```typescript +readWzString(): Promise; +``` +**Returns:** + +Promise<string> + diff --git a/docs/api/wz.wzbinaryreader.readwzstringatoffset.md b/docs/api/wz.wzbinaryreader.readwzstringatoffset.md index 388754f..3892bd8 100644 --- a/docs/api/wz.wzbinaryreader.readwzstringatoffset.md +++ b/docs/api/wz.wzbinaryreader.readwzstringatoffset.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzStringAtOffset](./wz.wzbinaryreader.readwzstringatoffset.md) - -## WzBinaryReader.readWzStringAtOffset() method - -Signature: - -```typescript -readWzStringAtOffset(offset: number, readByte?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| offset | number | | -| readByte | boolean | (Optional) | - -Returns: - -Promise<string> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [readWzStringAtOffset](./wz.wzbinaryreader.readwzstringatoffset.md) + +## WzBinaryReader.readWzStringAtOffset() method + +**Signature:** + +```typescript +readWzStringAtOffset(offset: number, readByte?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| offset | number | | +| readByte | boolean | _(Optional)_ | + +**Returns:** + +Promise<string> + diff --git a/docs/api/wz.wzbinaryreader.size.md b/docs/api/wz.wzbinaryreader.size.md index 76caa9a..b7899b2 100644 --- a/docs/api/wz.wzbinaryreader.size.md +++ b/docs/api/wz.wzbinaryreader.size.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [size](./wz.wzbinaryreader.size.md) - -## WzBinaryReader.size property - -Signature: - -```typescript -get size(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [size](./wz.wzbinaryreader.size.md) + +## WzBinaryReader.size property + +**Signature:** + +```typescript +get size(): number; +``` diff --git a/docs/api/wz.wzbinaryreader.wzkey.md b/docs/api/wz.wzbinaryreader.wzkey.md index fb5c532..4cd14f3 100644 --- a/docs/api/wz.wzbinaryreader.wzkey.md +++ b/docs/api/wz.wzbinaryreader.wzkey.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [wzKey](./wz.wzbinaryreader.wzkey.md) - -## WzBinaryReader.wzKey property - -Signature: - -```typescript -wzKey: WzMutableKey; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzBinaryReader](./wz.wzbinaryreader.md) > [wzKey](./wz.wzbinaryreader.wzkey.md) + +## WzBinaryReader.wzKey property + +**Signature:** + +```typescript +wzKey: WzMutableKey; +``` diff --git a/docs/api/wz.wzcanvasproperty._constructor_.md b/docs/api/wz.wzcanvasproperty._constructor_.md index 37ee6da..468b9a8 100644 --- a/docs/api/wz.wzcanvasproperty._constructor_.md +++ b/docs/api/wz.wzcanvasproperty._constructor_.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [(constructor)](./wz.wzcanvasproperty._constructor_.md) - -## WzCanvasProperty.(constructor) - -Constructs a new instance of the `WzCanvasProperty` class - -Signature: - -```typescript -constructor(name?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [(constructor)](./wz.wzcanvasproperty._constructor_.md) + +## WzCanvasProperty.(constructor) + +Constructs a new instance of the `WzCanvasProperty` class + +**Signature:** + +```typescript +constructor(name?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | + diff --git a/docs/api/wz.wzcanvasproperty.addproperties.md b/docs/api/wz.wzcanvasproperty.addproperties.md index 76afa39..9d0b25e 100644 --- a/docs/api/wz.wzcanvasproperty.addproperties.md +++ b/docs/api/wz.wzcanvasproperty.addproperties.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [addProperties](./wz.wzcanvasproperty.addproperties.md) - -## WzCanvasProperty.addProperties() method - -Signature: - -```typescript -addProperties(props: Set): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [addProperties](./wz.wzcanvasproperty.addproperties.md) + +## WzCanvasProperty.addProperties() method + +**Signature:** + +```typescript +addProperties(props: Set): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzcanvasproperty.addproperty.md b/docs/api/wz.wzcanvasproperty.addproperty.md index 83c4c70..af77a39 100644 --- a/docs/api/wz.wzcanvasproperty.addproperty.md +++ b/docs/api/wz.wzcanvasproperty.addproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [addProperty](./wz.wzcanvasproperty.addproperty.md) - -## WzCanvasProperty.addProperty() method - -Signature: - -```typescript -addProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [addProperty](./wz.wzcanvasproperty.addproperty.md) + +## WzCanvasProperty.addProperty() method + +**Signature:** + +```typescript +addProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzcanvasproperty.animationdelaypropertyname.md b/docs/api/wz.wzcanvasproperty.animationdelaypropertyname.md index 8c3cfdb..e48c682 100644 --- a/docs/api/wz.wzcanvasproperty.animationdelaypropertyname.md +++ b/docs/api/wz.wzcanvasproperty.animationdelaypropertyname.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [animationDelayPropertyName](./wz.wzcanvasproperty.animationdelaypropertyname.md) - -## WzCanvasProperty.animationDelayPropertyName property - -Signature: - -```typescript -get animationDelayPropertyName(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [animationDelayPropertyName](./wz.wzcanvasproperty.animationdelaypropertyname.md) + +## WzCanvasProperty.animationDelayPropertyName property + +**Signature:** + +```typescript +get animationDelayPropertyName(): string; +``` diff --git a/docs/api/wz.wzcanvasproperty.at.md b/docs/api/wz.wzcanvasproperty.at.md index 5e8e029..fd1b7e9 100644 --- a/docs/api/wz.wzcanvasproperty.at.md +++ b/docs/api/wz.wzcanvasproperty.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [at](./wz.wzcanvasproperty.at.md) - -## WzCanvasProperty.at() method - -Signature: - -```typescript -at(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [at](./wz.wzcanvasproperty.at.md) + +## WzCanvasProperty.at() method + +**Signature:** + +```typescript +at(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzcanvasproperty.clearproperties.md b/docs/api/wz.wzcanvasproperty.clearproperties.md index 11490f8..f762f8e 100644 --- a/docs/api/wz.wzcanvasproperty.clearproperties.md +++ b/docs/api/wz.wzcanvasproperty.clearproperties.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [clearProperties](./wz.wzcanvasproperty.clearproperties.md) - -## WzCanvasProperty.clearProperties() method - -Signature: - -```typescript -clearProperties(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [clearProperties](./wz.wzcanvasproperty.clearproperties.md) + +## WzCanvasProperty.clearProperties() method + +**Signature:** + +```typescript +clearProperties(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzcanvasproperty.dispose.md b/docs/api/wz.wzcanvasproperty.dispose.md index 50d99d1..6aa81f4 100644 --- a/docs/api/wz.wzcanvasproperty.dispose.md +++ b/docs/api/wz.wzcanvasproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [dispose](./wz.wzcanvasproperty.dispose.md) - -## WzCanvasProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [dispose](./wz.wzcanvasproperty.dispose.md) + +## WzCanvasProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzcanvasproperty.getbitmap.md b/docs/api/wz.wzcanvasproperty.getbitmap.md index 26f478b..6fc9bf2 100644 --- a/docs/api/wz.wzcanvasproperty.getbitmap.md +++ b/docs/api/wz.wzcanvasproperty.getbitmap.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getBitmap](./wz.wzcanvasproperty.getbitmap.md) - -## WzCanvasProperty.getBitmap() method - -Signature: - -```typescript -getBitmap(): Promise; -``` -Returns: - -Promise<[Canvas](./wz.canvas.md) \| null> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getBitmap](./wz.wzcanvasproperty.getbitmap.md) + +## WzCanvasProperty.getBitmap() method + +**Signature:** + +```typescript +getBitmap(): Promise; +``` +**Returns:** + +Promise<[Canvas](./wz.canvas.md) \| null> + diff --git a/docs/api/wz.wzcanvasproperty.getfrompath.md b/docs/api/wz.wzcanvasproperty.getfrompath.md index d4d29fd..3d3803f 100644 --- a/docs/api/wz.wzcanvasproperty.getfrompath.md +++ b/docs/api/wz.wzcanvasproperty.getfrompath.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getFromPath](./wz.wzcanvasproperty.getfrompath.md) - -## WzCanvasProperty.getFromPath() method - -Signature: - -```typescript -getFromPath(path: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getFromPath](./wz.wzcanvasproperty.getfrompath.md) + +## WzCanvasProperty.getFromPath() method + +**Signature:** + +```typescript +getFromPath(path: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md b/docs/api/wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md index 782b9e8..e109e98 100644 --- a/docs/api/wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md +++ b/docs/api/wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getLinkedWzCanvasBitmap](./wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md) - -## WzCanvasProperty.getLinkedWzCanvasBitmap() method - -Signature: - -```typescript -getLinkedWzCanvasBitmap(): Promise; -``` -Returns: - -Promise<[Canvas](./wz.canvas.md) \| null> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getLinkedWzCanvasBitmap](./wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md) + +## WzCanvasProperty.getLinkedWzCanvasBitmap() method + +**Signature:** + +```typescript +getLinkedWzCanvasBitmap(): Promise; +``` +**Returns:** + +Promise<[Canvas](./wz.canvas.md) \| null> + diff --git a/docs/api/wz.wzcanvasproperty.getproperty.md b/docs/api/wz.wzcanvasproperty.getproperty.md index ad5815e..ff466cc 100644 --- a/docs/api/wz.wzcanvasproperty.getproperty.md +++ b/docs/api/wz.wzcanvasproperty.getproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getProperty](./wz.wzcanvasproperty.getproperty.md) - -## WzCanvasProperty.getProperty() method - -Signature: - -```typescript -getProperty(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [getProperty](./wz.wzcanvasproperty.getproperty.md) + +## WzCanvasProperty.getProperty() method + +**Signature:** + +```typescript +getProperty(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzcanvasproperty.haveinlinkproperty.md b/docs/api/wz.wzcanvasproperty.haveinlinkproperty.md index c0739d0..97e48ac 100644 --- a/docs/api/wz.wzcanvasproperty.haveinlinkproperty.md +++ b/docs/api/wz.wzcanvasproperty.haveinlinkproperty.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [haveInlinkProperty](./wz.wzcanvasproperty.haveinlinkproperty.md) - -## WzCanvasProperty.haveInlinkProperty() method - -Signature: - -```typescript -haveInlinkProperty(): boolean; -``` -Returns: - -boolean - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [haveInlinkProperty](./wz.wzcanvasproperty.haveinlinkproperty.md) + +## WzCanvasProperty.haveInlinkProperty() method + +**Signature:** + +```typescript +haveInlinkProperty(): boolean; +``` +**Returns:** + +boolean + diff --git a/docs/api/wz.wzcanvasproperty.haveoutlinkproperty.md b/docs/api/wz.wzcanvasproperty.haveoutlinkproperty.md index d24edcd..5434f3e 100644 --- a/docs/api/wz.wzcanvasproperty.haveoutlinkproperty.md +++ b/docs/api/wz.wzcanvasproperty.haveoutlinkproperty.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [haveOutlinkProperty](./wz.wzcanvasproperty.haveoutlinkproperty.md) - -## WzCanvasProperty.haveOutlinkProperty() method - -Signature: - -```typescript -haveOutlinkProperty(): boolean; -``` -Returns: - -boolean - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [haveOutlinkProperty](./wz.wzcanvasproperty.haveoutlinkproperty.md) + +## WzCanvasProperty.haveOutlinkProperty() method + +**Signature:** + +```typescript +haveOutlinkProperty(): boolean; +``` +**Returns:** + +boolean + diff --git a/docs/api/wz.wzcanvasproperty.headpropertyname.md b/docs/api/wz.wzcanvasproperty.headpropertyname.md index 372afa8..3622718 100644 --- a/docs/api/wz.wzcanvasproperty.headpropertyname.md +++ b/docs/api/wz.wzcanvasproperty.headpropertyname.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [headPropertyName](./wz.wzcanvasproperty.headpropertyname.md) - -## WzCanvasProperty.headPropertyName property - -Signature: - -```typescript -get headPropertyName(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [headPropertyName](./wz.wzcanvasproperty.headpropertyname.md) + +## WzCanvasProperty.headPropertyName property + +**Signature:** + +```typescript +get headPropertyName(): string; +``` diff --git a/docs/api/wz.wzcanvasproperty.inlinkpropertyname.md b/docs/api/wz.wzcanvasproperty.inlinkpropertyname.md index 52d8e67..71ac2af 100644 --- a/docs/api/wz.wzcanvasproperty.inlinkpropertyname.md +++ b/docs/api/wz.wzcanvasproperty.inlinkpropertyname.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [inlinkPropertyName](./wz.wzcanvasproperty.inlinkpropertyname.md) - -## WzCanvasProperty.inlinkPropertyName property - -Signature: - -```typescript -get inlinkPropertyName(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [inlinkPropertyName](./wz.wzcanvasproperty.inlinkpropertyname.md) + +## WzCanvasProperty.inlinkPropertyName property + +**Signature:** + +```typescript +get inlinkPropertyName(): string; +``` diff --git a/docs/api/wz.wzcanvasproperty.ltpropertyname.md b/docs/api/wz.wzcanvasproperty.ltpropertyname.md index c724a39..3c2d6cf 100644 --- a/docs/api/wz.wzcanvasproperty.ltpropertyname.md +++ b/docs/api/wz.wzcanvasproperty.ltpropertyname.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [ltPropertyName](./wz.wzcanvasproperty.ltpropertyname.md) - -## WzCanvasProperty.ltPropertyName property - -Signature: - -```typescript -get ltPropertyName(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [ltPropertyName](./wz.wzcanvasproperty.ltpropertyname.md) + +## WzCanvasProperty.ltPropertyName property + +**Signature:** + +```typescript +get ltPropertyName(): string; +``` diff --git a/docs/api/wz.wzcanvasproperty.md b/docs/api/wz.wzcanvasproperty.md index d4cba09..39024f9 100644 --- a/docs/api/wz.wzcanvasproperty.md +++ b/docs/api/wz.wzcanvasproperty.md @@ -1,58 +1,58 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) - -## WzCanvasProperty class - - -Signature: - -```typescript -export declare class WzCanvasProperty extends WzExtended implements IPropertyContainer -``` -Extends: [WzExtended](./wz.wzextended.md) - -Implements: [IPropertyContainer](./wz.ipropertycontainer.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name)](./wz.wzcanvasproperty._constructor_.md) | | Constructs a new instance of the WzCanvasProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [animationDelayPropertyName](./wz.wzcanvasproperty.animationdelaypropertyname.md) | | string | | -| [headPropertyName](./wz.wzcanvasproperty.headpropertyname.md) | | string | | -| [inlinkPropertyName](./wz.wzcanvasproperty.inlinkpropertyname.md) | | string | | -| [ltPropertyName](./wz.wzcanvasproperty.ltpropertyname.md) | | string | | -| [name](./wz.wzcanvasproperty.name.md) | | string | | -| [originPropertyName](./wz.wzcanvasproperty.originpropertyname.md) | | string | | -| [outlinkPropertyName](./wz.wzcanvasproperty.outlinkpropertyname.md) | | string | | -| [parent](./wz.wzcanvasproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [pngProperty](./wz.wzcanvasproperty.pngproperty.md) | | [WzPngProperty](./wz.wzpngproperty.md) \| null | | -| [propertyType](./wz.wzcanvasproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [wzProperties](./wz.wzcanvasproperty.wzproperties.md) | | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | -| [wzValue](./wz.wzcanvasproperty.wzvalue.md) | | [WzPngProperty](./wz.wzpngproperty.md) \| null | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addProperties(props)](./wz.wzcanvasproperty.addproperties.md) | | | -| [addProperty(prop)](./wz.wzcanvasproperty.addproperty.md) | | | -| [at(name)](./wz.wzcanvasproperty.at.md) | | | -| [clearProperties()](./wz.wzcanvasproperty.clearproperties.md) | | | -| [dispose()](./wz.wzcanvasproperty.dispose.md) | | | -| [getBitmap()](./wz.wzcanvasproperty.getbitmap.md) | | | -| [getFromPath(path)](./wz.wzcanvasproperty.getfrompath.md) | | | -| [getLinkedWzCanvasBitmap()](./wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md) | | | -| [getProperty(name)](./wz.wzcanvasproperty.getproperty.md) | | | -| [haveInlinkProperty()](./wz.wzcanvasproperty.haveinlinkproperty.md) | | | -| [haveOutlinkProperty()](./wz.wzcanvasproperty.haveoutlinkproperty.md) | | | -| [removeProperty(prop)](./wz.wzcanvasproperty.removeproperty.md) | | | -| [set(name, value)](./wz.wzcanvasproperty.set.md) | | | -| [setValue(value)](./wz.wzcanvasproperty.setvalue.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) + +## WzCanvasProperty class + + +**Signature:** + +```typescript +export declare class WzCanvasProperty extends WzExtended implements IPropertyContainer +``` +**Extends:** [WzExtended](./wz.wzextended.md) + +**Implements:** [IPropertyContainer](./wz.ipropertycontainer.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name)](./wz.wzcanvasproperty._constructor_.md) | | Constructs a new instance of the WzCanvasProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [animationDelayPropertyName](./wz.wzcanvasproperty.animationdelaypropertyname.md) | readonly | string | | +| [headPropertyName](./wz.wzcanvasproperty.headpropertyname.md) | readonly | string | | +| [inlinkPropertyName](./wz.wzcanvasproperty.inlinkpropertyname.md) | readonly | string | | +| [ltPropertyName](./wz.wzcanvasproperty.ltpropertyname.md) | readonly | string | | +| [name](./wz.wzcanvasproperty.name.md) | | string | | +| [originPropertyName](./wz.wzcanvasproperty.originpropertyname.md) | readonly | string | | +| [outlinkPropertyName](./wz.wzcanvasproperty.outlinkpropertyname.md) | readonly | string | | +| [parent](./wz.wzcanvasproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [pngProperty](./wz.wzcanvasproperty.pngproperty.md) | | [WzPngProperty](./wz.wzpngproperty.md) \| null | | +| [propertyType](./wz.wzcanvasproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [wzProperties](./wz.wzcanvasproperty.wzproperties.md) | readonly | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | +| [wzValue](./wz.wzcanvasproperty.wzvalue.md) | readonly | [WzPngProperty](./wz.wzpngproperty.md) \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addProperties(props)](./wz.wzcanvasproperty.addproperties.md) | | | +| [addProperty(prop)](./wz.wzcanvasproperty.addproperty.md) | | | +| [at(name)](./wz.wzcanvasproperty.at.md) | | | +| [clearProperties()](./wz.wzcanvasproperty.clearproperties.md) | | | +| [dispose()](./wz.wzcanvasproperty.dispose.md) | | | +| [getBitmap()](./wz.wzcanvasproperty.getbitmap.md) | | | +| [getFromPath(path)](./wz.wzcanvasproperty.getfrompath.md) | | | +| [getLinkedWzCanvasBitmap()](./wz.wzcanvasproperty.getlinkedwzcanvasbitmap.md) | | | +| [getProperty(name)](./wz.wzcanvasproperty.getproperty.md) | | | +| [haveInlinkProperty()](./wz.wzcanvasproperty.haveinlinkproperty.md) | | | +| [haveOutlinkProperty()](./wz.wzcanvasproperty.haveoutlinkproperty.md) | | | +| [removeProperty(prop)](./wz.wzcanvasproperty.removeproperty.md) | | | +| [set(name, value)](./wz.wzcanvasproperty.set.md) | | | +| [setValue(value)](./wz.wzcanvasproperty.setvalue.md) | | | + diff --git a/docs/api/wz.wzcanvasproperty.name.md b/docs/api/wz.wzcanvasproperty.name.md index 1790def..fe5d8e3 100644 --- a/docs/api/wz.wzcanvasproperty.name.md +++ b/docs/api/wz.wzcanvasproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [name](./wz.wzcanvasproperty.name.md) - -## WzCanvasProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [name](./wz.wzcanvasproperty.name.md) + +## WzCanvasProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzcanvasproperty.originpropertyname.md b/docs/api/wz.wzcanvasproperty.originpropertyname.md index d5e23ef..0199fa6 100644 --- a/docs/api/wz.wzcanvasproperty.originpropertyname.md +++ b/docs/api/wz.wzcanvasproperty.originpropertyname.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [originPropertyName](./wz.wzcanvasproperty.originpropertyname.md) - -## WzCanvasProperty.originPropertyName property - -Signature: - -```typescript -get originPropertyName(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [originPropertyName](./wz.wzcanvasproperty.originpropertyname.md) + +## WzCanvasProperty.originPropertyName property + +**Signature:** + +```typescript +get originPropertyName(): string; +``` diff --git a/docs/api/wz.wzcanvasproperty.outlinkpropertyname.md b/docs/api/wz.wzcanvasproperty.outlinkpropertyname.md index 86fac8a..3817917 100644 --- a/docs/api/wz.wzcanvasproperty.outlinkpropertyname.md +++ b/docs/api/wz.wzcanvasproperty.outlinkpropertyname.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [outlinkPropertyName](./wz.wzcanvasproperty.outlinkpropertyname.md) - -## WzCanvasProperty.outlinkPropertyName property - -Signature: - -```typescript -get outlinkPropertyName(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [outlinkPropertyName](./wz.wzcanvasproperty.outlinkpropertyname.md) + +## WzCanvasProperty.outlinkPropertyName property + +**Signature:** + +```typescript +get outlinkPropertyName(): string; +``` diff --git a/docs/api/wz.wzcanvasproperty.parent.md b/docs/api/wz.wzcanvasproperty.parent.md index 184cbc6..73b7018 100644 --- a/docs/api/wz.wzcanvasproperty.parent.md +++ b/docs/api/wz.wzcanvasproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [parent](./wz.wzcanvasproperty.parent.md) - -## WzCanvasProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [parent](./wz.wzcanvasproperty.parent.md) + +## WzCanvasProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzcanvasproperty.pngproperty.md b/docs/api/wz.wzcanvasproperty.pngproperty.md index 30202b1..58c71eb 100644 --- a/docs/api/wz.wzcanvasproperty.pngproperty.md +++ b/docs/api/wz.wzcanvasproperty.pngproperty.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [pngProperty](./wz.wzcanvasproperty.pngproperty.md) - -## WzCanvasProperty.pngProperty property - -Signature: - -```typescript -pngProperty: WzPngProperty | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [pngProperty](./wz.wzcanvasproperty.pngproperty.md) + +## WzCanvasProperty.pngProperty property + +**Signature:** + +```typescript +pngProperty: WzPngProperty | null; +``` diff --git a/docs/api/wz.wzcanvasproperty.propertytype.md b/docs/api/wz.wzcanvasproperty.propertytype.md index b644123..6fd9334 100644 --- a/docs/api/wz.wzcanvasproperty.propertytype.md +++ b/docs/api/wz.wzcanvasproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [propertyType](./wz.wzcanvasproperty.propertytype.md) - -## WzCanvasProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [propertyType](./wz.wzcanvasproperty.propertytype.md) + +## WzCanvasProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzcanvasproperty.removeproperty.md b/docs/api/wz.wzcanvasproperty.removeproperty.md index 1294448..0a0f8c1 100644 --- a/docs/api/wz.wzcanvasproperty.removeproperty.md +++ b/docs/api/wz.wzcanvasproperty.removeproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [removeProperty](./wz.wzcanvasproperty.removeproperty.md) - -## WzCanvasProperty.removeProperty() method - -Signature: - -```typescript -removeProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [removeProperty](./wz.wzcanvasproperty.removeproperty.md) + +## WzCanvasProperty.removeProperty() method + +**Signature:** + +```typescript +removeProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzcanvasproperty.set.md b/docs/api/wz.wzcanvasproperty.set.md index 8749fd4..23e0deb 100644 --- a/docs/api/wz.wzcanvasproperty.set.md +++ b/docs/api/wz.wzcanvasproperty.set.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [set](./wz.wzcanvasproperty.set.md) - -## WzCanvasProperty.set() method - -Signature: - -```typescript -set(name: string, value: WzImageProperty | null): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| value | [WzImageProperty](./wz.wzimageproperty.md) \| null | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [set](./wz.wzcanvasproperty.set.md) + +## WzCanvasProperty.set() method + +**Signature:** + +```typescript +set(name: string, value: WzImageProperty | null): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| value | [WzImageProperty](./wz.wzimageproperty.md) \| null | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzcanvasproperty.setvalue.md b/docs/api/wz.wzcanvasproperty.setvalue.md index a1e970a..925fda8 100644 --- a/docs/api/wz.wzcanvasproperty.setvalue.md +++ b/docs/api/wz.wzcanvasproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [setValue](./wz.wzcanvasproperty.setvalue.md) - -## WzCanvasProperty.setValue() method - -Signature: - -```typescript -setValue(value: Uint8Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | Uint8Array | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [setValue](./wz.wzcanvasproperty.setvalue.md) + +## WzCanvasProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: Uint8Array): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | Uint8Array | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzcanvasproperty.wzproperties.md b/docs/api/wz.wzcanvasproperty.wzproperties.md index c35bb67..b1a3c1b 100644 --- a/docs/api/wz.wzcanvasproperty.wzproperties.md +++ b/docs/api/wz.wzcanvasproperty.wzproperties.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [wzProperties](./wz.wzcanvasproperty.wzproperties.md) - -## WzCanvasProperty.wzProperties property - -Signature: - -```typescript -get wzProperties(): Set; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [wzProperties](./wz.wzcanvasproperty.wzproperties.md) + +## WzCanvasProperty.wzProperties property + +**Signature:** + +```typescript +get wzProperties(): Set; +``` diff --git a/docs/api/wz.wzcanvasproperty.wzvalue.md b/docs/api/wz.wzcanvasproperty.wzvalue.md index e33ce19..05a1803 100644 --- a/docs/api/wz.wzcanvasproperty.wzvalue.md +++ b/docs/api/wz.wzcanvasproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [wzValue](./wz.wzcanvasproperty.wzvalue.md) - -## WzCanvasProperty.wzValue property - -Signature: - -```typescript -get wzValue(): WzPngProperty | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzCanvasProperty](./wz.wzcanvasproperty.md) > [wzValue](./wz.wzcanvasproperty.wzvalue.md) + +## WzCanvasProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): WzPngProperty | null; +``` diff --git a/docs/api/wz.wzconvexproperty._constructor_.md b/docs/api/wz.wzconvexproperty._constructor_.md index 77e43f2..1d0f8db 100644 --- a/docs/api/wz.wzconvexproperty._constructor_.md +++ b/docs/api/wz.wzconvexproperty._constructor_.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [(constructor)](./wz.wzconvexproperty._constructor_.md) - -## WzConvexProperty.(constructor) - -Constructs a new instance of the `WzConvexProperty` class - -Signature: - -```typescript -constructor(name?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [(constructor)](./wz.wzconvexproperty._constructor_.md) + +## WzConvexProperty.(constructor) + +Constructs a new instance of the `WzConvexProperty` class + +**Signature:** + +```typescript +constructor(name?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | + diff --git a/docs/api/wz.wzconvexproperty.addproperties.md b/docs/api/wz.wzconvexproperty.addproperties.md index 338fe25..fdd2a40 100644 --- a/docs/api/wz.wzconvexproperty.addproperties.md +++ b/docs/api/wz.wzconvexproperty.addproperties.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [addProperties](./wz.wzconvexproperty.addproperties.md) - -## WzConvexProperty.addProperties() method - -Signature: - -```typescript -addProperties(props: Set): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [addProperties](./wz.wzconvexproperty.addproperties.md) + +## WzConvexProperty.addProperties() method + +**Signature:** + +```typescript +addProperties(props: Set): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzconvexproperty.addproperty.md b/docs/api/wz.wzconvexproperty.addproperty.md index 17eed3e..f5c90f6 100644 --- a/docs/api/wz.wzconvexproperty.addproperty.md +++ b/docs/api/wz.wzconvexproperty.addproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [addProperty](./wz.wzconvexproperty.addproperty.md) - -## WzConvexProperty.addProperty() method - -Signature: - -```typescript -addProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [addProperty](./wz.wzconvexproperty.addproperty.md) + +## WzConvexProperty.addProperty() method + +**Signature:** + +```typescript +addProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzconvexproperty.at.md b/docs/api/wz.wzconvexproperty.at.md index dc822df..253dc91 100644 --- a/docs/api/wz.wzconvexproperty.at.md +++ b/docs/api/wz.wzconvexproperty.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [at](./wz.wzconvexproperty.at.md) - -## WzConvexProperty.at() method - -Signature: - -```typescript -at(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [at](./wz.wzconvexproperty.at.md) + +## WzConvexProperty.at() method + +**Signature:** + +```typescript +at(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzconvexproperty.clearproperties.md b/docs/api/wz.wzconvexproperty.clearproperties.md index 11d14d6..4e00235 100644 --- a/docs/api/wz.wzconvexproperty.clearproperties.md +++ b/docs/api/wz.wzconvexproperty.clearproperties.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [clearProperties](./wz.wzconvexproperty.clearproperties.md) - -## WzConvexProperty.clearProperties() method - -Signature: - -```typescript -clearProperties(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [clearProperties](./wz.wzconvexproperty.clearproperties.md) + +## WzConvexProperty.clearProperties() method + +**Signature:** + +```typescript +clearProperties(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzconvexproperty.dispose.md b/docs/api/wz.wzconvexproperty.dispose.md index 944d337..ab36eee 100644 --- a/docs/api/wz.wzconvexproperty.dispose.md +++ b/docs/api/wz.wzconvexproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [dispose](./wz.wzconvexproperty.dispose.md) - -## WzConvexProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [dispose](./wz.wzconvexproperty.dispose.md) + +## WzConvexProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzconvexproperty.getfrompath.md b/docs/api/wz.wzconvexproperty.getfrompath.md index e48f10c..714da67 100644 --- a/docs/api/wz.wzconvexproperty.getfrompath.md +++ b/docs/api/wz.wzconvexproperty.getfrompath.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [getFromPath](./wz.wzconvexproperty.getfrompath.md) - -## WzConvexProperty.getFromPath() method - -Signature: - -```typescript -getFromPath(path: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [getFromPath](./wz.wzconvexproperty.getfrompath.md) + +## WzConvexProperty.getFromPath() method + +**Signature:** + +```typescript +getFromPath(path: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzconvexproperty.getproperty.md b/docs/api/wz.wzconvexproperty.getproperty.md index 8617410..cf07cd5 100644 --- a/docs/api/wz.wzconvexproperty.getproperty.md +++ b/docs/api/wz.wzconvexproperty.getproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [getProperty](./wz.wzconvexproperty.getproperty.md) - -## WzConvexProperty.getProperty() method - -Signature: - -```typescript -getProperty(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [getProperty](./wz.wzconvexproperty.getproperty.md) + +## WzConvexProperty.getProperty() method + +**Signature:** + +```typescript +getProperty(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzconvexproperty.md b/docs/api/wz.wzconvexproperty.md index e8a9d19..55c715e 100644 --- a/docs/api/wz.wzconvexproperty.md +++ b/docs/api/wz.wzconvexproperty.md @@ -1,45 +1,45 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) - -## WzConvexProperty class - - -Signature: - -```typescript -export declare class WzConvexProperty extends WzExtended implements IPropertyContainer -``` -Extends: [WzExtended](./wz.wzextended.md) - -Implements: [IPropertyContainer](./wz.ipropertycontainer.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name)](./wz.wzconvexproperty._constructor_.md) | | Constructs a new instance of the WzConvexProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzconvexproperty.name.md) | | string | | -| [parent](./wz.wzconvexproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzconvexproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [wzProperties](./wz.wzconvexproperty.wzproperties.md) | | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addProperties(props)](./wz.wzconvexproperty.addproperties.md) | | | -| [addProperty(prop)](./wz.wzconvexproperty.addproperty.md) | | | -| [at(name)](./wz.wzconvexproperty.at.md) | | | -| [clearProperties()](./wz.wzconvexproperty.clearproperties.md) | | | -| [dispose()](./wz.wzconvexproperty.dispose.md) | | | -| [getFromPath(path)](./wz.wzconvexproperty.getfrompath.md) | | | -| [getProperty(name)](./wz.wzconvexproperty.getproperty.md) | | | -| [removeProperty(prop)](./wz.wzconvexproperty.removeproperty.md) | | | -| [setValue(\_value)](./wz.wzconvexproperty.setvalue.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) + +## WzConvexProperty class + + +**Signature:** + +```typescript +export declare class WzConvexProperty extends WzExtended implements IPropertyContainer +``` +**Extends:** [WzExtended](./wz.wzextended.md) + +**Implements:** [IPropertyContainer](./wz.ipropertycontainer.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name)](./wz.wzconvexproperty._constructor_.md) | | Constructs a new instance of the WzConvexProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzconvexproperty.name.md) | | string | | +| [parent](./wz.wzconvexproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzconvexproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [wzProperties](./wz.wzconvexproperty.wzproperties.md) | readonly | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addProperties(props)](./wz.wzconvexproperty.addproperties.md) | | | +| [addProperty(prop)](./wz.wzconvexproperty.addproperty.md) | | | +| [at(name)](./wz.wzconvexproperty.at.md) | | | +| [clearProperties()](./wz.wzconvexproperty.clearproperties.md) | | | +| [dispose()](./wz.wzconvexproperty.dispose.md) | | | +| [getFromPath(path)](./wz.wzconvexproperty.getfrompath.md) | | | +| [getProperty(name)](./wz.wzconvexproperty.getproperty.md) | | | +| [removeProperty(prop)](./wz.wzconvexproperty.removeproperty.md) | | | +| [setValue(\_value)](./wz.wzconvexproperty.setvalue.md) | | | + diff --git a/docs/api/wz.wzconvexproperty.name.md b/docs/api/wz.wzconvexproperty.name.md index 651eff3..cbdbfcc 100644 --- a/docs/api/wz.wzconvexproperty.name.md +++ b/docs/api/wz.wzconvexproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [name](./wz.wzconvexproperty.name.md) - -## WzConvexProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [name](./wz.wzconvexproperty.name.md) + +## WzConvexProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzconvexproperty.parent.md b/docs/api/wz.wzconvexproperty.parent.md index 51b0820..63ed06b 100644 --- a/docs/api/wz.wzconvexproperty.parent.md +++ b/docs/api/wz.wzconvexproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [parent](./wz.wzconvexproperty.parent.md) - -## WzConvexProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [parent](./wz.wzconvexproperty.parent.md) + +## WzConvexProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzconvexproperty.propertytype.md b/docs/api/wz.wzconvexproperty.propertytype.md index f19dbcb..308d972 100644 --- a/docs/api/wz.wzconvexproperty.propertytype.md +++ b/docs/api/wz.wzconvexproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [propertyType](./wz.wzconvexproperty.propertytype.md) - -## WzConvexProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [propertyType](./wz.wzconvexproperty.propertytype.md) + +## WzConvexProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzconvexproperty.removeproperty.md b/docs/api/wz.wzconvexproperty.removeproperty.md index b68c10d..b8c7cd0 100644 --- a/docs/api/wz.wzconvexproperty.removeproperty.md +++ b/docs/api/wz.wzconvexproperty.removeproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [removeProperty](./wz.wzconvexproperty.removeproperty.md) - -## WzConvexProperty.removeProperty() method - -Signature: - -```typescript -removeProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [removeProperty](./wz.wzconvexproperty.removeproperty.md) + +## WzConvexProperty.removeProperty() method + +**Signature:** + +```typescript +removeProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzconvexproperty.setvalue.md b/docs/api/wz.wzconvexproperty.setvalue.md index 2c0bd6f..68ae1ff 100644 --- a/docs/api/wz.wzconvexproperty.setvalue.md +++ b/docs/api/wz.wzconvexproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [setValue](./wz.wzconvexproperty.setvalue.md) - -## WzConvexProperty.setValue() method - -Signature: - -```typescript -setValue(_value: unknown): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_value | unknown | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [setValue](./wz.wzconvexproperty.setvalue.md) + +## WzConvexProperty.setValue() method + +**Signature:** + +```typescript +setValue(_value: unknown): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_value | unknown | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzconvexproperty.wzproperties.md b/docs/api/wz.wzconvexproperty.wzproperties.md index 2141c93..dac1084 100644 --- a/docs/api/wz.wzconvexproperty.wzproperties.md +++ b/docs/api/wz.wzconvexproperty.wzproperties.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [wzProperties](./wz.wzconvexproperty.wzproperties.md) - -## WzConvexProperty.wzProperties property - -Signature: - -```typescript -get wzProperties(): Set; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzConvexProperty](./wz.wzconvexproperty.md) > [wzProperties](./wz.wzconvexproperty.wzproperties.md) + +## WzConvexProperty.wzProperties property + +**Signature:** + +```typescript +get wzProperties(): Set; +``` diff --git a/docs/api/wz.wzdirectory._constructor_.md b/docs/api/wz.wzdirectory._constructor_.md index 948f7f0..7efafa1 100644 --- a/docs/api/wz.wzdirectory._constructor_.md +++ b/docs/api/wz.wzdirectory._constructor_.md @@ -1,24 +1,24 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [(constructor)](./wz.wzdirectory._constructor_.md) - -## WzDirectory.(constructor) - -Constructs a new instance of the `WzDirectory` class - -Signature: - -```typescript -constructor(reader: WzBinaryReader, name: string, hash: number, wzIv: Uint8Array, wzFile: WzFile); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| name | string | | -| hash | number | | -| wzIv | Uint8Array | | -| wzFile | [WzFile](./wz.wzfile.md) | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [(constructor)](./wz.wzdirectory._constructor_.md) + +## WzDirectory.(constructor) + +Constructs a new instance of the `WzDirectory` class + +**Signature:** + +```typescript +constructor(reader: WzBinaryReader, name: string, hash: number, wzIv: Uint8Array, wzFile: WzFile); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| name | string | | +| hash | number | | +| wzIv | Uint8Array | | +| wzFile | [WzFile](./wz.wzfile.md) | | + diff --git a/docs/api/wz.wzdirectory.adddirectory.md b/docs/api/wz.wzdirectory.adddirectory.md index e291a9d..23deb42 100644 --- a/docs/api/wz.wzdirectory.adddirectory.md +++ b/docs/api/wz.wzdirectory.adddirectory.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [addDirectory](./wz.wzdirectory.adddirectory.md) - -## WzDirectory.addDirectory() method - -Signature: - -```typescript -addDirectory(dir: WzDirectory): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| dir | [WzDirectory](./wz.wzdirectory.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [addDirectory](./wz.wzdirectory.adddirectory.md) + +## WzDirectory.addDirectory() method + +**Signature:** + +```typescript +addDirectory(dir: WzDirectory): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dir | [WzDirectory](./wz.wzdirectory.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzdirectory.addimage.md b/docs/api/wz.wzdirectory.addimage.md index d3f2933..62c578e 100644 --- a/docs/api/wz.wzdirectory.addimage.md +++ b/docs/api/wz.wzdirectory.addimage.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [addImage](./wz.wzdirectory.addimage.md) - -## WzDirectory.addImage() method - -Signature: - -```typescript -addImage(img: WzImage): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| img | [WzImage](./wz.wzimage.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [addImage](./wz.wzdirectory.addimage.md) + +## WzDirectory.addImage() method + +**Signature:** + +```typescript +addImage(img: WzImage): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| img | [WzImage](./wz.wzimage.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzdirectory.at.md b/docs/api/wz.wzdirectory.at.md index cc80992..555bb62 100644 --- a/docs/api/wz.wzdirectory.at.md +++ b/docs/api/wz.wzdirectory.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [at](./wz.wzdirectory.at.md) - -## WzDirectory.at() method - -Signature: - -```typescript -at(name: string): WzObject | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzObject](./wz.wzobject.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [at](./wz.wzdirectory.at.md) + +## WzDirectory.at() method + +**Signature:** + +```typescript +at(name: string): WzObject | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzObject](./wz.wzobject.md) \| null + diff --git a/docs/api/wz.wzdirectory.blocksize.md b/docs/api/wz.wzdirectory.blocksize.md index 732bc40..a35c06f 100644 --- a/docs/api/wz.wzdirectory.blocksize.md +++ b/docs/api/wz.wzdirectory.blocksize.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [blockSize](./wz.wzdirectory.blocksize.md) - -## WzDirectory.blockSize property - -Signature: - -```typescript -blockSize: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [blockSize](./wz.wzdirectory.blocksize.md) + +## WzDirectory.blockSize property + +**Signature:** + +```typescript +blockSize: number; +``` diff --git a/docs/api/wz.wzdirectory.checksum.md b/docs/api/wz.wzdirectory.checksum.md index 76b5047..97a3f8b 100644 --- a/docs/api/wz.wzdirectory.checksum.md +++ b/docs/api/wz.wzdirectory.checksum.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [checksum](./wz.wzdirectory.checksum.md) - -## WzDirectory.checksum property - -Signature: - -```typescript -checksum: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [checksum](./wz.wzdirectory.checksum.md) + +## WzDirectory.checksum property + +**Signature:** + +```typescript +checksum: number; +``` diff --git a/docs/api/wz.wzdirectory.cleardirectories.md b/docs/api/wz.wzdirectory.cleardirectories.md index ccef7b7..096d078 100644 --- a/docs/api/wz.wzdirectory.cleardirectories.md +++ b/docs/api/wz.wzdirectory.cleardirectories.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [clearDirectories](./wz.wzdirectory.cleardirectories.md) - -## WzDirectory.clearDirectories() method - -Signature: - -```typescript -clearDirectories(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [clearDirectories](./wz.wzdirectory.cleardirectories.md) + +## WzDirectory.clearDirectories() method + +**Signature:** + +```typescript +clearDirectories(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzdirectory.clearimages.md b/docs/api/wz.wzdirectory.clearimages.md index f54c02a..02b0e36 100644 --- a/docs/api/wz.wzdirectory.clearimages.md +++ b/docs/api/wz.wzdirectory.clearimages.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [clearImages](./wz.wzdirectory.clearimages.md) - -## WzDirectory.clearImages() method - -Signature: - -```typescript -clearImages(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [clearImages](./wz.wzdirectory.clearimages.md) + +## WzDirectory.clearImages() method + +**Signature:** + +```typescript +clearImages(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzdirectory.dispose.md b/docs/api/wz.wzdirectory.dispose.md index 758bfb4..f6c7667 100644 --- a/docs/api/wz.wzdirectory.dispose.md +++ b/docs/api/wz.wzdirectory.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [dispose](./wz.wzdirectory.dispose.md) - -## WzDirectory.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [dispose](./wz.wzdirectory.dispose.md) + +## WzDirectory.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzdirectory.getdirectorybyname.md b/docs/api/wz.wzdirectory.getdirectorybyname.md index 95f73fc..c3c6e33 100644 --- a/docs/api/wz.wzdirectory.getdirectorybyname.md +++ b/docs/api/wz.wzdirectory.getdirectorybyname.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [getDirectoryByName](./wz.wzdirectory.getdirectorybyname.md) - -## WzDirectory.getDirectoryByName() method - -Signature: - -```typescript -getDirectoryByName(name: string): WzDirectory | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzDirectory](./wz.wzdirectory.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [getDirectoryByName](./wz.wzdirectory.getdirectorybyname.md) + +## WzDirectory.getDirectoryByName() method + +**Signature:** + +```typescript +getDirectoryByName(name: string): WzDirectory | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzDirectory](./wz.wzdirectory.md) \| null + diff --git a/docs/api/wz.wzdirectory.getimagebyname.md b/docs/api/wz.wzdirectory.getimagebyname.md index 51676bf..2301236 100644 --- a/docs/api/wz.wzdirectory.getimagebyname.md +++ b/docs/api/wz.wzdirectory.getimagebyname.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [getImageByName](./wz.wzdirectory.getimagebyname.md) - -## WzDirectory.getImageByName() method - -Signature: - -```typescript -getImageByName(name: string): WzImage | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImage](./wz.wzimage.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [getImageByName](./wz.wzdirectory.getimagebyname.md) + +## WzDirectory.getImageByName() method + +**Signature:** + +```typescript +getImageByName(name: string): WzImage | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImage](./wz.wzimage.md) \| null + diff --git a/docs/api/wz.wzdirectory.hash.md b/docs/api/wz.wzdirectory.hash.md index 80ff797..7014822 100644 --- a/docs/api/wz.wzdirectory.hash.md +++ b/docs/api/wz.wzdirectory.hash.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [hash](./wz.wzdirectory.hash.md) - -## WzDirectory.hash property - -Signature: - -```typescript -hash: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [hash](./wz.wzdirectory.hash.md) + +## WzDirectory.hash property + +**Signature:** + +```typescript +hash: number; +``` diff --git a/docs/api/wz.wzdirectory.md b/docs/api/wz.wzdirectory.md index ee1919e..ca94c3d 100644 --- a/docs/api/wz.wzdirectory.md +++ b/docs/api/wz.wzdirectory.md @@ -1,54 +1,54 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) - -## WzDirectory class - - -Signature: - -```typescript -export declare class WzDirectory extends WzObject -``` -Extends: [WzObject](./wz.wzobject.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(reader, name, hash, wzIv, wzFile)](./wz.wzdirectory._constructor_.md) | | Constructs a new instance of the WzDirectory class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [blockSize](./wz.wzdirectory.blocksize.md) | | number | | -| [checksum](./wz.wzdirectory.checksum.md) | | number | | -| [hash](./wz.wzdirectory.hash.md) | | number | | -| [name](./wz.wzdirectory.name.md) | | string | | -| [objectType](./wz.wzdirectory.objecttype.md) | | [WzObjectType](./wz.wzobjecttype.md) | | -| [offset](./wz.wzdirectory.offset.md) | | number | | -| [parent](./wz.wzdirectory.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [reader](./wz.wzdirectory.reader.md) | | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| [wzDirectories](./wz.wzdirectory.wzdirectories.md) | | Set<[WzDirectory](./wz.wzdirectory.md)> | | -| [wzFile](./wz.wzdirectory.wzfile.md) | | [WzFile](./wz.wzfile.md) | | -| [wzFileParent](./wz.wzdirectory.wzfileparent.md) | | [WzFile](./wz.wzfile.md) \| null | | -| [wzImages](./wz.wzdirectory.wzimages.md) | | Set<[WzImage](./wz.wzimage.md)> | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addDirectory(dir)](./wz.wzdirectory.adddirectory.md) | | | -| [addImage(img)](./wz.wzdirectory.addimage.md) | | | -| [at(name)](./wz.wzdirectory.at.md) | | | -| [clearDirectories()](./wz.wzdirectory.cleardirectories.md) | | | -| [clearImages()](./wz.wzdirectory.clearimages.md) | | | -| [dispose()](./wz.wzdirectory.dispose.md) | | | -| [getDirectoryByName(name)](./wz.wzdirectory.getdirectorybyname.md) | | | -| [getImageByName(name)](./wz.wzdirectory.getimagebyname.md) | | | -| [parseDirectory(lazyParse)](./wz.wzdirectory.parsedirectory.md) | | | -| [parseImages()](./wz.wzdirectory.parseimages.md) | | | -| [set(name, value)](./wz.wzdirectory.set.md) | | | -| [setVersionHash(newHash)](./wz.wzdirectory.setversionhash.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) + +## WzDirectory class + + +**Signature:** + +```typescript +export declare class WzDirectory extends WzObject +``` +**Extends:** [WzObject](./wz.wzobject.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(reader, name, hash, wzIv, wzFile)](./wz.wzdirectory._constructor_.md) | | Constructs a new instance of the WzDirectory class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [blockSize](./wz.wzdirectory.blocksize.md) | | number | | +| [checksum](./wz.wzdirectory.checksum.md) | | number | | +| [hash](./wz.wzdirectory.hash.md) | | number | | +| [name](./wz.wzdirectory.name.md) | | string | | +| [objectType](./wz.wzdirectory.objecttype.md) | readonly | [WzObjectType](./wz.wzobjecttype.md) | | +| [offset](./wz.wzdirectory.offset.md) | | number | | +| [parent](./wz.wzdirectory.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [reader](./wz.wzdirectory.reader.md) | | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| [wzDirectories](./wz.wzdirectory.wzdirectories.md) | readonly | Set<[WzDirectory](./wz.wzdirectory.md)> | | +| [wzFile](./wz.wzdirectory.wzfile.md) | | [WzFile](./wz.wzfile.md) | | +| [wzFileParent](./wz.wzdirectory.wzfileparent.md) | readonly | [WzFile](./wz.wzfile.md) \| null | | +| [wzImages](./wz.wzdirectory.wzimages.md) | readonly | Set<[WzImage](./wz.wzimage.md)> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addDirectory(dir)](./wz.wzdirectory.adddirectory.md) | | | +| [addImage(img)](./wz.wzdirectory.addimage.md) | | | +| [at(name)](./wz.wzdirectory.at.md) | | | +| [clearDirectories()](./wz.wzdirectory.cleardirectories.md) | | | +| [clearImages()](./wz.wzdirectory.clearimages.md) | | | +| [dispose()](./wz.wzdirectory.dispose.md) | | | +| [getDirectoryByName(name)](./wz.wzdirectory.getdirectorybyname.md) | | | +| [getImageByName(name)](./wz.wzdirectory.getimagebyname.md) | | | +| [parseDirectory(lazyParse)](./wz.wzdirectory.parsedirectory.md) | | | +| [parseImages()](./wz.wzdirectory.parseimages.md) | | | +| [set(name, value)](./wz.wzdirectory.set.md) | | | +| [setVersionHash(newHash)](./wz.wzdirectory.setversionhash.md) | | | + diff --git a/docs/api/wz.wzdirectory.name.md b/docs/api/wz.wzdirectory.name.md index f7c4d9c..cbbd209 100644 --- a/docs/api/wz.wzdirectory.name.md +++ b/docs/api/wz.wzdirectory.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [name](./wz.wzdirectory.name.md) - -## WzDirectory.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [name](./wz.wzdirectory.name.md) + +## WzDirectory.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzdirectory.objecttype.md b/docs/api/wz.wzdirectory.objecttype.md index 721491b..65f56c0 100644 --- a/docs/api/wz.wzdirectory.objecttype.md +++ b/docs/api/wz.wzdirectory.objecttype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [objectType](./wz.wzdirectory.objecttype.md) - -## WzDirectory.objectType property - -Signature: - -```typescript -get objectType(): WzObjectType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [objectType](./wz.wzdirectory.objecttype.md) + +## WzDirectory.objectType property + +**Signature:** + +```typescript +get objectType(): WzObjectType; +``` diff --git a/docs/api/wz.wzdirectory.offset.md b/docs/api/wz.wzdirectory.offset.md index 3cde712..411686b 100644 --- a/docs/api/wz.wzdirectory.offset.md +++ b/docs/api/wz.wzdirectory.offset.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [offset](./wz.wzdirectory.offset.md) - -## WzDirectory.offset property - -Signature: - -```typescript -offset: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [offset](./wz.wzdirectory.offset.md) + +## WzDirectory.offset property + +**Signature:** + +```typescript +offset: number; +``` diff --git a/docs/api/wz.wzdirectory.parent.md b/docs/api/wz.wzdirectory.parent.md index 3f0a77a..82b201d 100644 --- a/docs/api/wz.wzdirectory.parent.md +++ b/docs/api/wz.wzdirectory.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [parent](./wz.wzdirectory.parent.md) - -## WzDirectory.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [parent](./wz.wzdirectory.parent.md) + +## WzDirectory.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzdirectory.parsedirectory.md b/docs/api/wz.wzdirectory.parsedirectory.md index d217caa..4fc0145 100644 --- a/docs/api/wz.wzdirectory.parsedirectory.md +++ b/docs/api/wz.wzdirectory.parsedirectory.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [parseDirectory](./wz.wzdirectory.parsedirectory.md) - -## WzDirectory.parseDirectory() method - -Signature: - -```typescript -parseDirectory(lazyParse?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| lazyParse | boolean | (Optional) | - -Returns: - -Promise<void> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [parseDirectory](./wz.wzdirectory.parsedirectory.md) + +## WzDirectory.parseDirectory() method + +**Signature:** + +```typescript +parseDirectory(lazyParse?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| lazyParse | boolean | _(Optional)_ | + +**Returns:** + +Promise<void> + diff --git a/docs/api/wz.wzdirectory.parseimages.md b/docs/api/wz.wzdirectory.parseimages.md index 93d9bba..1c43d78 100644 --- a/docs/api/wz.wzdirectory.parseimages.md +++ b/docs/api/wz.wzdirectory.parseimages.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [parseImages](./wz.wzdirectory.parseimages.md) - -## WzDirectory.parseImages() method - -Signature: - -```typescript -parseImages(): Promise; -``` -Returns: - -Promise<void> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [parseImages](./wz.wzdirectory.parseimages.md) + +## WzDirectory.parseImages() method + +**Signature:** + +```typescript +parseImages(): Promise; +``` +**Returns:** + +Promise<void> + diff --git a/docs/api/wz.wzdirectory.reader.md b/docs/api/wz.wzdirectory.reader.md index baa7b8e..9a1046a 100644 --- a/docs/api/wz.wzdirectory.reader.md +++ b/docs/api/wz.wzdirectory.reader.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [reader](./wz.wzdirectory.reader.md) - -## WzDirectory.reader property - -Signature: - -```typescript -reader: WzBinaryReader; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [reader](./wz.wzdirectory.reader.md) + +## WzDirectory.reader property + +**Signature:** + +```typescript +reader: WzBinaryReader; +``` diff --git a/docs/api/wz.wzdirectory.set.md b/docs/api/wz.wzdirectory.set.md index 4ceff8e..17dc5eb 100644 --- a/docs/api/wz.wzdirectory.set.md +++ b/docs/api/wz.wzdirectory.set.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [set](./wz.wzdirectory.set.md) - -## WzDirectory.set() method - -Signature: - -```typescript -set(name: string, value: WzObject): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| value | [WzObject](./wz.wzobject.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [set](./wz.wzdirectory.set.md) + +## WzDirectory.set() method + +**Signature:** + +```typescript +set(name: string, value: WzObject): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| value | [WzObject](./wz.wzobject.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzdirectory.setversionhash.md b/docs/api/wz.wzdirectory.setversionhash.md index dc79c71..b5a0026 100644 --- a/docs/api/wz.wzdirectory.setversionhash.md +++ b/docs/api/wz.wzdirectory.setversionhash.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [setVersionHash](./wz.wzdirectory.setversionhash.md) - -## WzDirectory.setVersionHash() method - -Signature: - -```typescript -setVersionHash(newHash: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newHash | number | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [setVersionHash](./wz.wzdirectory.setversionhash.md) + +## WzDirectory.setVersionHash() method + +**Signature:** + +```typescript +setVersionHash(newHash: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| newHash | number | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzdirectory.wzdirectories.md b/docs/api/wz.wzdirectory.wzdirectories.md index 60f991e..152c8e9 100644 --- a/docs/api/wz.wzdirectory.wzdirectories.md +++ b/docs/api/wz.wzdirectory.wzdirectories.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzDirectories](./wz.wzdirectory.wzdirectories.md) - -## WzDirectory.wzDirectories property - -Signature: - -```typescript -get wzDirectories(): Set; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzDirectories](./wz.wzdirectory.wzdirectories.md) + +## WzDirectory.wzDirectories property + +**Signature:** + +```typescript +get wzDirectories(): Set; +``` diff --git a/docs/api/wz.wzdirectory.wzfile.md b/docs/api/wz.wzdirectory.wzfile.md index d153d99..ed255f1 100644 --- a/docs/api/wz.wzdirectory.wzfile.md +++ b/docs/api/wz.wzdirectory.wzfile.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzFile](./wz.wzdirectory.wzfile.md) - -## WzDirectory.wzFile property - -Signature: - -```typescript -wzFile: WzFile; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzFile](./wz.wzdirectory.wzfile.md) + +## WzDirectory.wzFile property + +**Signature:** + +```typescript +wzFile: WzFile; +``` diff --git a/docs/api/wz.wzdirectory.wzfileparent.md b/docs/api/wz.wzdirectory.wzfileparent.md index df10ac1..2674524 100644 --- a/docs/api/wz.wzdirectory.wzfileparent.md +++ b/docs/api/wz.wzdirectory.wzfileparent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzFileParent](./wz.wzdirectory.wzfileparent.md) - -## WzDirectory.wzFileParent property - -Signature: - -```typescript -get wzFileParent(): WzFile | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzFileParent](./wz.wzdirectory.wzfileparent.md) + +## WzDirectory.wzFileParent property + +**Signature:** + +```typescript +get wzFileParent(): WzFile | null; +``` diff --git a/docs/api/wz.wzdirectory.wzimages.md b/docs/api/wz.wzdirectory.wzimages.md index 2a47b1d..e2fe798 100644 --- a/docs/api/wz.wzdirectory.wzimages.md +++ b/docs/api/wz.wzdirectory.wzimages.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzImages](./wz.wzdirectory.wzimages.md) - -## WzDirectory.wzImages property - -Signature: - -```typescript -get wzImages(): Set; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectory](./wz.wzdirectory.md) > [wzImages](./wz.wzdirectory.wzimages.md) + +## WzDirectory.wzImages property + +**Signature:** + +```typescript +get wzImages(): Set; +``` diff --git a/docs/api/wz.wzdirectorytype.md b/docs/api/wz.wzdirectorytype.md index ce2b9bb..9087f76 100644 --- a/docs/api/wz.wzdirectorytype.md +++ b/docs/api/wz.wzdirectorytype.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectoryType](./wz.wzdirectorytype.md) - -## WzDirectoryType enum - - -Signature: - -```typescript -export declare enum WzDirectoryType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| RetrieveStringFromOffset\_2 | 2 | | -| UnknownType\_1 | 1 | | -| WzDirectory\_3 | 3 | | -| WzImage\_4 | 4 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDirectoryType](./wz.wzdirectorytype.md) + +## WzDirectoryType enum + + +**Signature:** + +```typescript +export declare enum WzDirectoryType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| RetrieveStringFromOffset\_2 | 2 | | +| UnknownType\_1 | 1 | | +| WzDirectory\_3 | 3 | | +| WzImage\_4 | 4 | | + diff --git a/docs/api/wz.wzdoubleproperty._constructor_.md b/docs/api/wz.wzdoubleproperty._constructor_.md index 6917d8d..87336b1 100644 --- a/docs/api/wz.wzdoubleproperty._constructor_.md +++ b/docs/api/wz.wzdoubleproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [(constructor)](./wz.wzdoubleproperty._constructor_.md) - -## WzDoubleProperty.(constructor) - -Constructs a new instance of the `WzDoubleProperty` class - -Signature: - -```typescript -constructor(name?: string, val?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| val | number | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [(constructor)](./wz.wzdoubleproperty._constructor_.md) + +## WzDoubleProperty.(constructor) + +Constructs a new instance of the `WzDoubleProperty` class + +**Signature:** + +```typescript +constructor(name?: string, val?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| val | number | _(Optional)_ | + diff --git a/docs/api/wz.wzdoubleproperty.dispose.md b/docs/api/wz.wzdoubleproperty.dispose.md index 59a243f..f03f4e7 100644 --- a/docs/api/wz.wzdoubleproperty.dispose.md +++ b/docs/api/wz.wzdoubleproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [dispose](./wz.wzdoubleproperty.dispose.md) - -## WzDoubleProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [dispose](./wz.wzdoubleproperty.dispose.md) + +## WzDoubleProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzdoubleproperty.md b/docs/api/wz.wzdoubleproperty.md index f773357..4a55275 100644 --- a/docs/api/wz.wzdoubleproperty.md +++ b/docs/api/wz.wzdoubleproperty.md @@ -1,38 +1,38 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) - -## WzDoubleProperty class - - -Signature: - -```typescript -export declare class WzDoubleProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, val)](./wz.wzdoubleproperty._constructor_.md) | | Constructs a new instance of the WzDoubleProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzdoubleproperty.name.md) | | string | | -| [parent](./wz.wzdoubleproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzdoubleproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [value](./wz.wzdoubleproperty.value.md) | | number | | -| [wzValue](./wz.wzdoubleproperty.wzvalue.md) | | number | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzdoubleproperty.dispose.md) | | | -| [setValue(value)](./wz.wzdoubleproperty.setvalue.md) | | | -| [toString()](./wz.wzdoubleproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) + +## WzDoubleProperty class + + +**Signature:** + +```typescript +export declare class WzDoubleProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, val)](./wz.wzdoubleproperty._constructor_.md) | | Constructs a new instance of the WzDoubleProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzdoubleproperty.name.md) | | string | | +| [parent](./wz.wzdoubleproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzdoubleproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [value](./wz.wzdoubleproperty.value.md) | readonly | number | | +| [wzValue](./wz.wzdoubleproperty.wzvalue.md) | readonly | number | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzdoubleproperty.dispose.md) | | | +| [setValue(value)](./wz.wzdoubleproperty.setvalue.md) | | | +| [toString()](./wz.wzdoubleproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzdoubleproperty.name.md b/docs/api/wz.wzdoubleproperty.name.md index ada0e98..8d5f2e3 100644 --- a/docs/api/wz.wzdoubleproperty.name.md +++ b/docs/api/wz.wzdoubleproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [name](./wz.wzdoubleproperty.name.md) - -## WzDoubleProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [name](./wz.wzdoubleproperty.name.md) + +## WzDoubleProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzdoubleproperty.parent.md b/docs/api/wz.wzdoubleproperty.parent.md index a7cd33f..214e17f 100644 --- a/docs/api/wz.wzdoubleproperty.parent.md +++ b/docs/api/wz.wzdoubleproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [parent](./wz.wzdoubleproperty.parent.md) - -## WzDoubleProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [parent](./wz.wzdoubleproperty.parent.md) + +## WzDoubleProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzdoubleproperty.propertytype.md b/docs/api/wz.wzdoubleproperty.propertytype.md index 50c6294..4835d9d 100644 --- a/docs/api/wz.wzdoubleproperty.propertytype.md +++ b/docs/api/wz.wzdoubleproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [propertyType](./wz.wzdoubleproperty.propertytype.md) - -## WzDoubleProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [propertyType](./wz.wzdoubleproperty.propertytype.md) + +## WzDoubleProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzdoubleproperty.setvalue.md b/docs/api/wz.wzdoubleproperty.setvalue.md index 17c5257..5c5f52b 100644 --- a/docs/api/wz.wzdoubleproperty.setvalue.md +++ b/docs/api/wz.wzdoubleproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [setValue](./wz.wzdoubleproperty.setvalue.md) - -## WzDoubleProperty.setValue() method - -Signature: - -```typescript -setValue(value: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [setValue](./wz.wzdoubleproperty.setvalue.md) + +## WzDoubleProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | number | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzdoubleproperty.tostring.md b/docs/api/wz.wzdoubleproperty.tostring.md index 3789ce5..08f9326 100644 --- a/docs/api/wz.wzdoubleproperty.tostring.md +++ b/docs/api/wz.wzdoubleproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [toString](./wz.wzdoubleproperty.tostring.md) - -## WzDoubleProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [toString](./wz.wzdoubleproperty.tostring.md) + +## WzDoubleProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzdoubleproperty.value.md b/docs/api/wz.wzdoubleproperty.value.md index a22f5d5..064195f 100644 --- a/docs/api/wz.wzdoubleproperty.value.md +++ b/docs/api/wz.wzdoubleproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [value](./wz.wzdoubleproperty.value.md) - -## WzDoubleProperty.value property - -Signature: - -```typescript -get value(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [value](./wz.wzdoubleproperty.value.md) + +## WzDoubleProperty.value property + +**Signature:** + +```typescript +get value(): number; +``` diff --git a/docs/api/wz.wzdoubleproperty.wzvalue.md b/docs/api/wz.wzdoubleproperty.wzvalue.md index 034c1b3..c9fd599 100644 --- a/docs/api/wz.wzdoubleproperty.wzvalue.md +++ b/docs/api/wz.wzdoubleproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [wzValue](./wz.wzdoubleproperty.wzvalue.md) - -## WzDoubleProperty.wzValue property - -Signature: - -```typescript -get wzValue(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzDoubleProperty](./wz.wzdoubleproperty.md) > [wzValue](./wz.wzdoubleproperty.wzvalue.md) + +## WzDoubleProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): number; +``` diff --git a/docs/api/wz.wzerror._constructor_.md b/docs/api/wz.wzerror._constructor_.md index f9f5a4e..3250f78 100644 --- a/docs/api/wz.wzerror._constructor_.md +++ b/docs/api/wz.wzerror._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzError](./wz.wzerror.md) > [(constructor)](./wz.wzerror._constructor_.md) - -## WzError.(constructor) - -Constructs a new instance of the `WzError` class - -Signature: - -```typescript -constructor(level: ErrorLevel, message: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| level | [ErrorLevel](./wz.errorlevel.md) | | -| message | string | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzError](./wz.wzerror.md) > [(constructor)](./wz.wzerror._constructor_.md) + +## WzError.(constructor) + +Constructs a new instance of the `WzError` class + +**Signature:** + +```typescript +constructor(level: ErrorLevel, message: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| level | [ErrorLevel](./wz.errorlevel.md) | | +| message | string | | + diff --git a/docs/api/wz.wzerror.level.md b/docs/api/wz.wzerror.level.md index d83e995..60567e0 100644 --- a/docs/api/wz.wzerror.level.md +++ b/docs/api/wz.wzerror.level.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzError](./wz.wzerror.md) > [level](./wz.wzerror.level.md) - -## WzError.level property - -Signature: - -```typescript -level: ErrorLevel; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzError](./wz.wzerror.md) > [level](./wz.wzerror.level.md) + +## WzError.level property + +**Signature:** + +```typescript +level: ErrorLevel; +``` diff --git a/docs/api/wz.wzerror.md b/docs/api/wz.wzerror.md index d84347a..1fe7283 100644 --- a/docs/api/wz.wzerror.md +++ b/docs/api/wz.wzerror.md @@ -1,26 +1,26 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzError](./wz.wzerror.md) - -## WzError class - - -Signature: - -```typescript -export declare class WzError extends BaseError -``` -Extends: [BaseError](./wz.baseerror.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(level, message)](./wz.wzerror._constructor_.md) | | Constructs a new instance of the WzError class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [level](./wz.wzerror.level.md) | | [ErrorLevel](./wz.errorlevel.md) | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzError](./wz.wzerror.md) + +## WzError class + + +**Signature:** + +```typescript +export declare class WzError extends BaseError +``` +**Extends:** [BaseError](./wz.baseerror.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(level, message)](./wz.wzerror._constructor_.md) | | Constructs a new instance of the WzError class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [level](./wz.wzerror.level.md) | | [ErrorLevel](./wz.errorlevel.md) | | + diff --git a/docs/api/wz.wzextended.md b/docs/api/wz.wzextended.md index 51c52bd..8b4e12b 100644 --- a/docs/api/wz.wzextended.md +++ b/docs/api/wz.wzextended.md @@ -1,14 +1,14 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzExtended](./wz.wzextended.md) - -## WzExtended class - - -Signature: - -```typescript -export declare abstract class WzExtended extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzExtended](./wz.wzextended.md) + +## WzExtended class + + +**Signature:** + +```typescript +export declare abstract class WzExtended extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + diff --git a/docs/api/wz.wzfile._constructor_.md b/docs/api/wz.wzfile._constructor_.md index 2c061d1..6f3245d 100644 --- a/docs/api/wz.wzfile._constructor_.md +++ b/docs/api/wz.wzfile._constructor_.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [(constructor)](./wz.wzfile._constructor_.md) - -## WzFile.(constructor) - -Constructs a new instance of the `WzFile` class - -Signature: - -```typescript -constructor(filepath: string | File, version: WzMapleVersion, gameVersion?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filepath | string \| File | | -| version | [WzMapleVersion](./wz.wzmapleversion.md) | | -| gameVersion | number | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [(constructor)](./wz.wzfile._constructor_.md) + +## WzFile.(constructor) + +Constructs a new instance of the `WzFile` class + +**Signature:** + +```typescript +constructor(filepath: string | File, version: WzMapleVersion, gameVersion?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filepath | string \| File | | +| version | [WzMapleVersion](./wz.wzmapleversion.md) | | +| gameVersion | number | _(Optional)_ | + diff --git a/docs/api/wz.wzfile.at.md b/docs/api/wz.wzfile.at.md index f34e065..0472bf3 100644 --- a/docs/api/wz.wzfile.at.md +++ b/docs/api/wz.wzfile.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [at](./wz.wzfile.at.md) - -## WzFile.at() method - -Signature: - -```typescript -at(name: string): WzObject | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzObject](./wz.wzobject.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [at](./wz.wzfile.at.md) + +## WzFile.at() method + +**Signature:** + +```typescript +at(name: string): WzObject | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzObject](./wz.wzobject.md) \| null + diff --git a/docs/api/wz.wzfile.dispose.md b/docs/api/wz.wzfile.dispose.md index ac90745..d4e9bbf 100644 --- a/docs/api/wz.wzfile.dispose.md +++ b/docs/api/wz.wzfile.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [dispose](./wz.wzfile.dispose.md) - -## WzFile.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [dispose](./wz.wzfile.dispose.md) + +## WzFile.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzfile.filepath.md b/docs/api/wz.wzfile.filepath.md index d554421..745c2cc 100644 --- a/docs/api/wz.wzfile.filepath.md +++ b/docs/api/wz.wzfile.filepath.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [filepath](./wz.wzfile.filepath.md) - -## WzFile.filepath property - -Signature: - -```typescript -filepath: string | File; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [filepath](./wz.wzfile.filepath.md) + +## WzFile.filepath property + +**Signature:** + +```typescript +filepath: string | File; +``` diff --git a/docs/api/wz.wzfile.fullpath.md b/docs/api/wz.wzfile.fullpath.md index a176ff3..5576bbd 100644 --- a/docs/api/wz.wzfile.fullpath.md +++ b/docs/api/wz.wzfile.fullpath.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [fullPath](./wz.wzfile.fullpath.md) - -## WzFile.fullPath property - -Signature: - -```typescript -get fullPath(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [fullPath](./wz.wzfile.fullpath.md) + +## WzFile.fullPath property + +**Signature:** + +```typescript +get fullPath(): string; +``` diff --git a/docs/api/wz.wzfile.getobjectfrompath.md b/docs/api/wz.wzfile.getobjectfrompath.md index 9a3f25f..9916220 100644 --- a/docs/api/wz.wzfile.getobjectfrompath.md +++ b/docs/api/wz.wzfile.getobjectfrompath.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [getObjectFromPath](./wz.wzfile.getobjectfrompath.md) - -## WzFile.getObjectFromPath() method - -Signature: - -```typescript -getObjectFromPath(path: string, checkFirstDirectoryName?: boolean): WzObject | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | -| checkFirstDirectoryName | boolean | (Optional) | - -Returns: - -[WzObject](./wz.wzobject.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [getObjectFromPath](./wz.wzfile.getobjectfrompath.md) + +## WzFile.getObjectFromPath() method + +**Signature:** + +```typescript +getObjectFromPath(path: string, checkFirstDirectoryName?: boolean): WzObject | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | | +| checkFirstDirectoryName | boolean | _(Optional)_ | + +**Returns:** + +[WzObject](./wz.wzobject.md) \| null + diff --git a/docs/api/wz.wzfile.header.md b/docs/api/wz.wzfile.header.md index 53d57cd..d6dd1ee 100644 --- a/docs/api/wz.wzfile.header.md +++ b/docs/api/wz.wzfile.header.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [header](./wz.wzfile.header.md) - -## WzFile.header property - -Signature: - -```typescript -header: WzHeader; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [header](./wz.wzfile.header.md) + +## WzFile.header property + +**Signature:** + +```typescript +header: WzHeader; +``` diff --git a/docs/api/wz.wzfile.is64bitwzfile.md b/docs/api/wz.wzfile.is64bitwzfile.md index e950132..bd8ce6c 100644 --- a/docs/api/wz.wzfile.is64bitwzfile.md +++ b/docs/api/wz.wzfile.is64bitwzfile.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [is64BitWzFile](./wz.wzfile.is64bitwzfile.md) - -## WzFile.is64BitWzFile property - -Signature: - -```typescript -get is64BitWzFile(): boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [is64BitWzFile](./wz.wzfile.is64bitwzfile.md) + +## WzFile.is64BitWzFile property + +**Signature:** + +```typescript +get is64BitWzFile(): boolean; +``` diff --git a/docs/api/wz.wzfile.isunloaded.md b/docs/api/wz.wzfile.isunloaded.md index b9fed70..0e3bd07 100644 --- a/docs/api/wz.wzfile.isunloaded.md +++ b/docs/api/wz.wzfile.isunloaded.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [isUnloaded](./wz.wzfile.isunloaded.md) - -## WzFile.isUnloaded property - -Signature: - -```typescript -get isUnloaded(): boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [isUnloaded](./wz.wzfile.isunloaded.md) + +## WzFile.isUnloaded property + +**Signature:** + +```typescript +get isUnloaded(): boolean; +``` diff --git a/docs/api/wz.wzfile.maplelocaleversion.md b/docs/api/wz.wzfile.maplelocaleversion.md index a26af2d..7bf9e65 100644 --- a/docs/api/wz.wzfile.maplelocaleversion.md +++ b/docs/api/wz.wzfile.maplelocaleversion.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [mapleLocaleVersion](./wz.wzfile.maplelocaleversion.md) - -## WzFile.mapleLocaleVersion property - -Signature: - -```typescript -get mapleLocaleVersion(): MapleStoryLocalisation; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [mapleLocaleVersion](./wz.wzfile.maplelocaleversion.md) + +## WzFile.mapleLocaleVersion property + +**Signature:** + +```typescript +get mapleLocaleVersion(): MapleStoryLocalisation; +``` diff --git a/docs/api/wz.wzfile.mapleplocalversion.md b/docs/api/wz.wzfile.mapleplocalversion.md index 4f38423..df0f248 100644 --- a/docs/api/wz.wzfile.mapleplocalversion.md +++ b/docs/api/wz.wzfile.mapleplocalversion.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [maplepLocalVersion](./wz.wzfile.mapleplocalversion.md) - -## WzFile.maplepLocalVersion property - -Signature: - -```typescript -maplepLocalVersion: WzMapleVersion; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [maplepLocalVersion](./wz.wzfile.mapleplocalversion.md) + +## WzFile.maplepLocalVersion property + +**Signature:** + +```typescript +maplepLocalVersion: WzMapleVersion; +``` diff --git a/docs/api/wz.wzfile.maplestorypatchversion.md b/docs/api/wz.wzfile.maplestorypatchversion.md index 0f34749..0cc1f89 100644 --- a/docs/api/wz.wzfile.maplestorypatchversion.md +++ b/docs/api/wz.wzfile.maplestorypatchversion.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [mapleStoryPatchVersion](./wz.wzfile.maplestorypatchversion.md) - -## WzFile.mapleStoryPatchVersion property - -Signature: - -```typescript -mapleStoryPatchVersion: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [mapleStoryPatchVersion](./wz.wzfile.maplestorypatchversion.md) + +## WzFile.mapleStoryPatchVersion property + +**Signature:** + +```typescript +mapleStoryPatchVersion: number; +``` diff --git a/docs/api/wz.wzfile.md b/docs/api/wz.wzfile.md index cb124bc..fd8bc22 100644 --- a/docs/api/wz.wzfile.md +++ b/docs/api/wz.wzfile.md @@ -1,47 +1,47 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) - -## WzFile class - - -Signature: - -```typescript -export declare class WzFile extends WzObject -``` -Extends: [WzObject](./wz.wzobject.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(filepath, version, gameVersion)](./wz.wzfile._constructor_.md) | | Constructs a new instance of the WzFile class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [filepath](./wz.wzfile.filepath.md) | | string \| File | | -| [fullPath](./wz.wzfile.fullpath.md) | | string | | -| [header](./wz.wzfile.header.md) | | [WzHeader](./wz.wzheader.md) | | -| [is64BitWzFile](./wz.wzfile.is64bitwzfile.md) | | boolean | | -| [isUnloaded](./wz.wzfile.isunloaded.md) | | boolean | | -| [mapleLocaleVersion](./wz.wzfile.maplelocaleversion.md) | | [MapleStoryLocalisation](./wz.maplestorylocalisation.md) | | -| [maplepLocalVersion](./wz.wzfile.mapleplocalversion.md) | | [WzMapleVersion](./wz.wzmapleversion.md) | | -| [mapleStoryPatchVersion](./wz.wzfile.maplestorypatchversion.md) | | number | | -| [name](./wz.wzfile.name.md) | | string | | -| [objectType](./wz.wzfile.objecttype.md) | | [WzObjectType](./wz.wzobjecttype.md) | | -| [parent](./wz.wzfile.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [wzDirectory](./wz.wzfile.wzdirectory.md) | | [WzDirectory](./wz.wzdirectory.md) \| null | | -| [wzFileParent](./wz.wzfile.wzfileparent.md) | | [WzFile](./wz.wzfile.md) | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [at(name)](./wz.wzfile.at.md) | | | -| [dispose()](./wz.wzfile.dispose.md) | | | -| [getObjectFromPath(path, checkFirstDirectoryName)](./wz.wzfile.getobjectfrompath.md) | | | -| [parseWzFile(wzIv)](./wz.wzfile.parsewzfile.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) + +## WzFile class + + +**Signature:** + +```typescript +export declare class WzFile extends WzObject +``` +**Extends:** [WzObject](./wz.wzobject.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(filepath, version, gameVersion)](./wz.wzfile._constructor_.md) | | Constructs a new instance of the WzFile class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [filepath](./wz.wzfile.filepath.md) | | string \| File | | +| [fullPath](./wz.wzfile.fullpath.md) | readonly | string | | +| [header](./wz.wzfile.header.md) | | [WzHeader](./wz.wzheader.md) | | +| [is64BitWzFile](./wz.wzfile.is64bitwzfile.md) | readonly | boolean | | +| [isUnloaded](./wz.wzfile.isunloaded.md) | readonly | boolean | | +| [mapleLocaleVersion](./wz.wzfile.maplelocaleversion.md) | readonly | [MapleStoryLocalisation](./wz.maplestorylocalisation.md) | | +| [maplepLocalVersion](./wz.wzfile.mapleplocalversion.md) | | [WzMapleVersion](./wz.wzmapleversion.md) | | +| [mapleStoryPatchVersion](./wz.wzfile.maplestorypatchversion.md) | | number | | +| [name](./wz.wzfile.name.md) | | string | | +| [objectType](./wz.wzfile.objecttype.md) | readonly | [WzObjectType](./wz.wzobjecttype.md) | | +| [parent](./wz.wzfile.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [wzDirectory](./wz.wzfile.wzdirectory.md) | readonly | [WzDirectory](./wz.wzdirectory.md) \| null | | +| [wzFileParent](./wz.wzfile.wzfileparent.md) | readonly | [WzFile](./wz.wzfile.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [at(name)](./wz.wzfile.at.md) | | | +| [dispose()](./wz.wzfile.dispose.md) | | | +| [getObjectFromPath(path, checkFirstDirectoryName)](./wz.wzfile.getobjectfrompath.md) | | | +| [parseWzFile(wzIv)](./wz.wzfile.parsewzfile.md) | | | + diff --git a/docs/api/wz.wzfile.name.md b/docs/api/wz.wzfile.name.md index 6039457..92fa6ad 100644 --- a/docs/api/wz.wzfile.name.md +++ b/docs/api/wz.wzfile.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [name](./wz.wzfile.name.md) - -## WzFile.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [name](./wz.wzfile.name.md) + +## WzFile.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzfile.objecttype.md b/docs/api/wz.wzfile.objecttype.md index 22517b8..229eb5f 100644 --- a/docs/api/wz.wzfile.objecttype.md +++ b/docs/api/wz.wzfile.objecttype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [objectType](./wz.wzfile.objecttype.md) - -## WzFile.objectType property - -Signature: - -```typescript -get objectType(): WzObjectType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [objectType](./wz.wzfile.objecttype.md) + +## WzFile.objectType property + +**Signature:** + +```typescript +get objectType(): WzObjectType; +``` diff --git a/docs/api/wz.wzfile.parent.md b/docs/api/wz.wzfile.parent.md index ef6bc0f..5419b5c 100644 --- a/docs/api/wz.wzfile.parent.md +++ b/docs/api/wz.wzfile.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [parent](./wz.wzfile.parent.md) - -## WzFile.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [parent](./wz.wzfile.parent.md) + +## WzFile.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzfile.parsewzfile.md b/docs/api/wz.wzfile.parsewzfile.md index 1740a52..20fc317 100644 --- a/docs/api/wz.wzfile.parsewzfile.md +++ b/docs/api/wz.wzfile.parsewzfile.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [parseWzFile](./wz.wzfile.parsewzfile.md) - -## WzFile.parseWzFile() method - -Signature: - -```typescript -parseWzFile(wzIv?: Uint8Array | null): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| wzIv | Uint8Array \| null | (Optional) | - -Returns: - -Promise<[WzFileParseStatus](./wz.wzfileparsestatus.md)> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [parseWzFile](./wz.wzfile.parsewzfile.md) + +## WzFile.parseWzFile() method + +**Signature:** + +```typescript +parseWzFile(wzIv?: Uint8Array | null): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| wzIv | Uint8Array \| null | _(Optional)_ | + +**Returns:** + +Promise<[WzFileParseStatus](./wz.wzfileparsestatus.md)> + diff --git a/docs/api/wz.wzfile.wzdirectory.md b/docs/api/wz.wzfile.wzdirectory.md index 9afe455..5c32009 100644 --- a/docs/api/wz.wzfile.wzdirectory.md +++ b/docs/api/wz.wzfile.wzdirectory.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [wzDirectory](./wz.wzfile.wzdirectory.md) - -## WzFile.wzDirectory property - -Signature: - -```typescript -get wzDirectory(): WzDirectory | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [wzDirectory](./wz.wzfile.wzdirectory.md) + +## WzFile.wzDirectory property + +**Signature:** + +```typescript +get wzDirectory(): WzDirectory | null; +``` diff --git a/docs/api/wz.wzfile.wzfileparent.md b/docs/api/wz.wzfile.wzfileparent.md index 468bec7..45db4c8 100644 --- a/docs/api/wz.wzfile.wzfileparent.md +++ b/docs/api/wz.wzfile.wzfileparent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [wzFileParent](./wz.wzfile.wzfileparent.md) - -## WzFile.wzFileParent property - -Signature: - -```typescript -get wzFileParent(): WzFile; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFile](./wz.wzfile.md) > [wzFileParent](./wz.wzfile.wzfileparent.md) + +## WzFile.wzFileParent property + +**Signature:** + +```typescript +get wzFileParent(): WzFile; +``` diff --git a/docs/api/wz.wzfileparsestatus.md b/docs/api/wz.wzfileparsestatus.md index 4fbb916..897b711 100644 --- a/docs/api/wz.wzfileparsestatus.md +++ b/docs/api/wz.wzfileparsestatus.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFileParseStatus](./wz.wzfileparsestatus.md) - -## WzFileParseStatus enum - - -Signature: - -```typescript -export declare enum WzFileParseStatus -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ERROR\_GAME\_VER\_HASH | -2 | | -| FAILED\_UNKNOWN | 0 | | -| PATH\_IS\_NULL | -1 | | -| SUCCESS | 1 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFileParseStatus](./wz.wzfileparsestatus.md) + +## WzFileParseStatus enum + + +**Signature:** + +```typescript +export declare enum WzFileParseStatus +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| ERROR\_GAME\_VER\_HASH | -2 | | +| FAILED\_UNKNOWN | 0 | | +| PATH\_IS\_NULL | -1 | | +| SUCCESS | 1 | | + diff --git a/docs/api/wz.wzfloatproperty._constructor_.md b/docs/api/wz.wzfloatproperty._constructor_.md index cbfc37b..d082b73 100644 --- a/docs/api/wz.wzfloatproperty._constructor_.md +++ b/docs/api/wz.wzfloatproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [(constructor)](./wz.wzfloatproperty._constructor_.md) - -## WzFloatProperty.(constructor) - -Constructs a new instance of the `WzFloatProperty` class - -Signature: - -```typescript -constructor(name?: string, val?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| val | number | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [(constructor)](./wz.wzfloatproperty._constructor_.md) + +## WzFloatProperty.(constructor) + +Constructs a new instance of the `WzFloatProperty` class + +**Signature:** + +```typescript +constructor(name?: string, val?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| val | number | _(Optional)_ | + diff --git a/docs/api/wz.wzfloatproperty.dispose.md b/docs/api/wz.wzfloatproperty.dispose.md index 9f00cd6..962b428 100644 --- a/docs/api/wz.wzfloatproperty.dispose.md +++ b/docs/api/wz.wzfloatproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [dispose](./wz.wzfloatproperty.dispose.md) - -## WzFloatProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [dispose](./wz.wzfloatproperty.dispose.md) + +## WzFloatProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzfloatproperty.md b/docs/api/wz.wzfloatproperty.md index 21bf550..4bb038f 100644 --- a/docs/api/wz.wzfloatproperty.md +++ b/docs/api/wz.wzfloatproperty.md @@ -1,38 +1,38 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) - -## WzFloatProperty class - - -Signature: - -```typescript -export declare class WzFloatProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, val)](./wz.wzfloatproperty._constructor_.md) | | Constructs a new instance of the WzFloatProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzfloatproperty.name.md) | | string | | -| [parent](./wz.wzfloatproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzfloatproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [value](./wz.wzfloatproperty.value.md) | | number | | -| [wzValue](./wz.wzfloatproperty.wzvalue.md) | | number | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzfloatproperty.dispose.md) | | | -| [setValue(value)](./wz.wzfloatproperty.setvalue.md) | | | -| [toString()](./wz.wzfloatproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) + +## WzFloatProperty class + + +**Signature:** + +```typescript +export declare class WzFloatProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, val)](./wz.wzfloatproperty._constructor_.md) | | Constructs a new instance of the WzFloatProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzfloatproperty.name.md) | | string | | +| [parent](./wz.wzfloatproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzfloatproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [value](./wz.wzfloatproperty.value.md) | readonly | number | | +| [wzValue](./wz.wzfloatproperty.wzvalue.md) | readonly | number | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzfloatproperty.dispose.md) | | | +| [setValue(value)](./wz.wzfloatproperty.setvalue.md) | | | +| [toString()](./wz.wzfloatproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzfloatproperty.name.md b/docs/api/wz.wzfloatproperty.name.md index b6bbeb8..2e67a5e 100644 --- a/docs/api/wz.wzfloatproperty.name.md +++ b/docs/api/wz.wzfloatproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [name](./wz.wzfloatproperty.name.md) - -## WzFloatProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [name](./wz.wzfloatproperty.name.md) + +## WzFloatProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzfloatproperty.parent.md b/docs/api/wz.wzfloatproperty.parent.md index 49296f0..7e91f23 100644 --- a/docs/api/wz.wzfloatproperty.parent.md +++ b/docs/api/wz.wzfloatproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [parent](./wz.wzfloatproperty.parent.md) - -## WzFloatProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [parent](./wz.wzfloatproperty.parent.md) + +## WzFloatProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzfloatproperty.propertytype.md b/docs/api/wz.wzfloatproperty.propertytype.md index 3b05906..93566dc 100644 --- a/docs/api/wz.wzfloatproperty.propertytype.md +++ b/docs/api/wz.wzfloatproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [propertyType](./wz.wzfloatproperty.propertytype.md) - -## WzFloatProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [propertyType](./wz.wzfloatproperty.propertytype.md) + +## WzFloatProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzfloatproperty.setvalue.md b/docs/api/wz.wzfloatproperty.setvalue.md index 698040f..d7f9a52 100644 --- a/docs/api/wz.wzfloatproperty.setvalue.md +++ b/docs/api/wz.wzfloatproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [setValue](./wz.wzfloatproperty.setvalue.md) - -## WzFloatProperty.setValue() method - -Signature: - -```typescript -setValue(value: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [setValue](./wz.wzfloatproperty.setvalue.md) + +## WzFloatProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | number | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzfloatproperty.tostring.md b/docs/api/wz.wzfloatproperty.tostring.md index 404d7c4..68b6bb5 100644 --- a/docs/api/wz.wzfloatproperty.tostring.md +++ b/docs/api/wz.wzfloatproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [toString](./wz.wzfloatproperty.tostring.md) - -## WzFloatProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [toString](./wz.wzfloatproperty.tostring.md) + +## WzFloatProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzfloatproperty.value.md b/docs/api/wz.wzfloatproperty.value.md index 452789f..2bb862f 100644 --- a/docs/api/wz.wzfloatproperty.value.md +++ b/docs/api/wz.wzfloatproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [value](./wz.wzfloatproperty.value.md) - -## WzFloatProperty.value property - -Signature: - -```typescript -get value(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [value](./wz.wzfloatproperty.value.md) + +## WzFloatProperty.value property + +**Signature:** + +```typescript +get value(): number; +``` diff --git a/docs/api/wz.wzfloatproperty.wzvalue.md b/docs/api/wz.wzfloatproperty.wzvalue.md index 74bf9c8..024df9e 100644 --- a/docs/api/wz.wzfloatproperty.wzvalue.md +++ b/docs/api/wz.wzfloatproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [wzValue](./wz.wzfloatproperty.wzvalue.md) - -## WzFloatProperty.wzValue property - -Signature: - -```typescript -get wzValue(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzFloatProperty](./wz.wzfloatproperty.md) > [wzValue](./wz.wzfloatproperty.wzvalue.md) + +## WzFloatProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): number; +``` diff --git a/docs/api/wz.wzheader.copyright.md b/docs/api/wz.wzheader.copyright.md index 43755a7..7a38ea2 100644 --- a/docs/api/wz.wzheader.copyright.md +++ b/docs/api/wz.wzheader.copyright.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [copyright](./wz.wzheader.copyright.md) - -## WzHeader.copyright property - -Signature: - -```typescript -copyright: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [copyright](./wz.wzheader.copyright.md) + +## WzHeader.copyright property + +**Signature:** + +```typescript +copyright: string; +``` diff --git a/docs/api/wz.wzheader.fsize.md b/docs/api/wz.wzheader.fsize.md index fa529a1..5004e55 100644 --- a/docs/api/wz.wzheader.fsize.md +++ b/docs/api/wz.wzheader.fsize.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [fsize](./wz.wzheader.fsize.md) - -## WzHeader.fsize property - -Signature: - -```typescript -fsize: bigint; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [fsize](./wz.wzheader.fsize.md) + +## WzHeader.fsize property + +**Signature:** + +```typescript +fsize: bigint; +``` diff --git a/docs/api/wz.wzheader.fstart.md b/docs/api/wz.wzheader.fstart.md index 9cbe6a2..49f2459 100644 --- a/docs/api/wz.wzheader.fstart.md +++ b/docs/api/wz.wzheader.fstart.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [fstart](./wz.wzheader.fstart.md) - -## WzHeader.fstart property - -Signature: - -```typescript -fstart: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [fstart](./wz.wzheader.fstart.md) + +## WzHeader.fstart property + +**Signature:** + +```typescript +fstart: number; +``` diff --git a/docs/api/wz.wzheader.getdefault.md b/docs/api/wz.wzheader.getdefault.md index 59586fb..72807dc 100644 --- a/docs/api/wz.wzheader.getdefault.md +++ b/docs/api/wz.wzheader.getdefault.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [getDefault](./wz.wzheader.getdefault.md) - -## WzHeader.getDefault() method - -Signature: - -```typescript -static getDefault(): WzHeader; -``` -Returns: - -[WzHeader](./wz.wzheader.md) - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [getDefault](./wz.wzheader.getdefault.md) + +## WzHeader.getDefault() method + +**Signature:** + +```typescript +static getDefault(): WzHeader; +``` +**Returns:** + +[WzHeader](./wz.wzheader.md) + diff --git a/docs/api/wz.wzheader.ident.md b/docs/api/wz.wzheader.ident.md index d938ff2..f175b52 100644 --- a/docs/api/wz.wzheader.ident.md +++ b/docs/api/wz.wzheader.ident.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [ident](./wz.wzheader.ident.md) - -## WzHeader.ident property - -Signature: - -```typescript -ident: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [ident](./wz.wzheader.ident.md) + +## WzHeader.ident property + +**Signature:** + +```typescript +ident: string; +``` diff --git a/docs/api/wz.wzheader.md b/docs/api/wz.wzheader.md index 2ef2b80..54333a0 100644 --- a/docs/api/wz.wzheader.md +++ b/docs/api/wz.wzheader.md @@ -1,29 +1,29 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) - -## WzHeader class - - -Signature: - -```typescript -export declare class WzHeader -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [copyright](./wz.wzheader.copyright.md) | | string | | -| [fsize](./wz.wzheader.fsize.md) | | bigint | | -| [fstart](./wz.wzheader.fstart.md) | | number | | -| [ident](./wz.wzheader.ident.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [getDefault()](./wz.wzheader.getdefault.md) | static | | -| [recalculateFileStart()](./wz.wzheader.recalculatefilestart.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) + +## WzHeader class + + +**Signature:** + +```typescript +export declare class WzHeader +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [copyright](./wz.wzheader.copyright.md) | | string | | +| [fsize](./wz.wzheader.fsize.md) | | bigint | | +| [fstart](./wz.wzheader.fstart.md) | | number | | +| [ident](./wz.wzheader.ident.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [getDefault()](./wz.wzheader.getdefault.md) | static | | +| [recalculateFileStart()](./wz.wzheader.recalculatefilestart.md) | | | + diff --git a/docs/api/wz.wzheader.recalculatefilestart.md b/docs/api/wz.wzheader.recalculatefilestart.md index 96a7017..46a5df9 100644 --- a/docs/api/wz.wzheader.recalculatefilestart.md +++ b/docs/api/wz.wzheader.recalculatefilestart.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [recalculateFileStart](./wz.wzheader.recalculatefilestart.md) - -## WzHeader.recalculateFileStart() method - -Signature: - -```typescript -recalculateFileStart(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzHeader](./wz.wzheader.md) > [recalculateFileStart](./wz.wzheader.recalculatefilestart.md) + +## WzHeader.recalculateFileStart() method + +**Signature:** + +```typescript +recalculateFileStart(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzimage._constructor_.md b/docs/api/wz.wzimage._constructor_.md index a643d41..67f249f 100644 --- a/docs/api/wz.wzimage._constructor_.md +++ b/docs/api/wz.wzimage._constructor_.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [(constructor)](./wz.wzimage._constructor_.md) - -## WzImage.(constructor) - -Constructs a new instance of the `WzImage` class - -Signature: - -```typescript -constructor(name: string, reader: WzBinaryReader, checksum?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| checksum | number | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [(constructor)](./wz.wzimage._constructor_.md) + +## WzImage.(constructor) + +Constructs a new instance of the `WzImage` class + +**Signature:** + +```typescript +constructor(name: string, reader: WzBinaryReader, checksum?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| checksum | number | _(Optional)_ | + diff --git a/docs/api/wz.wzimage.addproperties.md b/docs/api/wz.wzimage.addproperties.md index d16d0cd..388a242 100644 --- a/docs/api/wz.wzimage.addproperties.md +++ b/docs/api/wz.wzimage.addproperties.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [addProperties](./wz.wzimage.addproperties.md) - -## WzImage.addProperties() method - -Signature: - -```typescript -addProperties(props: Set): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [addProperties](./wz.wzimage.addproperties.md) + +## WzImage.addProperties() method + +**Signature:** + +```typescript +addProperties(props: Set): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzimage.addproperty.md b/docs/api/wz.wzimage.addproperty.md index 678e0b4..4f04943 100644 --- a/docs/api/wz.wzimage.addproperty.md +++ b/docs/api/wz.wzimage.addproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [addProperty](./wz.wzimage.addproperty.md) - -## WzImage.addProperty() method - -Signature: - -```typescript -addProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [addProperty](./wz.wzimage.addproperty.md) + +## WzImage.addProperty() method + +**Signature:** + +```typescript +addProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzimage.at.md b/docs/api/wz.wzimage.at.md index 958c997..6074cb0 100644 --- a/docs/api/wz.wzimage.at.md +++ b/docs/api/wz.wzimage.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [at](./wz.wzimage.at.md) - -## WzImage.at() method - -Signature: - -```typescript -at(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [at](./wz.wzimage.at.md) + +## WzImage.at() method + +**Signature:** + +```typescript +at(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzimage.blocksize.md b/docs/api/wz.wzimage.blocksize.md index 9c4df7f..9f80033 100644 --- a/docs/api/wz.wzimage.blocksize.md +++ b/docs/api/wz.wzimage.blocksize.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [blockSize](./wz.wzimage.blocksize.md) - -## WzImage.blockSize property - -Signature: - -```typescript -blockSize: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [blockSize](./wz.wzimage.blocksize.md) + +## WzImage.blockSize property + +**Signature:** + +```typescript +blockSize: number; +``` diff --git a/docs/api/wz.wzimage.blockstart.md b/docs/api/wz.wzimage.blockstart.md index d0bd311..98e4f13 100644 --- a/docs/api/wz.wzimage.blockstart.md +++ b/docs/api/wz.wzimage.blockstart.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [blockStart](./wz.wzimage.blockstart.md) - -## WzImage.blockStart property - -Signature: - -```typescript -blockStart: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [blockStart](./wz.wzimage.blockstart.md) + +## WzImage.blockStart property + +**Signature:** + +```typescript +blockStart: number; +``` diff --git a/docs/api/wz.wzimage.calculateandsetimagechecksum.md b/docs/api/wz.wzimage.calculateandsetimagechecksum.md index de9c21a..fc73806 100644 --- a/docs/api/wz.wzimage.calculateandsetimagechecksum.md +++ b/docs/api/wz.wzimage.calculateandsetimagechecksum.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [calculateAndSetImageChecksum](./wz.wzimage.calculateandsetimagechecksum.md) - -## WzImage.calculateAndSetImageChecksum() method - -Signature: - -```typescript -calculateAndSetImageChecksum(bytes: Uint8Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| bytes | Uint8Array | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [calculateAndSetImageChecksum](./wz.wzimage.calculateandsetimagechecksum.md) + +## WzImage.calculateAndSetImageChecksum() method + +**Signature:** + +```typescript +calculateAndSetImageChecksum(bytes: Uint8Array): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| bytes | Uint8Array | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzimage.changed.md b/docs/api/wz.wzimage.changed.md index 783a4f9..ef3364c 100644 --- a/docs/api/wz.wzimage.changed.md +++ b/docs/api/wz.wzimage.changed.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [changed](./wz.wzimage.changed.md) - -## WzImage.changed property - -Signature: - -```typescript -changed: boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [changed](./wz.wzimage.changed.md) + +## WzImage.changed property + +**Signature:** + +```typescript +changed: boolean; +``` diff --git a/docs/api/wz.wzimage.checksum.md b/docs/api/wz.wzimage.checksum.md index 4200593..3031915 100644 --- a/docs/api/wz.wzimage.checksum.md +++ b/docs/api/wz.wzimage.checksum.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [checksum](./wz.wzimage.checksum.md) - -## WzImage.checksum property - -Signature: - -```typescript -checksum: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [checksum](./wz.wzimage.checksum.md) + +## WzImage.checksum property + +**Signature:** + +```typescript +checksum: number; +``` diff --git a/docs/api/wz.wzimage.clearproperties.md b/docs/api/wz.wzimage.clearproperties.md index c05dee3..a177f91 100644 --- a/docs/api/wz.wzimage.clearproperties.md +++ b/docs/api/wz.wzimage.clearproperties.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [clearProperties](./wz.wzimage.clearproperties.md) - -## WzImage.clearProperties() method - -Signature: - -```typescript -clearProperties(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [clearProperties](./wz.wzimage.clearproperties.md) + +## WzImage.clearProperties() method + +**Signature:** + +```typescript +clearProperties(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzimage.createfromfile.md b/docs/api/wz.wzimage.createfromfile.md index d9cf7b2..4d075f0 100644 --- a/docs/api/wz.wzimage.createfromfile.md +++ b/docs/api/wz.wzimage.createfromfile.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [createFromFile](./wz.wzimage.createfromfile.md) - -## WzImage.createFromFile() method - -Signature: - -```typescript -static createFromFile(filepath: string | File, version: WzMapleVersion): WzImage; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filepath | string \| File | | -| version | [WzMapleVersion](./wz.wzmapleversion.md) | | - -Returns: - -[WzImage](./wz.wzimage.md) - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [createFromFile](./wz.wzimage.createfromfile.md) + +## WzImage.createFromFile() method + +**Signature:** + +```typescript +static createFromFile(filepath: string | File, version: WzMapleVersion): WzImage; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filepath | string \| File | | +| version | [WzMapleVersion](./wz.wzmapleversion.md) | | + +**Returns:** + +[WzImage](./wz.wzimage.md) + diff --git a/docs/api/wz.wzimage.dispose.md b/docs/api/wz.wzimage.dispose.md index 7a94392..b4a4a99 100644 --- a/docs/api/wz.wzimage.dispose.md +++ b/docs/api/wz.wzimage.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [dispose](./wz.wzimage.dispose.md) - -## WzImage.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [dispose](./wz.wzimage.dispose.md) + +## WzImage.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzimage.getfrompath.md b/docs/api/wz.wzimage.getfrompath.md index c3389bc..9b3420e 100644 --- a/docs/api/wz.wzimage.getfrompath.md +++ b/docs/api/wz.wzimage.getfrompath.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [getFromPath](./wz.wzimage.getfrompath.md) - -## WzImage.getFromPath() method - -Signature: - -```typescript -getFromPath(path: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [getFromPath](./wz.wzimage.getfrompath.md) + +## WzImage.getFromPath() method + +**Signature:** + +```typescript +getFromPath(path: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzimage.isluaimage.md b/docs/api/wz.wzimage.isluaimage.md index a825665..b2972b4 100644 --- a/docs/api/wz.wzimage.isluaimage.md +++ b/docs/api/wz.wzimage.isluaimage.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [isLuaImage](./wz.wzimage.isluaimage.md) - -## WzImage.isLuaImage property - -Signature: - -```typescript -get isLuaImage(): boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [isLuaImage](./wz.wzimage.isluaimage.md) + +## WzImage.isLuaImage property + +**Signature:** + +```typescript +get isLuaImage(): boolean; +``` diff --git a/docs/api/wz.wzimage.md b/docs/api/wz.wzimage.md index 220bad1..a3144b9 100644 --- a/docs/api/wz.wzimage.md +++ b/docs/api/wz.wzimage.md @@ -1,61 +1,61 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) - -## WzImage class - - -Signature: - -```typescript -export declare class WzImage extends WzObject implements IPropertyContainer -``` -Extends: [WzObject](./wz.wzobject.md) - -Implements: [IPropertyContainer](./wz.ipropertycontainer.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, reader, checksum)](./wz.wzimage._constructor_.md) | | Constructs a new instance of the WzImage class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [blockSize](./wz.wzimage.blocksize.md) | | number | | -| [blockStart](./wz.wzimage.blockstart.md) | | number | | -| [changed](./wz.wzimage.changed.md) | | boolean | | -| [checksum](./wz.wzimage.checksum.md) | | number | | -| [isLuaImage](./wz.wzimage.isluaimage.md) | | boolean | | -| [name](./wz.wzimage.name.md) | | string | | -| [objectType](./wz.wzimage.objecttype.md) | | [WzObjectType](./wz.wzobjecttype.md) | | -| [offset](./wz.wzimage.offset.md) | | number | | -| [parent](./wz.wzimage.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [parsed](./wz.wzimage.parsed.md) | | boolean | | -| [parseEverything](./wz.wzimage.parseeverything.md) | | boolean | | -| [reader](./wz.wzimage.reader.md) | | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| [tempFileEnd](./wz.wzimage.tempfileend.md) | | bigint | | -| [tempFileStart](./wz.wzimage.tempfilestart.md) | | bigint | | -| [wzFileParent](./wz.wzimage.wzfileparent.md) | | [WzFile](./wz.wzfile.md) \| null | | -| [WzImageHeaderByte\_WithOffset](./wz.wzimage.wzimageheaderbyte_withoffset.md) | static | number | | -| [WzImageHeaderByte\_WithoutOffset](./wz.wzimage.wzimageheaderbyte_withoutoffset.md) | static | number | | -| [wzProperties](./wz.wzimage.wzproperties.md) | | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addProperties(props)](./wz.wzimage.addproperties.md) | | | -| [addProperty(prop)](./wz.wzimage.addproperty.md) | | | -| [at(name)](./wz.wzimage.at.md) | | | -| [calculateAndSetImageChecksum(bytes)](./wz.wzimage.calculateandsetimagechecksum.md) | | | -| [clearProperties()](./wz.wzimage.clearproperties.md) | | | -| [createFromFile(filepath, version)](./wz.wzimage.createfromfile.md) | static | | -| [dispose()](./wz.wzimage.dispose.md) | | | -| [getFromPath(path)](./wz.wzimage.getfrompath.md) | | | -| [parseImage(forceReadFromData)](./wz.wzimage.parseimage.md) | | | -| [removeProperty(prop)](./wz.wzimage.removeproperty.md) | | | -| [set(name, value)](./wz.wzimage.set.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) + +## WzImage class + + +**Signature:** + +```typescript +export declare class WzImage extends WzObject implements IPropertyContainer +``` +**Extends:** [WzObject](./wz.wzobject.md) + +**Implements:** [IPropertyContainer](./wz.ipropertycontainer.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, reader, checksum)](./wz.wzimage._constructor_.md) | | Constructs a new instance of the WzImage class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [blockSize](./wz.wzimage.blocksize.md) | | number | | +| [blockStart](./wz.wzimage.blockstart.md) | | number | | +| [changed](./wz.wzimage.changed.md) | | boolean | | +| [checksum](./wz.wzimage.checksum.md) | | number | | +| [isLuaImage](./wz.wzimage.isluaimage.md) | readonly | boolean | | +| [name](./wz.wzimage.name.md) | | string | | +| [objectType](./wz.wzimage.objecttype.md) | readonly | [WzObjectType](./wz.wzobjecttype.md) | | +| [offset](./wz.wzimage.offset.md) | | number | | +| [parent](./wz.wzimage.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [parsed](./wz.wzimage.parsed.md) | | boolean | | +| [parseEverything](./wz.wzimage.parseeverything.md) | | boolean | | +| [reader](./wz.wzimage.reader.md) | | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| [tempFileEnd](./wz.wzimage.tempfileend.md) | | bigint | | +| [tempFileStart](./wz.wzimage.tempfilestart.md) | | bigint | | +| [wzFileParent](./wz.wzimage.wzfileparent.md) | readonly | [WzFile](./wz.wzfile.md) \| null | | +| [WzImageHeaderByte\_WithOffset](./wz.wzimage.wzimageheaderbyte_withoffset.md) | static | number | | +| [WzImageHeaderByte\_WithoutOffset](./wz.wzimage.wzimageheaderbyte_withoutoffset.md) | static | number | | +| [wzProperties](./wz.wzimage.wzproperties.md) | readonly | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addProperties(props)](./wz.wzimage.addproperties.md) | | | +| [addProperty(prop)](./wz.wzimage.addproperty.md) | | | +| [at(name)](./wz.wzimage.at.md) | | | +| [calculateAndSetImageChecksum(bytes)](./wz.wzimage.calculateandsetimagechecksum.md) | | | +| [clearProperties()](./wz.wzimage.clearproperties.md) | | | +| [createFromFile(filepath, version)](./wz.wzimage.createfromfile.md) | static | | +| [dispose()](./wz.wzimage.dispose.md) | | | +| [getFromPath(path)](./wz.wzimage.getfrompath.md) | | | +| [parseImage(forceReadFromData)](./wz.wzimage.parseimage.md) | | | +| [removeProperty(prop)](./wz.wzimage.removeproperty.md) | | | +| [set(name, value)](./wz.wzimage.set.md) | | | + diff --git a/docs/api/wz.wzimage.name.md b/docs/api/wz.wzimage.name.md index c3b74f5..7c226a6 100644 --- a/docs/api/wz.wzimage.name.md +++ b/docs/api/wz.wzimage.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [name](./wz.wzimage.name.md) - -## WzImage.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [name](./wz.wzimage.name.md) + +## WzImage.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzimage.objecttype.md b/docs/api/wz.wzimage.objecttype.md index a39de19..e0165ba 100644 --- a/docs/api/wz.wzimage.objecttype.md +++ b/docs/api/wz.wzimage.objecttype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [objectType](./wz.wzimage.objecttype.md) - -## WzImage.objectType property - -Signature: - -```typescript -get objectType(): WzObjectType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [objectType](./wz.wzimage.objecttype.md) + +## WzImage.objectType property + +**Signature:** + +```typescript +get objectType(): WzObjectType; +``` diff --git a/docs/api/wz.wzimage.offset.md b/docs/api/wz.wzimage.offset.md index b16128d..5d1e974 100644 --- a/docs/api/wz.wzimage.offset.md +++ b/docs/api/wz.wzimage.offset.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [offset](./wz.wzimage.offset.md) - -## WzImage.offset property - -Signature: - -```typescript -offset: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [offset](./wz.wzimage.offset.md) + +## WzImage.offset property + +**Signature:** + +```typescript +offset: number; +``` diff --git a/docs/api/wz.wzimage.parent.md b/docs/api/wz.wzimage.parent.md index 734313d..b39b0cc 100644 --- a/docs/api/wz.wzimage.parent.md +++ b/docs/api/wz.wzimage.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parent](./wz.wzimage.parent.md) - -## WzImage.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parent](./wz.wzimage.parent.md) + +## WzImage.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzimage.parsed.md b/docs/api/wz.wzimage.parsed.md index 7fbda99..7d16d45 100644 --- a/docs/api/wz.wzimage.parsed.md +++ b/docs/api/wz.wzimage.parsed.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parsed](./wz.wzimage.parsed.md) - -## WzImage.parsed property - -Signature: - -```typescript -parsed: boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parsed](./wz.wzimage.parsed.md) + +## WzImage.parsed property + +**Signature:** + +```typescript +parsed: boolean; +``` diff --git a/docs/api/wz.wzimage.parseeverything.md b/docs/api/wz.wzimage.parseeverything.md index 4492bae..d9f9b2c 100644 --- a/docs/api/wz.wzimage.parseeverything.md +++ b/docs/api/wz.wzimage.parseeverything.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parseEverything](./wz.wzimage.parseeverything.md) - -## WzImage.parseEverything property - -Signature: - -```typescript -parseEverything: boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parseEverything](./wz.wzimage.parseeverything.md) + +## WzImage.parseEverything property + +**Signature:** + +```typescript +parseEverything: boolean; +``` diff --git a/docs/api/wz.wzimage.parseimage.md b/docs/api/wz.wzimage.parseimage.md index 028d82b..ba3088d 100644 --- a/docs/api/wz.wzimage.parseimage.md +++ b/docs/api/wz.wzimage.parseimage.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parseImage](./wz.wzimage.parseimage.md) - -## WzImage.parseImage() method - -Signature: - -```typescript -parseImage(forceReadFromData?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| forceReadFromData | boolean | (Optional) | - -Returns: - -Promise<boolean> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [parseImage](./wz.wzimage.parseimage.md) + +## WzImage.parseImage() method + +**Signature:** + +```typescript +parseImage(forceReadFromData?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| forceReadFromData | boolean | _(Optional)_ | + +**Returns:** + +Promise<boolean> + diff --git a/docs/api/wz.wzimage.reader.md b/docs/api/wz.wzimage.reader.md index 4ef034f..c38d3a9 100644 --- a/docs/api/wz.wzimage.reader.md +++ b/docs/api/wz.wzimage.reader.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [reader](./wz.wzimage.reader.md) - -## WzImage.reader property - -Signature: - -```typescript -reader: WzBinaryReader; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [reader](./wz.wzimage.reader.md) + +## WzImage.reader property + +**Signature:** + +```typescript +reader: WzBinaryReader; +``` diff --git a/docs/api/wz.wzimage.removeproperty.md b/docs/api/wz.wzimage.removeproperty.md index 38db7b4..83ce2e9 100644 --- a/docs/api/wz.wzimage.removeproperty.md +++ b/docs/api/wz.wzimage.removeproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [removeProperty](./wz.wzimage.removeproperty.md) - -## WzImage.removeProperty() method - -Signature: - -```typescript -removeProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [removeProperty](./wz.wzimage.removeproperty.md) + +## WzImage.removeProperty() method + +**Signature:** + +```typescript +removeProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzimage.set.md b/docs/api/wz.wzimage.set.md index 8df09af..9ac046f 100644 --- a/docs/api/wz.wzimage.set.md +++ b/docs/api/wz.wzimage.set.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [set](./wz.wzimage.set.md) - -## WzImage.set() method - -Signature: - -```typescript -set(name: string, value: T): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| value | T | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [set](./wz.wzimage.set.md) + +## WzImage.set() method + +**Signature:** + +```typescript +set(name: string, value: T): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| value | T | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzimage.tempfileend.md b/docs/api/wz.wzimage.tempfileend.md index 854483f..ead4fec 100644 --- a/docs/api/wz.wzimage.tempfileend.md +++ b/docs/api/wz.wzimage.tempfileend.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [tempFileEnd](./wz.wzimage.tempfileend.md) - -## WzImage.tempFileEnd property - -Signature: - -```typescript -tempFileEnd: bigint; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [tempFileEnd](./wz.wzimage.tempfileend.md) + +## WzImage.tempFileEnd property + +**Signature:** + +```typescript +tempFileEnd: bigint; +``` diff --git a/docs/api/wz.wzimage.tempfilestart.md b/docs/api/wz.wzimage.tempfilestart.md index f893c9d..418f428 100644 --- a/docs/api/wz.wzimage.tempfilestart.md +++ b/docs/api/wz.wzimage.tempfilestart.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [tempFileStart](./wz.wzimage.tempfilestart.md) - -## WzImage.tempFileStart property - -Signature: - -```typescript -tempFileStart: bigint; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [tempFileStart](./wz.wzimage.tempfilestart.md) + +## WzImage.tempFileStart property + +**Signature:** + +```typescript +tempFileStart: bigint; +``` diff --git a/docs/api/wz.wzimage.wzfileparent.md b/docs/api/wz.wzimage.wzfileparent.md index bfbe4b6..9705eda 100644 --- a/docs/api/wz.wzimage.wzfileparent.md +++ b/docs/api/wz.wzimage.wzfileparent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [wzFileParent](./wz.wzimage.wzfileparent.md) - -## WzImage.wzFileParent property - -Signature: - -```typescript -get wzFileParent(): WzFile | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [wzFileParent](./wz.wzimage.wzfileparent.md) + +## WzImage.wzFileParent property + +**Signature:** + +```typescript +get wzFileParent(): WzFile | null; +``` diff --git a/docs/api/wz.wzimage.wzimageheaderbyte_withoffset.md b/docs/api/wz.wzimage.wzimageheaderbyte_withoffset.md index 486f17d..9c47439 100644 --- a/docs/api/wz.wzimage.wzimageheaderbyte_withoffset.md +++ b/docs/api/wz.wzimage.wzimageheaderbyte_withoffset.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [WzImageHeaderByte\_WithOffset](./wz.wzimage.wzimageheaderbyte_withoffset.md) - -## WzImage.WzImageHeaderByte\_WithOffset property - -Signature: - -```typescript -static WzImageHeaderByte_WithOffset: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [WzImageHeaderByte\_WithOffset](./wz.wzimage.wzimageheaderbyte_withoffset.md) + +## WzImage.WzImageHeaderByte\_WithOffset property + +**Signature:** + +```typescript +static WzImageHeaderByte_WithOffset: number; +``` diff --git a/docs/api/wz.wzimage.wzimageheaderbyte_withoutoffset.md b/docs/api/wz.wzimage.wzimageheaderbyte_withoutoffset.md index bbc2d3f..aedce46 100644 --- a/docs/api/wz.wzimage.wzimageheaderbyte_withoutoffset.md +++ b/docs/api/wz.wzimage.wzimageheaderbyte_withoutoffset.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [WzImageHeaderByte\_WithoutOffset](./wz.wzimage.wzimageheaderbyte_withoutoffset.md) - -## WzImage.WzImageHeaderByte\_WithoutOffset property - -Signature: - -```typescript -static WzImageHeaderByte_WithoutOffset: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [WzImageHeaderByte\_WithoutOffset](./wz.wzimage.wzimageheaderbyte_withoutoffset.md) + +## WzImage.WzImageHeaderByte\_WithoutOffset property + +**Signature:** + +```typescript +static WzImageHeaderByte_WithoutOffset: number; +``` diff --git a/docs/api/wz.wzimage.wzproperties.md b/docs/api/wz.wzimage.wzproperties.md index 7c27114..a0105b0 100644 --- a/docs/api/wz.wzimage.wzproperties.md +++ b/docs/api/wz.wzimage.wzproperties.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [wzProperties](./wz.wzimage.wzproperties.md) - -## WzImage.wzProperties property - -Signature: - -```typescript -get wzProperties(): Set; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImage](./wz.wzimage.md) > [wzProperties](./wz.wzimage.wzproperties.md) + +## WzImage.wzProperties property + +**Signature:** + +```typescript +get wzProperties(): Set; +``` diff --git a/docs/api/wz.wzimageproperty.at.md b/docs/api/wz.wzimageproperty.at.md index 54b129f..32903c3 100644 --- a/docs/api/wz.wzimageproperty.at.md +++ b/docs/api/wz.wzimageproperty.at.md @@ -1,24 +1,24 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [at](./wz.wzimageproperty.at.md) - -## WzImageProperty.at() method - - -Signature: - -```typescript -/** @virtual */ -at(_name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [at](./wz.wzimageproperty.at.md) + +## WzImageProperty.at() method + + +**Signature:** + +```typescript +/** @virtual */ +at(_name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzimageproperty.extractmore.md b/docs/api/wz.wzimageproperty.extractmore.md index 19e44a1..a02b8fa 100644 --- a/docs/api/wz.wzimageproperty.extractmore.md +++ b/docs/api/wz.wzimageproperty.extractmore.md @@ -1,28 +1,28 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [extractMore](./wz.wzimageproperty.extractmore.md) - -## WzImageProperty.extractMore() method - -Signature: - -```typescript -static extractMore

(reader: WzBinaryReader, offset: number, _eob: number, name: string, iname: string, parent: P, imgParent: WzImage): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| offset | number | | -| \_eob | number | | -| name | string | | -| iname | string | | -| parent | P | | -| imgParent | [WzImage](./wz.wzimage.md) | | - -Returns: - -Promise<[WzExtended](./wz.wzextended.md)> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [extractMore](./wz.wzimageproperty.extractmore.md) + +## WzImageProperty.extractMore() method + +**Signature:** + +```typescript +static extractMore

(reader: WzBinaryReader, offset: number, _eob: number, name: string, iname: string, parent: P, imgParent: WzImage): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| offset | number | | +| \_eob | number | | +| name | string | | +| iname | string | | +| parent | P | | +| imgParent | [WzImage](./wz.wzimage.md) | | + +**Returns:** + +Promise<[WzExtended](./wz.wzextended.md)> + diff --git a/docs/api/wz.wzimageproperty.getfrompath.md b/docs/api/wz.wzimageproperty.getfrompath.md index 02cbd5d..52dc379 100644 --- a/docs/api/wz.wzimageproperty.getfrompath.md +++ b/docs/api/wz.wzimageproperty.getfrompath.md @@ -1,24 +1,24 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [getFromPath](./wz.wzimageproperty.getfrompath.md) - -## WzImageProperty.getFromPath() method - - -Signature: - -```typescript -/** @virtual */ -getFromPath(_path: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_path | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [getFromPath](./wz.wzimageproperty.getfrompath.md) + +## WzImageProperty.getFromPath() method + + +**Signature:** + +```typescript +/** @virtual */ +getFromPath(_path: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_path | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzimageproperty.getlinkedwzimageproperty.md b/docs/api/wz.wzimageproperty.getlinkedwzimageproperty.md index ff502ff..de4f152 100644 --- a/docs/api/wz.wzimageproperty.getlinkedwzimageproperty.md +++ b/docs/api/wz.wzimageproperty.getlinkedwzimageproperty.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [getLinkedWzImageProperty](./wz.wzimageproperty.getlinkedwzimageproperty.md) - -## WzImageProperty.getLinkedWzImageProperty() method - -Signature: - -```typescript -getLinkedWzImageProperty(): WzImageProperty; -``` -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [getLinkedWzImageProperty](./wz.wzimageproperty.getlinkedwzimageproperty.md) + +## WzImageProperty.getLinkedWzImageProperty() method + +**Signature:** + +```typescript +getLinkedWzImageProperty(): WzImageProperty; +``` +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) + diff --git a/docs/api/wz.wzimageproperty.md b/docs/api/wz.wzimageproperty.md index c5d5816..6aed1f3 100644 --- a/docs/api/wz.wzimageproperty.md +++ b/docs/api/wz.wzimageproperty.md @@ -1,37 +1,37 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) - -## WzImageProperty class - - -Signature: - -```typescript -export declare abstract class WzImageProperty extends WzObject -``` -Extends: [WzObject](./wz.wzobject.md) - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [objectType](./wz.wzimageproperty.objecttype.md) | | [WzObjectType](./wz.wzobjecttype.md) | | -| [parentImage](./wz.wzimageproperty.parentimage.md) | | [WzImage](./wz.wzimage.md) \| null | | -| [propertyType](./wz.wzimageproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [wzFileParent](./wz.wzimageproperty.wzfileparent.md) | | [WzFile](./wz.wzfile.md) \| null | | -| [wzProperties](./wz.wzimageproperty.wzproperties.md) | | Set<[WzImageProperty](./wz.wzimageproperty.md)> \| null | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [at(\_name)](./wz.wzimageproperty.at.md) | | | -| [extractMore(reader, offset, \_eob, name, iname, parent, imgParent)](./wz.wzimageproperty.extractmore.md) | static | | -| [getFromPath(\_path)](./wz.wzimageproperty.getfrompath.md) | | | -| [getLinkedWzImageProperty()](./wz.wzimageproperty.getlinkedwzimageproperty.md) | | | -| [parseExtendedProp(reader, offset, endOfBlock, name, parent, imgParent)](./wz.wzimageproperty.parseextendedprop.md) | static | | -| [parseLuaProperty(\_offset, reader, parent, \_parentImg)](./wz.wzimageproperty.parseluaproperty.md) | static | | -| [parsePropertyList(offset, reader, parent, parentImg)](./wz.wzimageproperty.parsepropertylist.md) | static | | -| [set(\_name, \_value)](./wz.wzimageproperty.set.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) + +## WzImageProperty class + + +**Signature:** + +```typescript +export declare abstract class WzImageProperty extends WzObject +``` +**Extends:** [WzObject](./wz.wzobject.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [objectType](./wz.wzimageproperty.objecttype.md) | readonly | [WzObjectType](./wz.wzobjecttype.md) | | +| [parentImage](./wz.wzimageproperty.parentimage.md) | readonly | [WzImage](./wz.wzimage.md) \| null | | +| [propertyType](./wz.wzimageproperty.propertytype.md) |

abstract

readonly

| [WzPropertyType](./wz.wzpropertytype.md) | | +| [wzFileParent](./wz.wzimageproperty.wzfileparent.md) | readonly | [WzFile](./wz.wzfile.md) \| null | | +| [wzProperties](./wz.wzimageproperty.wzproperties.md) | readonly | Set<[WzImageProperty](./wz.wzimageproperty.md)> \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [at(\_name)](./wz.wzimageproperty.at.md) | | | +| [extractMore(reader, offset, \_eob, name, iname, parent, imgParent)](./wz.wzimageproperty.extractmore.md) | static | | +| [getFromPath(\_path)](./wz.wzimageproperty.getfrompath.md) | | | +| [getLinkedWzImageProperty()](./wz.wzimageproperty.getlinkedwzimageproperty.md) | | | +| [parseExtendedProp(reader, offset, endOfBlock, name, parent, imgParent)](./wz.wzimageproperty.parseextendedprop.md) | static | | +| [parseLuaProperty(\_offset, reader, parent, \_parentImg)](./wz.wzimageproperty.parseluaproperty.md) | static | | +| [parsePropertyList(offset, reader, parent, parentImg)](./wz.wzimageproperty.parsepropertylist.md) | static | | +| [set(\_name, \_value)](./wz.wzimageproperty.set.md) | | | + diff --git a/docs/api/wz.wzimageproperty.objecttype.md b/docs/api/wz.wzimageproperty.objecttype.md index 2d0c8db..f05ce60 100644 --- a/docs/api/wz.wzimageproperty.objecttype.md +++ b/docs/api/wz.wzimageproperty.objecttype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [objectType](./wz.wzimageproperty.objecttype.md) - -## WzImageProperty.objectType property - -Signature: - -```typescript -get objectType(): WzObjectType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [objectType](./wz.wzimageproperty.objecttype.md) + +## WzImageProperty.objectType property + +**Signature:** + +```typescript +get objectType(): WzObjectType; +``` diff --git a/docs/api/wz.wzimageproperty.parentimage.md b/docs/api/wz.wzimageproperty.parentimage.md index a8b5c87..ad037c9 100644 --- a/docs/api/wz.wzimageproperty.parentimage.md +++ b/docs/api/wz.wzimageproperty.parentimage.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parentImage](./wz.wzimageproperty.parentimage.md) - -## WzImageProperty.parentImage property - -Signature: - -```typescript -get parentImage(): WzImage | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parentImage](./wz.wzimageproperty.parentimage.md) + +## WzImageProperty.parentImage property + +**Signature:** + +```typescript +get parentImage(): WzImage | null; +``` diff --git a/docs/api/wz.wzimageproperty.parseextendedprop.md b/docs/api/wz.wzimageproperty.parseextendedprop.md index e968981..ccac342 100644 --- a/docs/api/wz.wzimageproperty.parseextendedprop.md +++ b/docs/api/wz.wzimageproperty.parseextendedprop.md @@ -1,27 +1,27 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parseExtendedProp](./wz.wzimageproperty.parseextendedprop.md) - -## WzImageProperty.parseExtendedProp() method - -Signature: - -```typescript -static parseExtendedProp

(reader: WzBinaryReader, offset: number, endOfBlock: number, name: string, parent: P, imgParent: WzImage): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| offset | number | | -| endOfBlock | number | | -| name | string | | -| parent | P | | -| imgParent | [WzImage](./wz.wzimage.md) | | - -Returns: - -Promise<[WzExtended](./wz.wzextended.md)> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parseExtendedProp](./wz.wzimageproperty.parseextendedprop.md) + +## WzImageProperty.parseExtendedProp() method + +**Signature:** + +```typescript +static parseExtendedProp

(reader: WzBinaryReader, offset: number, endOfBlock: number, name: string, parent: P, imgParent: WzImage): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| offset | number | | +| endOfBlock | number | | +| name | string | | +| parent | P | | +| imgParent | [WzImage](./wz.wzimage.md) | | + +**Returns:** + +Promise<[WzExtended](./wz.wzextended.md)> + diff --git a/docs/api/wz.wzimageproperty.parseluaproperty.md b/docs/api/wz.wzimageproperty.parseluaproperty.md index 9910d54..23e0ab3 100644 --- a/docs/api/wz.wzimageproperty.parseluaproperty.md +++ b/docs/api/wz.wzimageproperty.parseluaproperty.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parseLuaProperty](./wz.wzimageproperty.parseluaproperty.md) - -## WzImageProperty.parseLuaProperty() method - -Signature: - -```typescript -static parseLuaProperty

(_offset: number, reader: WzBinaryReader, parent: P, _parentImg: WzImage): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_offset | number | | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| parent | P | | -| \_parentImg | [WzImage](./wz.wzimage.md) | | - -Returns: - -Promise<[WzLuaProperty](./wz.wzluaproperty.md)> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parseLuaProperty](./wz.wzimageproperty.parseluaproperty.md) + +## WzImageProperty.parseLuaProperty() method + +**Signature:** + +```typescript +static parseLuaProperty

(_offset: number, reader: WzBinaryReader, parent: P, _parentImg: WzImage): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_offset | number | | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| parent | P | | +| \_parentImg | [WzImage](./wz.wzimage.md) | | + +**Returns:** + +Promise<[WzLuaProperty](./wz.wzluaproperty.md)> + diff --git a/docs/api/wz.wzimageproperty.parsepropertylist.md b/docs/api/wz.wzimageproperty.parsepropertylist.md index 2827494..2ad24fc 100644 --- a/docs/api/wz.wzimageproperty.parsepropertylist.md +++ b/docs/api/wz.wzimageproperty.parsepropertylist.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parsePropertyList](./wz.wzimageproperty.parsepropertylist.md) - -## WzImageProperty.parsePropertyList() method - -Signature: - -```typescript -static parsePropertyList

(offset: number, reader: WzBinaryReader, parent: P, parentImg: WzImage): Promise>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| offset | number | | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | -| parent | P | | -| parentImg | [WzImage](./wz.wzimage.md) | | - -Returns: - -Promise<Set<[WzImageProperty](./wz.wzimageproperty.md)>> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [parsePropertyList](./wz.wzimageproperty.parsepropertylist.md) + +## WzImageProperty.parsePropertyList() method + +**Signature:** + +```typescript +static parsePropertyList

(offset: number, reader: WzBinaryReader, parent: P, parentImg: WzImage): Promise>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| offset | number | | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | +| parent | P | | +| parentImg | [WzImage](./wz.wzimage.md) | | + +**Returns:** + +Promise<Set<[WzImageProperty](./wz.wzimageproperty.md)>> + diff --git a/docs/api/wz.wzimageproperty.propertytype.md b/docs/api/wz.wzimageproperty.propertytype.md index 4aefb21..251dddf 100644 --- a/docs/api/wz.wzimageproperty.propertytype.md +++ b/docs/api/wz.wzimageproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [propertyType](./wz.wzimageproperty.propertytype.md) - -## WzImageProperty.propertyType property - -Signature: - -```typescript -abstract get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [propertyType](./wz.wzimageproperty.propertytype.md) + +## WzImageProperty.propertyType property + +**Signature:** + +```typescript +abstract get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzimageproperty.set.md b/docs/api/wz.wzimageproperty.set.md index 9ae41fd..f1e609f 100644 --- a/docs/api/wz.wzimageproperty.set.md +++ b/docs/api/wz.wzimageproperty.set.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [set](./wz.wzimageproperty.set.md) - -## WzImageProperty.set() method - - -Signature: - -```typescript -/** @virtual */ -set(_name: string, _value: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_name | string | | -| \_value | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [set](./wz.wzimageproperty.set.md) + +## WzImageProperty.set() method + + +**Signature:** + +```typescript +/** @virtual */ +set(_name: string, _value: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_name | string | | +| \_value | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzimageproperty.wzfileparent.md b/docs/api/wz.wzimageproperty.wzfileparent.md index 79f991f..335bf11 100644 --- a/docs/api/wz.wzimageproperty.wzfileparent.md +++ b/docs/api/wz.wzimageproperty.wzfileparent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [wzFileParent](./wz.wzimageproperty.wzfileparent.md) - -## WzImageProperty.wzFileParent property - -Signature: - -```typescript -get wzFileParent(): WzFile | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [wzFileParent](./wz.wzimageproperty.wzfileparent.md) + +## WzImageProperty.wzFileParent property + +**Signature:** + +```typescript +get wzFileParent(): WzFile | null; +``` diff --git a/docs/api/wz.wzimageproperty.wzproperties.md b/docs/api/wz.wzimageproperty.wzproperties.md index 6750432..e25732d 100644 --- a/docs/api/wz.wzimageproperty.wzproperties.md +++ b/docs/api/wz.wzimageproperty.wzproperties.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [wzProperties](./wz.wzimageproperty.wzproperties.md) - -## WzImageProperty.wzProperties property - - -Signature: - -```typescript -/** @virtual */ -get wzProperties(): Set | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzImageProperty](./wz.wzimageproperty.md) > [wzProperties](./wz.wzimageproperty.wzproperties.md) + +## WzImageProperty.wzProperties property + + +**Signature:** + +```typescript +/** @virtual */ +get wzProperties(): Set | null; +``` diff --git a/docs/api/wz.wzintproperty._constructor_.md b/docs/api/wz.wzintproperty._constructor_.md index 30462c5..3696a36 100644 --- a/docs/api/wz.wzintproperty._constructor_.md +++ b/docs/api/wz.wzintproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [(constructor)](./wz.wzintproperty._constructor_.md) - -## WzIntProperty.(constructor) - -Constructs a new instance of the `WzIntProperty` class - -Signature: - -```typescript -constructor(name?: string, val?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| val | number | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [(constructor)](./wz.wzintproperty._constructor_.md) + +## WzIntProperty.(constructor) + +Constructs a new instance of the `WzIntProperty` class + +**Signature:** + +```typescript +constructor(name?: string, val?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| val | number | _(Optional)_ | + diff --git a/docs/api/wz.wzintproperty.dispose.md b/docs/api/wz.wzintproperty.dispose.md index ce5780f..aa30013 100644 --- a/docs/api/wz.wzintproperty.dispose.md +++ b/docs/api/wz.wzintproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [dispose](./wz.wzintproperty.dispose.md) - -## WzIntProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [dispose](./wz.wzintproperty.dispose.md) + +## WzIntProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzintproperty.md b/docs/api/wz.wzintproperty.md index 94d2b9f..e706664 100644 --- a/docs/api/wz.wzintproperty.md +++ b/docs/api/wz.wzintproperty.md @@ -1,38 +1,38 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) - -## WzIntProperty class - - -Signature: - -```typescript -export declare class WzIntProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, val)](./wz.wzintproperty._constructor_.md) | | Constructs a new instance of the WzIntProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzintproperty.name.md) | | string | | -| [parent](./wz.wzintproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzintproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [value](./wz.wzintproperty.value.md) | | number | | -| [wzValue](./wz.wzintproperty.wzvalue.md) | | number | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzintproperty.dispose.md) | | | -| [setValue(value)](./wz.wzintproperty.setvalue.md) | | | -| [toString()](./wz.wzintproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) + +## WzIntProperty class + + +**Signature:** + +```typescript +export declare class WzIntProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, val)](./wz.wzintproperty._constructor_.md) | | Constructs a new instance of the WzIntProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzintproperty.name.md) | | string | | +| [parent](./wz.wzintproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzintproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [value](./wz.wzintproperty.value.md) | readonly | number | | +| [wzValue](./wz.wzintproperty.wzvalue.md) | readonly | number | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzintproperty.dispose.md) | | | +| [setValue(value)](./wz.wzintproperty.setvalue.md) | | | +| [toString()](./wz.wzintproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzintproperty.name.md b/docs/api/wz.wzintproperty.name.md index 92204e1..5a97503 100644 --- a/docs/api/wz.wzintproperty.name.md +++ b/docs/api/wz.wzintproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [name](./wz.wzintproperty.name.md) - -## WzIntProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [name](./wz.wzintproperty.name.md) + +## WzIntProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzintproperty.parent.md b/docs/api/wz.wzintproperty.parent.md index 51c9058..08612f7 100644 --- a/docs/api/wz.wzintproperty.parent.md +++ b/docs/api/wz.wzintproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [parent](./wz.wzintproperty.parent.md) - -## WzIntProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [parent](./wz.wzintproperty.parent.md) + +## WzIntProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzintproperty.propertytype.md b/docs/api/wz.wzintproperty.propertytype.md index b198302..2a47cc3 100644 --- a/docs/api/wz.wzintproperty.propertytype.md +++ b/docs/api/wz.wzintproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [propertyType](./wz.wzintproperty.propertytype.md) - -## WzIntProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [propertyType](./wz.wzintproperty.propertytype.md) + +## WzIntProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzintproperty.setvalue.md b/docs/api/wz.wzintproperty.setvalue.md index 282191a..55315cb 100644 --- a/docs/api/wz.wzintproperty.setvalue.md +++ b/docs/api/wz.wzintproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [setValue](./wz.wzintproperty.setvalue.md) - -## WzIntProperty.setValue() method - -Signature: - -```typescript -setValue(value: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [setValue](./wz.wzintproperty.setvalue.md) + +## WzIntProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | number | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzintproperty.tostring.md b/docs/api/wz.wzintproperty.tostring.md index 24ada24..7db2880 100644 --- a/docs/api/wz.wzintproperty.tostring.md +++ b/docs/api/wz.wzintproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [toString](./wz.wzintproperty.tostring.md) - -## WzIntProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [toString](./wz.wzintproperty.tostring.md) + +## WzIntProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzintproperty.value.md b/docs/api/wz.wzintproperty.value.md index 2d2d3ef..81dd1e7 100644 --- a/docs/api/wz.wzintproperty.value.md +++ b/docs/api/wz.wzintproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [value](./wz.wzintproperty.value.md) - -## WzIntProperty.value property - -Signature: - -```typescript -get value(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [value](./wz.wzintproperty.value.md) + +## WzIntProperty.value property + +**Signature:** + +```typescript +get value(): number; +``` diff --git a/docs/api/wz.wzintproperty.wzvalue.md b/docs/api/wz.wzintproperty.wzvalue.md index 6635410..8b9a28e 100644 --- a/docs/api/wz.wzintproperty.wzvalue.md +++ b/docs/api/wz.wzintproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [wzValue](./wz.wzintproperty.wzvalue.md) - -## WzIntProperty.wzValue property - -Signature: - -```typescript -get wzValue(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzIntProperty](./wz.wzintproperty.md) > [wzValue](./wz.wzintproperty.wzvalue.md) + +## WzIntProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): number; +``` diff --git a/docs/api/wz.wzlongproperty._constructor_.md b/docs/api/wz.wzlongproperty._constructor_.md index 7a588f6..0610607 100644 --- a/docs/api/wz.wzlongproperty._constructor_.md +++ b/docs/api/wz.wzlongproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [(constructor)](./wz.wzlongproperty._constructor_.md) - -## WzLongProperty.(constructor) - -Constructs a new instance of the `WzLongProperty` class - -Signature: - -```typescript -constructor(name?: string, val?: bigint); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| val | bigint | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [(constructor)](./wz.wzlongproperty._constructor_.md) + +## WzLongProperty.(constructor) + +Constructs a new instance of the `WzLongProperty` class + +**Signature:** + +```typescript +constructor(name?: string, val?: bigint); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| val | bigint | _(Optional)_ | + diff --git a/docs/api/wz.wzlongproperty.dispose.md b/docs/api/wz.wzlongproperty.dispose.md index 5b6076f..82c40ce 100644 --- a/docs/api/wz.wzlongproperty.dispose.md +++ b/docs/api/wz.wzlongproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [dispose](./wz.wzlongproperty.dispose.md) - -## WzLongProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [dispose](./wz.wzlongproperty.dispose.md) + +## WzLongProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzlongproperty.md b/docs/api/wz.wzlongproperty.md index 67b93c1..2089881 100644 --- a/docs/api/wz.wzlongproperty.md +++ b/docs/api/wz.wzlongproperty.md @@ -1,38 +1,38 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) - -## WzLongProperty class - - -Signature: - -```typescript -export declare class WzLongProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, val)](./wz.wzlongproperty._constructor_.md) | | Constructs a new instance of the WzLongProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzlongproperty.name.md) | | string | | -| [parent](./wz.wzlongproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzlongproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [value](./wz.wzlongproperty.value.md) | | bigint | | -| [wzValue](./wz.wzlongproperty.wzvalue.md) | | bigint | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzlongproperty.dispose.md) | | | -| [setValue(value)](./wz.wzlongproperty.setvalue.md) | | | -| [toString()](./wz.wzlongproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) + +## WzLongProperty class + + +**Signature:** + +```typescript +export declare class WzLongProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, val)](./wz.wzlongproperty._constructor_.md) | | Constructs a new instance of the WzLongProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzlongproperty.name.md) | | string | | +| [parent](./wz.wzlongproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzlongproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [value](./wz.wzlongproperty.value.md) | readonly | bigint | | +| [wzValue](./wz.wzlongproperty.wzvalue.md) | readonly | bigint | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzlongproperty.dispose.md) | | | +| [setValue(value)](./wz.wzlongproperty.setvalue.md) | | | +| [toString()](./wz.wzlongproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzlongproperty.name.md b/docs/api/wz.wzlongproperty.name.md index 6380e07..bb9634c 100644 --- a/docs/api/wz.wzlongproperty.name.md +++ b/docs/api/wz.wzlongproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [name](./wz.wzlongproperty.name.md) - -## WzLongProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [name](./wz.wzlongproperty.name.md) + +## WzLongProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzlongproperty.parent.md b/docs/api/wz.wzlongproperty.parent.md index 54a7cb7..5f210fa 100644 --- a/docs/api/wz.wzlongproperty.parent.md +++ b/docs/api/wz.wzlongproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [parent](./wz.wzlongproperty.parent.md) - -## WzLongProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [parent](./wz.wzlongproperty.parent.md) + +## WzLongProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzlongproperty.propertytype.md b/docs/api/wz.wzlongproperty.propertytype.md index 94f1d4f..80c6c98 100644 --- a/docs/api/wz.wzlongproperty.propertytype.md +++ b/docs/api/wz.wzlongproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [propertyType](./wz.wzlongproperty.propertytype.md) - -## WzLongProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [propertyType](./wz.wzlongproperty.propertytype.md) + +## WzLongProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzlongproperty.setvalue.md b/docs/api/wz.wzlongproperty.setvalue.md index ce25bea..e1bf895 100644 --- a/docs/api/wz.wzlongproperty.setvalue.md +++ b/docs/api/wz.wzlongproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [setValue](./wz.wzlongproperty.setvalue.md) - -## WzLongProperty.setValue() method - -Signature: - -```typescript -setValue(value: bigint | number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | bigint \| number | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [setValue](./wz.wzlongproperty.setvalue.md) + +## WzLongProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: bigint | number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | bigint \| number | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzlongproperty.tostring.md b/docs/api/wz.wzlongproperty.tostring.md index 3f68d44..175d0f1 100644 --- a/docs/api/wz.wzlongproperty.tostring.md +++ b/docs/api/wz.wzlongproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [toString](./wz.wzlongproperty.tostring.md) - -## WzLongProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [toString](./wz.wzlongproperty.tostring.md) + +## WzLongProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzlongproperty.value.md b/docs/api/wz.wzlongproperty.value.md index 4e550b2..e4f51d8 100644 --- a/docs/api/wz.wzlongproperty.value.md +++ b/docs/api/wz.wzlongproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [value](./wz.wzlongproperty.value.md) - -## WzLongProperty.value property - -Signature: - -```typescript -get value(): bigint; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [value](./wz.wzlongproperty.value.md) + +## WzLongProperty.value property + +**Signature:** + +```typescript +get value(): bigint; +``` diff --git a/docs/api/wz.wzlongproperty.wzvalue.md b/docs/api/wz.wzlongproperty.wzvalue.md index f69b8f7..32c6a3e 100644 --- a/docs/api/wz.wzlongproperty.wzvalue.md +++ b/docs/api/wz.wzlongproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [wzValue](./wz.wzlongproperty.wzvalue.md) - -## WzLongProperty.wzValue property - -Signature: - -```typescript -get wzValue(): bigint; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLongProperty](./wz.wzlongproperty.md) > [wzValue](./wz.wzlongproperty.wzvalue.md) + +## WzLongProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): bigint; +``` diff --git a/docs/api/wz.wzluaproperty._constructor_.md b/docs/api/wz.wzluaproperty._constructor_.md index 717b9ed..8077c38 100644 --- a/docs/api/wz.wzluaproperty._constructor_.md +++ b/docs/api/wz.wzluaproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [(constructor)](./wz.wzluaproperty._constructor_.md) - -## WzLuaProperty.(constructor) - -Constructs a new instance of the `WzLuaProperty` class - -Signature: - -```typescript -constructor(name: string, encryptedBytes: Uint8Array | null); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| encryptedBytes | Uint8Array \| null | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [(constructor)](./wz.wzluaproperty._constructor_.md) + +## WzLuaProperty.(constructor) + +Constructs a new instance of the `WzLuaProperty` class + +**Signature:** + +```typescript +constructor(name: string, encryptedBytes: Uint8Array | null); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| encryptedBytes | Uint8Array \| null | | + diff --git a/docs/api/wz.wzluaproperty.dispose.md b/docs/api/wz.wzluaproperty.dispose.md index aa08408..4998f1d 100644 --- a/docs/api/wz.wzluaproperty.dispose.md +++ b/docs/api/wz.wzluaproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [dispose](./wz.wzluaproperty.dispose.md) - -## WzLuaProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [dispose](./wz.wzluaproperty.dispose.md) + +## WzLuaProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzluaproperty.encryptedbytes.md b/docs/api/wz.wzluaproperty.encryptedbytes.md index 9c02fbe..f76f87b 100644 --- a/docs/api/wz.wzluaproperty.encryptedbytes.md +++ b/docs/api/wz.wzluaproperty.encryptedbytes.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [encryptedBytes](./wz.wzluaproperty.encryptedbytes.md) - -## WzLuaProperty.encryptedBytes property - -Signature: - -```typescript -encryptedBytes: Uint8Array | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [encryptedBytes](./wz.wzluaproperty.encryptedbytes.md) + +## WzLuaProperty.encryptedBytes property + +**Signature:** + +```typescript +encryptedBytes: Uint8Array | null; +``` diff --git a/docs/api/wz.wzluaproperty.md b/docs/api/wz.wzluaproperty.md index d527c84..00af168 100644 --- a/docs/api/wz.wzluaproperty.md +++ b/docs/api/wz.wzluaproperty.md @@ -1,40 +1,40 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) - -## WzLuaProperty class - - -Signature: - -```typescript -export declare class WzLuaProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, encryptedBytes)](./wz.wzluaproperty._constructor_.md) | | Constructs a new instance of the WzLuaProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [encryptedBytes](./wz.wzluaproperty.encryptedbytes.md) | | Uint8Array \| null | | -| [name](./wz.wzluaproperty.name.md) | | string | | -| [parent](./wz.wzluaproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzluaproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [value](./wz.wzluaproperty.value.md) | | Uint8Array \| null | | -| [wzKey](./wz.wzluaproperty.wzkey.md) | | [WzMutableKey](./wz.wzmutablekey.md) | | -| [wzValue](./wz.wzluaproperty.wzvalue.md) | | Uint8Array \| null | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzluaproperty.dispose.md) | | | -| [setValue(value)](./wz.wzluaproperty.setvalue.md) | | | -| [toString()](./wz.wzluaproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) + +## WzLuaProperty class + + +**Signature:** + +```typescript +export declare class WzLuaProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, encryptedBytes)](./wz.wzluaproperty._constructor_.md) | | Constructs a new instance of the WzLuaProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [encryptedBytes](./wz.wzluaproperty.encryptedbytes.md) | | Uint8Array \| null | | +| [name](./wz.wzluaproperty.name.md) | | string | | +| [parent](./wz.wzluaproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzluaproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [value](./wz.wzluaproperty.value.md) | readonly | Uint8Array \| null | | +| [wzKey](./wz.wzluaproperty.wzkey.md) | | [WzMutableKey](./wz.wzmutablekey.md) | | +| [wzValue](./wz.wzluaproperty.wzvalue.md) | readonly | Uint8Array \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzluaproperty.dispose.md) | | | +| [setValue(value)](./wz.wzluaproperty.setvalue.md) | | | +| [toString()](./wz.wzluaproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzluaproperty.name.md b/docs/api/wz.wzluaproperty.name.md index 026e190..b075e04 100644 --- a/docs/api/wz.wzluaproperty.name.md +++ b/docs/api/wz.wzluaproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [name](./wz.wzluaproperty.name.md) - -## WzLuaProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [name](./wz.wzluaproperty.name.md) + +## WzLuaProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzluaproperty.parent.md b/docs/api/wz.wzluaproperty.parent.md index 6abd84d..3e89e4b 100644 --- a/docs/api/wz.wzluaproperty.parent.md +++ b/docs/api/wz.wzluaproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [parent](./wz.wzluaproperty.parent.md) - -## WzLuaProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [parent](./wz.wzluaproperty.parent.md) + +## WzLuaProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzluaproperty.propertytype.md b/docs/api/wz.wzluaproperty.propertytype.md index b63ac05..c792389 100644 --- a/docs/api/wz.wzluaproperty.propertytype.md +++ b/docs/api/wz.wzluaproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [propertyType](./wz.wzluaproperty.propertytype.md) - -## WzLuaProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [propertyType](./wz.wzluaproperty.propertytype.md) + +## WzLuaProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzluaproperty.setvalue.md b/docs/api/wz.wzluaproperty.setvalue.md index 1d2d394..91550d4 100644 --- a/docs/api/wz.wzluaproperty.setvalue.md +++ b/docs/api/wz.wzluaproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [setValue](./wz.wzluaproperty.setvalue.md) - -## WzLuaProperty.setValue() method - -Signature: - -```typescript -setValue(value: Uint8Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | Uint8Array | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [setValue](./wz.wzluaproperty.setvalue.md) + +## WzLuaProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: Uint8Array): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | Uint8Array | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzluaproperty.tostring.md b/docs/api/wz.wzluaproperty.tostring.md index 70c1045..ac774aa 100644 --- a/docs/api/wz.wzluaproperty.tostring.md +++ b/docs/api/wz.wzluaproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [toString](./wz.wzluaproperty.tostring.md) - -## WzLuaProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [toString](./wz.wzluaproperty.tostring.md) + +## WzLuaProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzluaproperty.value.md b/docs/api/wz.wzluaproperty.value.md index 25880f3..a30d31b 100644 --- a/docs/api/wz.wzluaproperty.value.md +++ b/docs/api/wz.wzluaproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [value](./wz.wzluaproperty.value.md) - -## WzLuaProperty.value property - -Signature: - -```typescript -get value(): Uint8Array | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [value](./wz.wzluaproperty.value.md) + +## WzLuaProperty.value property + +**Signature:** + +```typescript +get value(): Uint8Array | null; +``` diff --git a/docs/api/wz.wzluaproperty.wzkey.md b/docs/api/wz.wzluaproperty.wzkey.md index 65fdf1a..a37c19d 100644 --- a/docs/api/wz.wzluaproperty.wzkey.md +++ b/docs/api/wz.wzluaproperty.wzkey.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [wzKey](./wz.wzluaproperty.wzkey.md) - -## WzLuaProperty.wzKey property - -Signature: - -```typescript -wzKey: WzMutableKey; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [wzKey](./wz.wzluaproperty.wzkey.md) + +## WzLuaProperty.wzKey property + +**Signature:** + +```typescript +wzKey: WzMutableKey; +``` diff --git a/docs/api/wz.wzluaproperty.wzvalue.md b/docs/api/wz.wzluaproperty.wzvalue.md index ea2df54..376f25a 100644 --- a/docs/api/wz.wzluaproperty.wzvalue.md +++ b/docs/api/wz.wzluaproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [wzValue](./wz.wzluaproperty.wzvalue.md) - -## WzLuaProperty.wzValue property - -Signature: - -```typescript -get wzValue(): Uint8Array | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzLuaProperty](./wz.wzluaproperty.md) > [wzValue](./wz.wzluaproperty.wzvalue.md) + +## WzLuaProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): Uint8Array | null; +``` diff --git a/docs/api/wz.wzmaindirectory._constructor_.md b/docs/api/wz.wzmaindirectory._constructor_.md index 83eb92c..cc73ced 100644 --- a/docs/api/wz.wzmaindirectory._constructor_.md +++ b/docs/api/wz.wzmaindirectory._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) > [(constructor)](./wz.wzmaindirectory._constructor_.md) - -## WzMainDirectory.(constructor) - -Constructs a new instance of the `WzMainDirectory` class - -Signature: - -```typescript -constructor(file: WzFile, directory?: WzDirectory); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| file | [WzFile](./wz.wzfile.md) | | -| directory | [WzDirectory](./wz.wzdirectory.md) | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) > [(constructor)](./wz.wzmaindirectory._constructor_.md) + +## WzMainDirectory.(constructor) + +Constructs a new instance of the `WzMainDirectory` class + +**Signature:** + +```typescript +constructor(file: WzFile, directory?: WzDirectory); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| file | [WzFile](./wz.wzfile.md) | | +| directory | [WzDirectory](./wz.wzdirectory.md) | _(Optional)_ | + diff --git a/docs/api/wz.wzmaindirectory.directory.md b/docs/api/wz.wzmaindirectory.directory.md index ebb4d3e..464c406 100644 --- a/docs/api/wz.wzmaindirectory.directory.md +++ b/docs/api/wz.wzmaindirectory.directory.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) > [directory](./wz.wzmaindirectory.directory.md) - -## WzMainDirectory.directory property - -Signature: - -```typescript -get directory(): WzDirectory | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) > [directory](./wz.wzmaindirectory.directory.md) + +## WzMainDirectory.directory property + +**Signature:** + +```typescript +get directory(): WzDirectory | null; +``` diff --git a/docs/api/wz.wzmaindirectory.file.md b/docs/api/wz.wzmaindirectory.file.md index b18b5fc..d6d562f 100644 --- a/docs/api/wz.wzmaindirectory.file.md +++ b/docs/api/wz.wzmaindirectory.file.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) > [file](./wz.wzmaindirectory.file.md) - -## WzMainDirectory.file property - -Signature: - -```typescript -file: WzFile; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) > [file](./wz.wzmaindirectory.file.md) + +## WzMainDirectory.file property + +**Signature:** + +```typescript +file: WzFile; +``` diff --git a/docs/api/wz.wzmaindirectory.md b/docs/api/wz.wzmaindirectory.md index 86022ca..a5beb70 100644 --- a/docs/api/wz.wzmaindirectory.md +++ b/docs/api/wz.wzmaindirectory.md @@ -1,26 +1,26 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) - -## WzMainDirectory class - - -Signature: - -```typescript -export declare class WzMainDirectory -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(file, directory)](./wz.wzmaindirectory._constructor_.md) | | Constructs a new instance of the WzMainDirectory class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [directory](./wz.wzmaindirectory.directory.md) | | [WzDirectory](./wz.wzdirectory.md) \| null | | -| [file](./wz.wzmaindirectory.file.md) | | [WzFile](./wz.wzfile.md) | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMainDirectory](./wz.wzmaindirectory.md) + +## WzMainDirectory class + + +**Signature:** + +```typescript +export declare class WzMainDirectory +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(file, directory)](./wz.wzmaindirectory._constructor_.md) | | Constructs a new instance of the WzMainDirectory class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [directory](./wz.wzmaindirectory.directory.md) | readonly | [WzDirectory](./wz.wzdirectory.md) \| null | | +| [file](./wz.wzmaindirectory.file.md) | | [WzFile](./wz.wzfile.md) | | + diff --git a/docs/api/wz.wzmapleversion.md b/docs/api/wz.wzmapleversion.md index 4941d18..f42d8c1 100644 --- a/docs/api/wz.wzmapleversion.md +++ b/docs/api/wz.wzmapleversion.md @@ -1,26 +1,26 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMapleVersion](./wz.wzmapleversion.md) - -## WzMapleVersion enum - - -Signature: - -```typescript -export declare enum WzMapleVersion -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| BMS | 2 | BMS / GMS / MapleSEA / メイプルストーリー / 메이플스토리 | -| CLASSIC | 3 | | -| CUSTOM | 6 | 自定义编码 | -| EMS | 1 | 新楓之谷 / 冒险岛Online / 메이플스토리 / MapleSEA / EMS (old) | -| GENERATE | 4 | 生成 | -| GETFROMZLZ | 5 | | -| GMS | 0 | Global MapleStory (old) | -| UNKNOWN | 99 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMapleVersion](./wz.wzmapleversion.md) + +## WzMapleVersion enum + + +**Signature:** + +```typescript +export declare enum WzMapleVersion +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| BMS | 2 | BMS / GMS / MapleSEA / メイプルストーリー / 메이플스토리 | +| CLASSIC | 3 | | +| CUSTOM | 6 | 自定义编码 | +| EMS | 1 | 新楓之谷 / 冒险岛Online / 메이플스토리 / MapleSEA / EMS (old) | +| GENERATE | 4 | 生成 | +| GETFROMZLZ | 5 | | +| GMS | 0 | Global MapleStory (old) | +| UNKNOWN | 99 | | + diff --git a/docs/api/wz.wzmutablekey._constructor_.md b/docs/api/wz.wzmutablekey._constructor_.md index 9c07abb..1592b08 100644 --- a/docs/api/wz.wzmutablekey._constructor_.md +++ b/docs/api/wz.wzmutablekey._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) > [(constructor)](./wz.wzmutablekey._constructor_.md) - -## WzMutableKey.(constructor) - -Constructs a new instance of the `WzMutableKey` class - -Signature: - -```typescript -constructor(_iv: Uint8Array, _aesUserKey: Uint8Array); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_iv | Uint8Array | | -| \_aesUserKey | Uint8Array | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) > [(constructor)](./wz.wzmutablekey._constructor_.md) + +## WzMutableKey.(constructor) + +Constructs a new instance of the `WzMutableKey` class + +**Signature:** + +```typescript +constructor(_iv: Uint8Array, _aesUserKey: Uint8Array); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_iv | Uint8Array | | +| \_aesUserKey | Uint8Array | | + diff --git a/docs/api/wz.wzmutablekey.at.md b/docs/api/wz.wzmutablekey.at.md index 62d910a..d466b88 100644 --- a/docs/api/wz.wzmutablekey.at.md +++ b/docs/api/wz.wzmutablekey.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) > [at](./wz.wzmutablekey.at.md) - -## WzMutableKey.at() method - -Signature: - -```typescript -at(index: number): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | | - -Returns: - -number - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) > [at](./wz.wzmutablekey.at.md) + +## WzMutableKey.at() method + +**Signature:** + +```typescript +at(index: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | | + +**Returns:** + +number + diff --git a/docs/api/wz.wzmutablekey.ensurekeysize.md b/docs/api/wz.wzmutablekey.ensurekeysize.md index 6ef6880..6296d03 100644 --- a/docs/api/wz.wzmutablekey.ensurekeysize.md +++ b/docs/api/wz.wzmutablekey.ensurekeysize.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) > [ensureKeySize](./wz.wzmutablekey.ensurekeysize.md) - -## WzMutableKey.ensureKeySize() method - -Signature: - -```typescript -ensureKeySize(size: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| size | number | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) > [ensureKeySize](./wz.wzmutablekey.ensurekeysize.md) + +## WzMutableKey.ensureKeySize() method + +**Signature:** + +```typescript +ensureKeySize(size: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| size | number | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzmutablekey.md b/docs/api/wz.wzmutablekey.md index ced50ab..4e9127b 100644 --- a/docs/api/wz.wzmutablekey.md +++ b/docs/api/wz.wzmutablekey.md @@ -1,26 +1,26 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) - -## WzMutableKey class - - -Signature: - -```typescript -export declare class WzMutableKey -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(\_iv, \_aesUserKey)](./wz.wzmutablekey._constructor_.md) | | Constructs a new instance of the WzMutableKey class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [at(index)](./wz.wzmutablekey.at.md) | | | -| [ensureKeySize(size)](./wz.wzmutablekey.ensurekeysize.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzMutableKey](./wz.wzmutablekey.md) + +## WzMutableKey class + + +**Signature:** + +```typescript +export declare class WzMutableKey +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(\_iv, \_aesUserKey)](./wz.wzmutablekey._constructor_.md) | | Constructs a new instance of the WzMutableKey class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [at(index)](./wz.wzmutablekey.at.md) | | | +| [ensureKeySize(size)](./wz.wzmutablekey.ensurekeysize.md) | | | + diff --git a/docs/api/wz.wznullproperty._constructor_.md b/docs/api/wz.wznullproperty._constructor_.md index 741ccba..64d54bc 100644 --- a/docs/api/wz.wznullproperty._constructor_.md +++ b/docs/api/wz.wznullproperty._constructor_.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [(constructor)](./wz.wznullproperty._constructor_.md) - -## WzNullProperty.(constructor) - -Constructs a new instance of the `WzNullProperty` class - -Signature: - -```typescript -constructor(name?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [(constructor)](./wz.wznullproperty._constructor_.md) + +## WzNullProperty.(constructor) + +Constructs a new instance of the `WzNullProperty` class + +**Signature:** + +```typescript +constructor(name?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | + diff --git a/docs/api/wz.wznullproperty.dispose.md b/docs/api/wz.wznullproperty.dispose.md index c3dff55..454eb75 100644 --- a/docs/api/wz.wznullproperty.dispose.md +++ b/docs/api/wz.wznullproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [dispose](./wz.wznullproperty.dispose.md) - -## WzNullProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [dispose](./wz.wznullproperty.dispose.md) + +## WzNullProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wznullproperty.md b/docs/api/wz.wznullproperty.md index 7f1b76d..4b7ade6 100644 --- a/docs/api/wz.wznullproperty.md +++ b/docs/api/wz.wznullproperty.md @@ -1,35 +1,35 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) - -## WzNullProperty class - - -Signature: - -```typescript -export declare class WzNullProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name)](./wz.wznullproperty._constructor_.md) | | Constructs a new instance of the WzNullProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wznullproperty.name.md) | | string | | -| [parent](./wz.wznullproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wznullproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wznullproperty.dispose.md) | | | -| [setValue(\_value)](./wz.wznullproperty.setvalue.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) + +## WzNullProperty class + + +**Signature:** + +```typescript +export declare class WzNullProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name)](./wz.wznullproperty._constructor_.md) | | Constructs a new instance of the WzNullProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wznullproperty.name.md) | | string | | +| [parent](./wz.wznullproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wznullproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wznullproperty.dispose.md) | | | +| [setValue(\_value)](./wz.wznullproperty.setvalue.md) | | | + diff --git a/docs/api/wz.wznullproperty.name.md b/docs/api/wz.wznullproperty.name.md index 779f916..ae2a9ea 100644 --- a/docs/api/wz.wznullproperty.name.md +++ b/docs/api/wz.wznullproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [name](./wz.wznullproperty.name.md) - -## WzNullProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [name](./wz.wznullproperty.name.md) + +## WzNullProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wznullproperty.parent.md b/docs/api/wz.wznullproperty.parent.md index 566ad8e..142dc38 100644 --- a/docs/api/wz.wznullproperty.parent.md +++ b/docs/api/wz.wznullproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [parent](./wz.wznullproperty.parent.md) - -## WzNullProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [parent](./wz.wznullproperty.parent.md) + +## WzNullProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wznullproperty.propertytype.md b/docs/api/wz.wznullproperty.propertytype.md index 9e2e0a7..36109f7 100644 --- a/docs/api/wz.wznullproperty.propertytype.md +++ b/docs/api/wz.wznullproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [propertyType](./wz.wznullproperty.propertytype.md) - -## WzNullProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [propertyType](./wz.wznullproperty.propertytype.md) + +## WzNullProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wznullproperty.setvalue.md b/docs/api/wz.wznullproperty.setvalue.md index 963a422..4274b7d 100644 --- a/docs/api/wz.wznullproperty.setvalue.md +++ b/docs/api/wz.wznullproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [setValue](./wz.wznullproperty.setvalue.md) - -## WzNullProperty.setValue() method - -Signature: - -```typescript -setValue(_value: unknown): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_value | unknown | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzNullProperty](./wz.wznullproperty.md) > [setValue](./wz.wznullproperty.setvalue.md) + +## WzNullProperty.setValue() method + +**Signature:** + +```typescript +setValue(_value: unknown): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_value | unknown | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzobject._disposed.md b/docs/api/wz.wzobject._disposed.md index 97f0fc1..e88870a 100644 --- a/docs/api/wz.wzobject._disposed.md +++ b/docs/api/wz.wzobject._disposed.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [\_disposed](./wz.wzobject._disposed.md) - -## WzObject.\_disposed property - -Signature: - -```typescript -protected _disposed: boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [\_disposed](./wz.wzobject._disposed.md) + +## WzObject.\_disposed property + +**Signature:** + +```typescript +protected _disposed: boolean; +``` diff --git a/docs/api/wz.wzobject.at.md b/docs/api/wz.wzobject.at.md index 3346b69..5c093d7 100644 --- a/docs/api/wz.wzobject.at.md +++ b/docs/api/wz.wzobject.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [at](./wz.wzobject.at.md) - -## WzObject.at() method - -Signature: - -```typescript -abstract at(name: string): WzObject | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzObject](./wz.wzobject.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [at](./wz.wzobject.at.md) + +## WzObject.at() method + +**Signature:** + +```typescript +abstract at(name: string): WzObject | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzObject](./wz.wzobject.md) \| null + diff --git a/docs/api/wz.wzobject.dispose.md b/docs/api/wz.wzobject.dispose.md index f225b1d..dcfa91b 100644 --- a/docs/api/wz.wzobject.dispose.md +++ b/docs/api/wz.wzobject.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [dispose](./wz.wzobject.dispose.md) - -## WzObject.dispose() method - -Signature: - -```typescript -abstract dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [dispose](./wz.wzobject.dispose.md) + +## WzObject.dispose() method + +**Signature:** + +```typescript +abstract dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzobject.fullpath.md b/docs/api/wz.wzobject.fullpath.md index 8d916b4..6d94b3e 100644 --- a/docs/api/wz.wzobject.fullpath.md +++ b/docs/api/wz.wzobject.fullpath.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [fullPath](./wz.wzobject.fullpath.md) - -## WzObject.fullPath property - -Signature: - -```typescript -get fullPath(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [fullPath](./wz.wzobject.fullpath.md) + +## WzObject.fullPath property + +**Signature:** + +```typescript +get fullPath(): string; +``` diff --git a/docs/api/wz.wzobject.getbitmap.md b/docs/api/wz.wzobject.getbitmap.md index c71a518..670a62e 100644 --- a/docs/api/wz.wzobject.getbitmap.md +++ b/docs/api/wz.wzobject.getbitmap.md @@ -1,17 +1,17 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [getBitmap](./wz.wzobject.getbitmap.md) - -## WzObject.getBitmap() method - - -Signature: - -```typescript -/** @virtual */ -getBitmap(): Promise; -``` -Returns: - -Promise<[Canvas](./wz.canvas.md) \| null> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [getBitmap](./wz.wzobject.getbitmap.md) + +## WzObject.getBitmap() method + + +**Signature:** + +```typescript +/** @virtual */ +getBitmap(): Promise; +``` +**Returns:** + +Promise<[Canvas](./wz.canvas.md) \| null> + diff --git a/docs/api/wz.wzobject.gettopmostwzdirectory.md b/docs/api/wz.wzobject.gettopmostwzdirectory.md index 5777cf1..eb4e49b 100644 --- a/docs/api/wz.wzobject.gettopmostwzdirectory.md +++ b/docs/api/wz.wzobject.gettopmostwzdirectory.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [getTopMostWzDirectory](./wz.wzobject.gettopmostwzdirectory.md) - -## WzObject.getTopMostWzDirectory() method - -Signature: - -```typescript -getTopMostWzDirectory(): WzObject; -``` -Returns: - -[WzObject](./wz.wzobject.md) - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [getTopMostWzDirectory](./wz.wzobject.gettopmostwzdirectory.md) + +## WzObject.getTopMostWzDirectory() method + +**Signature:** + +```typescript +getTopMostWzDirectory(): WzObject; +``` +**Returns:** + +[WzObject](./wz.wzobject.md) + diff --git a/docs/api/wz.wzobject.md b/docs/api/wz.wzobject.md index cc61b7b..ba1ed27 100644 --- a/docs/api/wz.wzobject.md +++ b/docs/api/wz.wzobject.md @@ -1,35 +1,35 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) - -## WzObject class - - -Signature: - -```typescript -export declare abstract class WzObject implements IDisposable -``` -Implements: [IDisposable](./wz.idisposable.md) - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_disposed](./wz.wzobject._disposed.md) | | boolean | | -| [fullPath](./wz.wzobject.fullpath.md) | | string | | -| [name](./wz.wzobject.name.md) | | string | | -| [objectType](./wz.wzobject.objecttype.md) | | [WzObjectType](./wz.wzobjecttype.md) | | -| [parent](./wz.wzobject.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [wzFileParent](./wz.wzobject.wzfileparent.md) | | [WzFile](./wz.wzfile.md) \| null | | -| [wzValue](./wz.wzobject.wzvalue.md) | | any | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [at(name)](./wz.wzobject.at.md) | | | -| [dispose()](./wz.wzobject.dispose.md) | | | -| [getBitmap()](./wz.wzobject.getbitmap.md) | | | -| [getTopMostWzDirectory()](./wz.wzobject.gettopmostwzdirectory.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) + +## WzObject class + + +**Signature:** + +```typescript +export declare abstract class WzObject implements IDisposable +``` +**Implements:** [IDisposable](./wz.idisposable.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_disposed](./wz.wzobject._disposed.md) | protected | boolean | | +| [fullPath](./wz.wzobject.fullpath.md) | readonly | string | | +| [name](./wz.wzobject.name.md) | abstract | string | | +| [objectType](./wz.wzobject.objecttype.md) |

abstract

readonly

| [WzObjectType](./wz.wzobjecttype.md) | | +| [parent](./wz.wzobject.parent.md) | abstract | [WzObject](./wz.wzobject.md) \| null | | +| [wzFileParent](./wz.wzobject.wzfileparent.md) |

abstract

readonly

| [WzFile](./wz.wzfile.md) \| null | | +| [wzValue](./wz.wzobject.wzvalue.md) | readonly | any | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [at(name)](./wz.wzobject.at.md) | abstract | | +| [dispose()](./wz.wzobject.dispose.md) | abstract | | +| [getBitmap()](./wz.wzobject.getbitmap.md) | | | +| [getTopMostWzDirectory()](./wz.wzobject.gettopmostwzdirectory.md) | | | + diff --git a/docs/api/wz.wzobject.name.md b/docs/api/wz.wzobject.name.md index dd1a564..5fdc761 100644 --- a/docs/api/wz.wzobject.name.md +++ b/docs/api/wz.wzobject.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [name](./wz.wzobject.name.md) - -## WzObject.name property - -Signature: - -```typescript -abstract name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [name](./wz.wzobject.name.md) + +## WzObject.name property + +**Signature:** + +```typescript +abstract name: string; +``` diff --git a/docs/api/wz.wzobject.objecttype.md b/docs/api/wz.wzobject.objecttype.md index 8cccab9..009baa0 100644 --- a/docs/api/wz.wzobject.objecttype.md +++ b/docs/api/wz.wzobject.objecttype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [objectType](./wz.wzobject.objecttype.md) - -## WzObject.objectType property - -Signature: - -```typescript -abstract get objectType(): WzObjectType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [objectType](./wz.wzobject.objecttype.md) + +## WzObject.objectType property + +**Signature:** + +```typescript +abstract get objectType(): WzObjectType; +``` diff --git a/docs/api/wz.wzobject.parent.md b/docs/api/wz.wzobject.parent.md index 7b9fda7..59124fa 100644 --- a/docs/api/wz.wzobject.parent.md +++ b/docs/api/wz.wzobject.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [parent](./wz.wzobject.parent.md) - -## WzObject.parent property - -Signature: - -```typescript -abstract parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [parent](./wz.wzobject.parent.md) + +## WzObject.parent property + +**Signature:** + +```typescript +abstract parent: WzObject | null; +``` diff --git a/docs/api/wz.wzobject.wzfileparent.md b/docs/api/wz.wzobject.wzfileparent.md index 50821d9..4211cf0 100644 --- a/docs/api/wz.wzobject.wzfileparent.md +++ b/docs/api/wz.wzobject.wzfileparent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [wzFileParent](./wz.wzobject.wzfileparent.md) - -## WzObject.wzFileParent property - -Signature: - -```typescript -abstract get wzFileParent(): WzFile | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [wzFileParent](./wz.wzobject.wzfileparent.md) + +## WzObject.wzFileParent property + +**Signature:** + +```typescript +abstract get wzFileParent(): WzFile | null; +``` diff --git a/docs/api/wz.wzobject.wzvalue.md b/docs/api/wz.wzobject.wzvalue.md index 624e92d..5a6aa38 100644 --- a/docs/api/wz.wzobject.wzvalue.md +++ b/docs/api/wz.wzobject.wzvalue.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [wzValue](./wz.wzobject.wzvalue.md) - -## WzObject.wzValue property - - -Signature: - -```typescript -/** @virtual */ -get wzValue(): any; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObject](./wz.wzobject.md) > [wzValue](./wz.wzobject.wzvalue.md) + +## WzObject.wzValue property + + +**Signature:** + +```typescript +/** @virtual */ +get wzValue(): any; +``` diff --git a/docs/api/wz.wzobjecttype.md b/docs/api/wz.wzobjecttype.md index a94d96c..a11363e 100644 --- a/docs/api/wz.wzobjecttype.md +++ b/docs/api/wz.wzobjecttype.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObjectType](./wz.wzobjecttype.md) - -## WzObjectType enum - - -Signature: - -```typescript -export declare enum WzObjectType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Directory | 2 | | -| File | 0 | | -| Image | 1 | | -| List | 4 | | -| Property | 3 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzObjectType](./wz.wzobjecttype.md) + +## WzObjectType enum + + +**Signature:** + +```typescript +export declare enum WzObjectType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Directory | 2 | | +| File | 0 | | +| Image | 1 | | +| List | 4 | | +| Property | 3 | | + diff --git a/docs/api/wz.wzpngproperty.create.md b/docs/api/wz.wzpngproperty.create.md index 9397cda..1bb5376 100644 --- a/docs/api/wz.wzpngproperty.create.md +++ b/docs/api/wz.wzpngproperty.create.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [create](./wz.wzpngproperty.create.md) - -## WzPngProperty.create() method - -Signature: - -```typescript -static create(reader: WzBinaryReader): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | - -Returns: - -Promise<[WzPngProperty](./wz.wzpngproperty.md)> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [create](./wz.wzpngproperty.create.md) + +## WzPngProperty.create() method + +**Signature:** + +```typescript +static create(reader: WzBinaryReader): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| reader | [WzBinaryReader](./wz.wzbinaryreader.md) | | + +**Returns:** + +Promise<[WzPngProperty](./wz.wzpngproperty.md)> + diff --git a/docs/api/wz.wzpngproperty.dispose.md b/docs/api/wz.wzpngproperty.dispose.md index d8e8057..2e5edc2 100644 --- a/docs/api/wz.wzpngproperty.dispose.md +++ b/docs/api/wz.wzpngproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [dispose](./wz.wzpngproperty.dispose.md) - -## WzPngProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [dispose](./wz.wzpngproperty.dispose.md) + +## WzPngProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzpngproperty.format1.md b/docs/api/wz.wzpngproperty.format1.md index 6a83260..5694cc9 100644 --- a/docs/api/wz.wzpngproperty.format1.md +++ b/docs/api/wz.wzpngproperty.format1.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [format1](./wz.wzpngproperty.format1.md) - -## WzPngProperty.format1 property - -Signature: - -```typescript -format1: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [format1](./wz.wzpngproperty.format1.md) + +## WzPngProperty.format1 property + +**Signature:** + +```typescript +format1: number; +``` diff --git a/docs/api/wz.wzpngproperty.format2.md b/docs/api/wz.wzpngproperty.format2.md index 65a3ff0..f75546b 100644 --- a/docs/api/wz.wzpngproperty.format2.md +++ b/docs/api/wz.wzpngproperty.format2.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [format2](./wz.wzpngproperty.format2.md) - -## WzPngProperty.format2 property - -Signature: - -```typescript -format2: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [format2](./wz.wzpngproperty.format2.md) + +## WzPngProperty.format2 property + +**Signature:** + +```typescript +format2: number; +``` diff --git a/docs/api/wz.wzpngproperty.getbitmap.md b/docs/api/wz.wzpngproperty.getbitmap.md index cc3d47e..8940857 100644 --- a/docs/api/wz.wzpngproperty.getbitmap.md +++ b/docs/api/wz.wzpngproperty.getbitmap.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [getBitmap](./wz.wzpngproperty.getbitmap.md) - -## WzPngProperty.getBitmap() method - -Signature: - -```typescript -getBitmap(): Promise; -``` -Returns: - -Promise<[Canvas](./wz.canvas.md) \| null> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [getBitmap](./wz.wzpngproperty.getbitmap.md) + +## WzPngProperty.getBitmap() method + +**Signature:** + +```typescript +getBitmap(): Promise; +``` +**Returns:** + +Promise<[Canvas](./wz.canvas.md) \| null> + diff --git a/docs/api/wz.wzpngproperty.getcompressedbytes.md b/docs/api/wz.wzpngproperty.getcompressedbytes.md index 836e5f2..1935516 100644 --- a/docs/api/wz.wzpngproperty.getcompressedbytes.md +++ b/docs/api/wz.wzpngproperty.getcompressedbytes.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [getCompressedBytes](./wz.wzpngproperty.getcompressedbytes.md) - -## WzPngProperty.getCompressedBytes() method - -Signature: - -```typescript -getCompressedBytes(saveInMemory?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| saveInMemory | boolean | (Optional) | - -Returns: - -Promise<Uint8Array> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [getCompressedBytes](./wz.wzpngproperty.getcompressedbytes.md) + +## WzPngProperty.getCompressedBytes() method + +**Signature:** + +```typescript +getCompressedBytes(saveInMemory?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| saveInMemory | boolean | _(Optional)_ | + +**Returns:** + +Promise<Uint8Array> + diff --git a/docs/api/wz.wzpngproperty.getimage.md b/docs/api/wz.wzpngproperty.getimage.md index c1be12f..570589d 100644 --- a/docs/api/wz.wzpngproperty.getimage.md +++ b/docs/api/wz.wzpngproperty.getimage.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [getImage](./wz.wzpngproperty.getimage.md) - -## WzPngProperty.getImage() method - -Signature: - -```typescript -getImage(saveInMemory?: boolean): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| saveInMemory | boolean | (Optional) | - -Returns: - -Promise<[Canvas](./wz.canvas.md) \| null> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [getImage](./wz.wzpngproperty.getimage.md) + +## WzPngProperty.getImage() method + +**Signature:** + +```typescript +getImage(saveInMemory?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| saveInMemory | boolean | _(Optional)_ | + +**Returns:** + +Promise<[Canvas](./wz.canvas.md) \| null> + diff --git a/docs/api/wz.wzpngproperty.height.md b/docs/api/wz.wzpngproperty.height.md index 851b674..e78f324 100644 --- a/docs/api/wz.wzpngproperty.height.md +++ b/docs/api/wz.wzpngproperty.height.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [height](./wz.wzpngproperty.height.md) - -## WzPngProperty.height property - -Signature: - -```typescript -height: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [height](./wz.wzpngproperty.height.md) + +## WzPngProperty.height property + +**Signature:** + +```typescript +height: number; +``` diff --git a/docs/api/wz.wzpngproperty.md b/docs/api/wz.wzpngproperty.md index 1c717b5..50a98f1 100644 --- a/docs/api/wz.wzpngproperty.md +++ b/docs/api/wz.wzpngproperty.md @@ -1,40 +1,40 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) - -## WzPngProperty class - - -Signature: - -```typescript -export declare class WzPngProperty extends WzExtended -``` -Extends: [WzExtended](./wz.wzextended.md) - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [format1](./wz.wzpngproperty.format1.md) | | number | | -| [format2](./wz.wzpngproperty.format2.md) | | number | | -| [height](./wz.wzpngproperty.height.md) | | number | | -| [name](./wz.wzpngproperty.name.md) | | string | | -| [offs](./wz.wzpngproperty.offs.md) | | number | | -| [parent](./wz.wzpngproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzpngproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [width](./wz.wzpngproperty.width.md) | | number | | -| [wzValue](./wz.wzpngproperty.wzvalue.md) | | Promise<[Canvas](./wz.canvas.md) \| null> | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [create(reader)](./wz.wzpngproperty.create.md) | static | | -| [dispose()](./wz.wzpngproperty.dispose.md) | | | -| [getBitmap()](./wz.wzpngproperty.getbitmap.md) | | | -| [getCompressedBytes(saveInMemory)](./wz.wzpngproperty.getcompressedbytes.md) | | | -| [getImage(saveInMemory)](./wz.wzpngproperty.getimage.md) | | | -| [saveToFile(file)](./wz.wzpngproperty.savetofile.md) | | | -| [setValue(\_value)](./wz.wzpngproperty.setvalue.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) + +## WzPngProperty class + + +**Signature:** + +```typescript +export declare class WzPngProperty extends WzExtended +``` +**Extends:** [WzExtended](./wz.wzextended.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [format1](./wz.wzpngproperty.format1.md) | | number | | +| [format2](./wz.wzpngproperty.format2.md) | | number | | +| [height](./wz.wzpngproperty.height.md) | | number | | +| [name](./wz.wzpngproperty.name.md) | readonly | string | | +| [offs](./wz.wzpngproperty.offs.md) | | number | | +| [parent](./wz.wzpngproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzpngproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [width](./wz.wzpngproperty.width.md) | | number | | +| [wzValue](./wz.wzpngproperty.wzvalue.md) | readonly | Promise<[Canvas](./wz.canvas.md) \| null> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [create(reader)](./wz.wzpngproperty.create.md) | static | | +| [dispose()](./wz.wzpngproperty.dispose.md) | | | +| [getBitmap()](./wz.wzpngproperty.getbitmap.md) | | | +| [getCompressedBytes(saveInMemory)](./wz.wzpngproperty.getcompressedbytes.md) | | | +| [getImage(saveInMemory)](./wz.wzpngproperty.getimage.md) | | | +| [saveToFile(file)](./wz.wzpngproperty.savetofile.md) | | | +| [setValue(\_value)](./wz.wzpngproperty.setvalue.md) | | | + diff --git a/docs/api/wz.wzpngproperty.name.md b/docs/api/wz.wzpngproperty.name.md index 1f3bc44..73ce9a8 100644 --- a/docs/api/wz.wzpngproperty.name.md +++ b/docs/api/wz.wzpngproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [name](./wz.wzpngproperty.name.md) - -## WzPngProperty.name property - -Signature: - -```typescript -get name(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [name](./wz.wzpngproperty.name.md) + +## WzPngProperty.name property + +**Signature:** + +```typescript +get name(): string; +``` diff --git a/docs/api/wz.wzpngproperty.offs.md b/docs/api/wz.wzpngproperty.offs.md index 331e058..5b88e07 100644 --- a/docs/api/wz.wzpngproperty.offs.md +++ b/docs/api/wz.wzpngproperty.offs.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [offs](./wz.wzpngproperty.offs.md) - -## WzPngProperty.offs property - -Signature: - -```typescript -offs: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [offs](./wz.wzpngproperty.offs.md) + +## WzPngProperty.offs property + +**Signature:** + +```typescript +offs: number; +``` diff --git a/docs/api/wz.wzpngproperty.parent.md b/docs/api/wz.wzpngproperty.parent.md index bcc8471..b57c824 100644 --- a/docs/api/wz.wzpngproperty.parent.md +++ b/docs/api/wz.wzpngproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [parent](./wz.wzpngproperty.parent.md) - -## WzPngProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [parent](./wz.wzpngproperty.parent.md) + +## WzPngProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzpngproperty.propertytype.md b/docs/api/wz.wzpngproperty.propertytype.md index 6a04ec4..f4194e2 100644 --- a/docs/api/wz.wzpngproperty.propertytype.md +++ b/docs/api/wz.wzpngproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [propertyType](./wz.wzpngproperty.propertytype.md) - -## WzPngProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [propertyType](./wz.wzpngproperty.propertytype.md) + +## WzPngProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzpngproperty.savetofile.md b/docs/api/wz.wzpngproperty.savetofile.md index 2fbe9fe..ccd039f 100644 --- a/docs/api/wz.wzpngproperty.savetofile.md +++ b/docs/api/wz.wzpngproperty.savetofile.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [saveToFile](./wz.wzpngproperty.savetofile.md) - -## WzPngProperty.saveToFile() method - -Signature: - -```typescript -saveToFile(file: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| file | string | | - -Returns: - -Promise<boolean> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [saveToFile](./wz.wzpngproperty.savetofile.md) + +## WzPngProperty.saveToFile() method + +**Signature:** + +```typescript +saveToFile(file: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| file | string | | + +**Returns:** + +Promise<boolean> + diff --git a/docs/api/wz.wzpngproperty.setvalue.md b/docs/api/wz.wzpngproperty.setvalue.md index 9f9dd6e..1c79ce7 100644 --- a/docs/api/wz.wzpngproperty.setvalue.md +++ b/docs/api/wz.wzpngproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [setValue](./wz.wzpngproperty.setvalue.md) - -## WzPngProperty.setValue() method - -Signature: - -```typescript -setValue(_value: Uint8Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_value | Uint8Array | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [setValue](./wz.wzpngproperty.setvalue.md) + +## WzPngProperty.setValue() method + +**Signature:** + +```typescript +setValue(_value: Uint8Array): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_value | Uint8Array | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzpngproperty.width.md b/docs/api/wz.wzpngproperty.width.md index 2434fab..aab2b07 100644 --- a/docs/api/wz.wzpngproperty.width.md +++ b/docs/api/wz.wzpngproperty.width.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [width](./wz.wzpngproperty.width.md) - -## WzPngProperty.width property - -Signature: - -```typescript -width: number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [width](./wz.wzpngproperty.width.md) + +## WzPngProperty.width property + +**Signature:** + +```typescript +width: number; +``` diff --git a/docs/api/wz.wzpngproperty.wzvalue.md b/docs/api/wz.wzpngproperty.wzvalue.md index 34290a6..4b7c37b 100644 --- a/docs/api/wz.wzpngproperty.wzvalue.md +++ b/docs/api/wz.wzpngproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [wzValue](./wz.wzpngproperty.wzvalue.md) - -## WzPngProperty.wzValue property - -Signature: - -```typescript -get wzValue(): Promise; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPngProperty](./wz.wzpngproperty.md) > [wzValue](./wz.wzpngproperty.wzvalue.md) + +## WzPngProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): Promise; +``` diff --git a/docs/api/wz.wzpropertytype.md b/docs/api/wz.wzpropertytype.md index 9d687cf..4a4cd36 100644 --- a/docs/api/wz.wzpropertytype.md +++ b/docs/api/wz.wzpropertytype.md @@ -1,33 +1,33 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPropertyType](./wz.wzpropertytype.md) - -## WzPropertyType enum - - -Signature: - -```typescript -export declare enum WzPropertyType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Canvas | 8 | | -| Convex | 10 | | -| Double | 5 | | -| Float | 4 | | -| Int | 2 | | -| Long | 3 | | -| Lua | 13 | | -| Null | 0 | | -| PNG | 14 | | -| Short | 1 | | -| Sound | 11 | | -| String | 6 | | -| SubProperty | 7 | | -| UOL | 12 | | -| Vector | 9 | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzPropertyType](./wz.wzpropertytype.md) + +## WzPropertyType enum + + +**Signature:** + +```typescript +export declare enum WzPropertyType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Canvas | 8 | | +| Convex | 10 | | +| Double | 5 | | +| Float | 4 | | +| Int | 2 | | +| Long | 3 | | +| Lua | 13 | | +| Null | 0 | | +| PNG | 14 | | +| Short | 1 | | +| Sound | 11 | | +| String | 6 | | +| SubProperty | 7 | | +| UOL | 12 | | +| Vector | 9 | | + diff --git a/docs/api/wz.wzshortproperty._constructor_.md b/docs/api/wz.wzshortproperty._constructor_.md index 43c3980..2e864af 100644 --- a/docs/api/wz.wzshortproperty._constructor_.md +++ b/docs/api/wz.wzshortproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [(constructor)](./wz.wzshortproperty._constructor_.md) - -## WzShortProperty.(constructor) - -Constructs a new instance of the `WzShortProperty` class - -Signature: - -```typescript -constructor(name?: string, val?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| val | number | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [(constructor)](./wz.wzshortproperty._constructor_.md) + +## WzShortProperty.(constructor) + +Constructs a new instance of the `WzShortProperty` class + +**Signature:** + +```typescript +constructor(name?: string, val?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| val | number | _(Optional)_ | + diff --git a/docs/api/wz.wzshortproperty.dispose.md b/docs/api/wz.wzshortproperty.dispose.md index 1daf629..5f48968 100644 --- a/docs/api/wz.wzshortproperty.dispose.md +++ b/docs/api/wz.wzshortproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [dispose](./wz.wzshortproperty.dispose.md) - -## WzShortProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [dispose](./wz.wzshortproperty.dispose.md) + +## WzShortProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzshortproperty.md b/docs/api/wz.wzshortproperty.md index 7bb7a40..ae66f87 100644 --- a/docs/api/wz.wzshortproperty.md +++ b/docs/api/wz.wzshortproperty.md @@ -1,38 +1,38 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) - -## WzShortProperty class - - -Signature: - -```typescript -export declare class WzShortProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, val)](./wz.wzshortproperty._constructor_.md) | | Constructs a new instance of the WzShortProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzshortproperty.name.md) | | string | | -| [parent](./wz.wzshortproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzshortproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [value](./wz.wzshortproperty.value.md) | | number | | -| [wzValue](./wz.wzshortproperty.wzvalue.md) | | number | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzshortproperty.dispose.md) | | | -| [setValue(value)](./wz.wzshortproperty.setvalue.md) | | | -| [toString()](./wz.wzshortproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) + +## WzShortProperty class + + +**Signature:** + +```typescript +export declare class WzShortProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, val)](./wz.wzshortproperty._constructor_.md) | | Constructs a new instance of the WzShortProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzshortproperty.name.md) | | string | | +| [parent](./wz.wzshortproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzshortproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [value](./wz.wzshortproperty.value.md) | readonly | number | | +| [wzValue](./wz.wzshortproperty.wzvalue.md) | readonly | number | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzshortproperty.dispose.md) | | | +| [setValue(value)](./wz.wzshortproperty.setvalue.md) | | | +| [toString()](./wz.wzshortproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzshortproperty.name.md b/docs/api/wz.wzshortproperty.name.md index beb1876..07b9788 100644 --- a/docs/api/wz.wzshortproperty.name.md +++ b/docs/api/wz.wzshortproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [name](./wz.wzshortproperty.name.md) - -## WzShortProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [name](./wz.wzshortproperty.name.md) + +## WzShortProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzshortproperty.parent.md b/docs/api/wz.wzshortproperty.parent.md index 4ae804f..9386e49 100644 --- a/docs/api/wz.wzshortproperty.parent.md +++ b/docs/api/wz.wzshortproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [parent](./wz.wzshortproperty.parent.md) - -## WzShortProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [parent](./wz.wzshortproperty.parent.md) + +## WzShortProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzshortproperty.propertytype.md b/docs/api/wz.wzshortproperty.propertytype.md index fe7904f..d30ead6 100644 --- a/docs/api/wz.wzshortproperty.propertytype.md +++ b/docs/api/wz.wzshortproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [propertyType](./wz.wzshortproperty.propertytype.md) - -## WzShortProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [propertyType](./wz.wzshortproperty.propertytype.md) + +## WzShortProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzshortproperty.setvalue.md b/docs/api/wz.wzshortproperty.setvalue.md index 828b138..18f6484 100644 --- a/docs/api/wz.wzshortproperty.setvalue.md +++ b/docs/api/wz.wzshortproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [setValue](./wz.wzshortproperty.setvalue.md) - -## WzShortProperty.setValue() method - -Signature: - -```typescript -setValue(value: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | number | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [setValue](./wz.wzshortproperty.setvalue.md) + +## WzShortProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | number | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzshortproperty.tostring.md b/docs/api/wz.wzshortproperty.tostring.md index efea681..2f7d8c3 100644 --- a/docs/api/wz.wzshortproperty.tostring.md +++ b/docs/api/wz.wzshortproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [toString](./wz.wzshortproperty.tostring.md) - -## WzShortProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [toString](./wz.wzshortproperty.tostring.md) + +## WzShortProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzshortproperty.value.md b/docs/api/wz.wzshortproperty.value.md index dfc5aa0..dbece55 100644 --- a/docs/api/wz.wzshortproperty.value.md +++ b/docs/api/wz.wzshortproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [value](./wz.wzshortproperty.value.md) - -## WzShortProperty.value property - -Signature: - -```typescript -get value(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [value](./wz.wzshortproperty.value.md) + +## WzShortProperty.value property + +**Signature:** + +```typescript +get value(): number; +``` diff --git a/docs/api/wz.wzshortproperty.wzvalue.md b/docs/api/wz.wzshortproperty.wzvalue.md index af61237..23fd44b 100644 --- a/docs/api/wz.wzshortproperty.wzvalue.md +++ b/docs/api/wz.wzshortproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [wzValue](./wz.wzshortproperty.wzvalue.md) - -## WzShortProperty.wzValue property - -Signature: - -```typescript -get wzValue(): number; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzShortProperty](./wz.wzshortproperty.md) > [wzValue](./wz.wzshortproperty.wzvalue.md) + +## WzShortProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): number; +``` diff --git a/docs/api/wz.wzstringproperty._constructor_.md b/docs/api/wz.wzstringproperty._constructor_.md index 7661b0f..880fe98 100644 --- a/docs/api/wz.wzstringproperty._constructor_.md +++ b/docs/api/wz.wzstringproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [(constructor)](./wz.wzstringproperty._constructor_.md) - -## WzStringProperty.(constructor) - -Constructs a new instance of the `WzStringProperty` class - -Signature: - -```typescript -constructor(name?: string, val?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| val | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [(constructor)](./wz.wzstringproperty._constructor_.md) + +## WzStringProperty.(constructor) + +Constructs a new instance of the `WzStringProperty` class + +**Signature:** + +```typescript +constructor(name?: string, val?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| val | string | _(Optional)_ | + diff --git a/docs/api/wz.wzstringproperty.dispose.md b/docs/api/wz.wzstringproperty.dispose.md index fc1ed67..414f085 100644 --- a/docs/api/wz.wzstringproperty.dispose.md +++ b/docs/api/wz.wzstringproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [dispose](./wz.wzstringproperty.dispose.md) - -## WzStringProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [dispose](./wz.wzstringproperty.dispose.md) + +## WzStringProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzstringproperty.md b/docs/api/wz.wzstringproperty.md index 26a2855..dbcb5dd 100644 --- a/docs/api/wz.wzstringproperty.md +++ b/docs/api/wz.wzstringproperty.md @@ -1,38 +1,38 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) - -## WzStringProperty class - - -Signature: - -```typescript -export declare class WzStringProperty extends WzImageProperty -``` -Extends: [WzImageProperty](./wz.wzimageproperty.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, val)](./wz.wzstringproperty._constructor_.md) | | Constructs a new instance of the WzStringProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzstringproperty.name.md) | | string | | -| [parent](./wz.wzstringproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzstringproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [value](./wz.wzstringproperty.value.md) | | string | | -| [wzValue](./wz.wzstringproperty.wzvalue.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzstringproperty.dispose.md) | | | -| [setValue(value)](./wz.wzstringproperty.setvalue.md) | | | -| [toString()](./wz.wzstringproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) + +## WzStringProperty class + + +**Signature:** + +```typescript +export declare class WzStringProperty extends WzImageProperty +``` +**Extends:** [WzImageProperty](./wz.wzimageproperty.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, val)](./wz.wzstringproperty._constructor_.md) | | Constructs a new instance of the WzStringProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzstringproperty.name.md) | | string | | +| [parent](./wz.wzstringproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzstringproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [value](./wz.wzstringproperty.value.md) | readonly | string | | +| [wzValue](./wz.wzstringproperty.wzvalue.md) | readonly | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzstringproperty.dispose.md) | | | +| [setValue(value)](./wz.wzstringproperty.setvalue.md) | | | +| [toString()](./wz.wzstringproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzstringproperty.name.md b/docs/api/wz.wzstringproperty.name.md index b730326..711f482 100644 --- a/docs/api/wz.wzstringproperty.name.md +++ b/docs/api/wz.wzstringproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [name](./wz.wzstringproperty.name.md) - -## WzStringProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [name](./wz.wzstringproperty.name.md) + +## WzStringProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzstringproperty.parent.md b/docs/api/wz.wzstringproperty.parent.md index 71bea46..87dc219 100644 --- a/docs/api/wz.wzstringproperty.parent.md +++ b/docs/api/wz.wzstringproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [parent](./wz.wzstringproperty.parent.md) - -## WzStringProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [parent](./wz.wzstringproperty.parent.md) + +## WzStringProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzstringproperty.propertytype.md b/docs/api/wz.wzstringproperty.propertytype.md index d45b442..bc6d902 100644 --- a/docs/api/wz.wzstringproperty.propertytype.md +++ b/docs/api/wz.wzstringproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [propertyType](./wz.wzstringproperty.propertytype.md) - -## WzStringProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [propertyType](./wz.wzstringproperty.propertytype.md) + +## WzStringProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzstringproperty.setvalue.md b/docs/api/wz.wzstringproperty.setvalue.md index 787547c..c50748f 100644 --- a/docs/api/wz.wzstringproperty.setvalue.md +++ b/docs/api/wz.wzstringproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [setValue](./wz.wzstringproperty.setvalue.md) - -## WzStringProperty.setValue() method - -Signature: - -```typescript -setValue(value: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | string | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [setValue](./wz.wzstringproperty.setvalue.md) + +## WzStringProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzstringproperty.tostring.md b/docs/api/wz.wzstringproperty.tostring.md index 2ca8d81..e6fa59c 100644 --- a/docs/api/wz.wzstringproperty.tostring.md +++ b/docs/api/wz.wzstringproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [toString](./wz.wzstringproperty.tostring.md) - -## WzStringProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [toString](./wz.wzstringproperty.tostring.md) + +## WzStringProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzstringproperty.value.md b/docs/api/wz.wzstringproperty.value.md index 964fac0..cf1551c 100644 --- a/docs/api/wz.wzstringproperty.value.md +++ b/docs/api/wz.wzstringproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [value](./wz.wzstringproperty.value.md) - -## WzStringProperty.value property - -Signature: - -```typescript -get value(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [value](./wz.wzstringproperty.value.md) + +## WzStringProperty.value property + +**Signature:** + +```typescript +get value(): string; +``` diff --git a/docs/api/wz.wzstringproperty.wzvalue.md b/docs/api/wz.wzstringproperty.wzvalue.md index a2dc221..6f8bc49 100644 --- a/docs/api/wz.wzstringproperty.wzvalue.md +++ b/docs/api/wz.wzstringproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [wzValue](./wz.wzstringproperty.wzvalue.md) - -## WzStringProperty.wzValue property - -Signature: - -```typescript -get wzValue(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzStringProperty](./wz.wzstringproperty.md) > [wzValue](./wz.wzstringproperty.wzvalue.md) + +## WzStringProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): string; +``` diff --git a/docs/api/wz.wzsubproperty._constructor_.md b/docs/api/wz.wzsubproperty._constructor_.md index 186d442..4eb1c99 100644 --- a/docs/api/wz.wzsubproperty._constructor_.md +++ b/docs/api/wz.wzsubproperty._constructor_.md @@ -1,20 +1,20 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [(constructor)](./wz.wzsubproperty._constructor_.md) - -## WzSubProperty.(constructor) - -Constructs a new instance of the `WzSubProperty` class - -Signature: - -```typescript -constructor(name?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [(constructor)](./wz.wzsubproperty._constructor_.md) + +## WzSubProperty.(constructor) + +Constructs a new instance of the `WzSubProperty` class + +**Signature:** + +```typescript +constructor(name?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | + diff --git a/docs/api/wz.wzsubproperty.addproperties.md b/docs/api/wz.wzsubproperty.addproperties.md index f22ef46..eefa752 100644 --- a/docs/api/wz.wzsubproperty.addproperties.md +++ b/docs/api/wz.wzsubproperty.addproperties.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [addProperties](./wz.wzsubproperty.addproperties.md) - -## WzSubProperty.addProperties() method - -Signature: - -```typescript -addProperties(props: Set): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [addProperties](./wz.wzsubproperty.addproperties.md) + +## WzSubProperty.addProperties() method + +**Signature:** + +```typescript +addProperties(props: Set): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| props | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzsubproperty.addproperty.md b/docs/api/wz.wzsubproperty.addproperty.md index eb32220..0c3912b 100644 --- a/docs/api/wz.wzsubproperty.addproperty.md +++ b/docs/api/wz.wzsubproperty.addproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [addProperty](./wz.wzsubproperty.addproperty.md) - -## WzSubProperty.addProperty() method - -Signature: - -```typescript -addProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [addProperty](./wz.wzsubproperty.addproperty.md) + +## WzSubProperty.addProperty() method + +**Signature:** + +```typescript +addProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzsubproperty.at.md b/docs/api/wz.wzsubproperty.at.md index 2ade831..30f1a30 100644 --- a/docs/api/wz.wzsubproperty.at.md +++ b/docs/api/wz.wzsubproperty.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [at](./wz.wzsubproperty.at.md) - -## WzSubProperty.at() method - -Signature: - -```typescript -at(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [at](./wz.wzsubproperty.at.md) + +## WzSubProperty.at() method + +**Signature:** + +```typescript +at(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzsubproperty.clearproperties.md b/docs/api/wz.wzsubproperty.clearproperties.md index 4abd370..e9dfc61 100644 --- a/docs/api/wz.wzsubproperty.clearproperties.md +++ b/docs/api/wz.wzsubproperty.clearproperties.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [clearProperties](./wz.wzsubproperty.clearproperties.md) - -## WzSubProperty.clearProperties() method - -Signature: - -```typescript -clearProperties(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [clearProperties](./wz.wzsubproperty.clearproperties.md) + +## WzSubProperty.clearProperties() method + +**Signature:** + +```typescript +clearProperties(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzsubproperty.dispose.md b/docs/api/wz.wzsubproperty.dispose.md index 443143b..040a034 100644 --- a/docs/api/wz.wzsubproperty.dispose.md +++ b/docs/api/wz.wzsubproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [dispose](./wz.wzsubproperty.dispose.md) - -## WzSubProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [dispose](./wz.wzsubproperty.dispose.md) + +## WzSubProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzsubproperty.getfrompath.md b/docs/api/wz.wzsubproperty.getfrompath.md index 7600d72..12a0317 100644 --- a/docs/api/wz.wzsubproperty.getfrompath.md +++ b/docs/api/wz.wzsubproperty.getfrompath.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [getFromPath](./wz.wzsubproperty.getfrompath.md) - -## WzSubProperty.getFromPath() method - -Signature: - -```typescript -getFromPath(path: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [getFromPath](./wz.wzsubproperty.getfrompath.md) + +## WzSubProperty.getFromPath() method + +**Signature:** + +```typescript +getFromPath(path: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzsubproperty.md b/docs/api/wz.wzsubproperty.md index fa212f9..ea39b24 100644 --- a/docs/api/wz.wzsubproperty.md +++ b/docs/api/wz.wzsubproperty.md @@ -1,45 +1,45 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) - -## WzSubProperty class - - -Signature: - -```typescript -export declare class WzSubProperty extends WzExtended implements IPropertyContainer -``` -Extends: [WzExtended](./wz.wzextended.md) - -Implements: [IPropertyContainer](./wz.ipropertycontainer.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name)](./wz.wzsubproperty._constructor_.md) | | Constructs a new instance of the WzSubProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzsubproperty.name.md) | | string | | -| [parent](./wz.wzsubproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzsubproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [wzProperties](./wz.wzsubproperty.wzproperties.md) | | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addProperties(props)](./wz.wzsubproperty.addproperties.md) | | | -| [addProperty(prop)](./wz.wzsubproperty.addproperty.md) | | | -| [at(name)](./wz.wzsubproperty.at.md) | | | -| [clearProperties()](./wz.wzsubproperty.clearproperties.md) | | | -| [dispose()](./wz.wzsubproperty.dispose.md) | | | -| [getFromPath(path)](./wz.wzsubproperty.getfrompath.md) | | | -| [removeProperty(prop)](./wz.wzsubproperty.removeproperty.md) | | | -| [set(name, value)](./wz.wzsubproperty.set.md) | | | -| [setValue(\_value)](./wz.wzsubproperty.setvalue.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) + +## WzSubProperty class + + +**Signature:** + +```typescript +export declare class WzSubProperty extends WzExtended implements IPropertyContainer +``` +**Extends:** [WzExtended](./wz.wzextended.md) + +**Implements:** [IPropertyContainer](./wz.ipropertycontainer.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name)](./wz.wzsubproperty._constructor_.md) | | Constructs a new instance of the WzSubProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzsubproperty.name.md) | | string | | +| [parent](./wz.wzsubproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzsubproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [wzProperties](./wz.wzsubproperty.wzproperties.md) | readonly | Set<[WzImageProperty](./wz.wzimageproperty.md)> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addProperties(props)](./wz.wzsubproperty.addproperties.md) | | | +| [addProperty(prop)](./wz.wzsubproperty.addproperty.md) | | | +| [at(name)](./wz.wzsubproperty.at.md) | | | +| [clearProperties()](./wz.wzsubproperty.clearproperties.md) | | | +| [dispose()](./wz.wzsubproperty.dispose.md) | | | +| [getFromPath(path)](./wz.wzsubproperty.getfrompath.md) | | | +| [removeProperty(prop)](./wz.wzsubproperty.removeproperty.md) | | | +| [set(name, value)](./wz.wzsubproperty.set.md) | | | +| [setValue(\_value)](./wz.wzsubproperty.setvalue.md) | | | + diff --git a/docs/api/wz.wzsubproperty.name.md b/docs/api/wz.wzsubproperty.name.md index 849789c..fa20996 100644 --- a/docs/api/wz.wzsubproperty.name.md +++ b/docs/api/wz.wzsubproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [name](./wz.wzsubproperty.name.md) - -## WzSubProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [name](./wz.wzsubproperty.name.md) + +## WzSubProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzsubproperty.parent.md b/docs/api/wz.wzsubproperty.parent.md index 1579e4f..98310c3 100644 --- a/docs/api/wz.wzsubproperty.parent.md +++ b/docs/api/wz.wzsubproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [parent](./wz.wzsubproperty.parent.md) - -## WzSubProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [parent](./wz.wzsubproperty.parent.md) + +## WzSubProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzsubproperty.propertytype.md b/docs/api/wz.wzsubproperty.propertytype.md index af06eaf..c9fa620 100644 --- a/docs/api/wz.wzsubproperty.propertytype.md +++ b/docs/api/wz.wzsubproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [propertyType](./wz.wzsubproperty.propertytype.md) - -## WzSubProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [propertyType](./wz.wzsubproperty.propertytype.md) + +## WzSubProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzsubproperty.removeproperty.md b/docs/api/wz.wzsubproperty.removeproperty.md index a9ff0f8..fdb6ad1 100644 --- a/docs/api/wz.wzsubproperty.removeproperty.md +++ b/docs/api/wz.wzsubproperty.removeproperty.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [removeProperty](./wz.wzsubproperty.removeproperty.md) - -## WzSubProperty.removeProperty() method - -Signature: - -```typescript -removeProperty(prop: WzImageProperty): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prop | [WzImageProperty](./wz.wzimageproperty.md) | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [removeProperty](./wz.wzsubproperty.removeproperty.md) + +## WzSubProperty.removeProperty() method + +**Signature:** + +```typescript +removeProperty(prop: WzImageProperty): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prop | [WzImageProperty](./wz.wzimageproperty.md) | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzsubproperty.set.md b/docs/api/wz.wzsubproperty.set.md index 2c07f92..d474938 100644 --- a/docs/api/wz.wzsubproperty.set.md +++ b/docs/api/wz.wzsubproperty.set.md @@ -1,23 +1,23 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [set](./wz.wzsubproperty.set.md) - -## WzSubProperty.set() method - -Signature: - -```typescript -set(name: string, value: T): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | -| value | T | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [set](./wz.wzsubproperty.set.md) + +## WzSubProperty.set() method + +**Signature:** + +```typescript +set(name: string, value: T): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| value | T | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzsubproperty.setvalue.md b/docs/api/wz.wzsubproperty.setvalue.md index f619cac..f99c1e4 100644 --- a/docs/api/wz.wzsubproperty.setvalue.md +++ b/docs/api/wz.wzsubproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [setValue](./wz.wzsubproperty.setvalue.md) - -## WzSubProperty.setValue() method - -Signature: - -```typescript -setValue(_value: unknown): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_value | unknown | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [setValue](./wz.wzsubproperty.setvalue.md) + +## WzSubProperty.setValue() method + +**Signature:** + +```typescript +setValue(_value: unknown): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| \_value | unknown | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzsubproperty.wzproperties.md b/docs/api/wz.wzsubproperty.wzproperties.md index 0e30c95..8dcaab9 100644 --- a/docs/api/wz.wzsubproperty.wzproperties.md +++ b/docs/api/wz.wzsubproperty.wzproperties.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [wzProperties](./wz.wzsubproperty.wzproperties.md) - -## WzSubProperty.wzProperties property - -Signature: - -```typescript -get wzProperties(): Set; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzSubProperty](./wz.wzsubproperty.md) > [wzProperties](./wz.wzsubproperty.wzproperties.md) + +## WzSubProperty.wzProperties property + +**Signature:** + +```typescript +get wzProperties(): Set; +``` diff --git a/docs/api/wz.wzuolproperty._constructor_.md b/docs/api/wz.wzuolproperty._constructor_.md index 46be503..d67e43f 100644 --- a/docs/api/wz.wzuolproperty._constructor_.md +++ b/docs/api/wz.wzuolproperty._constructor_.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [(constructor)](./wz.wzuolproperty._constructor_.md) - -## WzUOLProperty.(constructor) - -Constructs a new instance of the `WzUOLProperty` class - -Signature: - -```typescript -constructor(name?: string, val?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| val | string | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [(constructor)](./wz.wzuolproperty._constructor_.md) + +## WzUOLProperty.(constructor) + +Constructs a new instance of the `WzUOLProperty` class + +**Signature:** + +```typescript +constructor(name?: string, val?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| val | string | _(Optional)_ | + diff --git a/docs/api/wz.wzuolproperty.at.md b/docs/api/wz.wzuolproperty.at.md index eb63ef3..51d7005 100644 --- a/docs/api/wz.wzuolproperty.at.md +++ b/docs/api/wz.wzuolproperty.at.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [at](./wz.wzuolproperty.at.md) - -## WzUOLProperty.at() method - -Signature: - -```typescript -at(name: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [at](./wz.wzuolproperty.at.md) + +## WzUOLProperty.at() method + +**Signature:** + +```typescript +at(name: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzuolproperty.dispose.md b/docs/api/wz.wzuolproperty.dispose.md index 7dff024..7a8d903 100644 --- a/docs/api/wz.wzuolproperty.dispose.md +++ b/docs/api/wz.wzuolproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [dispose](./wz.wzuolproperty.dispose.md) - -## WzUOLProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [dispose](./wz.wzuolproperty.dispose.md) + +## WzUOLProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzuolproperty.getbitmap.md b/docs/api/wz.wzuolproperty.getbitmap.md index 6e04e2f..a7a8c12 100644 --- a/docs/api/wz.wzuolproperty.getbitmap.md +++ b/docs/api/wz.wzuolproperty.getbitmap.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [getBitmap](./wz.wzuolproperty.getbitmap.md) - -## WzUOLProperty.getBitmap() method - -Signature: - -```typescript -getBitmap(): Promise; -``` -Returns: - -Promise<[Canvas](./wz.canvas.md) \| null> - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [getBitmap](./wz.wzuolproperty.getbitmap.md) + +## WzUOLProperty.getBitmap() method + +**Signature:** + +```typescript +getBitmap(): Promise; +``` +**Returns:** + +Promise<[Canvas](./wz.canvas.md) \| null> + diff --git a/docs/api/wz.wzuolproperty.getfrompath.md b/docs/api/wz.wzuolproperty.getfrompath.md index f2cfb76..4df02c3 100644 --- a/docs/api/wz.wzuolproperty.getfrompath.md +++ b/docs/api/wz.wzuolproperty.getfrompath.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [getFromPath](./wz.wzuolproperty.getfrompath.md) - -## WzUOLProperty.getFromPath() method - -Signature: - -```typescript -getFromPath(path: string): WzImageProperty | null; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | - -Returns: - -[WzImageProperty](./wz.wzimageproperty.md) \| null - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [getFromPath](./wz.wzuolproperty.getfrompath.md) + +## WzUOLProperty.getFromPath() method + +**Signature:** + +```typescript +getFromPath(path: string): WzImageProperty | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | | + +**Returns:** + +[WzImageProperty](./wz.wzimageproperty.md) \| null + diff --git a/docs/api/wz.wzuolproperty.linkvalue.md b/docs/api/wz.wzuolproperty.linkvalue.md index a8688dc..05dfd96 100644 --- a/docs/api/wz.wzuolproperty.linkvalue.md +++ b/docs/api/wz.wzuolproperty.linkvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [linkValue](./wz.wzuolproperty.linkvalue.md) - -## WzUOLProperty.linkValue property - -Signature: - -```typescript -get linkValue(): WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [linkValue](./wz.wzuolproperty.linkvalue.md) + +## WzUOLProperty.linkValue property + +**Signature:** + +```typescript +get linkValue(): WzObject | null; +``` diff --git a/docs/api/wz.wzuolproperty.md b/docs/api/wz.wzuolproperty.md index ceb4394..5db2512 100644 --- a/docs/api/wz.wzuolproperty.md +++ b/docs/api/wz.wzuolproperty.md @@ -1,44 +1,44 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) - -## WzUOLProperty class - - -Signature: - -```typescript -export declare class WzUOLProperty extends WzExtended -``` -Extends: [WzExtended](./wz.wzextended.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, val)](./wz.wzuolproperty._constructor_.md) | | Constructs a new instance of the WzUOLProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [linkValue](./wz.wzuolproperty.linkvalue.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [name](./wz.wzuolproperty.name.md) | | string | | -| [parent](./wz.wzuolproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzuolproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [UOLRES](./wz.wzuolproperty.uolres.md) | static | boolean | | -| [value](./wz.wzuolproperty.value.md) | | string | | -| [wzProperties](./wz.wzuolproperty.wzproperties.md) | | Set<[WzImageProperty](./wz.wzimageproperty.md)> \| null | | -| [wzValue](./wz.wzuolproperty.wzvalue.md) | | [WzObject](./wz.wzobject.md) \| null | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [at(name)](./wz.wzuolproperty.at.md) | | | -| [dispose()](./wz.wzuolproperty.dispose.md) | | | -| [getBitmap()](./wz.wzuolproperty.getbitmap.md) | | | -| [getFromPath(path)](./wz.wzuolproperty.getfrompath.md) | | | -| [setValue(value)](./wz.wzuolproperty.setvalue.md) | | | -| [toString()](./wz.wzuolproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) + +## WzUOLProperty class + + +**Signature:** + +```typescript +export declare class WzUOLProperty extends WzExtended +``` +**Extends:** [WzExtended](./wz.wzextended.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, val)](./wz.wzuolproperty._constructor_.md) | | Constructs a new instance of the WzUOLProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [linkValue](./wz.wzuolproperty.linkvalue.md) | readonly | [WzObject](./wz.wzobject.md) \| null | | +| [name](./wz.wzuolproperty.name.md) | | string | | +| [parent](./wz.wzuolproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzuolproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [UOLRES](./wz.wzuolproperty.uolres.md) | static | boolean | | +| [value](./wz.wzuolproperty.value.md) | readonly | string | | +| [wzProperties](./wz.wzuolproperty.wzproperties.md) | readonly | Set<[WzImageProperty](./wz.wzimageproperty.md)> \| null | | +| [wzValue](./wz.wzuolproperty.wzvalue.md) | readonly | [WzObject](./wz.wzobject.md) \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [at(name)](./wz.wzuolproperty.at.md) | | | +| [dispose()](./wz.wzuolproperty.dispose.md) | | | +| [getBitmap()](./wz.wzuolproperty.getbitmap.md) | | | +| [getFromPath(path)](./wz.wzuolproperty.getfrompath.md) | | | +| [setValue(value)](./wz.wzuolproperty.setvalue.md) | | | +| [toString()](./wz.wzuolproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzuolproperty.name.md b/docs/api/wz.wzuolproperty.name.md index c8947c5..814bd20 100644 --- a/docs/api/wz.wzuolproperty.name.md +++ b/docs/api/wz.wzuolproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [name](./wz.wzuolproperty.name.md) - -## WzUOLProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [name](./wz.wzuolproperty.name.md) + +## WzUOLProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzuolproperty.parent.md b/docs/api/wz.wzuolproperty.parent.md index 5b81de0..8b18903 100644 --- a/docs/api/wz.wzuolproperty.parent.md +++ b/docs/api/wz.wzuolproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [parent](./wz.wzuolproperty.parent.md) - -## WzUOLProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [parent](./wz.wzuolproperty.parent.md) + +## WzUOLProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzuolproperty.propertytype.md b/docs/api/wz.wzuolproperty.propertytype.md index c1c2d25..1915103 100644 --- a/docs/api/wz.wzuolproperty.propertytype.md +++ b/docs/api/wz.wzuolproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [propertyType](./wz.wzuolproperty.propertytype.md) - -## WzUOLProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [propertyType](./wz.wzuolproperty.propertytype.md) + +## WzUOLProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzuolproperty.setvalue.md b/docs/api/wz.wzuolproperty.setvalue.md index a89ec84..5069db4 100644 --- a/docs/api/wz.wzuolproperty.setvalue.md +++ b/docs/api/wz.wzuolproperty.setvalue.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [setValue](./wz.wzuolproperty.setvalue.md) - -## WzUOLProperty.setValue() method - -Signature: - -```typescript -setValue(value: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | string | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [setValue](./wz.wzuolproperty.setvalue.md) + +## WzUOLProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzuolproperty.tostring.md b/docs/api/wz.wzuolproperty.tostring.md index 695a88b..4954dd9 100644 --- a/docs/api/wz.wzuolproperty.tostring.md +++ b/docs/api/wz.wzuolproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [toString](./wz.wzuolproperty.tostring.md) - -## WzUOLProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [toString](./wz.wzuolproperty.tostring.md) + +## WzUOLProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzuolproperty.uolres.md b/docs/api/wz.wzuolproperty.uolres.md index 7c29640..05a04c9 100644 --- a/docs/api/wz.wzuolproperty.uolres.md +++ b/docs/api/wz.wzuolproperty.uolres.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [UOLRES](./wz.wzuolproperty.uolres.md) - -## WzUOLProperty.UOLRES property - -Signature: - -```typescript -static UOLRES: boolean; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [UOLRES](./wz.wzuolproperty.uolres.md) + +## WzUOLProperty.UOLRES property + +**Signature:** + +```typescript +static UOLRES: boolean; +``` diff --git a/docs/api/wz.wzuolproperty.value.md b/docs/api/wz.wzuolproperty.value.md index d082880..b7bfe4f 100644 --- a/docs/api/wz.wzuolproperty.value.md +++ b/docs/api/wz.wzuolproperty.value.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [value](./wz.wzuolproperty.value.md) - -## WzUOLProperty.value property - -Signature: - -```typescript -get value(): string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [value](./wz.wzuolproperty.value.md) + +## WzUOLProperty.value property + +**Signature:** + +```typescript +get value(): string; +``` diff --git a/docs/api/wz.wzuolproperty.wzproperties.md b/docs/api/wz.wzuolproperty.wzproperties.md index 3463aa9..7dc45ad 100644 --- a/docs/api/wz.wzuolproperty.wzproperties.md +++ b/docs/api/wz.wzuolproperty.wzproperties.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [wzProperties](./wz.wzuolproperty.wzproperties.md) - -## WzUOLProperty.wzProperties property - -Signature: - -```typescript -get wzProperties(): Set | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [wzProperties](./wz.wzuolproperty.wzproperties.md) + +## WzUOLProperty.wzProperties property + +**Signature:** + +```typescript +get wzProperties(): Set | null; +``` diff --git a/docs/api/wz.wzuolproperty.wzvalue.md b/docs/api/wz.wzuolproperty.wzvalue.md index 73360cc..826459e 100644 --- a/docs/api/wz.wzuolproperty.wzvalue.md +++ b/docs/api/wz.wzuolproperty.wzvalue.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [wzValue](./wz.wzuolproperty.wzvalue.md) - -## WzUOLProperty.wzValue property - -Signature: - -```typescript -get wzValue(): WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzUOLProperty](./wz.wzuolproperty.md) > [wzValue](./wz.wzuolproperty.wzvalue.md) + +## WzUOLProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): WzObject | null; +``` diff --git a/docs/api/wz.wzvectorproperty._constructor_.md b/docs/api/wz.wzvectorproperty._constructor_.md index 13be142..2aaf53d 100644 --- a/docs/api/wz.wzvectorproperty._constructor_.md +++ b/docs/api/wz.wzvectorproperty._constructor_.md @@ -1,22 +1,22 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [(constructor)](./wz.wzvectorproperty._constructor_.md) - -## WzVectorProperty.(constructor) - -Constructs a new instance of the `WzVectorProperty` class - -Signature: - -```typescript -constructor(name?: string, x?: number, y?: number); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | (Optional) | -| x | number | (Optional) | -| y | number | (Optional) | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [(constructor)](./wz.wzvectorproperty._constructor_.md) + +## WzVectorProperty.(constructor) + +Constructs a new instance of the `WzVectorProperty` class + +**Signature:** + +```typescript +constructor(name?: string, x?: number, y?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | _(Optional)_ | +| x | number | _(Optional)_ | +| y | number | _(Optional)_ | + diff --git a/docs/api/wz.wzvectorproperty.dispose.md b/docs/api/wz.wzvectorproperty.dispose.md index 68d8497..446405d 100644 --- a/docs/api/wz.wzvectorproperty.dispose.md +++ b/docs/api/wz.wzvectorproperty.dispose.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [dispose](./wz.wzvectorproperty.dispose.md) - -## WzVectorProperty.dispose() method - -Signature: - -```typescript -dispose(): void; -``` -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [dispose](./wz.wzvectorproperty.dispose.md) + +## WzVectorProperty.dispose() method + +**Signature:** + +```typescript +dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/wz.wzvectorproperty.md b/docs/api/wz.wzvectorproperty.md index 758971a..93d5c5b 100644 --- a/docs/api/wz.wzvectorproperty.md +++ b/docs/api/wz.wzvectorproperty.md @@ -1,39 +1,39 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) - -## WzVectorProperty class - - -Signature: - -```typescript -export declare class WzVectorProperty extends WzExtended -``` -Extends: [WzExtended](./wz.wzextended.md) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(name, x, y)](./wz.wzvectorproperty._constructor_.md) | | Constructs a new instance of the WzVectorProperty class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./wz.wzvectorproperty.name.md) | | string | | -| [parent](./wz.wzvectorproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | -| [propertyType](./wz.wzvectorproperty.propertytype.md) | | [WzPropertyType](./wz.wzpropertytype.md) | | -| [wzValue](./wz.wzvectorproperty.wzvalue.md) | | { x: number; y: number; } | | -| [x](./wz.wzvectorproperty.x.md) | | [WzIntProperty](./wz.wzintproperty.md) \| null | | -| [y](./wz.wzvectorproperty.y.md) | | [WzIntProperty](./wz.wzintproperty.md) \| null | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./wz.wzvectorproperty.dispose.md) | | | -| [setValue(value)](./wz.wzvectorproperty.setvalue.md) | | | -| [toString()](./wz.wzvectorproperty.tostring.md) | | | - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) + +## WzVectorProperty class + + +**Signature:** + +```typescript +export declare class WzVectorProperty extends WzExtended +``` +**Extends:** [WzExtended](./wz.wzextended.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, x, y)](./wz.wzvectorproperty._constructor_.md) | | Constructs a new instance of the WzVectorProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./wz.wzvectorproperty.name.md) | | string | | +| [parent](./wz.wzvectorproperty.parent.md) | | [WzObject](./wz.wzobject.md) \| null | | +| [propertyType](./wz.wzvectorproperty.propertytype.md) | readonly | [WzPropertyType](./wz.wzpropertytype.md) | | +| [wzValue](./wz.wzvectorproperty.wzvalue.md) | readonly | { x: number; y: number; } | | +| [x](./wz.wzvectorproperty.x.md) | | [WzIntProperty](./wz.wzintproperty.md) \| null | | +| [y](./wz.wzvectorproperty.y.md) | | [WzIntProperty](./wz.wzintproperty.md) \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./wz.wzvectorproperty.dispose.md) | | | +| [setValue(value)](./wz.wzvectorproperty.setvalue.md) | | | +| [toString()](./wz.wzvectorproperty.tostring.md) | | | + diff --git a/docs/api/wz.wzvectorproperty.name.md b/docs/api/wz.wzvectorproperty.name.md index 2451b63..a3600cf 100644 --- a/docs/api/wz.wzvectorproperty.name.md +++ b/docs/api/wz.wzvectorproperty.name.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [name](./wz.wzvectorproperty.name.md) - -## WzVectorProperty.name property - -Signature: - -```typescript -name: string; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [name](./wz.wzvectorproperty.name.md) + +## WzVectorProperty.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/wz.wzvectorproperty.parent.md b/docs/api/wz.wzvectorproperty.parent.md index 5cd8032..62e1bf2 100644 --- a/docs/api/wz.wzvectorproperty.parent.md +++ b/docs/api/wz.wzvectorproperty.parent.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [parent](./wz.wzvectorproperty.parent.md) - -## WzVectorProperty.parent property - -Signature: - -```typescript -parent: WzObject | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [parent](./wz.wzvectorproperty.parent.md) + +## WzVectorProperty.parent property + +**Signature:** + +```typescript +parent: WzObject | null; +``` diff --git a/docs/api/wz.wzvectorproperty.propertytype.md b/docs/api/wz.wzvectorproperty.propertytype.md index 15939cf..f9ce4a5 100644 --- a/docs/api/wz.wzvectorproperty.propertytype.md +++ b/docs/api/wz.wzvectorproperty.propertytype.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [propertyType](./wz.wzvectorproperty.propertytype.md) - -## WzVectorProperty.propertyType property - -Signature: - -```typescript -get propertyType(): WzPropertyType; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [propertyType](./wz.wzvectorproperty.propertytype.md) + +## WzVectorProperty.propertyType property + +**Signature:** + +```typescript +get propertyType(): WzPropertyType; +``` diff --git a/docs/api/wz.wzvectorproperty.setvalue.md b/docs/api/wz.wzvectorproperty.setvalue.md index 2a6cdd0..28dcb52 100644 --- a/docs/api/wz.wzvectorproperty.setvalue.md +++ b/docs/api/wz.wzvectorproperty.setvalue.md @@ -1,25 +1,25 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [setValue](./wz.wzvectorproperty.setvalue.md) - -## WzVectorProperty.setValue() method - -Signature: - -```typescript -setValue(value: { - x: number; - y: number; - }): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | { x: number; y: number; } | | - -Returns: - -void - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [setValue](./wz.wzvectorproperty.setvalue.md) + +## WzVectorProperty.setValue() method + +**Signature:** + +```typescript +setValue(value: { + x: number; + y: number; + }): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | { x: number; y: number; } | | + +**Returns:** + +void + diff --git a/docs/api/wz.wzvectorproperty.tostring.md b/docs/api/wz.wzvectorproperty.tostring.md index 6088012..e23a19c 100644 --- a/docs/api/wz.wzvectorproperty.tostring.md +++ b/docs/api/wz.wzvectorproperty.tostring.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [toString](./wz.wzvectorproperty.tostring.md) - -## WzVectorProperty.toString() method - -Signature: - -```typescript -toString(): string; -``` -Returns: - -string - + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [toString](./wz.wzvectorproperty.tostring.md) + +## WzVectorProperty.toString() method + +**Signature:** + +```typescript +toString(): string; +``` +**Returns:** + +string + diff --git a/docs/api/wz.wzvectorproperty.wzvalue.md b/docs/api/wz.wzvectorproperty.wzvalue.md index cdde2cc..98d9434 100644 --- a/docs/api/wz.wzvectorproperty.wzvalue.md +++ b/docs/api/wz.wzvectorproperty.wzvalue.md @@ -1,14 +1,14 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [wzValue](./wz.wzvectorproperty.wzvalue.md) - -## WzVectorProperty.wzValue property - -Signature: - -```typescript -get wzValue(): { - x: number; - y: number; - }; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [wzValue](./wz.wzvectorproperty.wzvalue.md) + +## WzVectorProperty.wzValue property + +**Signature:** + +```typescript +get wzValue(): { + x: number; + y: number; + }; +``` diff --git a/docs/api/wz.wzvectorproperty.x.md b/docs/api/wz.wzvectorproperty.x.md index 095557a..33c7f3c 100644 --- a/docs/api/wz.wzvectorproperty.x.md +++ b/docs/api/wz.wzvectorproperty.x.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [x](./wz.wzvectorproperty.x.md) - -## WzVectorProperty.x property - -Signature: - -```typescript -x: WzIntProperty | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [x](./wz.wzvectorproperty.x.md) + +## WzVectorProperty.x property + +**Signature:** + +```typescript +x: WzIntProperty | null; +``` diff --git a/docs/api/wz.wzvectorproperty.y.md b/docs/api/wz.wzvectorproperty.y.md index ccffdbf..0493fea 100644 --- a/docs/api/wz.wzvectorproperty.y.md +++ b/docs/api/wz.wzvectorproperty.y.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [y](./wz.wzvectorproperty.y.md) - -## WzVectorProperty.y property - -Signature: - -```typescript -y: WzIntProperty | null; -``` + + +[Home](./index.md) > [@tybys/wz](./wz.md) > [WzVectorProperty](./wz.wzvectorproperty.md) > [y](./wz.wzvectorproperty.y.md) + +## WzVectorProperty.y property + +**Signature:** + +```typescript +y: WzIntProperty | null; +```