Feat/client labor #2666
Feat/client labor #2666
Conversation
|
Hi @bob0005! You need to be added as a user to interact with me. Please ask @ponderingdemocritus to add you on the settings page. You are receiving this comment because I am set to review all PRs. That is configurable here. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
client/apps/game/src/main.tsxOops! Something went wrong! :( ESLint: 9.18.0 ESLint couldn't find an eslint.config.(js|mjs|cjs) file. From ESLint v9.0.0, the default configuration file is now eslint.config.js. https://eslint.org/docs/latest/use/configure/migration-guide If you still have problems after following the migration guide, please stop by WalkthroughThis pull request introduces a comprehensive set of changes focused on implementing a labor production system in the game. The modifications span multiple files across the client and core packages, adding new components, enums, and methods to support labor-related functionality. Key additions include a new Changes
Sequence DiagramsequenceDiagram
participant User
participant RightNavigationModule
participant EntityLaborTable
participant LaborChip
participant SystemCalls
User->>RightNavigationModule: Select Labor Table
RightNavigationModule->>EntityLaborTable: Render with entityId
EntityLaborTable->>LaborChip: Display Labor Options
User->>LaborChip: Set Production Amount
User->>LaborChip: Click "Start Producing"
LaborChip->>SystemCalls: start_production(resourceType, amount)
SystemCalls-->>LaborChip: Production Started
Suggested reviewers
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Failed to generate code suggestions for PR |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (10)
packages/core/src/constants/utils.ts (1)
17-18: Mirror the same constant usage for clarity.
The same “255” offset reappears here. Reuse a dedicated constant for both functions to avoid drift and improve clarity.- return 255 - laborType; + const ID_OFFSET = 255; + return ID_OFFSET - laborType;packages/core/src/managers/config-manager.ts (4)
42-55: Modular initialization with a minor logging nitpick.
Splitting out initialization methods is a clean approach, but consider removing or downgrading theconsole.login production to prevent log verbosity.- console.log("setting dojo for config manager"); + // console.debug("setting dojo for config manager");
Line range hint
136-174: Large default object for troop config.
Consider extracting the default object into a well-documented constant for clarity and maintainability.
563-578: Resource output initialization with commented labor cost.
You might reintroduce or remove thelaborCostline. Leaving it commented can cause confusion.- // laborCost: this.divideByPrecision(Number(productionConfig?.labor_cost)), + // TODO: Decide whether to remove or incorporate labor cost logic.
639-642: Structure cost handling limited to Hyperstructure.
Only Hyperstructure is assigned a construction cost. If you plan to add more structure types, expand this logic.Do you want me to scaffold placeholders for future structures?
client/apps/game/src/ui/components/resources/entity-labor-table.tsx (1)
12-23: Add loading state and user feedback for production actions.The production start function should:
- Show loading state during the async operation
- Provide user feedback on success/failure
- Validate input parameters before making the system call
+ const [isLoading, setIsLoading] = useState(false); + const startProduction = async (resourceType: ResourcesIds, producedAmount: number) => { + if (producedAmount <= 0) { + console.error("Production amount must be positive"); + return; + } + setIsLoading(true); try { await dojo.setup.systemCalls.start_production({ signer: dojo.account.account, entity_id: entityId, resource_type: resourceType, amount: producedAmount, }); + // TODO: Add toast notification for success } catch (error) { console.error("Failed to start production", error); + // TODO: Add toast notification for error + } finally { + setIsLoading(false); } };client/apps/game/src/ui/components/resources/labor-chip.tsx (2)
48-50: Add disabled state and loading indicator to the production button.The button should be disabled when:
- Production amount is 0 or invalid
- Production is in progress
-<Button variant="primary" onClick={() => startProduction(resourceId, productionAmount)}> +<Button + variant="primary" + disabled={productionAmount <= 0 || isLoading} + onClick={() => startProduction(resourceId, productionAmount)} +> - Start Producing + {isLoading ? 'Starting...' : 'Start Producing'} </Button>
27-27: Improve accessibility by adding ARIA labels.Add proper ARIA labels to improve accessibility for screen readers.
-<div className={`flex gap-2 relative group items-center text-xs px-2 p-1 hover:bg-gold/20 `}> +<div + className={`flex gap-2 relative group items-center text-xs px-2 p-1 hover:bg-gold/20`} + role="region" + aria-label={`Labor production for ${findResourceById(resourceId)?.trait}`} +>client/apps/game/src/ui/components/hyperstructures/hyperstructure-resource-chip.tsx (1)
Line range hint
1-110: Fix code formatting issues.The pipeline indicates formatting issues. Please run Prettier to format the code:
prettier --write "client/apps/game/src/ui/components/hyperstructures/hyperstructure-resource-chip.tsx"🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting issues detected. Run Prettier with --write to fix.
packages/core/src/provider/index.ts (1)
1142-1159: LGTM! Consider extracting contract address.The implementation is correct and follows the pattern of other methods. However, consider extracting the contract address to avoid repetition.
Apply this diff to improve the code:
public async start_production(props: SystemProps.StartProductionProps) { const { entity_id, resource_type, amount, signer } = props; + const contractAddress = getContractByName(this.manifest, `${NAMESPACE}-production_systems`); const makeProductionLaborCallData = { - contractAddress: getContractByName(this.manifest, `${NAMESPACE}-production_systems`), + contractAddress, entrypoint: "make_production_labor", calldata: [entity_id, resource_type, amount], }; const burnProductionLaborCallData = { - contractAddress: getContractByName(this.manifest, `${NAMESPACE}-production_systems`), + contractAddress, entrypoint: "burn_production_labor", calldata: [entity_id, resource_type, amount], }; const calldataArray = [makeProductionLaborCallData, burnProductionLaborCallData]; return await this.executeAndCheckTransaction(signer, calldataArray); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
client/apps/game/src/main.tsx(1 hunks)client/apps/game/src/types/index.ts(1 hunks)client/apps/game/src/ui/components/hyperstructures/hyperstructure-resource-chip.tsx(3 hunks)client/apps/game/src/ui/components/resources/entity-labor-table.tsx(1 hunks)client/apps/game/src/ui/components/resources/entity-resource-table.tsx(2 hunks)client/apps/game/src/ui/components/resources/labor-chip.tsx(1 hunks)client/apps/game/src/ui/components/resources/resource-chip.tsx(3 hunks)client/apps/game/src/ui/components/structures/construction/structure-construction-menu.tsx(2 hunks)client/apps/game/src/ui/config.tsx(1 hunks)client/apps/game/src/ui/elements/resource-icon.tsx(1 hunks)client/apps/game/src/ui/modules/navigation/right-navigation-module.tsx(4 hunks)contracts/game/src/models/config.cairo(0 hunks)contracts/game/src/systems/config/contracts.cairo(0 hunks)contracts/game/src/systems/production/contracts.cairo(0 hunks)packages/core/src/constants/index.ts(1 hunks)packages/core/src/constants/utils.ts(2 hunks)packages/core/src/dojo/create-system-calls.ts(2 hunks)packages/core/src/managers/config-manager.ts(22 hunks)packages/core/src/managers/resource-manager.ts(2 hunks)packages/core/src/provider/index.ts(1 hunks)packages/core/src/types/provider.ts(1 hunks)
💤 Files with no reviewable changes (3)
- contracts/game/src/models/config.cairo
- contracts/game/src/systems/production/contracts.cairo
- contracts/game/src/systems/config/contracts.cairo
🧰 Additional context used
🪛 Biome (1.9.4)
client/apps/game/src/ui/components/resources/entity-labor-table.tsx
[error] 26-26: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead.
See the MDN documentation for more details.
Unsafe fix: Use Number.isNaN instead.
(lint/suspicious/noGlobalIsNan)
🪛 GitHub Actions: lint
client/apps/game/src/ui/components/hyperstructures/hyperstructure-resource-chip.tsx
[warning] Code formatting issues detected. Run Prettier with --write to fix.
🔇 Additional comments (47)
packages/core/src/constants/utils.ts (2)
1-1: Import statement looks correct.
The new import forLaborIdsaligns well with the added functions below.
13-15: Avoid magic number “255.”
This function hardcodes255. Consider storing255in a named constant (e.g.,const ID_OFFSET = 255;) or verifying thatresourceTypecannot exceed 255.packages/core/src/managers/config-manager.ts (30)
18-18: New imports from “../types.”
ImportingResourceCost,TickIds, andTravelTypesappears consistent with the added functionality.
24-32: New properties for labor and resource initialization.
DefininglaborInputsand other records at the class level centralizes configuration data. This approach is concise and maintainable.
Line range hint
98-105: Check for negative or unexpected resource weights.
The_getValueOrDefaultusage is consistent, but confirm whether a negative or zero weight is acceptable.
Line range hint
108-115: Confirm default of 1 for travel stamina cost.
Returning a fallback of1might unintentionally penalize or benefit travel if that’s not the correct domain assumption.
Line range hint
118-125: Explore stamina default parity with travel.
A fallback of1for explore stamina cost should match domain expectations.
128-134: Zero explore reward fallback.
If the config is absent, a reward of0might undercut exploration incentives. Verify it’s correct.
Line range hint
177-189: Grace tick logic is straightforward.
The switch statement is fine; just confirm additional structure types do not require a custom immunity.
191-197: Zero battle delay fallback.
A zero delay could allow battles to happen too rapidly. Ensure this matches the game design.
Line range hint
199-234: Resource bridge fee configuration is robust.
Storing all fee distributions here is a good design, neatly enumerating each fee type.
Line range hint
236-243: Potential issues with zero tick interval.
A tick interval of0might trigger continuous updates or break logic. Verify this fallback.
Line range hint
247-278: Bank config defaults.
Returning0for all cost and fees is convenient but might be risky if the system expects a positive cost.
280-285: Capacity checks.
Confirm if a fallback of0capacity is feasible or if a minimum capacity is necessary.
Line range hint
287-299: Behavior if speed is zero.
A0speed might skip travel time or cause undefined behavior. Validate it.
Line range hint
301-319: No population or capacity fallback.
Returning zeros might cause building logic to fail if not handled.
Line range hint
321-339: Hyperstructure config fallback.
All-zero configuration might allow immediate completion or no progress. Double-check.
Line range hint
403-410: Base population capacity fallback.
If set to0, population might never grow. Confirm whether this is the intended behavior.
Line range hint
412-421: Default resource outputs.
A fallback of0might be correct for some resources, but verify it doesn’t break progression or cause confusion.
Line range hint
423-445: Food cost fallback.
Check that a cost of0won’t result in free movement.
Line range hint
447-452: Troop stamina fallback.
0stamina could lock troops or cause them to be perpetually exhausted.
Line range hint
477-485: No cost percent increase fallback.
A0percent might mean building costs never escalate. Confirm that’s desired.
Line range hint
487-502: Season bridge configuration.
A fallback of0nseconds could allow immediate or indefinite closures. Confirm the impact on bridging.
Line range hint
504-520: Season defaults imply an ended season.
WithisOver: trueandendedAt: 0n, normal gaming flow could be skipped. Validate if that’s okay.
Line range hint
522-530: Weightless resources.
If resources are truly weightless, the code is correct. Otherwise, investigate whether weight0is an omission.
532-561: Realm upgrade cost initialization.
Good use of a loop to gather cost data, but consider if level 0 or above max level needs handling.
580-606: Building costs per resource.
Ensure that if a resource is invalid or missing, the loop doesn’t push undefined entries.
608-637: General building cost logic.
The iteration to fetch resource cost details is consistent.
643-653: Hyperstructure construction cost with min_amount.
Currently pulling themin_amountalone. If a max or random range is needed, verify the logic.
655-672: Total hyperstructure costs are well-organized.
Collects min and max amounts by resource tier. Implemented cleanly.
674-696: Labor inputs initialization.
Neatly retrieves labor costs for each resource, enhancing flexibility for future expansions.
698-703: Generic value fallback.
A solid utility pattern for fallback values.client/apps/game/src/types/index.ts (1)
6-6: New “LaborTable” enum value.
AddingLaborTableunderRightViewseamlessly supports the new labor UI.client/apps/game/src/ui/components/resources/entity-resource-table.tsx (1)
42-42: LGTM! Type safety improvement.Good improvement replacing
anywith properResourcesIdstype for better type safety.packages/core/src/constants/index.ts (1)
48-75: 🛠️ Refactor suggestionDocument and validate the labor ID calculation logic.
The current implementation has several potential issues:
- The magic number 255 lacks documentation explaining its significance
- There's no validation that ResourcesIds values are less than 255
- Could generate duplicate LaborIds if ResourcesIds > 255
Let's verify if any ResourcesIds values could cause issues:
Consider adding:
- Documentation explaining the 255 constant
- Runtime validation
- A type-safe mapping function
/** Maximum value for resource IDs to ensure valid labor ID calculation */ const MAX_RESOURCE_ID = 255; /** Maps resource IDs to labor IDs using bitwise complement within byte range */ function validateLaborId(resourceId: number): number { if (resourceId > MAX_RESOURCE_ID) { throw new Error(`Resource ID ${resourceId} exceeds maximum value ${MAX_RESOURCE_ID}`); } return MAX_RESOURCE_ID - resourceId; } export enum LaborIds { Stone = validateLaborId(ResourcesIds.Stone), Coal = validateLaborId(ResourcesIds.Coal), // ... rest of the mappings }client/apps/game/src/main.tsx (1)
75-75: LGTM! Proper initialization sequence.The placement of
initialSyncaftersetupResultensures correct initialization order and prevents duplicate sync calls.client/apps/game/src/ui/components/hyperstructures/hyperstructure-resource-chip.tsx (1)
7-7: LGTM! Simplified resource identification logic.The direct use of
findResourceByIdmakes the code more straightforward and reduces unnecessary function calls.Also applies to: 73-73, 86-86
🧰 Tools
🪛 GitHub Actions: lint
[warning] Code formatting issues detected. Run Prettier with --write to fix.
client/apps/game/src/ui/modules/navigation/right-navigation-module.tsx (2)
38-52: LGTM! Well-structured labor table navigation.The labor table navigation follows the existing pattern and includes proper conditional rendering based on structureEntityId.
99-100: LGTM! Clean conditional rendering.The conditional rendering of resource and labor tables is well-implemented, ensuring only one view is active at a time.
client/apps/game/src/ui/config.tsx (1)
107-107: LGTM! Consistent enum extension.The addition of
laborTableto MenuEnum follows the existing pattern and integrates well with the navigation system.client/apps/game/src/ui/components/structures/construction/structure-construction-menu.tsx (1)
118-118: Verify resource cost calculation after RESOURCE_PRECISION removal.The removal of RESOURCE_PRECISION multiplication from the resource cost calculation could affect how costs are displayed. Please ensure this change is intentional and doesn't impact the accuracy of displayed resource costs.
client/apps/game/src/ui/elements/resource-icon.tsx (2)
1-1: LGTM! Improved SVG handling.The change to use ReactComponent for the People icon import is a better approach for SVG handling.
Line range hint
12-12: LGTM! Enhanced tooltip customization.The addition of the optional tooltipText prop improves component flexibility while maintaining backward compatibility.
packages/core/src/dojo/create-system-calls.ts (2)
113-115: LGTM! Clean implementation of start_production.The new system call follows the established pattern and is properly integrated into the systemCalls export.
300-300: LGTM! Proper systemCalls update.The start_production system call is correctly added to the exported systemCalls object.
packages/core/src/types/provider.ts (1)
241-245: LGTM! Well-structured interface for production system.The
StartProductionPropsinterface follows the established patterns and includes all necessary properties with appropriate types.client/apps/game/src/ui/components/resources/resource-chip.tsx (1)
5-5: LGTM! Clean removal of labor-specific logic.The removal of the
isLaborprop simplifies the component by:
- Relying solely on
resourceIdfor resource identification- Moving labor-specific logic to dedicated components
- Maintaining core functionality while reducing complexity
Also applies to: 81-81, 96-96, 99-99
| }; | ||
|
|
||
| return Object.entries(LaborIds).map(([_, laborId]) => { | ||
| if (isNaN(Number(laborId))) return null; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace isNaN with Number.isNaN for safer type checking.
The isNaN function performs type coercion which can lead to unexpected results. Use Number.isNaN instead for more reliable number validation.
- if (isNaN(Number(laborId))) return null;
+ if (Number.isNaN(Number(laborId))) return null;📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| if (isNaN(Number(laborId))) return null; | |
| if (Number.isNaN(Number(laborId))) return null; |
🧰 Tools
🪛 Biome (1.9.4)
[error] 26-26: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead.
See the MDN documentation for more details.
Unsafe fix: Use Number.isNaN instead.
(lint/suspicious/noGlobalIsNan)
| <NumberInput | ||
| value={productionAmount} | ||
| onChange={(productionAmount) => setProductionAmount(productionAmount)} | ||
| className="col-span-7" | ||
| /> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add validation for production amount input.
The NumberInput component should have minimum/maximum value constraints and proper validation.
<NumberInput
value={productionAmount}
onChange={(productionAmount) => setProductionAmount(productionAmount)}
+ min={0}
+ max={999999}
className="col-span-7"
/>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <NumberInput | |
| value={productionAmount} | |
| onChange={(productionAmount) => setProductionAmount(productionAmount)} | |
| className="col-span-7" | |
| /> | |
| <NumberInput | |
| value={productionAmount} | |
| onChange={(productionAmount) => setProductionAmount(productionAmount)} | |
| min={0} | |
| max={999999} | |
| className="col-span-7" | |
| /> |
| {laborInputs?.map(({ resource, amount }) => ( | ||
| <div key={resource} className="flex flex-row items-center"> | ||
| <ResourceIcon | ||
| withTooltip={false} | ||
| resource={findResourceById(resource)?.trait as string} | ||
| size="sm" | ||
| className="mr-3 self-center" | ||
| /> | ||
| <div className="text-red">-{amount * productionAmount}</div> | ||
| </div> | ||
| ))} |
There was a problem hiding this comment.
Add null check for laborInputs before mapping.
The current implementation might throw if laborInputs is undefined.
- {laborInputs?.map(({ resource, amount }) => (
+ {laborInputs ? (
+ laborInputs.map(({ resource, amount }) => (
<div key={resource} className="flex flex-row items-center">
<ResourceIcon
withTooltip={false}
resource={findResourceById(resource)?.trait as string}
size="sm"
className="mr-3 self-center"
/>
<div className="text-red">-{amount * productionAmount}</div>
</div>
- ))}
+ ))
+ ) : (
+ <div>No labor inputs configured</div>
+ )}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {laborInputs?.map(({ resource, amount }) => ( | |
| <div key={resource} className="flex flex-row items-center"> | |
| <ResourceIcon | |
| withTooltip={false} | |
| resource={findResourceById(resource)?.trait as string} | |
| size="sm" | |
| className="mr-3 self-center" | |
| /> | |
| <div className="text-red">-{amount * productionAmount}</div> | |
| </div> | |
| ))} | |
| {laborInputs ? ( | |
| laborInputs.map(({ resource, amount }) => ( | |
| <div key={resource} className="flex flex-row items-center"> | |
| <ResourceIcon | |
| withTooltip={false} | |
| resource={findResourceById(resource)?.trait as string} | |
| size="sm" | |
| className="mr-3 self-center" | |
| /> | |
| <div className="text-red">-{amount * productionAmount}</div> | |
| </div> | |
| )) | |
| ) : ( | |
| <div>No labor inputs configured</div> | |
| )} |
| <a | ||
| className="text-brown cursor-pointer text-lg w-full" | ||
| href={`https://empire.realms.world/trade`} | ||
| target="_blank" | ||
| rel="noopener noreferrer" | ||
| > | ||
| <Button variant="secondary" className="w-full"> | ||
| <div className="flex items-center gap-2"> | ||
| <ResourceIcon resource="Lords" size="xs" /> | ||
| Bridge Lords & Resources | ||
| </div> | ||
| </Button> | ||
| </a> |
There was a problem hiding this comment.
💡 Codebase verification
Environment-specific URL handling needs attention
While the link is secure with proper target="_blank" and rel="noopener noreferrer" attributes, there's an inconsistency in environment handling:
- The bridge URL in
right-navigation-module.tsxis hardcoded to mainnet (empire.realms.world/trade) - Other components (e.g.,
onboarding.tsx) properly switch between mainnet/non-mainnet URLs based onVITE_PUBLIC_CHAIN
Consider updating the URL to respect the environment setting:
const bridgeUrl = env.VITE_PUBLIC_CHAIN === "mainnet"
? "https://empire.realms.world/trade"
: "https://empire-next.realms.world/trade";🔗 Analysis chain
Verify security implications of external link.
The external link to empire.realms.world is properly implemented with security attributes (target="_blank" and rel="noopener noreferrer"). However, please verify:
- The URL is correct and points to the intended environment
- The feature flag or environment check is not needed for this link
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for other instances of this URL to verify consistency
rg -l 'empire\.realms\.world'
# Search for environment-specific URL configurations
rg -l 'VITE_PUBLIC.*URL|VITE_PUBLIC.*ENDPOINT'
Length of output: 1059
Script:
#!/bin/bash
# Check how the URL is used in other files
rg -A 2 -B 2 'empire\.realms\.world'
# Check environment configuration files for URL settings
cat client/apps/game/env.ts
cat client/apps/game/dojoConfig.ts
# Look for any feature flags related to trading or bridging
rg -i "feature.*flag.*bridge|feature.*flag.*trade"
Length of output: 8038
| public getLabor() { | ||
| const labor = getComponentValue( | ||
| this.components.Resource, | ||
| getEntityIdFromKeys([BigInt(this.entityId), BigInt(getLaborIdFromResourceId(this.resourceId))]), | ||
| ); | ||
| return labor; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling to getLabor method.
The method should handle cases where getComponentValue returns undefined.
public getLabor() {
const labor = getComponentValue(
this.components.Resource,
getEntityIdFromKeys([BigInt(this.entityId), BigInt(getLaborIdFromResourceId(this.resourceId))]),
);
- return labor;
+ if (!labor) {
+ return null; // or a default value depending on your needs
+ }
+ return labor;
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| public getLabor() { | |
| const labor = getComponentValue( | |
| this.components.Resource, | |
| getEntityIdFromKeys([BigInt(this.entityId), BigInt(getLaborIdFromResourceId(this.resourceId))]), | |
| ); | |
| return labor; | |
| } | |
| public getLabor() { | |
| const labor = getComponentValue( | |
| this.components.Resource, | |
| getEntityIdFromKeys([BigInt(this.entityId), BigInt(getLaborIdFromResourceId(this.resourceId))]), | |
| ); | |
| if (!labor) { | |
| return null; // or a default value depending on your needs | |
| } | |
| return labor; | |
| } |
| /** | ||
| // * Start production of a resource | ||
| // * | ||
| // * @param props - Properties for starting production | ||
| // * @param props.entity_id - ID of the entity that owns the production building | ||
| // * @param props.resource_type - Type of resource to start production of | ||
| // * @param props.labor_amount - Amount of resources to produce | ||
| // * @param props.signer - Account executing the transaction | ||
| // * @returns Transaction receipt | ||
| // * | ||
| // * @example | ||
| // * ```typescript | ||
| // * // Burn 100 units of labor for resource type 1 | ||
| // * { | ||
| // * entity_id: 123, | ||
| // * resource_type: 1, | ||
| // * labor_amount: 100, | ||
| // * signer: account | ||
| // * } | ||
| // * ``` | ||
| // */ |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Uncomment and update the method documentation.
The documentation is currently commented out. It should be uncommented and the parameter name should be updated from labor_amount to amount to match the implementation.
Apply this diff to fix the documentation:
- // * Start production of a resource
- // *
- // * @param props - Properties for starting production
- // * @param props.entity_id - ID of the entity that owns the production building
- // * @param props.resource_type - Type of resource to start production of
- // * @param props.labor_amount - Amount of resources to produce
- // * @param props.signer - Account executing the transaction
- // * @returns Transaction receipt
- // *
- // * @example
- // * ```typescript
- // * // Burn 100 units of labor for resource type 1
- // * {
- // * entity_id: 123,
- // * resource_type: 1,
- // * labor_amount: 100,
- // * signer: account
- // * }
- // * ```
- // */
+ /**
+ * Start production of a resource
+ *
+ * @param props - Properties for starting production
+ * @param props.entity_id - ID of the entity that owns the production building
+ * @param props.resource_type - Type of resource to start production of
+ * @param props.amount - Amount of resources to produce
+ * @param props.signer - Account executing the transaction
+ * @returns Transaction receipt
+ *
+ * @example
+ * ```typescript
+ * // Burn 100 units of labor for resource type 1
+ * {
+ * entity_id: 123,
+ * resource_type: 1,
+ * amount: 100,
+ * signer: account
+ * }
+ * ```
+ */
Temp UI element to start production
Summary by CodeRabbit
New Features
Improvements
Bug Fixes
Chores