Guild of Writers

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>

Change <animation name> to the name of an animation without the Male/Female prefix. Change <animation start> to the name of an object placed at the position where you want the animation to start.

The animation will not run automatically. We need a bit of Python script to activate it.

actClickableObject = ptAttribActivator(1, 'Clickable object activator')
strObject = ptAttribString(2, 'Object string')
Behavior = ptAttribBehavior(3, 'Avatar animation')
kAnimSeconds = 2.0
kAnimID = 1

class myPythonFile(ptModifier,):

    def OnNotify(self, state, id, events):
        if ((id == actClickableObject.id) and state):
            Avatar = PtFindAvatar(events)
            Behavior.run(Avatar)
            PtAtTimeCallback(self.key, kAnimSeconds, kAnimID)



    def OnTimer(self, id):
        if (id == kButtonID):
            #here comes the action for your clickable



# paste default glue section here

Adding a click sound

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

Change "MyEmitter" to the name of your sound emitter.