jsonpack

◀ Node

Helper class used for creating nodes.

Example Code

module = jsonpack.Module('default', 'data')

@module.node()
class Item(jsonpack.Node):
    ...

Default Arguments

Argument	Description
__file__	File path to the file that was loaded.

Methods

• .to_dict()
  Converts a :class:Node to a :class:dict
• .from_dict(data)
  Converts a :class:dict to a :class:Node
• .on_load()
  Should be overridden. Triggers when this node is loaded.
• .on_unload()
  Should be overridden. Triggers when this node is unloaded.

Componentable

Helper class used for creating nodes with dynamic components.

Example Code

module = jsonpack.Module('default', 'data')

@module.node()
class Item(jsonpack.Node, jsonpack.Componentable):
    traits = ['components']

@Item.component()
async def on_click(ctx:jsonpack.Context):
    pass

Arguments

Argument	Description
components	All components for this node.

Methods

• .get_component(name)
  Returns the component.
• .trigger_component(name, **extra)
  Returns the result of the component function when called.

Eventable

Helper class used for creating nodes with dynamic events.

Example Code

module = jsonpack.Module('default', 'data')

@module.node()
class Item(jsonpack.Node, jsonpack.Eventable):
    traits = ['events']

Arguments

Argument	Description
events	All events for this node.

Methods

• .add_event(name, **kw)
  Adds an event to the node.
• .remove_event(name)
  Removes an event at a specified name.
• .clear_events()
  Removes all events from this node.
• .get_event(name)
  Get the event from the name.
• .trigger_event(name)
  Runs this event from the name.

Imageable

Example Code

module = jsonpack.Module('default', 'resources')

@module.node()
class Texture(jsonpack.Node):
    traits = ['images']

Arguments

Argument	Description
image	The PIL.ImageFile from the loaded image

This site is open source. Improve this page.