Class Pf2eBridge

Bridge for Pathfinder 2e

Hierarchy (view full)

BridgeAbstract
- Pf2eBridge

Index

Constructors

Accessors

attackHooks hyperInformation itemHooks systemInformation

Methods

_createItems _deleteItems createItems deleteItems getBasicItemInformation getHookInformation getItemInformation registerReplicated setItemInformation

Constructors

constructor

new Pf2eBridge(): Pf2eBridge
Returns Pf2eBridge
Inherited from BridgeAbstract.constructor

Accessors

attackHooks

get attackHooks(): {
name: string;
value: string;
}[]
Returns all the hooks useful for attack

Returns {
name: string;
value: string;
}[]
Overrides BridgeAbstract.attackHooks
- Defined in bridge/pf2e.ts:17

hyperInformation

get hyperInformation(): HyperInformation
Returns all the hyper information about the bridge

Returns HyperInformation
Overrides BridgeAbstract.hyperInformation
- Defined in bridge/pf2e.ts:45

itemHooks

get itemHooks(): {
name: string;
value: string;
}[]
Returns all the hooks useful for items

Returns {
name: string;
value: string;
}[]
Overrides BridgeAbstract.itemHooks
- Defined in bridge/pf2e.ts:31

systemInformation

get systemInformation(): SystemInformation
Returns information specific to this system that can be useful

Returns SystemInformation
Overrides BridgeAbstract.systemInformation
- Defined in bridge/pf2e.ts:54

Methods

_createItems

_createItems(targetUuid, items): Promise<void>
Method that creates an item
Parameters
- targetUuid: any
- items: any
Returns Promise<void>
Overrides BridgeAbstract._createItems
- Defined in bridge/pf2e.ts:62

_deleteItems

_deleteItems(targetUuid, itemIds): Promise<void>
Method that delets an item
Parameters
- targetUuid: any
- itemIds: any
Returns Promise<void>
Overrides BridgeAbstract._deleteItems
- Defined in bridge/pf2e.ts:76

createItems

createItems(target, items): any
API method that creates an item
Parameters
- target: any
- items: any
Returns any
Overrides BridgeAbstract.createItems
- Defined in bridge/pf2e.ts:69

deleteItems

deleteItems(target, itemIds): any
API method that deletes an item
Parameters
- target: any
- itemIds: any
Returns any
Overrides BridgeAbstract.deleteItems
- Defined in bridge/pf2e.ts:83

getBasicItemInformation

getBasicItemInformation(item): {
    image: any;
    name: any;
    owner: any;
}
Method that extracts the basic information of an item
Parameters
- item: any
Returns {
    image: any;
    name: any;
    owner: any;
}
- image: any
- name: any
- owner: any
Inherited from BridgeAbstract.getBasicItemInformation
- Defined in bridge/bridge_abstract.ts:125

getHookInformation

getHookInformation(workflow, source, from): HookInformation
Method that is called when a hook is triggered and returns the information that can be extract from it
Parameters
- workflow: any
- source: HookType
- from: any
Returns HookInformation
Overrides BridgeAbstract.getHookInformation
- Defined in bridge/pf2e.ts:140

getItemInformation

getItemInformation(item): ItemInformation
Method that extracts useful information from an item
Parameters
- item: any
Returns ItemInformation
Overrides BridgeAbstract.getItemInformation
- Defined in bridge/pf2e.ts:90

registerReplicated

registerReplicated(socket): void
Register the replicated methods
Parameters
- socket: any
  Instance of a socket from socketlib
Returns void
Overrides BridgeAbstract.registerReplicated
- Defined in bridge/pf2e.ts:12

setItemInformation

setItemInformation(item, information): Promise<void>
Method that sets the information of an item
Parameters
- item: any
- information: ItemInformation
Returns Promise<void>
Overrides BridgeAbstract.setItemInformation
- Defined in bridge/pf2e.ts:131