Gorilla.Utils.SkillSystem

Fields

• protected FGUID : TGUID
  
• protected FEnabled : Boolean
  
• protected FName : TGorillaLanguageMap
  
• protected FIcon : Integer
  
• protected FPosition : TPointF
  

Methods

• public constructor Create  ( ACollection :  TCollection ) ;
• public destructor Destroy  ( ) ;
• protected function GetName  ( )  : string ;  virtual;
• protected procedure SetName  ( const  AValue :  string ) ;  virtual;
• protected function GetSkillSystem  ( )  : TGorillaSkillSystem ;  virtual;
• protected procedure DoOnFromXmlProperty  ( const  ANode :  TMz_XmlElement ) ;  virtual;

  Used to react on property nodes of a parent xml element.

• public function GetIdentifier  ( )  : string ;  class abstract virtual;
• public procedure FromXml  ( const  ANode :  TMz_XmlElement ) ;  virtual;

  Read entity properties and attributes from a specific xml element.

• public function ToXml  ( const  AParent :  TMz_XmlElement )  : TMz_XmlElement ;  virtual;

  Write entity properties and attributes to a specific xml element.

Properties

• public GUID : TGUID

  Defines a unique identifier for this entity. This guid is useful to find an entity in global context.

  read FGUID
  
• public Name : string

  Defines a multi-lingual table for a skill specific name.

  read GetName
  write SetName
  
• public SkillSystem : TGorillaSkillSystem

  Holds a reference to the parent skill system.

  read GetSkillSystem
  
• published Enabled : Boolean

  Defines if this entity (skill or group) is unlocked for usage.

  read FEnabled
  write FEnabled
  
• published Icon : Integer

  Use this property if you like to set an individual skill icon. The value contains the index of a specific icon in an imagelist.

  read FIcon
  write FIcon
  
• published Position : TPointF

  An absolute position stored for this entity. This property is used for reloading the skill system into a flow chart and to restore position.

  read FPosition
  write FPosition
  

Methods

• protected function GetSkillSystem  ( )  : TGorillaSkillSystem ;  virtual;
• public procedure FromXml  ( const  ANode :  TMz_XmlElement ) ;  virtual;
• public function ToXml  ( const  ATagName :  string; const  AParent :  TMz_XmlElement )  : TMz_XmlElement ;  virtual;

Properties

• public SkillSystem : TGorillaSkillSystem

  Holds a reference to the parent skill system.

  read GetSkillSystem
  

Fields

• protected FActivated : Boolean
  
• protected FValue : Single
  
• protected FFactor : Single
  
• protected FInterpolation : TGorillaSkillLevelInterpolation
  
• protected FLevel : Integer
  
• protected FMaxLevel : Integer
  
• protected FLevelingTime : Integer
  
• protected FNextSkill : TGUID
  
• protected FNextSkillObj : TGorillaSkill
  
• protected FData : TValue
  

Methods

• public constructor Create  ( ACollection :  TCollection ) ;
• public destructor Destroy  ( ) ;
• protected function GetSkillGroup  ( )  : TGorillaSkillGroup ;  virtual;
• protected function GetNextSkillObject  ( )  : TGorillaSkill ;  virtual;
• protected procedure DoLevelUp  ( const  AProcess :  TGorillaSkillProcess ) ;  virtual;
• protected function DoInterpolateValue  ( const  ALevel :  Integer; const  ACurrentValue :  Single; const  AFactor :  Single )  : Single ;  virtual;
• protected procedure DoOnFromXmlProperty  ( const  ANode :  TMz_XmlElement ) ;  override;
• public function GetIdentifier  ( )  : string ;  class override;
• public function ToXml  ( const  AParent :  TMz_XmlElement )  : TMz_XmlElement ;  override;
• public function StartLevelingUp  ( )  : TGorillaSkillProcess ;  virtual;

  Starts an up-leveling async process.

• public function GetLastActivatedSkill  ( )  : TGorillaSkill ;  virtual;

  Iterates through the complete chain of skill links and returns the last activated skill.

• public function GetLastSkill  ( )  : TGorillaSkill ;  virtual;

  Iterates through the complete chain of skill links and returns the last skill.

Properties

• public Group : TGorillaSkillGroup

  Requests the skill group in which this skill was registered.

  read GetSkillGroup
  
• public NextSkillObj : TGorillaSkill
  read GetNextSkillObject
  
• published Activated : Boolean

  Defines if the skill is activated for use. It is different to "Enabled" which only unlocks the skill for activation.

  read FActivated
  write FActivated
  
• published Value : Single

  Defines the main property/skill value. Use this value to compute game / app effects.

  read FValue
  write FValue
  
• published Factor : Single

  Defines an interpolation factor used with the interpolation method to calculate the level corresponding value.

  read FFactor
  write FFactor
  
• published Interpolation : TGorillaSkillLevelInterpolation

  Defines an interpolation function by which a new value is computed, in dependency to the level.

  read FInterpolation
  write FInterpolation
  
• published Level : Integer

  Defines a value to identify a level category.

  read FLevel
  write FLevel
  
• published MaxLevel : Integer

  Defines the maximum level to be reached.

  read FMaxLevel
  write FMaxLevel
  
• published LevelingTime : Integer

  Defines the time for leveling up this skill. By default this value is set to 1000ms.

  read FLevelingTime
  write FLevelingTime
  
• published NextSkill : TGUID

  Defines a linked skill which will be enabled on leveling up. Use this property instead of interpolation mechanism.

  read FNextSkill
  write FNextSkill
  
• published Data : TValue

  Use this value to store skill specific variable content. For example if the Value field do not provide enough information for this skill.

  read FData
  write FData
  

Fields

• protected FSkill : TGorillaSkill
  
• protected FToLevel : Integer
  
• protected FNewValue : Single
  
• protected FStartTime : Int64
  
• protected FTotalTime : Integer
  

Methods

• public constructor Create  ( const  ASkill :  TGorillaSkill; const  ATotalTime :  Integer; const  AToLevel :  Integer; const  ANewValue :  Single ) ;
• protected function GetIsStarted  ( )  : Boolean ;
• protected function GetIsElapsed  ( )  : Boolean ;
• public procedure Start  ( ) ;  virtual;

  Explicitly starts the leveling process. If a process was already started this method ignores the action.

• public procedure FromXml  ( const  ASkillSystem :  TGorillaSkillSystem; const  ANode :  TMz_XmlElement ) ;  virtual;
• public procedure ToXml  ( const  AParent :  TMz_XmlElement ) ;  virtual;

Properties

• public Skill : TGorillaSkill

  Referenced skill on which this leveling process will be applied.

  read FSkill
  
• public ToLevel : Integer

  Defines the destination level after finishing the leveling process.

  read FToLevel
  
• public NewValue : Single

  Defines the destination value after finishing the leveling process.

  read FNewValue
  
• public StartTime : Int64

  Returns the starting time of the process. The start time is only set by a call of Start() method.

  read FStartTime
  
• public TotalTime : Integer

  Defines the total time of the leveling process in milliseconds.

  read FTotalTime
  
• public IsStarted : Boolean

  Returns if the specific leveling process was started.

  read GetIsStarted
  
• public IsElapsed : Boolean

  Returns if the specific leveling process is already finished.

  read GetIsElapsed
  

Fields

• protected FProcesses : TGorillaSkillProcessList
  

Methods

• public constructor Create  ( ASuspended :  Boolean ) ;
• public destructor Destroy  ( ) ;
• protected procedure Execute  ( ) ;  override;
• protected procedure DoOnProcessListNotify  ( ASender :  TObject; const  AItem :  TGorillaSkillProcess; AAction :  TCollectionNotification ) ;  virtual;
• public procedure AddProcess  ( const  AProcess :  TGorillaSkillProcess ) ;  virtual;

  Adds a leveling process to the thread.

• public procedure ClearProcesses  ( ) ;  virtual;

  Clears all available process.

Properties

• public Processes : TThreadList<Gorilla.Utils.SkillSystem.TGorillaSkillProcess>

  Defines a thread safe list of skill leveling processes.

  read FProcesses
  

Properties

• public Group : TGorillaSkillGroup

  Holds a reference to the owner group which holds this skill collection.

  read GetGroup
  

Fields

• protected FSkills : TGorillaSkillCollection
  

Methods

• public constructor Create  ( ACollection :  TCollection ) ;
• public destructor Destroy  ( ) ;
• protected procedure DoOnFromXmlProperty  ( const  ANode :  TMz_XmlElement ) ;  override;
• public function GetIdentifier  ( )  : string ;  class override;
• public function ToXml  ( const  AParent :  TMz_XmlElement )  : TMz_XmlElement ;  override;
• public function AddSkill  ( )  : TGorillaSkill ;  virtual;

  Adds a new and empty skill instance to the specific group and returns the newly created instance.

• public function FindSkillByName  ( const  ASkillName :  string )  : TGorillaSkill ;  virtual;

  Tries to find a specific skill by its display name. If the method cannot find a skill, it returns nil.

• public function FindSkillByGUID  ( const  AGUID :  TGUID )  : TGorillaSkill ;  virtual;

  Tries to find a specific skill by its GUID. If the method cannot find a skill, it returns nil.

• public function GetActivatedSkills  ( )  : TGorillaSkillMap ;  virtual;

  Searches and returns all activated skills. Each skill will be iterated to get the latest skill in row (if skills are linked).

Properties

• published Skills : TGorillaSkillCollection

  A collection of TGorillaSkill instances representing a single skill entity.

  read FSkills
  write FSkills
  

Fields

• protected FLanguage : Integer
  
• protected FGroups : TGorillaSkillGroupCollection
  
• protected FPosition : TPointF
  
• protected FLeveling : TGorillaSkillProcessThread
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• public procedure SaveToStream  ( const  AStream :  TStream ) ;  virtual;

  Stores the current skill system to stream as xml-format. Including all groups with skills and currently active leveling processes.

• public procedure SaveToFile  ( const  AFilename :  string ) ;  virtual;

  Stores the current skill system to file as xml-format. Including all groups with skills and currently active leveling processes.

• public procedure LoadFromStream  ( const  AStream :  TStream ) ;  virtual;

  Loads the skill system from xml formatted stream. Including all groups with skills and currently active leveling processes.

• public procedure LoadFromFile  ( const  AFilename :  string ) ;  virtual;

  Loads the skill system from xml file. Including all groups with skills and currently active leveling processes.

• public function GetCurrentLanguageId  ( )  : string ;  virtual;

  Returns the current language id depending on the set language value.

• public function AddGroup  ( )  : TGorillaSkillGroup ;  virtual;

  Adds and returns a new skill group to the system.

• public procedure RemoveGroup  ( const  AGroup :  TGorillaSkillGroup ) ;  virtual;

  Removes an existing skill group from system.

• public function FindSkillByGUID  ( const  AGUID :  TGUID )  : TGorillaSkill ;  virtual;

  Tries to find a specific skill by its unique guid. If no skill with this guid could be found, the method returns null.

Properties

• public Leveling : TGorillaSkillProcessThread

  Defines an integrated thread for leveling processes.

  read FLeveling
  
• public Position : TPointF

  Returns the internally stored pattern position. This is used for restoring the skilling system inside of a flow chart.

  read FPosition
  write FPosition
  
• published Language : Integer

  Defines the default language for automatic naming translation.

  read FLanguage
  write FLanguage
  
• published Groups : TGorillaSkillGroupCollection

  Defines a collection of skill groups / categories.

  read FGroups
  write FGroups