dfpyre 0.8.0__py3-none-any.whl → 0.8.2__py3-none-any.whl

dfpyre/action_literals.py

@@ -0,0 +1,16 @@
+from typing import Literal
+
+PLAYER_ACTION_ACTION = Literal['SetHotbar', 'SetReducedDebug', 'CloseInv', 'GiveItems', 'NoKeepInv', 'SetHandCrafting', 'BossBar', 'SetBossBar', 'ParticleSphere', 'SetVelocity', 'Particle', 'AddInvRow', 'NoNatRegen', 'DisplayLightning', 'Damage', 'SendAnimation', 'SetXPProg', 'SetInventory', 'TpSequence', 'Heal', 'SetSpawnPoint', 'SetInventoryKept', 'LaunchUp', 'GetTargetEntity', 'ForceFlight', 'LoadInv', 'ChatStyle', 'ChatColor', 'Kick', 'ProjColl', 'MiscAttribute', 'SpectateTarget', 'HurtAnimation', 'SurvivalMode', 'GmSurvival', 'DisplayBellRing', 'SetStatus', 'SetCursorItem', 'SetAbsorption', 'SetFireTicks', 'CombatAttribute', 'SetGamemode', 'RemoveInvRow', 'WakeUpAnimation', 'DisableBlocks', 'SetScoreObj', 'L SetHealth', 'ParticleEffect', 'ClearInv', 'SetFreezeTicks', 'SetGliding', 'SetRotation', 'ClearItems', 'SetFlying', 'DisplayBlockOpen', 'SetHandItem', 'SendAdvancement', 'ClearChat', 'SetMenuItem', 'LaunchToward', 'SetArmor', 'DisplayGateway', 'GiveSaturation', 'DisplayEquipment', 'GiveExp', 'FaceLocation', 'ClearScoreboard', 'ActionBar', 'SetChatTag', 'ShiftWorldBorder', 'DisplaySignText', 'SetSpeed', 'ExpandInv', 'LaunchProj', 'NoProjColl', 'ShowDisguise', 'ParticleCuboidA', 'PlaySound', 'SetCompass', 'MobDisguise', 'EnableBlocks', 'OpenBlockInv', 'ParticleCircleA', 'RemoveBossBar', 'ClearBars', 'SetEquipment', 'GiveRngItem', 'SetDropsEnabled', 'SendToPlot', 'RemovePotion', 'RemoveEffect', 'DisplayFracture', 'SetEntityHidden', 'SetSidebar', 'AllowDrops', 'Vibration', 'SetSlot', 'ParticleRay', 'ParticleCuboid', 'SendMessageSeq', 'SendDialogue', 'SetNamePrefix', 'ClearDispBlock', 'SetRainLevel', 'Undisguise', 'ParticleSpiralA', 'InstantRespawn', 'SetScore', 'SetNameColor', 'ReachAttribute', 'SetAtkSpeed', 'DisablePvp', 'SetTickRate', 'PlayEntitySound', 'ReplaceProj', 'SetExp', 'MiningAttribute', 'KBAttribute', 'MovementAttribute', 'ParticleSpiral', 'FallingAttribute', 'SetAllowFlight', 'SetMaxHealth', ' RemoveBossBar ', 'SetFogDistance', 'AdventureMode', 'GmAdventure', 'SpectatorMode', 'DispHeadTexture', 'ClearPotions', 'ClearEffects', 'SetTabListInfo', 'EnablePvp', 'HideDisguise', 'ScoreLineFormat', ' SetBossBar ', 'SetSkin', 'SpectatorCollision', 'SetNameVisible', 'SetInvulTicks', 'EnableFlight', 'SetStingsStuck', 'RemoveScore', 'DisallowDrops', 'SetExhaustion', 'ParticleCircle', 'DisplayBlock', 'RideEntity', 'WeatherRain', 'RmWorldBorder', 'ResourcePack', ' SetInvName ', 'GiveExhaustion', 'Teleport', 'SetAllowPVP', 'DisableFlight', 'SetVisualFire', 'SetDisguiseVisible', 'SetArrowsStuck', 'GetItemCooldown', 'SetItems', 'KeepInv', 'ReplaceItems', 'ReplaceItem', 'SendMessage', 'SetSlotItem', 'PlaySoundSeq', 'ParticleLineA', 'Respawn', 'SetInvName', 'SetItemCooldown', 'SetPlayerWeather', 'SendHover', 'SetShoulder', 'SetAirTicks', 'DisplayPickup', 'SetWorldBorder', 'SetPlayerTime', 'GiveFood', 'NatRegen', 'GivePotion', 'GiveEffect', 'RemoveItems', 'BoostElytra', 'SaveInv', 'OpenBook', 'SetHealth', 'BlockDisguise', 'RollbackBlocks', 'NoDeathDrops', 'WalkSpeed', 'SetCollidable', 'LaunchFwd', 'SetFallDistance', 'CreativeMode', 'AttackAnimation', 'DisplayHologram', ' SetAbsorption ', 'DeathDrops', 'ShowInv', 'SetFoodLevel', 'PlayerDisguise', 'SetSaturation', 'WeatherClear', 'SendTitle', 'Title', 'ScoreDefFormat', 'StopSound', 'HealthAttribute', 'ParticleLine']
+ENTITY_ACTION_ACTION = Literal['DispRotationEuler', 'Shear', 'SetVelocity', 'SetGlowSquidDark', 'SetFrogType', 'DispRotAxisAngle', 'Damage', 'SetMobSitting', 'SendAnimation', 'DisableGlowing', 'SetWardenAnger', 'SetHorsePattern', 'Heal', 'SetPandaSadTicks', 'SetItemOwner', 'SetDyeColor', 'LaunchUp', 'SetAge', ' SetName ', 'NoGravity', 'SetArmsRaised', 'SetMoveSpeed', 'SetInvulnerable', 'SetFriction', 'ProjColl', 'ArmorStandTags', 'SetPickupDelay', 'DropItems', 'MiscAttribute', 'SetCreeperPower', 'SetMarker', 'RemoveCustomTag', 'SetAbsorption', 'CreeperCharged', 'SetFireTicks', 'CombatAttribute', 'SetName', 'Jump', 'BDisplayBlock', 'SetFreezeTicks', 'TDisplaySeeThru', 'SetGliding', 'SetRotation', 'SetPandaRolling', 'SetFishPattern', 'SetWolfType', 'DispInterpolation', 'SetHandItem', 'SetEndermanBlock', 'LaunchToward', 'SetArmor', ' SetArmor ', 'GetCustomTag', 'InteractionSize', 'FaceLocation', 'SetCatType', 'SetArrowDamage', 'DisplayScale', 'TDisplayAlign', 'LaunchProj', 'EnableAI', 'DisplayBillboard', 'NoProjColl', 'Tame', 'SetGoatScreaming', 'SetBeeStinger', 'MobDisguise', 'SetMinecartBlock', 'FoxSleeping', 'SetEquipment', 'SetSilenced', 'SetBeeNectar', 'AttachLead', 'RemovePotion', 'RemoveEffect', 'ShearSheep', 'ArmorStandSlots', 'SetAllayDancing', 'SetRabbitType', 'SetSize', 'ShowName', 'SetAngry', 'SetAngerTicks', 'Undisguise', 'SetDeathDrops', 'SetPersistent', 'ProjectileItem', 'SetNameColor', 'SetCarryingChest', 'SetParrotColor', 'DispTranslation', 'Remove', 'TDispBackground', 'DisplayCullingSize', 'HideName', 'SetAxolotlColor', 'GetAllEntityTags', 'SetAI', 'KBAttribute', 'MovementAttribute', 'SetRiptiding', 'SetArrowNoClip', 'FallingAttribute', 'SetProjSource', 'SetFoxLeaping', 'SetPandaGene', 'SetMaxHealth', 'SetFishingTime', 'EndCrystalBeam', 'FrogEat', 'DisplayBrightness', 'SetProfession', 'ClearPotions', 'ClearEffects', 'ArmorStandParts', ' SetNameVisible ', 'SetTarget', 'TDisplayShadow', 'SetNameVisible', 'SetInvulTicks', 'SetShulkerPeek', ' SetPose ', 'SetRearing', 'SetCloudRadius', 'SetGravity', 'DispTPDuration', 'SetWitherInvul', 'Silence', 'SetArrowPierce', 'DisplayShadow', 'InteractResponse', 'UseItem', 'RideEntity', 'DisplayMatrix', 'NoDrops', 'SnifferState', 'EnableGlowing', 'Teleport', 'DisplayGlowColor', 'SetVisualFire', 'SetAge/Size', 'L SetArmor', 'SetSaddle', 'SetBulletTarget', 'TDisplayLineWidth', 'SetDragonPhase', 'SetLlamaColor', 'SetVillagerBiome', 'SetCreeperFuse', 'SetBaby', 'MooshroomType', 'SetInvisible', 'SheepEat', 'SetCatResting', 'GivePotion', 'GiveEffect', 'SetGoatHorns', 'SetGlowing', 'SetPandaOnBack', 'IDisplayModelType', 'SetHealth', 'BlockDisguise', 'SetCollidable', 'ArmorStandPose', 'SetPose', 'LaunchFwd', 'SetFallDistance', 'MoveToLoc', 'TDisplayOpacity', 'IDisplayItem', 'AttackAnimation', 'SnowmanPumpkin', 'SetCustomTag', 'Gravity', 'DisplayViewRange', 'NoAI', 'PlayerDisguise', 'SetItem', 'Explode', 'ExplodeCreeper', 'SetDigging', 'MoveTo', 'SetArrowHitSound', 'SetVexCharging', 'SetVillagerExp', 'IgniteCreeper', 'SetCelebrating', 'TDisplayText', 'SetHorseJump', 'Unsilence', 'HealthAttribute', 'Ram', 'SetFoxType']
+GAME_ACTION_ACTION = Literal['FillContainer', 'BreakBlock', 'L PFX Spiral', 'ParticleSphere', 'PFX Sphere', 'ChangeSign', 'WebRequest', 'ClearScBoard', 'HideSidebar', 'SpawnItemDisplay', 'WriteTransaction', 'ParticleSpiral', 'PFX Spiral', 'SetBlockData', 'Firework', 'SetEventDamage', 'SpawnItem', 'SignColor', 'ShulkerBullet', 'FireworkEffect', 'SetContainer', 'SpawnInteraction', 'SetItemInSlot', 'CloneRegion', 'CopyBlocks', 'UncancelEvent', 'SetLecternBook', 'SpawnArmorStand', 'SpawnBlockDisp', 'ClearContainer', 'CancelEvent', 'ParticleEffect', 'Particle FX', 'SpawnFangs', 'SetEventSound', 'SetEventXP', 'LockContainer', 'RemoveScore', 'CreateHologram', 'SetExhaustion', 'ParticleCircle', 'PFX Circle', 'PFX Line [A]', 'ClearItems', 'StartLoop', 'SetFurnaceSpeed', 'BlockDropsOn', 'BoneMeal', 'DebugStackTrace', 'FallingBlock', 'DiscordWebhook', 'TickBlock', 'ReplaceItems', 'SetEventProj', 'Explosion', 'SpawnMob', 'SetBrushableItem', 'ParticleLineA', 'SpawnEnderEye', 'ShowSidebar', 'SpawnPotionCloud', 'LaunchProj', ' SetBlock ', 'SpawnItemDisp', 'SetBlockGrowth', 'Wait', 'SetContainerName', 'SetHead', 'RemoveHologram', 'RemoveItems', 'SpawnRngItem', 'SetRegion', 'SetBlock', 'ParticleCircleA', 'PFX Circle [A]', 'SpawnTNT', 'SpawnExpOrb', 'SetBiome', 'SetEventHeal', 'PFX Path', 'ApplyTransaction', 'ParticleRay', 'PFX Ray', 'GenerateTree', 'StopLoop', 'SetScObj', 'SpawnCrystal', 'SetCampfireItem', 'SpawnTextDisplay', 'SpawnVehicle', 'Lightning', 'ParticleSpiralA', 'PFX Spiral [A]', 'SetScore', 'ParticleCluster', 'PFX Cluster', 'L PFX Cluster', 'BlockDropsOff', 'ParticleLine', 'PFX Line']
+SET_VAR_ACTION = Literal['GetItemFood', 'String', 'Text', 'SetParticleType', 'SetItemEnchants', 'ClearItemTag', 'PurgeVars', 'ShiftAllAxes', 'ShiftLocCoord', 'GetParticleMat', 'SetParticleSprd', 'AbsoluteValue', 'AppendValue', '%', 'ShiftOnVector', 'AddVectorLoc', 'GetItemAttribute', 'ClearDict', '+', 'ShiftRotation', 'RotateLocation', '-', ' GetItemName ', 'GetItemRarity', 'MultiplyVector', '/', 'GetSignText', 'Bitwise', 'GetLecternPage', 'ParseX', 'ShiftOnAxis', 'ShiftAxis', 'ParseY', 'VectorBetween', 'ParseZ', 'GetVectorComp', '=', 'RmText', 'AddItemAttribute', 'GetCenterLoc', 'FindCenter', 'AlignLoc', 'GetSoundVolume', 'RandomNumber', 'ContainerName', 'Raycast', 'RotateAroundVec', 'SetItemFood', 'GetParticleMotion', 'SetParticleMotion', 'Average', 'WrapNumber', 'ClampLoc', 'SetY', 'SetMapTexture', 'GetBlockData', 'SetX', 'SortDict', 'GetLecternBook', 'GetCustomSound', 'CrossProduct', 'x', 'GetParticleRoll', 'ParseYaw', 'DotProduct', 'SetZ', 'SetArmorTrim', 'PopListValue', 'SetParticleOpac', 'Noise', 'MinNumber', 'MinValue', 'Min', 'GetPotionType', 'SetItemName', 'ListLength', 'Sine', 'DirectionName', 'RepeatString', 'DuplicateText', 'RepeatText', 'GetItemLore', 'JoinString', 'JoinText', 'ReverseList', 'DedupList', 'CreateDict', 'GetBlockByMCTag', 'RoundNumber', 'FaceLocation', 'GetItemLoreLine', 'SetVectorLength', 'SetPotionDur', 'BlockResistance', 'SplitString', 'SplitText', 'NormalRandom', 'SetPotionType', 'AlignVector', 'SetItemDura', 'SetBreakability', 'SetMaxAmount', ' GetSignText ', 'RaycastEntity', 'SetDictValue', 'SetAllCoords', 'RGBColor', 'SetCanDestroy', 'HSLColor', ' GetDirection ', ' GetItemLore ', 'RemoveListIndex', 'CellularNoise', 'Logarithm', 'SetItemTag', 'TrimString', 'TrimText', 'ParseMiniMessageExpr', 'GetItemAmount', 'SetPotionAmp', 'GetCanDestroy', 'RotateAroundAxis', 'GetItemName', 'GetItemDura', 'ShiftInDirection', 'WrapNum', 'ReplaceString', 'ReplaceText', 'SetItemGlowing', ' SetItemName ', 'SetLodestoneLoc', 'FlattenList', 'BlockHardness', 'GetPotionAmp', 'GetParticleAmount', 'GetDictSize', 'SetItemAmount', 'SubtractVectors', 'SetCase', 'SetParticleColor', 'GetLight', ' GetBookText ', 'GetDictValues', 'Vector', 'Distance', 'SetItemLore', 'Root', 'SquareRoot', 'SetParticleAmount', 'AddItemEnchant', 'AddItemToolRule', 'GetItemType', 'GetDirection', 'GetLoreLine', 'GetParticleType', 'SetItemMaxDura', 'RemoveString', 'RemoveText', 'GetAllBlockData', 'MaxNumber', 'MaxValue', 'Max', 'GetDictKeys', 'TrimStyledText', 'SetParticleMat', 'GetCoord', 'RemoveItemTag', 'SetParticleSize', 'GetPotionDur', 'RandomLoc', 'SetSoundType', 'GetLodestoneLoc', 'ShiftDirection', 'GetContainerName', 'GetParticleSprd', 'ReflectVector', 'GetHeadOwner', 'GetItemEnchants', 'AppendDict', 'GetMaxItemAmount', 'GetColorChannels', ' SetDirection ', 'SetListValue', ' SetItemEnchants ', 'SetBookText', 'RandomValue', 'RandomObj', ' SetItemFlags ', 'SetItemType', 'GetSoundType', 'GetListValue', 'BounceNum', 'Tangent', 'VoronoiNoise', 'SetDirection', 'FaceDirection', 'HSBColor', 'HSVColor', '+=', 'GetSoundVariant', 'GetItemColor', 'ClearFormatting', 'InsertListValue', 'InsertListIndex', 'SetSoundVolume', 'SetCoord', 'AddVectors', 'SetPitch', 'GetParticleFade', 'RaycastBlock', 'SetItemTool', ' GetItemEnchants ', 'SetHeadTexture', 'SetHeadOwner', 'PerlinNoise', 'WorleyNoise', 'SetItemColor', 'SetLeatherColor', 'GetParticleColor', 'SetSoundPitch', ' RoundNumber ', 'GetCanPlaceOn', 'SortList', 'SetCustomSound', 'RemoveDictEntry', 'FormatTime', 'SetItemFlags', 'StringLength', 'TextLength', 'GetItemEffects', 'StyledText', 'GetMiniMessageExpr', 'SetYaw', ' SetItemLore ', 'SetItemEffects', '-=', 'GetItemTag', 'CreateList', 'AppendList', 'GetContainerItems', 'ShiftToward', 'ShiftTowards', 'ShiftLocTowards', 'TrimList', 'GradientNoise', 'SetItemHideTooltip', 'GetBlockDrops', 'ClearEnchants', 'Cosine', 'GetParticleOpac', 'GetItemByMCTag', 'SetParticleFade', 'SetVectorComp', 'ParseNumber', 'Exponent', 'ShiftAllDirs', 'GetValueIndex', 'RemItemEnchant', 'AddItemLore', 'GetBookText', 'SetParticleRoll', 'SetSoundVariant', 'ShiftLocation', 'RandomizeList', 'ClampNumber', 'Round', 'GetSoundPitch', 'TranslateColors', 'GetBlockGrowth', 'GetAllItemTags', 'RemoveListValue', 'ShiftAllDirections', 'ValueNoise', 'SetCanPlaceOn', 'GetBlockType', 'ParsePitch', 'GetDictValue', 'ContainerLock', 'GetBlockPower', 'GetVectorLength', 'ContentLength', 'SetModelData', 'SetCoords', 'GetMaxAmount', 'GetParticleSize']
+IF_PLAYER_ACTION = Literal['IsLookingAt', 'InWorldBorder', 'IsInGameMode', 'HasRoomForItem', 'PHasRoomForItem', 'IsHoldingOff', 'UsingPack', 'NoItemCooldown', 'IsUsingItem', 'HasAllItems', 'IsSwimming', 'HasItem', 'BlockEquals', 'IsWearing', 'PIsWearing', 'IsNear', 'PIsNear', 'IsRiding', 'StandingOn', 'PStandingOn', 'CmdEquals', ' StandingOn ', ' PStandingOn ', 'IsGrounded', 'CursorItem', 'SlotEquals', 'ItemEquals', 'IsHoldingMain', 'IsHolding', 'MenuSlotEquals', 'IsBlocking', 'HasPermission', ' IsRiding ', 'MainHandEquals', 'IsSneaking', 'IsFlying', 'HasPotion', 'HasEffect', 'NameEquals', 'PNameEquals', 'InvOpen', 'HasSlotItem', 'IsSprinting', 'IsGliding', 'CmdArgEquals']
+IF_ENTITY_ACTION = Literal['IsVehicle', 'IsGrounded', 'EIsGrounded', 'IsType', 'IsProj', 'IsMob', 'HasCustomTag', 'IsSheared', 'IsItem', ' IsRiding ', 'Exists', 'IsNear', 'EIsNear', 'HasPotion', 'IsRiding', 'StandingOn', 'EStandingOn', 'NameEquals', 'ENameEquals', ' StandingOn ', ' EStandingOn ']
+IF_GAME_ACTION = Literal['SignHasTxt', 'HasRoomForItem', 'EventBlockEquals', 'CommandEquals', 'EventItemEquals', ' SignHasTxt ', 'AttackIsCrit', 'ContainerHas', 'BlockEquals', 'GBlockEquals', 'InBlock', 'BlockPowered', 'HasPlayer', 'ContainerHasAll', 'CmdArgEquals', 'EventCancelled', 'IsChunkLoaded']
+IF_VAR_ACTION = Literal['<=', 'ItemHasEnchant', 'ItemIsBlock', 'DictValueEquals', 'ItemHasTag', 'StringMatches', ' TextMatches ', 'ListIsEmpty', 'StartsWith', 'ListValueEq', 'VarIsType', 'TextMatches', 'EqIgnoreCase', 'IsNear', 'VIsNear', ' InRange ', 'VarExists', 'BlockIsSolid', 'ItemEquals', 'VItemEquals', 'ListContains', 'InRange', 'LocIsNear', 'Contains', '!=', '<', '=', ' = ', '>', 'EndsWith', '>=', 'DictHasKey']
+REPEAT_ACTION = Literal['Adjacent', 'Path', 'Multiple', 'N Times', 'Grid', 'While', 'WhileCond', 'Range', 'ForEach', 'Sphere', 'Forever', ' Range ', 'ForEachEntry']
+SELECT_OBJ_ACTION = Literal['LastMob', 'RandomPlayer', 'LastEntity', 'Shooter', 'AllMobs', 'EntityName', 'FilterRandom', 'RandomSelected', 'DefaultEntity', 'PlayerName', 'AllEntities', 'Damager', 'FilterDistance', 'FilterRay', 'Reset', 'None', 'EventTarget', 'Killer', 'Victim', 'EntitiesCond', 'AllPlayers', 'Invert', 'RandomEntity', 'FilterCondition', 'FilterSelect', 'MobsCond', 'FilterSort', 'Projectile', 'DefaultPlayer', 'PlayersCond', 'MobName']
+CONTROL_ACTION = Literal['StopRepeat', 'Return', 'ReturnNTimes', 'Skip', 'End', 'Wait']
+EVENT_ACTION = Literal['ClickContainerSlot', 'CloseInv', 'StartFly', 'BreakBlock', 'StartSprint', 'MobKillPlayer', 'Teleport', 'ShootBow', 'StopFly', 'TameEntity', 'LeftClick', 'PlayerTakeDmg', 'ProjHit', 'KillPlayer', 'VehicleJump', 'ClickInvSlot', 'ClickOwnInv', 'Respawn', 'SwapHands', 'PackLoad', 'DamageEntity', 'Sneak', 'PlayerHeal', 'ClickPlayer', 'Consume', 'Death', 'PlaceBlock', 'Walk', 'PickUpItem', 'PickupItem', 'Dismount', 'CloudImbuePlayer', 'Leave', 'Quit', 'DropItem', 'LeftClickPlayer', 'ChangeSlot', 'ClickEntity', 'HorseJump', 'ShootProjectile', 'Move', 'Unsneak', 'Fish', 'FishEvent', 'FallDamage', 'BreakItem', 'LoopEvent', 'PlayerResurrect', 'RightClick', 'ClickMenuSlot', 'ClickItem', 'Riptide', 'KillMob', 'Join', 'EntityDmgPlayer', 'StopSprint', 'Jump', 'LoadCrossbow', 'ProjDmgPlayer', 'Command', 'LeftClickEntity', 'Exhaustion', 'PackDecline', 'PlayerDmgPlayer']
+ENTITY_EVENT_ACTION = Literal['EntityKillEntity', 'BlockFall', 'ProjKillEntity', 'EntityDmgEntity', 'FallingBlockLand', 'EntityResurrect', 'ItemMerge', 'EntityHeal', 'Teleport', 'ShootBow', 'EntityDmg', 'ProjDmgEntity', 'EntityExplode', 'EntityDeath', 'VehicleDamage', 'Transform', 'RegrowWool']
+REPEAT_SUBACTION = IF_PLAYER_ACTION | IF_ENTITY_ACTION | IF_GAME_ACTION | IF_VAR_ACTION

dfpyre/pyre.py

@@ -13,6 +13,7 @@ from dfpyre.util import *
 from dfpyre.items import *
 from dfpyre.scriptgen import generate_script, GeneratorFlags
 from dfpyre.actiondump import CODEBLOCK_DATA, get_default_tags
+from dfpyre.action_literals import *
 
 
 VARIABLE_TYPES = {'txt', 'comp', 'num', 'item', 'loc', 'var', 'snd', 'part', 'pot', 'g_val', 'vec', 'pn_el'}
@@ -349,47 +350,124 @@ def _assemble_template(starting_block: CodeBlock, codeblocks: list[CodeBlock], a
     return DFTemplate(template_codeblocks, author)
 
 
-def player_event(event_name: str, codeblocks: list[CodeBlock]=(), author: str|None=None) -> DFTemplate:
+def player_event(event_name: EVENT_ACTION, codeblocks: list[CodeBlock]=(), author: str|None=None) -> DFTemplate:
+    """
+    Represents a Player Event codeblock.
+
+    :param str event_name: The name of the event. (Ex: "Join")
+    :param list[CodeBlock] codeblocks: The list of codeblocks in this template.
+    :param str|None author: The author of this template.
+    """
     starting_block = CodeBlock.new_action('event', event_name, (), {})
     return _assemble_template(starting_block, codeblocks, author)
 
 
-def entity_event(event_name: str, codeblocks: list[CodeBlock]=[], author: str|None=None) -> DFTemplate:
+def entity_event(event_name: ENTITY_EVENT_ACTION, codeblocks: list[CodeBlock]=[], author: str|None=None) -> DFTemplate:
+    """
+    Represents an Entity Event codeblock.
+
+    :param str event_name: The name of the event. (Ex: "EntityDmg")
+    :param list[CodeBlock] codeblocks: The list of codeblocks in this template.
+    :param str|None author: The author of this template.
+    """
     starting_block = CodeBlock.new_action('entity_event', event_name, (), {})
     return _assemble_template(starting_block, codeblocks, author)
 
 
 def function(function_name: str, *args, tags: dict[str, str]={}, codeblocks: list[CodeBlock]=[], author: str|None=None) -> DFTemplate:
+    """
+    Represents a Function codeblock.
+
+    :param str event_name: The name of the function.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    :param list[CodeBlock] codeblocks: The list of codeblocks in this template.
+    :param str|None author: The author of this template.
+    """
     starting_block = CodeBlock.new_data('func', function_name, args, tags)
     return _assemble_template(starting_block, codeblocks, author)
 
 
 def process(process_name: str, *args, tags: dict[str, str]={}, codeblocks: list[CodeBlock]=[], author: str|None=None) -> DFTemplate:
+    """
+    Represents a Process codeblock.
+
+    :param str event_name: The name of the process.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    :param list[CodeBlock] codeblocks: The list of codeblocks in this template.
+    :param str|None author: The author of this template.
+    """
     starting_block = CodeBlock.new_data('process', process_name, args, tags)
     return _assemble_template(starting_block, codeblocks, author)
 
 
 def call_function(function_name: str, *args) -> CodeBlock:
+    """
+    Represents a Call Function codeblock.
+
+    :param str event_name: The name of the function.
+    :param tuple args: The argument items to include.
+    """
     return CodeBlock.new_data('call_func', function_name, args, {})
 
 
 def start_process(process_name: str, *args, tags: dict[str, str]={}) -> CodeBlock:
+    """
+    Represents a Call Function codeblock.
+
+    :param str event_name: The name of the function.
+    :param tuple args: The argument items to include.
+    """
     return CodeBlock.new_data('start_process', process_name, args, tags)
 
 
-def player_action(action_name: str, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}) -> CodeBlock:
+def player_action(action_name: PLAYER_ACTION_ACTION, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}) -> CodeBlock:
+    """
+    Represents a Player Action codeblock.
+
+    :param str action_name: The name of the action.
+    :param tuple args: The argument items to include.
+    :param Target target: The target for the action.
+    :param dict[str, str] tags: The tags to include.
+    """
     return CodeBlock.new_action('player_action', action_name, args, tags, target=target)
 
 
-def entity_action(action_name: str, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}) -> CodeBlock:
+def entity_action(action_name: ENTITY_ACTION_ACTION, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}) -> CodeBlock:
+    """
+    Represents an Entity Action codeblock.
+
+    :param str action_name: The name of the action.
+    :param tuple args: The argument items to include.
+    :param Target target: The target for the action.
+    :param dict[str, str] tags: The tags to include.
+    """
     return CodeBlock.new_action('entity_action', action_name, args, tags, target=target)
 
 
-def game_action(action_name: str, *args, tags: dict[str, str]={}) -> CodeBlock:
+def game_action(action_name: GAME_ACTION_ACTION, *args, tags: dict[str, str]={}) -> CodeBlock:
+    """
+    Represents a Game Action codeblock.
+
+    :param str action_name: The name of the action.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    """
     return CodeBlock.new_action('game_action', action_name, args, tags)
 
 
-def if_player(action_name: str, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+def if_player(action_name: IF_PLAYER_ACTION, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+    """
+    Represents an If Player codeblock.
+
+    :param str action_name: The name of the condition.
+    :param tuple args: The argument items to include.
+    :param Target target: The target for the condition.
+    :param dict[str, str] tags: The tags to include.
+    :param bool inverted: Whether the condition should be inverted.
+    :param list[CodeBlock] codeblocks: The list of codeblocks inside the brackets.
+    """
     return [
         CodeBlock.new_conditional('if_player', action_name, args, tags, inverted, target),
         CodeBlock.new_bracket('open', 'norm')
@@ -397,7 +475,17 @@ def if_player(action_name: str, *args, target: Target=DEFAULT_TARGET, tags: dict
         CodeBlock.new_bracket('close', 'norm')
     ]
 
-def if_entity(action_name: str, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+def if_entity(action_name: IF_ENTITY_ACTION, *args, target: Target=DEFAULT_TARGET, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+    """
+    Represents an If Entity codeblock.
+
+    :param str action_name: The name of the condition.
+    :param tuple args: The argument items to include.
+    :param Target target: The target for the condition.
+    :param dict[str, str] tags: The tags to include.
+    :param bool inverted: Whether the condition should be inverted.
+    :param list[CodeBlock] codeblocks: The list of codeblocks inside the brackets.
+    """
     return [
         CodeBlock.new_conditional('if_entity', action_name, args, tags, inverted, target),
         CodeBlock.new_bracket('open', 'norm')
@@ -406,7 +494,16 @@ def if_entity(action_name: str, *args, target: Target=DEFAULT_TARGET, tags: dict
     ]
 
 
-def if_game(action_name: str, *args, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+def if_game(action_name: IF_GAME_ACTION, *args, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+    """
+    Represents an If Game codeblock.
+
+    :param str action_name: The name of the condition.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    :param bool inverted: Whether the condition should be inverted.
+    :param list[CodeBlock] codeblocks: The list of codeblocks inside the brackets.
+    """
     return [
         CodeBlock.new_conditional('if_game', action_name, args, tags, inverted),
         CodeBlock.new_bracket('open', 'norm')
@@ -415,7 +512,16 @@ def if_game(action_name: str, *args, tags: dict[str, str]={}, inverted: bool=Fal
     ]
 
 
-def if_variable(action_name: str, *args, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+def if_variable(action_name: IF_VAR_ACTION, *args, tags: dict[str, str]={}, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+    """
+    Represents an If Variable codeblock.
+
+    :param str action_name: The name of the condition.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    :param bool inverted: Whether the condition should be inverted.
+    :param list[CodeBlock] codeblocks: The list of codeblocks inside the brackets.
+    """
     return [
         CodeBlock.new_conditional('if_var', action_name, args, tags, inverted),
         CodeBlock.new_bracket('open', 'norm')
@@ -425,6 +531,11 @@ def if_variable(action_name: str, *args, tags: dict[str, str]={}, inverted: bool
 
 
 def else_(codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
+    """
+    Represents an Else codeblock.
+
+    :param list[CodeBlock] codeblocks: The list of codeblocks inside the brackets.
+    """
     return [
         CodeBlock.new_else(),
         CodeBlock.new_bracket('open', 'norm')
@@ -433,7 +544,17 @@ def else_(codeblocks: list[CodeBlock]=[]) -> list[CodeBlock]:
     ]
 
 
-def repeat(action_name: str, *args, tags: dict[str, str]={}, sub_action: str|None=None, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> CodeBlock:
+def repeat(action_name: REPEAT_ACTION, *args, tags: dict[str, str]={}, sub_action: REPEAT_SUBACTION|None=None, inverted: bool=False, codeblocks: list[CodeBlock]=[]) -> CodeBlock:
+    """
+    Represents a Repeat codeblock.
+
+    :param str action_name: The name of the action.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    :param str|None sub_action: The sub-action for the repeat action (Only relevant for `While`)
+    :param bool inverted: Whether the sub-action condition should be inverted.
+    :param list[CodeBlock] codeblocks: The list of codeblocks inside the brackets.
+    """
     return [
         CodeBlock.new_repeat(action_name, args, tags, sub_action, inverted),
         CodeBlock.new_bracket('open', 'repeat')
@@ -442,13 +563,34 @@ def repeat(action_name: str, *args, tags: dict[str, str]={}, sub_action: str|Non
     ]
 
 
-def control(action_name: str, *args, tags: dict[str, str]={}) -> CodeBlock:
+def control(action_name: CONTROL_ACTION, *args, tags: dict[str, str]={}) -> CodeBlock:
+    """
+    Represents a Control codeblock.
+
+    :param str action_name: The name of the action.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    """
     return CodeBlock.new_action('control', action_name, args, tags)
 
 
-def select_object(action_name: str, *args, tags: dict[str, str]={}) -> CodeBlock:
+def select_object(action_name: SELECT_OBJ_ACTION, *args, tags: dict[str, str]={}) -> CodeBlock:
+    """
+    Represents a Select Object codeblock.
+
+    :param str action_name: The name of the action.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    """
     return CodeBlock.new_action('select_obj', action_name, args, tags) 
 
 
-def set_variable(action_name: str, *args, tags: dict[str, str]={}) -> CodeBlock:
+def set_variable(action_name: SET_VAR_ACTION, *args, tags: dict[str, str]={}) -> CodeBlock:
+    """
+    Represents a Set Variable codeblock.
+
+    :param str action_name: The name of the action.
+    :param tuple args: The argument items to include.
+    :param dict[str, str] tags: The tags to include.
+    """
     return CodeBlock.new_action('set_var', action_name, args, tags)

dfpyre/scriptgen.py

@@ -28,7 +28,7 @@ TEMPLATE_FUNCTION_LOOKUP = {
 }
 
 TARGET_CODEBLOCKS = {'player_action', 'entity_action', 'if_player', 'if_entity'}
-CONTAINER_CODEBLOCKS = {'event', 'entity_event', 'func', 'process', 'if_player', 'if_entity', 'if_game', 'if_variable', 'else', 'repeat'}
+CONTAINER_CODEBLOCKS = {'event', 'entity_event', 'func', 'process', 'if_player', 'if_entity', 'if_game', 'if_var', 'else', 'repeat'}
 VAR_SCOPES = {'unsaved': 'g', 'saved': 's', 'local': 'l', 'line': 'i'}
 
 
@@ -129,10 +129,15 @@ def add_script_line(flags: GeneratorFlags, script_lines: list[str], indent_level
 def generate_script(template, flags: GeneratorFlags) -> str:
     indent_level = 0
     script_lines = []
+
+    def remove_comma_from_last_line():
+        script_lines[-1] = script_lines[-1][:-1]
+
     for codeblock in template.codeblocks:
         # Handle closing brackets
         if codeblock.type == 'bracket':
             if codeblock.data['direct'] == 'close':
+                remove_comma_from_last_line()
                 indent_level -= 1
                 add_script_line(flags, script_lines, indent_level, '])')
             continue
@@ -182,6 +187,7 @@ def generate_script(template, flags: GeneratorFlags) -> str:
             line = f'{function_name}({", ".join(function_args)})'
             add_script_line(flags, script_lines, indent_level, line)
     
+    remove_comma_from_last_line()
     indent_level -= 1
     add_script_line(flags, script_lines, indent_level, '])')  # add final closing brackets
     return SCRIPT_START + '\n'.join(script_lines)

{dfpyre-0.8.0.dist-info → dfpyre-0.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dfpyre
-Version: 0.8.0
+Version: 0.8.2
 Summary: A package for creating and modifying code templates for the DiamondFire Minecraft server.
 Home-page: https://github.com/Amp63/pyre
 License: MIT
@@ -29,6 +29,11 @@ Run the following command in a terminal:
 pip install dfpyre
 ```
 
+
+### CodeClient Installation
+
+This module works best with [CodeClient](https://modrinth.com/mod/codeclient) installed. Once you've installed it, enable `CodeClient API` in the General config tab.
+
 ## Features
 - All code block types
 - All code item types
@@ -103,7 +108,7 @@ player_event('Join', [
 
 ## Events and Actions
 
-You can find a list of events and actions [here](#method-list)
+You can find a list of events and actions [here](#function-list)
 
 The following program sends a message to all players and gives a player 10 apples upon joining:
 
@@ -111,7 +116,7 @@ The following program sends a message to all players and gives a player 10 apple
 from dfpyre import *
 
 player_event('Join', [
-  player_action('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
+  player_action('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS),
   player_action('GiveItems', Item('apple', 10))
 ]).build_and_send('codeclient')
 ```
@@ -133,7 +138,7 @@ You can either:
 Represents a DiamondFire text item:
 
 ```py
-text('hello %default.')
+Text('hello %default.')
 ```
 
 If a regular string is passed to a method as a chest parameter, it will automatically be converted to a text object:
@@ -159,7 +164,7 @@ If a regular integer or float is passed to a method as a chest parameter, it wil
 
 ```py
 # These do the same thing:
-set_variable('=', Variable('number'), num(10))
+set_variable('=', Variable('number'), Number(10))
 set_variable('=', Variable('number'), 10)
 ```
 
@@ -275,7 +280,7 @@ from dfpyre import *
 
 part = Particle({'particle':'Cloud','cluster':{'amount':1,'horizontal':0.0,'vertical':0.0},'data':{'x':1.0,'y':0.0,'z':0.0,'motionVariation':100}})
 player_event('Join', [
-  player_action('Particle', part, loc(5, 50, 5))
+  player_action('Particle', part, Location(5, 50, 5))
 ])
 ```
 
@@ -288,14 +293,14 @@ Alias: `Pot`
 Represents a DiamondFire potion item:
 
 ```py
-# gives speed 1 for 1 minute
+# Gives speed 1 for 1 minute
 Potion('Speed', dur=1200, amp=0)
 ```
 
 Example:
 
 ```py
-# gives the player infinite saturation 255
+# Gives the player infinite saturation 10
 from dfpyre import *
 
 player_event('Join', [
@@ -315,7 +320,7 @@ GameValue('Location' target='Selection')
 Example:
 
 ```py
-# function that prints player count and cpu
+# Function that prints player count and CPU usage
 from dfpyre import *
 
 function('printData', [
@@ -336,7 +341,7 @@ Vector(x=1.1, y=0.0, z=0.5)
 Example:
 
 ```py
-# sets the player's x velocity to 1.0 on join
+# Sets the player's x velocity to 1.0 on join
 from dfpyre import *
 
 player_event('Join', [
@@ -355,20 +360,20 @@ Parameter('text', ParameterType.STRING)
 Example:
 
 ```py
-# builds a function that says "Hello, [name]" where `name` is the inputted parameter.
+# Builds a function that says "Hello, [name]" where `name` is the inputted parameter.
 from dfpyre import *
 
 name_parameter = parameter('name', ParameterType.TEXT)
-function('SayHi', name_parameter codeblocks=[
+function('SayHi', name_parameter, codeblocks=[
   player_action('SendMessage', 'Hello, ', Variable('name', 'line'))
 ])
 ```
 
 ### Conditionals and Brackets
 
-A list of conditionals and loops can be found [here](#method-list).
+A list of conditionals and loops can be found [here](#function-list).
 
-A specific syntax must be followed when creating conditionals and loops. Here's an example:
+To create code inside of brackets, use the `codeblocks` argument. Here's an example:
 
 ```py
 # Prints 'clicked' when a player right clicks with a stick in their hand
@@ -387,19 +392,21 @@ To create an `else` statement, use the `else_` method:
 # Says the player is 'on the ground' when grounded and 'in the air' otherwise.
 from dfpyre import *
 
-function('grounded' [
+function('grounded', codeblocks=[
   if_player('IsGrounded', codeblocks=[
     player_action('ActionBar', 'on the ground')
-  ])
+  ]),
   else_([
     player_action('ActionBar', 'in the air')
   ])
 ])
 ```
 
+Note that `player_event`, `entity_event`, and `else_` do not require `codeblocks=`, but all other bracket blocks do.
+
 ### Loops
 
-As for loops, the bracket syntax is the same and will automatically change to "repeat-type" brackets:
+As for loops, the syntax is the same and will automatically change to "repeat-type" brackets:
 
 ```py
 # Prints numbers 1-5
@@ -420,7 +427,7 @@ To create a function or process, just start the template with `function` or `pro
 # Function that gives a player 64 golden apples
 from dfpyre import *
 
-function('doStuff', codeblocks=[
+function('giveApples', codeblocks=[
   player_action('GiveItems', Item('golden_apple', 64))
 ])
 ```
@@ -433,12 +440,12 @@ Calling Functions and processes is also simple:
 from dfpyre import *
 
 player_event('Join', [
-  call_function('doStuff')
+  call_function('giveApples')
 ])
 ```
 
 ### Editing Tags
-You can edit an action's tags by passing the `tags` argument to a template method:
+You can modify an action's tags by passing the `tags` argument to a template method:
 
 ```py
 from dfpyre import *
@@ -466,7 +473,7 @@ t = DFTemplate.from_code(template_code)
 
 ### Script Generation
 
-You can also generate an equivalent python script for a template from a template object:
+You can also generate an equivalent Python script for a template from a template object:
 
 ```py
 from dfpyre import *
@@ -476,9 +483,11 @@ t = DFTemplate.from_code(template_code)
 t.generate_script('my_template.py')    # generated python script will be written to my_template.py
 ```
 
+This feature is useful for getting a text representation of existing templates.
+
 ### Function List
 
-- Events / Function / Process
+- **Events / Function / Process**
   - player_event
   - entity_event
   - function
@@ -486,12 +495,12 @@ t.generate_script('my_template.py')    # generated python script will be written
   - call_function
   - start_process
 
-- Actions
+- **Actions**
   - player_action
   - game_action
   - entity_action
 
-- Conditionals / Loops
+- **Conditionals / Loops**
   - if_player
   - if_variable
   - if_game
@@ -499,7 +508,7 @@ t.generate_script('my_template.py')    # generated python script will be written
   - else_
   - repeat
 
-- Other
+- **Other**
   - control
   - select_object
   - set_variable

{dfpyre-0.8.0.dist-info → dfpyre-0.8.2.dist-info}/RECORD

@@ -1,12 +1,13 @@
 dfpyre/__init__.py,sha256=apPsSxJ1Tztfl71MoORoSmDfX7LyKLYlLwOGeLQUitw,25
+dfpyre/action_literals.py,sha256=jvI3ZI1_rnDqS58q5Z0_bb5jgKJ2pu_pgN-1whXpEDQ,16212
 dfpyre/actiondump.py,sha256=MVI1kVJBNpab882Tgqo-xtemiBN2W1_2OcopBcRupWQ,2587
 dfpyre/data/actiondump_min.json,sha256=hFcIbG_G55FWwqRSW6X77ZrKkQiXLs4CGgJrZgyR2Gg,1938799
 dfpyre/items.py,sha256=fNcgX6oHc8F65Aj6TCC8BE0XhGsOmrLnPVcSZB3oPB0,11662
-dfpyre/pyre.py,sha256=UZRyEEG9PUBsMs97RNHzIkRAAtwlNB4I11ipDr1YmQ0,19125
-dfpyre/scriptgen.py,sha256=UUb5N-h_YUnbardeR1B2VDXMZq70al1U3PTEYqMoeHc,7424
+dfpyre/pyre.py,sha256=DM7QuLIPMRlHh13frzyx__6t-Auvx3yOjr2wiXRXzsI,24494
+dfpyre/scriptgen.py,sha256=X0GeH3DYJXXuXEF3Jj5joBu-MC94L2oswGCU1IlhToQ,7589
 dfpyre/style.py,sha256=mLW1CFvvi8_9fk8JaH10I5S4WI0YBdQIXHtI3G_4sR8,980
 dfpyre/util.py,sha256=EpX4XGwwX0A9MlObuQTEuHj4Q-55wj29m8am8ULPmz8,791
-dfpyre-0.8.0.dist-info/LICENSE,sha256=_vuDskB0ja2c-Fgm7Gt8Q8cO9NsLNpZAVyvmZwX7E6o,1060
-dfpyre-0.8.0.dist-info/METADATA,sha256=z8SXYRQTfmFjpjuNElBpePNXgd5caGwoTmK1-hV39B8,10898
-dfpyre-0.8.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-dfpyre-0.8.0.dist-info/RECORD,,
+dfpyre-0.8.2.dist-info/LICENSE,sha256=_vuDskB0ja2c-Fgm7Gt8Q8cO9NsLNpZAVyvmZwX7E6o,1060
+dfpyre-0.8.2.dist-info/METADATA,sha256=tbmPOL3dSlog2RVTj7_PcWG4Wf0TbA-0JvCZ1sNgrtY,11335
+dfpyre-0.8.2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+dfpyre-0.8.2.dist-info/RECORD,,