UAM/Python - Revision history

Dustin at 04:15, 24 October 2010

2010-10-24T04:15:57Z

Dustin at 17:02, 23 October 2010

2010-10-23T17:02:47Z

WikiSysop at 01:08, 20 October 2010

2010-10-20T01:08:55Z

Dustin at 23:57, 19 October 2010

2010-10-19T23:57:22Z

Dustin at 23:56, 19 October 2010

2010-10-19T23:56:09Z

Dustin at 23:48, 19 October 2010

2010-10-19T23:48:02Z

Dustin at 23:42, 19 October 2010

2010-10-19T23:42:38Z

Dustin at 23:37, 19 October 2010

2010-10-19T23:37:48Z

Dustin at 23:32, 19 October 2010

2010-10-19T23:32:44Z

Dustin: Created page with 'This page lists some of the many things you can do with the "uam" Python module! =Commands= ==LinkToAge== x = 3 '

2010-10-19T23:29:22Z

Created page with 'This page lists some of the many things you can do with the "uam" Python module! =Commands= ==LinkToAge== <source lang="python"> x = 3 </source>'

New page

This page lists some of the many things you can do with the "uam" Python module!

=Commands=
==LinkToAge==
<source lang="python">
x = 3
</source>

@@ Line 71: / Line 71: @@
 ==EnableReltoPage==
-This is only to be used on Relto Pages that *you* have yourself made.  Most Relto pages will probably be had by players by default.  But a fan-made Relto page can be set to be "unattained" by default, so that the player must ear it, and calling this will give it to them.  So you would want to call this after they have solved a puzzle or such.  It will cause their Relto book to flash too, just like when collecting one of Cyan's Relto pages.  For more information, see [[UAM/ReltoPages]]
+This is only to be used on Relto Pages that *you* have yourself made.  Most Relto pages will probably be had by players by default.  But a fan-made Relto page can be set to be "unattained" by default, so that the player must earn it, and calling this will give it to them.  So you would want to call this after they have solved a puzzle or such.  It will cause their Relto book to flash too, just like when collecting one of Cyan's Relto pages.  For more information, see [[UAM/ReltoPages]]
 If your Relto page is called "Personal_District_UamPage-DustinsFancyReltoThing.prp", you might do this example.  (Note that the name of the page does not include the "UamPage-" part.)

@@ Line 10: / Line 10: @@
 Here's an example of setting the value to "red" if it is currently set to "green":
 <source lang="python">
-    import uam
+import uam
-    puzcolor = uam.GetAgeChronicle("PuzzleColour")
+puzcolor = uam.GetAgeChronicle("PuzzleColour")
-    if puzcolor=="green":
+if puzcolor=="green":
-        puzcolor = "red"
+    puzcolor = "red"
-        uam.SetAgeChronicle("PuzzleColour",puzcolor)
+    uam.SetAgeChronicle("PuzzleColour",puzcolor)
 </source>
@@ Line 23: / Line 23: @@
 Here is an example, for if you want to link to the Age "EderRiltehInaltahv".  You could also have specified another spawnpoint, but LinkInPointDefault is the normal starting point in an Age.
 <source lang="python">
-    import uam
+import uam
-    uam.LinkToAge("EderRiltehInaltahv","LinkInPointDefault")
+uam.LinkToAge("EderRiltehInaltahv","LinkInPointDefault")
 </source>
@@ Line 33: / Line 33: @@
 E.g.
 <source lang="python">
-    import uam
+import uam
-    uam.PrintKiMessage("Hello player!")
+uam.PrintKiMessage("Hello player!")
 </source>
@@ Line 43: / Line 43: @@
 This example will have it wait 4.0 seconds, at which time it will print a message to the screen.  Notice that the function "SayHello" takes no arguments.  Note that all of this, including the definition for "SayHello", can all be inside another function.
 <source lang="python">
-    import uam
+import uam
-    def SayHello():
+def SayHello():
-        uam.PrintKiMessage("Ah my friend, you've returned!")
+    uam.PrintKiMessage("Ah my friend, you've returned!")
-    uam.SetTimer(SayHello, 4.0)
+uam.SetTimer(SayHello, 4.0)
 </source>
@@ Line 55: / Line 55: @@
 To show an open journal:
 <source lang="python">
-    import uam
+import uam
-    uam.DisplayJournal("Thanks for reading me!", True)
+uam.DisplayJournal("Thanks for reading me!", True)
 </source>
@@ Line 65: / Line 65: @@
 To show the linking book for Aerie, using the standard link-in point:
 <source lang="python">
-    import uam
+import uam
-    uam.DisplayLinkingBook("Aerie", "LinkInPointDefault")
+uam.DisplayLinkingBook("Aerie", "LinkInPointDefault")
 </source>
@@ Line 75: / Line 75: @@
 If your Relto page is called "Personal_District_UamPage-DustinsFancyReltoThing.prp", you might do this example.  (Note that the name of the page does not include the "UamPage-" part.)
 <source lang="python">
-    import uam
+import uam
-    if puzzlesolved==True:
+if puzzlesolved==True:
-        uam.EnableReltoPage("DustinsFancyReltoThing")
+    uam.EnableReltoPage("DustinsFancyReltoThing")
 </source>

@@ Line 2: / Line 2: @@
 =General Information=
-Although the examples show the "import uam" line all the time, you can normally just write that one time, at the top of the file.
+Although the examples show the "import uam" line all the time, you can normally just write that one time, at the top of the file.  The rule for what can be used and what can't is very simple:  Anything that begins with a "_" can't be used, and everything else can!  (This applies to [[UamVars]] too.)  So don't import any UAM modules that begin with "_" and don't use any functions that begin with "_".  It's thus easy to keep clear what is reliable and cross-platform, and what isn't!
 =Commands=

@@ Line 71: / Line 71: @@
 ==EnableReltoPage==
-This is only to be used on Relto Pages that *you* have yourself made.  Most Relto pages will probably be had by players by default.  But a fan-made Relto page can be set to be "unattained" by default, so that the player must ear it, and calling this will give it to them.  So you would want to call this after they have solved a puzzle or such.  It will cause their Relto book to flash too, just like when collecting one of Cyan's Relto pages.
+This is only to be used on Relto Pages that *you* have yourself made.  Most Relto pages will probably be had by players by default.  But a fan-made Relto page can be set to be "unattained" by default, so that the player must ear it, and calling this will give it to them.  So you would want to call this after they have solved a puzzle or such.  It will cause their Relto book to flash too, just like when collecting one of Cyan's Relto pages.  For more information, see [[UAM/ReltoPages]]
 If your Relto page is called "Personal_District_UamPage-DustinsFancyReltoThing.prp", you might do this example.  (Note that the name of the page does not include the "UamPage-" part.)

@@ Line 57: / Line 57: @@
      import uam
      uam.DisplayJournal("Thanks for reading me!", True)
 </source>