doc-worldobject.html

<!doctype html>
<html lang="en">
  <head>
    <!-- Required meta tags -->
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <link rel="icon" href="images/TotalAILogoTrans32.png" type="image/x-icon">
    <link rel="preconnect" href="https://fonts.gstatic.com">
    <link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600|Roboto Mono&amp;display=swap" rel="stylesheet">
    <link href="https://fonts.googleapis.com/css2?family=Goldman&display=swap" rel="stylesheet">

    <!-- Bootstrap CSS -->
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
    <link rel="stylesheet" href="main.css">

    <title>Total AI</title>
  </head>
  <body>
    
    <nav class="navbar sticky-top tai-navbar">
      <a class="navbar-brand" style="margin-top: -8px; margin-bottom: -8px;" href="index.html">
        <img src="images/TotalAILogoTrans.png" height="40" alt="" loading="lazy">
      </a>
    
      <ul class="nav mr-auto">
        <li class="nav-item">
          <a class="nav-link" href="index.html">Home <span class="sr-only">(current)</span></a>
        </li>
        <li class="nav-item">
          <a class="nav-link active" href="doc-introduction.html">Guide</a>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="insp-introduction.html">Inspectors</a>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="script-introduction.html">Scripts</a>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="videos.html">Videos</a>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="contributors.html">Contributors</a>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="about.html">About</a>
        </li>
        <li class="nav-item" style="padding-left: 25px;">
          <a class="nav-link" href="contrib-introduction.html">Contribute</a>
        </li>
      </ul>
      <ul class="nav justify-content-end">
        <li class="nav-item">
          <a class="nav-link" target="_blank" href="https://discord.gg/PfKUm42Zax">
            Discord
            <svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
              <path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
              <path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
            </svg>
          </a>
        </li>
        <li class="nav-item">
          <a class="nav-link" target="_blank" href="https://github.com/TotalAI/TotalAI">
            GitHub
            <svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
              <path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
              <path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
            </svg>
          </a>
        </li>
        <li class="nav-item">
          <a class="nav-link" target="_blank" href="https://patreon.com/zacwarren">
            Patreon
            <svg width="1em" height="1em" viewBox="0 0 20 20" class="bi bi-box-arrow-up-right" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
              <path fill-rule="evenodd" d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z"/>
              <path fill-rule="evenodd" d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z"/>
            </svg>
          </a>
        </li>
      </ul>
    </nav>
    
    <main style="width: 100%">
    <div class="container-fluid">
      <div class="row flex-xl-nowrap">
        <div class="col-md-3 col-xl-2" style="position: sticky; top: 0; z-index: 1000; height: calc(100vh - 4rem); order: 0; overflow-y: auto; padding-top: 10px; padding-bottom: 40px;">
          <h3 class="nav-header">Getting Started</h3>
          <ul class="nav flex-column">
            <li class="nav-item">
              <a class="nav-link" href="doc-introduction.html">Introduction</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-installation.html">Install & Setup</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-demo.html">Demo Worlds</a>
            </li>
          </ul>
          <h3 class="nav-header">Entities</h3>
          <ul class="nav flex-column navbar-light">
            <li class="nav-item">
              <a class="nav-link" href="doc-agent.html">Agent</a>
            </li>
            <li class="nav-item">
              <a class="nav-link active" href="doc-worldobject.html">WorldObject</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-agentevent.html">AgentEvent</a>
            </li>
          </ul>
          <h3 class="nav-header">Levels</h3>
          <ul class="nav flex-column navbar-light">
            <li class="nav-item">
              <a class="nav-link" href="doc-drive.html">Drive</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-action.html">Action</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-attribute.html">Attribute</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-tag.html">Tag</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-role.html">Role</a>
            </li>
          <h3 class="nav-header">Agent</h3>
          <ul class="nav flex-column navbar-light">
            <li class="nav-item">
              <a class="nav-link" href="doc-agent-main-loop.html">Main Loop</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-movementtype.html">Movement Type</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-animationtype.html">Animation Type</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-sensortype.html">Sensor Type</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-memorytype.html">Memory Type</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-decider.html">Decider</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-plannertype.html">Planner Type</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-mapping.html">Plans & Mappings</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-behavior.html">Behavior</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-historytype.html">History Type</a>
            </li>
          </ul>
          <h3 class="nav-header">AI Types</h3>
          <ul class="nav flex-column navbar-light">
            <li class="nav-item">
              <a class="nav-link" href="doc-fsm.html">FSM</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-goap.html">GOAP</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-utility-ai.html">Utility AI</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-deep-rl.html">Deep RL</a>
            </li>
          </ul>
          <h3 class="nav-header">Other</h3>
          <ul class="nav flex-column navbar-light">
            <li class="nav-item">
              <a class="nav-link" href="doc-typematching.html">Type Matching</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-inventory.html">Inventory</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-design-principles.html">Design Principles</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-scriptableobjects.html">ScriptableObjects</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-selector.html">Selector</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-utility-curve.html">Utility Curve</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-utility-function.html">Utility Function Type</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-included-ui.html">UI & Placement</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="doc-more-resources.html">External Links</a>
            </li>
          </ul>
        </div>
      <div class="col-md-1">

      </div>
      <div class="col content" style="padding-top: 40px; padding-bottom: 40px; line-height: 1.6em; color: #304455; font-size: 1rem;">
      
        <h1>World Object</h1>
        
        <h3>What is a World Object?</h3>
        <hr>
        <p>
          A World Object is an Entity that exists in the World but can't make decisions or act. World Object derives
          from MonoBehavior so it is a component that is attached to a Game Object.  A World Object can have <b>inventory,
          states, various appearances, and can be built or grow</b>.
        </p>
        <h3>World Object Type</h3>
        <hr>
        <p>
          An World Object Type <b>defines the default configuration</b> for a World Object.  It also defines what Mapping Types
          a World Object of World Object Type can be part of.
          <br><br>
          <a class="text-link" href="insp-worldobjecttype.html">Inspector Reference</a>
          <br>
          <a class="text-link" href="script-worldobjecttype.html">Script Reference</a>
        </p>
        <h3>Inventory</h3>
        <hr>
        <p>
          WorldObjects are Entities and can therefore can carry Entities or be carried.
          <br><br>
          See the <a class="text-link" href="doc-inventory.html">inventory section</a> for more information.
        </p>
        <h3>Built</h3>
        <hr>
        <p>
           World Object Types can be built by setting the type to "Built" and by setting a Completion Points amount.
           This is the number of points
           required for a World Object to be considered Completed.  Completion points can be increased through Mappings
           run by Agents.  The physical representation of the WorldObject can change as the completion points increase.
           This can either be done through scaling up the base prefab or through different prefabs that are shown depending
           on the completion points.  These are set in the Skin Prefabs section.
        </p>
        <h3>Grows</h3>
        <hr>
        <p>
           World Object can also grow.  Usually these are some kind of vegetation.  The World Object Type allows you to specify
           the growth rate.
        </p>
        <h3>Damagable</h3>
        <hr>
        <p>
           A World Object Type can also allow a World Object to be damaged and after reaching a certain damaged level the
           World Object can be destroyed.
        </p>
        <h3>States</h3>
        <hr>
        <p>
           World Objects can also exist in various states.  The most common example would be a Door being either "Open" or
           "Closed".  Through Mapping Types an Agent can change the World Object's state.  States can also automatically change
           over a period of time.
           When a World Object enters or exits a State it can have exit or enter
           <a class="text-link" href="insp-outputchange.html" >Output Changes</a> run.
        </p>
        <h3>Skin Prefabs</h3>
        <hr>
        <p>
           Skin prefabs determine the appearance of the World Object based on Completion Points, Damage Points,
           current State, and Inventory Slot Conditions.  Inventory Slot Conditions allow for the World Object to
           change how it looks based on its inventory.
           <br><br>
           The change of appearance is accomplished by having an empty GameObject containing the model under it.  The World
           Object will then switch out everything under the empty GameObject when the skin prefab changes.  The name
           of this empty GameObject is specified in the Skin Game Object Name field.  The order of the skin prefabs
           does matter as it will pick the first skin prefab where all of the conditions pass.
        </p>
        <h3>Inventory Recipes</h3>
        <hr>
        <p>
           World Objects can convert their inventory into other inventory using WOT Inventory Recipes.  This will happen
           automatically if the World Object is in the correct state with the correct amount of input Entity Types.
           The amount of time it takes to convert can also be specified.
        </p>
      </div>
      <div class="col-md-3">

      </div>
    </div>
    </main>

    <script>
      $(document).ready(function() {
        $(window).resize(function() {
          resize();
        });
        function resize() {
          var myheight = $(window).outerHeight(true) - 0;
          $('.main').outerHeight(myheight);
        }
        resize();
      });
    </script>
    <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
  </body>
</html>