Skill Web
  • Skill Web Documentation
  • đŸ•šī¸Quick Start
    • Installation
  • Start Developing
  • 💡General
    • Running the Demos
  • Menu Options
  • UI Customizations
    • uGUI
      • Skill Node
      • Connection Line
      • Web View
      • Hovercard
  • Datasets
  • 🎓Tutorials
    • Runes Demo Walkthrough
  • âœī¸Editors
    • Skill Bank
  • Web Creator
  • Settings
  • Components
    • Skill Web Initializer
    • uGUI
      • Skill Node UGUI
      • Connection Line
        • Curved Connection Line
      • Web View UGUI
        • Web View Selector UGUI
      • Skill Hovercard UGUI
    • Player Web Link
  • 📄Scripting API
    • Initialization
  • Skills
    • Skill
      • Skill Dataset Attributes
    • Skill Node
  • Webs
    • Web Graph
    • Web
  • UI
    • Loading a Web
    • Web View Input Handling
    • Customize Connection Line
    • Customize Hovercard
  • Player Web Link
  • Custom Logic
  • Saving & Loading
  • Events
  • Skill Web Settings
  • Procedural Generation (Beta)
  • đŸ› ī¸Support
    • Getting Help
  • 📚Changelogs
    • Latest Releases
    • Future Plans
    • ⭐Rate Me?
Powered by GitBook
On this page
  • Fields & Properties
  • Notable Methods
  • Link
  • Unlink
  • Get Skill Nodes
  • Is Obtained

Player Web Link

Scripting with the PlayerWebLink class.

The PlayerWebLink is used to link a Web with the player (or any) GameObject.

Fields & Properties

Name
Description
Type
Access

webName

The name of the web to link with.

string

public

linkAutomatically

If the component should automatically link to the web. Automatic linking requires a Web to be loaded by a web view component. Disable this if you'd like to handle linking yourself.

bool

public

linkedWeb

The linked web. This will be null if there was no link made.

Web

public

obtainedSkills

A list of obtained skills. This is updated automatically as long as there is a link set.

List<SkillNode>

public

IsLinked

If linked with a web.

bool

public

Notable Methods

Link

The Link method tries to link with a web using the webName field. No link will be made if the relevant web view component is not found.

playerWebLink.Link();

Alternatively, you can provide a Web reference to link to Web without the need of a web view.

playerWebLink.Link(myWeb);

Unlink

The Unlink method unlinks from a linked web. Nothing happens if there is no link set.

playerWebLink.Unlink();

Get Skill Nodes

You can get the first SkillNode by its skill ID or skill name with the GetSkillNode method.

SkillNode skillNode = playerWebLink.GetSkillNode("My Skill");

Alternatively, you can use GetSkillNodes to get all skills in the graph with a matching skill ID or skill name.

List<SkillNode> skillNodes = playerWebLink.GetSkillNodes("My Skill");

Getting all obtained skill nodes has a special method called GetObtainedSkillNodes.

List<SkillNode> obtainedSkillNodes = playerWebLink.GetAllObtainedSkills();

Is Obtained

The IsObtained method checks if a skill node with a specific skill ID or skill name is obtained.

bool isObtained = web.IsObtained("My Skill");
PreviousCustomize HovercardNextCustom Logic

Last updated 11 days ago