Category: Gameplay Classes
Actors act as controllers, combining some number of ba.Nodes, - ba.Textures, ba.Sounds, etc. into one cohesive unit.
+ ba.Textures, ba.Sounds, etc. into a high-level cohesive unit. -Some example actors include ba.Bomb, ba.Flag, and ba.Spaz.
+Some example actors include Bomb, Flag, and Spaz classes in bastd.
One key feature of Actors is that they generally 'die' (killing off or transitioning out their nodes) when the last Python reference to them disappears, so you can use logic such as:
- # create a flag Actor in our game activity
- self.flag = ba.Flag(position=(0, 10, 0))
+ # Create a flag Actor in our game activity:
+ from bastd.actor.flag import Flag
+ self.flag = Flag(position=(0, 10, 0))
-# later, destroy the flag.. +# Later, destroy the flag. # (provided nothing else is holding a reference to it) - # we could also just assign a new flag to this value. - # either way, the old flag disappears. + # We could also just assign a new flag to this value. + # Either way, the old flag disappears. self.flag = NoneThis is in contrast to the behavior of the more low level ba.Nodes, @@ -566,13 +568,13 @@ is a convenient way to access this same functionality.
takes a single arbitrary object as an argument. This provides a safe way to communicate between ba.Actor, ba.Activity, ba.Session, and any other class providing a handlemessage() method. The most universally handled - message type for actors is the ba.DieMessage. + message type for Actors is the ba.DieMessage. -# another way to kill the flag from the example above: - # we can safely call this on any type with a 'handlemessage' method - # (though its not guaranteed to always have a meaningful effect) - # in this case the Actor instance will still be around, but its exists() - # and is_alive() methods will both return False +# Another way to kill the flag from the example above: + # We can safely call this on any type with a 'handlemessage' method + # (though its not guaranteed to always have a meaningful effect). + # In this case the Actor instance will still be around, but its exists() + # and is_alive() methods will both return False. self.flag.handlemessage(ba.DieMessage())@@ -590,15 +592,10 @@ is a convenient way to access this same functionality.<constructor>, autoretain(), exists(), getactivity(), handlemessage(), is_alive(), is_expired(), on_expire()
ba.Actor(node: ba.Node = None)
+ba.Actor()
Instantiates an Actor in the current ba.Activity.
-If 'node' is provided, it is stored as the 'node' attribute -and the default ba.Actor.handlemessage() and ba.Actor.exists() -implementations will apply to it. This allows the creation of -simple node-wrapping Actors without having to create a new subclass.
-autoretain(self: T) -> T
@@ -627,8 +624,7 @@ their corpse is visible; this is about presence, not being 'alive' deleted without affecting the game; this call is often used when pruning lists of Actors, such as with ba.Actor.autoretain() -The default implementation of this method returns 'node.exists()' -if the Actor has a 'node' attr; otherwise True.
+The default implementation of this method always return True.
Note that the boolean operator for the Actor class calls this method, so a simple "if myactor" test will conveniently do the right thing @@ -1106,7 +1102,7 @@ when done.
Instantiate a Call; pass a callable as the first arg, followed by any number of arguments or keywords.
-# Example: wrap a method call with 1 positional and 1 keyword arg. +# Example: wrap a method call with 1 positional and 1 keyword arg: mycall = ba.Call(myobj.dostuff, argval1, namedarg=argval2)# Now we have a single callable to run that whole mess. @@ -1345,8 +1341,8 @@ Usage: sets the context as current on entry and resets it to the previous value on exit. -# example: load a few textures into the UI context -# (for use in widgets, etc) +# Example: load a few textures into the UI context +# (for use in widgets, etc): with ba.Context('ui'): tex1 = ba.gettexture('foo_tex_1') tex2 = ba.gettexture('foo_tex_2')@@ -3250,7 +3246,7 @@ the two nodes exist. The connection can be severed by setting the target attribute to any value or connecting another node attribute to it. -# example: create a locator and attach a light to it +# Example: create a locator and attach a light to it: light = ba.newnode('light') loc = ba.newnode('locator', attrs={'position': (0,10,0)}) loc.connectattr('position', light, 'position')@@ -3311,6 +3307,48 @@ Node-messages communicate directly with the low-level node layer and are delivered simultaneously on all game clients, acting as an alternative to setting node attributes. +
inherits from: ba.Actor
+A simple ba.Actor type that wraps a single ba.Node.
+ +Category: Gameplay Classes
+ +This Actor will delete its Node when told to die, and it's + exists() call will return whether the Node still exists or not. +
+ +The Activity this Actor was created in.
+ +Raises a ba.ActivityNotFoundError if the Activity no longer exists.
+ +ba.NodeActor(node: ba.Node)
+ +Instantiates an Actor in the current ba.Activity.
+ +handlemessage(self, msg: Any) -> Any
+ +General message handling; can be passed any message object.
+ +The default implementation will handle ba.DieMessages by +calling self.node.delete() if self contains a 'node' attribute.
+the 'timeformat' arg defaults to SECONDS but can also be MILLISECONDS if you want to pass time as milliseconds.
-# example: use a Timer object to print repeatedly for a few seconds: +# Example: use a Timer object to print repeatedly for a few seconds: def say_it(): ba.screenmessage('BADGER!') def stop_saying_it(): @@ -4817,7 +4855,7 @@ self.t = ba.Timer(0.3, say_it, repeat=True)Instantiate a WeakCall; pass a callable as the first arg, followed by any number of arguments or keywords.
-# example: wrap a method call with some positional and +# Example: wrap a method call with some positional and # keyword args: myweakcall = ba.WeakCall(myobj.dostuff, argval1, namedarg=argval2)@@ -5149,6 +5187,11 @@ logs. The call functions by registering the filename and line where The call is made from. Returns True if this location has not been registered already, and False if it has. +# Example: this print will only fire for the first loop iteration: +for i in range(10): + if ba.do_once(): + print('Hello once from loop!')+
ba.emitfx()
emitfx(position: Sequence[float],