LeechCraft 0.6.70-17609-g3dde4097dd
Modular cross-platform feature rich live environment.
Loading...
Searching...
No Matches
EntityTestHandleResult Struct Reference

The result of testing whether an entity could be handled by a plugin. More...

#include "entitytesthandleresult.h"

Public Types

enum  Priority {
  PIdeal = 1000 ,
  PHigh = 800 ,
  PNormal = 600 ,
  PLow = 200 ,
  PNone = 0
}
 The typical values for the priority. More...
 

Public Attributes

int HandlePriority_ = Priority::PNone
 The priority with which an entity could be handled.
 

Detailed Description

The result of testing whether an entity could be handled by a plugin.

Both processing an Entity with IEntityHandler and IDownload are considered to be "handling".

The test result also includes the so-called priority which shows how much the plugin is ready to handle the entity. The higher is the priority, the more ready the plugin is to handle the entity.

Typically the handler with the highest priority will be chosen. A value of 0 or lower means that the given entity can't be handled by this handler/downloader at all.

Definition at line 25 of file entitytesthandleresult.h.

Member Enumeration Documentation

◆ Priority

The typical values for the priority.

Enumerator
PIdeal 
PHigh 
PNormal 
PLow 
PNone 

Definition at line 29 of file entitytesthandleresult.h.

Member Data Documentation

◆ HandlePriority_

int EntityTestHandleResult::HandlePriority_ = Priority::PNone

The priority with which an entity could be handled.

Definition at line 40 of file entitytesthandleresult.h.


The documentation for this struct was generated from the following file: