Guild of Writers

Revision as of 04:46, 3 May 2008

Given that you have an object in your scene (e.g. a book), this tutorial explains how to make it "clickable" - when you click on the book, it will trigger a script.

You will first need to create a "click region" around your object. Below are the steps to create a click region:

1. Choose Scripts->Add->PyPRP, then choose "Add a (Generic) Logic Region". It will appear in layer 2.
2. Select it, then move it to the place where the avatar will be standing when they attempt to click on the object.
   Below is an example of a click region surrounding a book.
   
3. Scale it so that it can encompass an avatar and the object that is clickable, then hit Ctrl-A to apply scale and rotation into the vertices.
4. Rename the object to something meaningful (e.g. MyClickRegion)
5. On the Logic panel:
   1. Click on Bounds, then set it to "Convex Hull Polytope"
   2. Click the Actor button on the Logic panel
   3. Your Logic panel should look like this:
      

Next, you need to prepare your object to be "clickable":

1. Select the object
2. On the Logic panel:
   1. Click on Bounds, then set it to "Convex Hull Polytope"
   2. Click the Actor button on the Logic panel
3. Add the following AlcScript entry:

   ObjectName:
       physical:
           pinned: true
       quickscript:
           simpleclick:
               pythonfile: myPythonFile
               region: MyClickRegion

But change "ObjectName" to your object's name, "myPythonFile" to the name of your python file, and "MyClickRegion" to the name of your click region.

Now you're ready to write your script. If you wish to write a journal, please use D'Lanor's Dynamic Book Template.

Adding an avatar animation

   ObjectName:
       physical:
           pinned: true
       quickscript:
           simpleclick:
               pythonfile: myPythonFile
               region: MyClickRegion
               animation: <animation name>
               animtarget: <animation start point>

The animation will not run automatically when added this way. We need a bit of Python script to activate it (which will be added as soon as I figure out how to get Python code on the wiki).

Adding a click sound

   ObjectName:
       physical:
           pinned: true
       quickscript:
           simpleclick:
               pythonfile: myPythonFile
               region: MyClickRegion
               soundemitter: MyEmitter